ExecuteProgram Data Member Function

Executes the specified <Program> node using the specified work group and local group counts. Please see OpenGL dispatch compute for more information.

Prototype

int32 ExecuteProgram( int32 p_nDispatchLocalGroupSizes, int32 p_nGroupSizeX, int32 p_nGroupSizeY, int32 p_nGroupSizeZ, int32 p_nLocalSizeX, int32 p_nLocalSizeY, int32 p_nLocalSizeZ )

Parameters

Parameter Type Parameter Name Documentation
int32p_nDispatchLocalGroupSizesSpecifies whether or not you wish to specify local group sizes during compute dispatch instead of specifying them in the compute shader. The GL rendering device that performs the compute operation must support the extension GL_ARB_compute_variable_group_size for this option to have any affect. Otherwise this option has no effect, and you must specify local_size_x, local_size_y, and local_size_z in the compute shader.
int32p_nGroupSizeXThe value of the workgroup size on the X axis. This corresponds to GLuint num_groups_x which is specified during glDispatchCompute().
int32p_nGroupSizeYThe value of the workgroup size on the Y axis. This corresponds to GLuint num_groups_y which is specified during glDispatchCompute().
int32p_nGroupSizeZThe value of the workgroup size on the Z axis. This corresponds to GLuint num_groups_z which is specified during glDispatchCompute().
int32p_nLocalSizeXThe value of the local workgroup size on the X axis.
int32p_nLocalSizeYThe value of the local workgroup size on the Y axis.
int32p_nLocalSizeZThe value of the local workgroup size on the Z axis.

Examples

Copy Text To Clipboard

None published. Please look for an example in the Scenome Scripting Language code base.