Click or drag to resize
SoFragmentShader Class

Node that defines a fragment shader.

Inheritance Hierarchy

Namespace: OIV.Inventor.Nodes
Assembly: OIV.Inventor (in OIV.Inventor.dll) Version: 10.12.3.0 (10.12.3.0)
Syntax
public class SoFragmentShader : SoShaderObject

The SoFragmentShader type exposes the following members.

Constructors
  NameDescription
Public methodSoFragmentShader

Constructor.

Top
Methods
  NameDescription
Public methodAddShaderParameter(String, SbVec2f) (Inherited from SoShaderObject.)
Public methodAddShaderParameter(String, SbVec2i32) (Inherited from SoShaderObject.)
Public methodAddShaderParameter(String, SbVec3f) (Inherited from SoShaderObject.)
Public methodAddShaderParameter(String, SbVec3i32) (Inherited from SoShaderObject.)
Public methodAddShaderParameter(String, SbVec4f) (Inherited from SoShaderObject.)
Public methodAddShaderParameter(String, SbVec4i32) (Inherited from SoShaderObject.)
Public methodAddShaderParameter(String, Int32) (Inherited from SoShaderObject.)
Public methodAddShaderParameter(String, Single) (Inherited from SoShaderObject.)
Public methodAffectsState

Returns true if a node has an effect on the state during traversal.

(Inherited from SoNode.)
Public methodCallback
(Inherited from SoNode.)
Public methodCopy
Calls Copy(false).
(Inherited from SoNode.)
Public methodCopy(Boolean)

Creates and returns an exact copy of the node.

(Inherited from SoNode.)
Public methodCopyFieldValues(SoFieldContainer)
Calls CopyFieldValues(fc, false).
(Inherited from SoFieldContainer.)
Public methodCopyFieldValues(SoFieldContainer, Boolean)

Copies the contents of fc's fields into this object's fields.

(Inherited from SoFieldContainer.)
Public methodDispose
Releases all resources used by SoDisposable.
(Inherited from SoDisposable.)
Public methodDistribute
(Inherited from SoNode.)
Public methodDoAction
(Inherited from SoNode.)
Public methodEnableNotify

Notification at this Field Container is enabled (if flag == true) or disabled (if flag == false).

(Inherited from SoFieldContainer.)
Public methodEquals
Determines whether the specified Object is equal to the current Object.
(Inherited from Object.)
Public methodFieldsAreEqual

Returns true if this object's fields are exactly equal to fc's fields.

(Inherited from SoFieldContainer.)
Public methodGet

Returns the values of the fields of this object in the Open Inventor ASCII file format in the given string.

(Inherited from SoFieldContainer.)
Public methodGetAllFields

Returns a list of fields, including the eventIn's and eventOut's.

(Inherited from SoFieldContainer.)
Public methodGetAlternateRep

This method is called by actions to allow the node to provide an "alternate representation" when appropriate (typically depending on the action type).

(Inherited from SoNode.)
Public methodGetBoundingBox
(Inherited from SoNode.)
Public methodGetEventIn

Returns a the eventIn with the given name.

(Inherited from SoFieldContainer.)
Public methodGetEventOut

Returns the eventOut with the given name.

(Inherited from SoFieldContainer.)
Public methodGetField

Returns a the field of this object whose name is fieldName.

(Inherited from SoFieldContainer.)
Public methodGetFieldName

Returns the name of the given field in the fieldName argument.

(Inherited from SoFieldContainer.)
Public methodGetFields

Appends references to all of this object's fields to resultList, and returns the number of fields appended.

(Inherited from SoFieldContainer.)
Public methodGetHashCode
Overrides GetHashCode().
(Inherited from SoNetBase.)
Public methodGetMatrix
(Inherited from SoNode.)
Public methodStatic memberGetMaxTextureImageUnit

Returns the maximum number of texture image units.

Public methodGetName

Returns the name of an instance.

(Inherited from SoBase.)
Public methodGetPrimitiveCount
(Inherited from SoNode.)
Public methodGetRenderEngineMode

