SoComputeShader Class Reference
[Shaders]
Node that defines a compute shader.
More...
#include <Inventor/nodes/SoComputeShader.h>
Public Member Functions | |
| virtual SoType | getTypeId () const |
| SoComputeShader () | |
| virtual ShaderType | getShaderType () const |
Static Public Member Functions | |
| static SoType | getClassTypeId () |
| static SbBool | isSupported (SoShaderObject::SourceType sourceType, SoState *state=nullptr) |
Detailed Description
Node that defines a compute shader.
This node defines a compute shader, a shader stage used entirely for computing arbitrary information.
To store the result of the computation, an SoComputeShader may use SoShaderParameterImage or SoShaderParameterBufferObject with SoShaderParameterBufferObject::SHADER_STORAGE_BUFFER buffer type.
To fetch data, an SoComputeShader may use the above-mentioned parameter types, or regular texture access.
See SoShaderProgram for general information about using shaders and shader parameters.
See parent class SoShaderObject for details about using the inherited fields.
See SoComputeShaderScheduler for information about compute shader invocation.
Notes & Limitations:
- Compute shaders cannot coexist with other shader stages in the same shader program. Otherwise, an error will be generated and the shader won't compile (for example, you cannot insert an SoFragmentShader along with an SoComputeShader into the field SoShaderProgram::shaderObject).
- An SoShaderProgram containing compute shaders cannot be applied on SoShape nodes. If such a shader program is present on state when a shape is traversed by a rendering action, errors might be raised and the shape will not be rendered. To avoid this case, those SoShaderProgram should be isolated in their own SoSeparator, along with the SoComputeShaderScheduler nodes.
FILE FORMAT/DEFAULT
- ComputeShader {
| sourceProgram | "" |
| sourceType | FILENAME |
| isActive | TRUE |
| parameter | NULL |
SEE ALSO
SoVertexShader, SoFragmentShader, SoGeometryShader, SoShaderObject, SoShaderProgram, SoTessellationControlShader, SoTessellationEvaluationShader, SoUniformShaderParameter, SoShaderParameterBufferObject, SoShaderParameterImage
NOTE: node available since Open Inventor 10.12Constructor & Destructor Documentation
| SoComputeShader::SoComputeShader | ( | ) |
Member Function Documentation
| static SoType SoComputeShader::getClassTypeId | ( | ) | [static] |
Returns the type identifier for this class.
Reimplemented from SoShaderObject.
| virtual ShaderType SoComputeShader::getShaderType | ( | ) | const [inline, virtual] |
Returns the shader type.
Implements SoShaderObject.
| virtual SoType SoComputeShader::getTypeId | ( | ) | const [virtual] |
Returns the type identifier for this specific instance.
Reimplemented from SoShaderObject.
| static SbBool SoComputeShader::isSupported | ( | SoShaderObject::SourceType | sourceType, | |
| SoState * | state = nullptr | |||
| ) | [static] |
Indicates if compute shaders in the specified language are supported by your graphics board.
When using a debug build of Open Inventor, warning messages such as "no context available" may be generated. You can ignore them or see SoGLExtension for an example of using SoGLContext to avoid them.
The documentation for this class was generated from the following file:
- Inventor/nodes/SoComputeShader.h