| SoFragmentShader Class |
Node that defines a fragment shader.
Inheritance HierarchyOIV.InventorSoNetBase
OIV.InventorSoDisposable
OIV.Inventor.MiscSoBase
OIV.Inventor.FieldsSoFieldContainer
OIV.Inventor.NodesSoNode
OIV.Inventor.NodesSoShaderObject
OIV.Inventor.NodesSoFragmentShader
Namespace: OIV.Inventor.Nodes
Assembly: OIV.Inventor (in OIV.Inventor.dll) Version: 2024.1.1.0 (2024.1.1)
SyntaxThe SoFragmentShader type exposes the following members.
Constructors| Name | Description | |
|---|---|---|
 | SoFragmentShader | Constructor. |
Methods| Name | Description | |
|---|---|---|
| AddShaderParameter(String, SbVec2f) | (Inherited from SoShaderObject.) |
| AddShaderParameter(String, SbVec2i32) | (Inherited from SoShaderObject.) |
| AddShaderParameter(String, SbVec3f) | (Inherited from SoShaderObject.) |
| AddShaderParameter(String, SbVec3i32) | (Inherited from SoShaderObject.) |
| AddShaderParameter(String, SbVec4f) | (Inherited from SoShaderObject.) |
| AddShaderParameter(String, SbVec4i32) | (Inherited from SoShaderObject.) |
| AddShaderParameter(String, Int32) | (Inherited from SoShaderObject.) |
| AddShaderParameter(String, Single) | (Inherited from SoShaderObject.) |
| AffectsState | Returns true if a node has an effect on the state during traversal. |
| Callback | (Inherited from SoNode.) |
| Copy | Calls Copy(false). (Inherited from SoNode.) |
| Copy(Boolean) | Creates and returns an exact copy of the node. |
| CopyFieldValues(SoFieldContainer) | Calls CopyFieldValues(fc, false). (Inherited from SoFieldContainer.) |
| CopyFieldValues(SoFieldContainer, Boolean) | Copies the contents of fc's fields into this object's fields. |
| Dispose |
Releases all resources used by SoDisposable.
(Inherited from SoDisposable.) |
| Distribute | (Inherited from SoNode.) |
| DoAction | (Inherited from SoNode.) |
| EnableNotify | Notification at this Field Container is enabled (if flag == true) or disabled (if flag == false). |
| Equals | Determines whether the specified Object is equal to the current Object. (Inherited from Object.) |
| FieldsAreEqual | Returns true if this object's fields are exactly equal to fc's fields. |
| Get | Returns the values of the fields of this object in the Open Inventor ASCII file format in the given string. |
| GetAllFields | Returns a list of fields, including the eventIn's and eventOut's. |
| GetAlternateRep | This method is called by actions to allow the node to provide an "alternate representation" when appropriate (typically depending on the action type). |
| GetBoundingBox | (Inherited from SoNode.) |
| GetEventIn | Returns a the eventIn with the given name. |
| GetEventOut | Returns the eventOut with the given name. |
| GetField | Returns a the field of this object whose name is fieldName. |
| GetFieldName | Returns the name of the given field in the fieldName argument. |
| GetFields | Appends references to all of this object's fields to resultList, and returns the number of fields appended. |
| GetHashCode |
Overrides GetHashCode().
(Inherited from SoNetBase.) |
| GetMatrix | (Inherited from SoNode.) |
 | GetMaxTextureImageUnit | Returns the maximum number of texture image units. |