Returns the supported Render engine mode.

(Inherited from SoNode.)
Public methodGetRenderUnitID
(Inherited from SoNode.)
Public methodGetShaderType

Returns the shader type.

(Overrides SoShaderObjectGetShaderType.)
Public methodGetStringName (Inherited from SoBase.)
Public methodGetType
Gets the Type of the current instance.
(Inherited from Object.)
Public methodGLRender
(Inherited from SoNode.)
Public methodGLRenderBelowPath
(Inherited from SoNode.)
Public methodGLRenderInPath
(Inherited from SoNode.)
Public methodGLRenderOffPath
(Inherited from SoNode.)
Public methodGrabEventsCleanup
(Inherited from SoNode.)
Public methodGrabEventsSetup
(Inherited from SoNode.)
Public methodHandleEvent
(Inherited from SoNode.)
Public methodHasDefaultValues

Returns true if all of the object's fields have their default values.

(Inherited from SoFieldContainer.)
Public methodIsBoundingBoxIgnoring

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.

(Inherited from SoNode.)
Public methodIsNotifyEnabled

Notification is the process of telling interested objects that this object has changed.

(Inherited from SoFieldContainer.)
Public methodIsOverride

Returns the state of the override flag.

(Inherited from SoNode.)
Public methodStatic memberIsSupported(SoShaderObjectSourceTypes)
Calls IsSupported(sourceType, (OIV.Inventor.Misc.SoState ^)nullptr).
Public methodStatic memberIsSupported(SoShaderObjectSourceTypes, SoState)

Indicates if fragment shaders in the specified language are supported by your graphics board.

Public methodIsSynchronizable

Gets the ScaleViz synchronizable state of this object.

(Inherited from SoBase.)
Public methodPick
(Inherited from SoNode.)
Public methodRayPick
(Inherited from SoNode.)
Public methodSearch
(Inherited from SoNode.)
Public methodSet

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.

(Inherited from SoFieldContainer.)
Public methodSetName (Inherited from SoBase.)
Public methodSetOverride

Turns the override flag on or off.

(Inherited from SoNode.)
Public methodSetShaderParameter(String, SbVec2f) (Inherited from SoShaderObject.)
Public methodSetShaderParameter(String, SbVec2i32) (Inherited from SoShaderObject.)
Public methodSetShaderParameter(String, SbVec3f) (Inherited from SoShaderObject.)
Public methodSetShaderParameter(String, SbVec3i32) (Inherited from SoShaderObject.)
Public methodSetShaderParameter(String, SbVec4f) (Inherited from SoShaderObject.)
Public methodSetShaderParameter(String, SbVec4i32) (Inherited from SoShaderObject.)
Public methodSetShaderParameter(String, Int32) (Inherited from SoShaderObject.)
Public methodSetShaderParameter(String, Single) (Inherited from SoShaderObject.)
Public methodSetSynchronizable

Sets this to be a ScaleViz synchronizable object.

(Inherited from SoBase.)
Public methodSetToDefaults

Sets all fields in this object to their default values.

(Inherited from SoFieldContainer.)
Public methodToString
Converts this SoBase structure to a human readable string.
(Inherited from SoBase.)
Public methodTouch

Marks an instance as modified, simulating a change to it.

(Inherited from SoNode.)
Public methodWrite
(Inherited from SoNode.)
Top
Properties
  NameDescription
Public propertyisActive

Specifies if the shader object is active or not.

(Inherited from SoShaderObject.)
Public propertyIsDisposable
ISafeDisposable interface implementation.
(Inherited from SoDisposable.)
Public propertyparameter

Contains the shader's uniform parameters.

(Inherited from SoShaderObject.)
Public propertysourceProgram (Inherited from SoShaderObject.)
Public propertysourceType

Specifies the shader object's source type.

(Inherited from SoShaderObject.)
Public propertyUserData
Gets or sets the user data to be contained by the field container.
(Inherited from SoFieldContainer.)
Top
Remarks

This 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