Provides script language access to C++ objects of this type.
| Class Hierarchy | Type » Render3D |
Function members are as follows:
| Return Type | Function Name | Documentation |
|---|---|---|
| int32 | AttachColorBuffer | Attaches a color buffer to the specified frame buffer. The size of the color buffer must match the size of the frame buffer or this function will fail. |
| int32 | AttachDepthBuffer | Attaches a depth buffer to the specified frame buffer. The size of the depth buffer must match the size of the frame buffer or this function will fail. |
| int32 | ClearBuffers | Clears the color and/or depth buffer of the rendering device before rendering traversal. |
| int32 | CopyFrameBuffer | Internal use only. |
| int32 | CpuAwaitFence | Calls glClientWaitSync and inserts a fence that causes the CPU/client to wait until all commands issued to OpenGL have completed. |
| int32 | CreateColorBuffer | Creates a color buffer of the specified format, width and height. This color buffer can then be attached to a frame buffer using the rendering device's AttachColorBuffer function. It can also be applied to a dynamic texture handle using the rendering device's GetColorBufferTextureHandle function. |
| int32 | CreateColorDepthBuffer | Creates a color buffer of the specified format, width and height. This color buffer can then be attached to a frame buffer using the rendering device's AttachColorBuffer function. It can also be applied to a dynamic texture handle using the rendering device's GetColorBufferTextureHandle function. |
| int32 | CreateDepthBuffer | Creates a depth buffer of the specified width and height. This depth buffer can then be attached to a frame buffer using the rendering device's AttachDepthBuffer function. |
| int32 | CreateFrameBuffer | Creates a frame buffer of the specified width and height. |
| int32 | DeleteBuffer | Deletes a buffer created by the rendering device. |
| int32 | DeleteFence | Calls glDeleteFence and deletes the specified fence. |
| int64 | DeleteProgram | Deletes a <Program> created by the rendering device. Note that it cannot be used to delete a <Program> node. |
| int32 | DestroyShaderBuffer | Deallocates the shader buffer on the GPU. |
| int32 | DestroyTexture | Deallocates a texture on the GPU. |
| int32 | DestroyUniformBuffer | Deallocates the uniform buffer on the GPU. |
| int32 | DetachColorBuffer | Detaches a color buffer from the specified frame buffer. |
| int32 | DisplayBufferPreview | Displays a frame buffer on the rendering device, in the specified viewport. |
| int32 | DisplayPreview | Displays the current state of the rendering device in the specified viewport. |
| int32 | DisplayTexturePreview | Displays a texture on the rendering device, in the specified viewport. |
| int32 | EnableColorBuffer | Toggles color buffer writes in the rendering device. |
| int32 | EnableDepthBuffer | Toggles depth buffer writes in the rendering device. |
| int32 | ExecuteMeshProgram | Executes a task/mesh/fragment program. |
| int32 | ExecuteProgram | Executes the specified <Program> node using the specified work group and local group counts. Please see OpenGL dispatch compute for more information. |
| int32 | Finish | Calls glFinish. |
| int32 | Flush | Calls glFlush. |
| <Matrix> | GetCameraInverseMatrix | Retrieves the current camera transformation matrix in world coordinates. That is, the transformation from eye space to world coordinates. |
| <Matrix> | GetCameraMatrix | Retrieves the complete camera and view specification active in the device. |
| int32 | GetColorBufferTextureHandle | Returns a texture handle from a color buffer. One use for the resulting texture handle would be as the handle for a dynamic texture object. |
| <RenderDeviceCaps> | GetDeviceCapabilities | Returns a pointer to the <RenderDeviceCaps> object, which can be queried for shader hardware capabilities such as maximum texture size. |
| float64 | GetFarZ | Gets the far clipping plane distance of the rendering device. |
| int32 | GetHeight | Returns the height of the active frame buffer, which may be the default frame buffer of the context. |
| int32 | GetMaximumTextureUnits | Retrieves the maximum number of texture units supported by the rendering device. |
| <Matrix> | GetModelMatrix | Retrieves the current model-view transformation matrix state. |
| float64 | GetNearZ | Gets the near clipping plane distance of the rendering device. |
| <Vec> | GetOrientation | Retrieves the current camera orientation, a ZYX Euler angle rotation, of the rendering device. |
| <Vec> | GetPosition | Gets the current camera position of the rendering device. |
| int32 | GetProgramAttribIndex | Returns an index for a specific attribute in a <Program>. |
| int32 | GetProgramConstantCount | Returns the number of active constants for the specified shader program handle. |
| float64 | GetProgramConstantFloat32 | Reads the GPU-resident value of the uniform at the specified location. |
| int32 | GetProgramConstantFloat32Range | Reads the GPU-resident value of the uniform at the specified location. |
| float64 | GetProgramConstantFloat64 | Reads the GPU-resident value of the uniform at the specified location. |
| int32 | GetProgramConstantFloat64Range | Reads the GPU-resident value of the uniform at the specified location. |
| int32 | GetProgramConstantIndex | Gets an index for a constant in a <Program>. The result can then be used to set the value of the constant, which will be set in the <Program> before the <Program> is executed. |
| int32 | GetProgramConstantInfo | Populates a <ProgramConstantInfo> object with information about the specified program constant. |
| int32 | GetProgramConstantInfoByIndex | Populates a <ProgramConstantInfo> object with information about the constant at the specified index. |
| int32 | GetProgramConstantInt32 | Reads the GPU-resident value of the uniform at the specified location. |
| int32 | GetProgramConstantInt32Range | Reads the GPU-resident value of the uniform at the specified location. |
| int64 | GetProgramConstantInt64 | Reads the GPU-resident value of the uniform at the specified location. |
| int32 | GetProgramConstantInt64Range | Reads the GPU-resident value of the uniform at the specified location. |
| uint32 | GetProgramConstantUint32 | Reads the GPU-resident value of the uniform at the specified location. |
| int32 | GetProgramConstantUint32Range | Reads the GPU-resident value of the uniform at the specified location. |
| uint64 | GetProgramConstantUint64 | Reads the GPU-resident value of the uniform at the specified location. |
| int32 | GetProgramConstantUint64Range | Reads the GPU-resident value of the uniform at the specified location. |
| int32 | GetProgramShaderBufferIndex | Returns the index of the specified shader buffer. |
| int32 | GetProgramShaderBufferSize | Returns the total size of the shader buffer. |
| int32 | GetProgramSubroutineCount | Returns the number of active subroutines for the <Program>. |
| int32 | GetProgramSubroutineIndex | Returns the index of the specified subroutine. |
| int32 | GetProgramSubroutineName | Populates a <Str> object with the name of the subroutine at the specified index. |
| int32 | GetProgramSubroutineUniformIndex | Returns the index of the specified subroutine uniform. |
| int32 | GetProgramSubroutineUniformName | Sets the value of the specified <Str> object to the value of the subroutine uniform at the specified index. |
| int32 | GetProgramSubroutines | Populates an <Int32Array> with the indices of the subroutine uniforms at the specified index. |
| int32 | GetProgramUniformBufferIndex | Returns the index of the specified uniform buffer. |
| int32 | GetProgramUniformBufferSize | Returns the total size of the uniform buffer. |
| int32 | GetProjection | Returns the projection of the rendering device. |
| <Matrix> | GetProjectionMatrix | Retrieves the current projection matrix state. |
| <Matrix> | GetTransform | Retrieves the current model-view transformation matrix state. |
| <Matrix> | GetViewMatrix | Retrieves the current model-view transformation matrix state. |
| int32 | GetWidth | Returns the width of the active frame buffer, which may be the default frame buffer of the context. |
| float64 | GetZoom | Gets the zoom value of the rendering device. |
| int32 | GpuAwaitFence | Calls glWaitSync and inserts a fence that causes the GPU/GL server to wait until all commands issued to OpenGL have completed. |
| int32 | InsertFence | Associates a <GLsync> object with a <GpuFence> object. Initially, a <GpuFence> object's internal pointer to a <glSync> object is nullptr. Executing this command creates a <glSync> object that will be managed by the <GpuFence> object. Note that you cannot access the <GLsync> itself. |
| int32 | InsertMemoryBarrier | Inserts a memory barrier in the current OpenGL command list. |
| int32 | LogResourceSet | Dumps a log of the current OpenGL resource set including buffers, textures, and uniforms. |
| int32 | QueryDeviceParameterFloat32 | Calls glGetFloatv to query the driver about the state of OpenGL on the physical device. |
| int32 | QueryDeviceParameterFloat64 | Calls glGetDoublev to query the driver about the state of OpenGL on the physical device. |
| int32 | QueryDeviceParameterIndexedFloat32 | Calls glGetFloati_v to query the driver about the state of OpenGL on the physical device. |
| int32 | QueryDeviceParameterIndexedFloat64 | Calls glGetDoublei_v to query the driver about the state of OpenGL on the physical device. |
| int32 | QueryDeviceParameterIndexedInt32 | Calls glGetIntegeri_v to query the driver about the state of OpenGL on the physical device. |
| int32 | QueryDeviceParameterIndexedInt64 | Calls glGetInteger64i_v to query the driver about the state of OpenGL on the physical device. |
| int32 | QueryDeviceParameterInt32 | Calls glGetIntegerv to query the driver about the state of OpenGL on the physical device. |
| int32 | QueryDeviceParameterInt64 | Calls glGetInteger64v to query the driver about the state of OpenGL on the physical device. |
| int32 | QueryDeviceParameterString | Calls glGetString to query the driver about the physical device manufacturer, GL version, and GLSL version. |
| int32 | QueryInternalFormati64v | Queries OpenGL for information about the specified format. |
| int32 | QueryInternalFormativ | Queries OpenGL for information about the specified format. |
| int32 | QueryProgramParameter | Allows you to query OpenGL for values such as GL_COMPUTE_WORK_GROUP_SIZE. See app_service_opengl_util.ssl for a list of query items. This function wraps glGetProgramiv . |
| int32 | ReadBuffer | Reads a rectangular region of the active framebuffer into the specified <Image> object. It may be any buffer that is part of the frame buffer (depth or visual buffers, including MRTs), whether the "primary" buffer of the context, or a user-defined buffer. This is defined in part by the format of the <Image> object. |
| int32 | ReadShaderSubBuffer | Reads a sub-region of memory from a shader storage buffer at the specified offset. |
| int32 | ReadTextureBuffer | Reads an image from the GPU. |
| int32 | ReadTextureBufferToArray | Reads an <Image> back from the GPU. |
| int32 | ReadTextureSubBuffer | Reads a sub-section of an <Image> back from the GPU. |
| int32 | ReadUniformSubBuffer | Reads a sub-region of memory from a uniform buffer at the specified offset. |
| int32 | RenderTriangle | Renders a triangle. Each point specifies a 3D coordinate, a color, and a 2D texture coordinate. |
| int32 | SelectMaterial | Sets the device state to render using a <Material> defined by Material_Flags options and alpha-blending opacity. This refers to the Material_Flags enumeration. Please see APP_SERVICE_ENUMERATION_UTIL.SSL in the application scripts folder for more information. |
| int32 | SelectMaterialState | Sets the device state to render using a <Material> defined by Material_Flags options and alpha-blending opacity. The new <Material> state inherits current texture state, if the flags do not include MF_Solid, and the current program, if the flags do not include MF_InheritProgram. This refers to the Material_Flags enumeration. Please see APP_SERVICE_ENUMERATION_UTIL.SSL in the application scripts folder for more information. |
| uint64 | SelectProgram | Select a program into the rendering device, or clear the current program. |
| int32 | SelectRenderTarget | Selects the specified frame buffer as the new render target for the rendering device. If a valid frame buffer is selected, its color buffer and depth buffer will contain the results of the rendering pass after rendering is complete. |
| int32 | SelectTexture | Selects a texture into texture unit 0 of the rendering device's texture stack. Use the SelectTextureUnit function if you wish to use a texture unit other than 0. |
| int32 | SelectTextureFrameBuffer | Selects a color buffer attached to the specified frame buffer into the specified texture unit. At present, the first color buffer is used. |
| int32 | SelectTextureUnit | Selects a <Texture> into the specified texture unit of the rendering device. To determine the maximum number of texture units supported by the rendering device, call the GetMaximumTextureUnits function. |
| int32 | SetFront | Sets the view projection of the rendering device to front view. |
| int32 | SetModelMatrix | Assigns the model-view matrix transformation state. |
| int32 | SetNearFarZ | Sets the distance between the camera and the near and far clipping planes. |
| int32 | SetOrientation | Sets the camera orientation of the rendering device to the specified ZYX Euler angle rotation. |
| int32 | SetPerspective | Sets the view projection of the rendering device to perspective view. |
| int32 | SetPosition | Sets the camera position of the rendering device to the specified position. |
| int32 | SetProgramConstantBool32 | Stores a bool value inside a program constant with at least one component. |
| int32 | SetProgramConstantBool32Vector | Sets a vector of Boolean values as a shader constant. |
| int32 | SetProgramConstantBool32VectorArray | Sets an array of vectors of Boolean values as a shader constant. |
| int32 | SetProgramConstantBool32x2 | Sets the value of a two-component shader constant. |
| int32 | SetProgramConstantBool32x3 | Sets the value of a three-component shader constant. |
| int32 | SetProgramConstantBool32x4 | Sets the value of a four-component shader constant. |
| int32 | SetProgramConstantBool32xN | Sets the value of an array shader constant. |
| int32 | SetProgramConstantFloat32 | Sets the value of a shader constant. |
| int32 | SetProgramConstantFloat32Matrix | Sets a matrix as a shader constant. |
| int32 | SetProgramConstantFloat32MatrixMxN | Sets the value of a matrix shader constant. |
| int32 | SetProgramConstantFloat32MatrixMxNxN | Sets the value of a matrix array shader constant. |
| int32 | SetProgramConstantFloat32MatrixN | Sets the value of a matrix array shader constant. |
| int32 | SetProgramConstantFloat32Vector | Sets a vector of single-precision floating point values as a shader constant. |
| int32 | SetProgramConstantFloat32VectorArray | Sets an array of vectors of single-precision floating point values as a shader constant. |
| int32 | SetProgramConstantFloat32x2 | Stores two floating point values inside a program constant with at least two components. |
| int32 | SetProgramConstantFloat32x3 | Stores three floating point values inside a program constant with at least three components. |
| int32 | SetProgramConstantFloat32x4 | Stores four floating point values inside a program constant with at least four components. |
| int32 | SetProgramConstantFloat32xN | Sets the value of an array shader constant. |
| int32 | SetProgramConstantFloat64 | Sets the value of a shader constant. |
| int32 | SetProgramConstantFloat64Matrix | Sets a matrix as a shader constant. |
| int32 | SetProgramConstantFloat64MatrixMxN | Sets the value of a matrix shader constant. |
| int32 | SetProgramConstantFloat64MatrixMxNxN | Sets the value of a matrix array shader constant. |
| int32 | SetProgramConstantFloat64MatrixN | Sets the value of a matrix array shader constant. |
| int32 | SetProgramConstantFloat64Vector | Sets a vector of double-precision floating point values as a shader constant. |
| int32 | SetProgramConstantFloat64VectorArray | Sets an array of vectors of <float64> point values as a shader constant. |
| int32 | SetProgramConstantFloat64x2 | Sets the value of a two-component shader constant. |
| int32 | SetProgramConstantFloat64x3 | Sets the value of a three-component shader constant. |
| int32 | SetProgramConstantFloat64x4 | Sets the value of a four-component shader constant. |
| int32 | SetProgramConstantFloat64xN | Sets the value of an array shader constant. |
| int32 | SetProgramConstantInfo | Sets a program constant meta-data value for a constant that is resident on the GPU. It should be noted that this is a debug only feature, and that incorrect alterations to GL state may cause undefined behavior. |
| int32 | SetProgramConstantInt32 | Stores an <int32> value inside a program constant with at least one component. |
| int32 | SetProgramConstantInt32Vector | Sets a vector of <int32> values as a shader constant. |
| int32 | SetProgramConstantInt32VectorArray | Sets an array of vectors of <int32> values as a shader constant. |
| int32 | SetProgramConstantInt32x2 | Sets the value of a two-component shader constant. |
| int32 | SetProgramConstantInt32x3 | Sets the value of a three-component shader constant. |
| int32 | SetProgramConstantInt32x4 | Sets the value of a four-component shader constant. |
| int32 | SetProgramConstantInt32xN | Sets the value of an array shader constant. |
| int32 | SetProgramConstantInt64 | Sets the value of a shader constant. |
| int32 | SetProgramConstantInt64Vector | Sets a vector of <int64> values as a shader constant. |
| int32 | SetProgramConstantInt64VectorArray | Sets an array of vectors of <int64> values as a shader constant. |
| int32 | SetProgramConstantInt64x2 | Sets the value of a two-component shader constant. |
| int32 | SetProgramConstantInt64x3 | Sets the value of a three-component shader constant. |
| int32 | SetProgramConstantInt64x4 | Sets the value of a four-component shader constant. |
| int32 | SetProgramConstantInt64xN | Sets the value of an array shader constant. |
| int32 | SetProgramConstantMatrix | Stores a 4x4 matrix inside a program constant. |
| int32 | SetProgramConstantMatrixMxN | Stores an 'M' x 'N' matrix inside a program constant. The upper left matrix of size RowCount x ColumnCount is taken from the parameter 'Value'. |
| int32 | SetProgramConstantMatrixMxNxN | Sets the value of a matrix array shader constant. |
| int32 | SetProgramConstantMatrixN | Sets the value of a matrix array shader constant. |
| int32 | SetProgramConstantUint32 | Sets the value of a shader constant. |
| int32 | SetProgramConstantUint32Vector | Sets a vector of <uint32> values as a shader constant. |
| int32 | SetProgramConstantUint32VectorArray | Sets an array of vectors of <uint32> values as a shader constant. |
| int32 | SetProgramConstantUint32x2 | Sets the value of a two-component shader constant. |
| int32 | SetProgramConstantUint32x3 | Sets the value of a three-component shader constant. |
| int32 | SetProgramConstantUint32x4 | Sets the value of a four-component shader constant. |
| int32 | SetProgramConstantUint32xN | Sets the value of an array shader constant. |
| int32 | SetProgramConstantUint64 | Sets the value of a shader constant. |
| int32 | SetProgramConstantUint64Vector | Sets a vector of <uint64> values as a shader constant. |
| int32 | SetProgramConstantUint64VectorArray | Sets an array of vectors of <uint64> values as a shader constant. |
| int32 | SetProgramConstantUint64x2 | Sets the value of a two-component shader constant. |
| int32 | SetProgramConstantUint64x3 | Sets the value of a three-component shader constant. |
| int32 | SetProgramConstantUint64x4 | Sets the value of a four-component shader constant. |
| int32 | SetProgramConstantUint64xN | Sets the value of an array shader constant. |
| int32 | SetProgramShaderBufferBinding | Binds a shader buffer. |
| int32 | SetProgramUniformBufferBinding | Binds a shader buffer. |
| int32 | SetProjection | Sets the view projection of the rendering device. |
| <Matrix> | SetProjectionMatrix | Assigns a new projection matrix state. |
| int32 | SetSide | Sets the view projection of the rendering device to side view. |
| int32 | SetTop | Sets the view projection of the rendering device to top view. |
| int32 | SetTransform | Assigns the model-view matrix transformation state. |
| int32 | SetViewMatrix | This member assigns the model-view matrix transformation state. |
| int32 | SetViewport | Changes the rendering device's viewport dimensions to the specified values. |
| int32 | SetZoom | Sets the zoom value of the rendering device. |
| int32 | UpdateShaderBuffer | Sets the size and usage flag for the buffer. |
| int32 | UpdateTexture1D | Updates a 1D texture that is currently resident on the GPU. You can only use this to update 1D textures. |
| int32 | UpdateTexture2D | Updates a 2D texture that is currently resident on the GPU. You must use this if you wish to update 2D textures, 1D array textures, and cubemaps. |
| int32 | UpdateTexture3D | Updates a 3D texture that is currently resident on the GPU. You must use this if you wish to update 3D textures, 2D array textures, and cubemap array textures. |
| int32 | UpdateTextureData | Updates the entire specified <Texture> without creating a new OpenGL® texture resource. Effect use prevents re-binding, which can be an expensive operation, and promotes reuse of OpenGL teture resources. |
| int32 | UpdateTextureSubData | Updates a sub-region of the specified <Texture> without creating a new OpenGL® texture resource. Effect use prevents re-binding, which can be an expensive operation, and promotes reuse of OpenGL teture resources. |
| int32 | UpdateUniformBuffer | Sets the size and usage flag for the buffer. |
| int32 | WriteShaderSubBuffer | Writes data to the shader buffer. |
| int32 | WriteUniformSubBuffer | Writes data to the uniform buffer. |
Object members are as follows:
| Type Name | Accessor Name | Documentation |
|---|---|---|
| <ModelView> | View | Gets or sets the model view attached to the rendering device. |
| int32 | DisplayCompilerLog | Toggles the <Program> shader compiler log messages on/off. This can only be set for <Render3D> objects accessed via Application.GetAccel3D(). |
| int32 | LightSourceEnable | Gets or sets the lighting state of the rendering device. |
| int32 | PolygonFillMode | Gets or sets the polygon fill mode currently used by the rendering device. |