| GetName | Returns the name of an instance. |
| GetPrimitiveCount | (Inherited from SoNode.) |
| GetRenderEngineMode | Returns the supported Render engine mode. |
| GetRenderUnitID | (Inherited from SoNode.) |
| GetShaderType | Returns the shader type. |
| GetStringName | (Inherited from SoBase.) |
| GetType | Gets the Type of the current instance. (Inherited from Object.) |
| GLRender | (Inherited from SoNode.) |
| GLRenderBelowPath | (Inherited from SoNode.) |
| GLRenderInPath | (Inherited from SoNode.) |
| GLRenderOffPath | (Inherited from SoNode.) |
| GrabEventsCleanup | (Inherited from SoNode.) |
| GrabEventsSetup | (Inherited from SoNode.) |
| HandleEvent | (Inherited from SoNode.) |
| HasDefaultValues | Returns true if all of the object's fields have their default values. |
| IsBoundingBoxIgnoring | This method is used by getBoundingBox action traversal to know if the current node must be traversed or not, ie the bounding should be ignored. |
| IsNotifyEnabled | Notification is the process of telling interested objects that this object has changed. |
| IsOverride | Returns the state of the override flag. |
| IsSupported(SoShaderObjectSourceTypes) | Calls IsSupported(sourceType, (OIV.Inventor.Misc.SoState ^)nullptr). |
| IsSupported(SoShaderObjectSourceTypes, SoState) | Indicates if fragment shaders in the specified language are supported by your graphics board. |
| IsSynchronizable | Gets the ScaleViz synchronizable state of this object. |
| Pick | (Inherited from SoNode.) |
| RayPick | (Inherited from SoNode.) |
| Search | (Inherited from SoNode.) |
| Set | Sets one or more fields in this object to the values specified in the given string, which should be a string in the Open Inventor file format. |
| SetName | (Inherited from SoBase.) |
| SetOverride | Turns the override flag on or off. |
| SetShaderParameter(String, SbVec2f) | (Inherited from SoShaderObject.) |
| SetShaderParameter(String, SbVec2i32) | (Inherited from SoShaderObject.) |
| SetShaderParameter(String, SbVec3f) | (Inherited from SoShaderObject.) |
| SetShaderParameter(String, SbVec3i32) | (Inherited from SoShaderObject.) |
| SetShaderParameter(String, SbVec4f) | (Inherited from SoShaderObject.) |
| SetShaderParameter(String, SbVec4i32) | (Inherited from SoShaderObject.) |
| SetShaderParameter(String, Int32) | (Inherited from SoShaderObject.) |
| SetShaderParameter(String, Single) | (Inherited from SoShaderObject.) |
| SetSynchronizable | Sets this to be a ScaleViz synchronizable object. |
| SetToDefaults | Sets all fields in this object to their default values. |
| ToString |
Converts this SoBase structure to a human readable string.
(Inherited from SoBase.) |
| Touch | Marks an instance as modified, simulating a change to it. |
| Write | (Inherited from SoNode.) |
Properties| Name | Description | |
|---|---|---|
 | isActive | Specifies if the shader object is active or not. |
| IsDisposable | ISafeDisposable interface implementation.
(Inherited from SoDisposable.) |
| parameter | Contains the shader's uniform parameters. |
| sourceProgram | Contains the shader object's source program, specified by a filename (OIV.Inventor.Nodes.SoShaderObject.sourceType set to OIV.Inventor.Nodes.SoShaderObject.SourceTypes.FILENAME) or by the string containing the program (OIV.Inventor.Nodes.SoShaderObject.sourceType set to OIV.Inventor.Nodes.SoShaderObject.SourceTypes.GLSL_PROGRAM). |
| sourceType | Specifies the shader object's source type. |
| UserData |
Gets or sets the user data to be contained by the field container.
(Inherited from SoFieldContainer.) |
RemarksThis node defines a fragment shader.
See OIV.Inventor.Nodes.SoShaderProgram for general information about using shaders and shader parameters.
See parent class OIV.Inventor.Nodes.SoShaderObject for details about using the inherited fields.
Notes:
Shaders in the scene graph. Shader object nodes cannot be inserted directly in a scene graph. They must be added to the shaderObject field of an OIV.Inventor.Nodes.SoShaderProgram node.
Predefined GLSL variables. Open Inventor uses a compatibility profile context for rendering. So legacy GLSL predefined variables, for example gl_FragColor, can be used in fragment shaders. However, if you use the GLSL "#version" directive in a shader, you should append the keyword "compatibility", for example: "#version 150 compatibility".
Transparency. To maintain compatibility with Open Inventor's high quality transparency algorithms like SORTED_PIXEL, fragment shaders should not output a color by setting gl_FragColor (or equivalent parameter) directly. Use the GLSL method OivDepthPeelingOutputColor() instead. Fragment shaders can access the depthPeeling API using Open Inventor's built-in "include" mechanism as shown below. (Note: In the "oiv_include" statement there must not be any white space in the string "//!oiv_include". The space character shown below is required by a limitation of our documentation tools.)
void main() { if (OivDepthPeel( gl_FragCoord.xyz )) { // Compute and set fragment color vec4 color = . . . OivDepthPeelingOutputColor( color ); } }
Transparency. If a fragment shader makes geometry transparent (sets alpha values < 1), the application should set the OIV.Inventor.Nodes.SoShaderProgram.generateTransparency field to true. This ensures that Open Inventor knows to apply the correct handling for the current transparency mode.
Shadows. To integrate with Open Inventor's shadow casting algorithm, fragment shaders should call the GLSL methods OivComputeShadow() and OivGenerateShadowMap(). Please see OIV.Inventor.Nodes.SoShadowGroup for example code.
FILE FORMAT/DEFAULT
FragmentShader {
| sourceProgram | "" |
| sourceType | FILENAME |
| isActive | true |
| parameter | NULL |
See Also