Provides script language access to C++ objects of this type.
Function members are as follows:
| Return Type | Function Name | Documentation |
|---|---|---|
| int32 | Execute | Executes a <ProgramExecute> object. |
| int32 | Select | Sets this <ProgramExecute> as active in the rendering system. |
| int32 | Set | Sets the workgroup and local group value at the specified index. The first three values are work_group_x, work_group_y, and work_group_z. The last three values are local_size_x, local_size_y, and local_size_z. These values can also be set in the compute shader. |
Object members are as follows:
| Type Name | Accessor Name | Documentation |
|---|---|---|
| int32 | DispatchLocalGroupSizes | Sets or gets the flag that specifies 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 effect. Otherwise this option has no effect, and you must specify local_size_x, local_size_y, and local_size_z in the compute shader. |
| <Node> | ImagePalette | Gets or sets the <TexturePaletteNode> or <SamplerPaletteNode> this <ProgramExecute> should use. |
| <Node> | ImagePaletteLink | Gets or sets the <TexturePaletteNode> or <SamplerPaletteNode> this <ProgramExecute> should use. |
| int32 | LocalGroupCountX | Gets or sets the local_size_x value. Can also be set by declaring 'layout( local_size_x = n ) in' in the compute shader source. |
| int32 | LocalGroupCountY | Gets or sets the local_size_y value. Can also be set by declaring 'layout( local_size_y = n ) in' in the compute shader source. |
| int32 | LocalGroupCountZ | Gets or sets the local_size_z value. Can also be set by declaring 'layout( local_size_z = n ) in' in the compute shader source. |
| int32 | PipelineMode | This flag gets the PipelineMode flag value. You cannot set this value because the value is set when this node is rendered (based on the PipelineMode of the source <Program> node object). |
| <Node> | Program | Gets or sets the <Program> this <ProgramExecute> should run. |
| <Node> | ProgramLink | Gets or sets the <Program> this <ProgramExecute> should run. |
| int32 | RenderDownloadFrequency | Sets or gets the frequency with which the node's value is updated on the GPU. At present, this supports updating once when the application loads the document, or once per frame. This refers to the RenderDownloadFrequency enumeration. Please see TYPE_SERVICE_ENUMERATION_UTIL.SSL in the application scripts folder for more information. |
| <Node> | RenderHook | Gets or sets the <UniformPaletteNode> this <ProgramExecute> should use. |
| <Node> | RenderHookLink | Gets or sets the <UniformPaletteNode> this <ProgramExecute> should use. |
| <Node> | SamplerPalette | Gets or sets the <SamplerPaletteNode> this <ProgramExecute> should use. |
| <Node> | SamplerPaletteLink | Gets or sets the <SamplerPaletteNode> this <ProgramExecute> should use. |
| <Node> | TexturePalette | Gets or sets the <TexturePaletteNode> this <ProgramExecute> should use. |
| <Node> | TexturePaletteLink | Gets or sets the <TexturePaletteNode> this <ProgramExecute> should use. |
| <Node> | UniformPalette | Gets or sets the <UniformPaletteNode> this <ProgramExecute> should use. |
| <Node> | UniformPaletteLink | Gets or sets the <UniformPaletteNode> this <ProgramExecute> should use. |
| int32 | WorkGroupCountX | Gets or sets the local_size_x value. |
| int32 | WorkGroupCountY | Gets or sets the local_size_y value. |
| int32 | WorkGroupCountZ | Gets or sets the local_size_z value. |