SoFragmentShader Class Reference
[Shaders]

Node that defines a fragment shader. More...

#include <Inventor/nodes/SoFragmentShader.h>

Inheritance diagram for SoFragmentShader:

List of all members.

Public Member Functions
virtual SoType	getTypeId () const
	SoFragmentShader ()
virtual ShaderType	getShaderType () const
Static Public Member Functions
static SoType	getClassTypeId ()
static SbBool	isSupported (SoShaderObject::SourceType sourceType, SoState *state=NULL)
static unsigned int	getMaxTextureImageUnit ()

---

Detailed Description

Node that defines a fragment shader.

This node defines a fragment shader.

See SoShaderProgram for general information about using shaders and shader parameters.

See parent class 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 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.)

     // Fragment shader GLSL code
  
     // !oiv_include <Inventor/oivDepthPeeling_frag.h> 
  
     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 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 SoShadowGroup for example code.

FILE FORMAT/DEFAULT

FragmentShader {

sourceProgram	""
sourceType	FILENAME
isActive	TRUE
parameter	NULL

}

SEE ALSO

SoGeometryShader, SoShaderObject, SoShaderProgram, SoTessellationControlShader, SoTessellationEvaluationShader, SoUniformShaderParameter, SoVertexShader

See related examples:

InteractiveThresholding, MarkerPicking, OverlayDisplay, CustomAlgebraicShape, CustomComputeColor, GPUGeometry, InterleavedVertexAttribFeedback, SimpleVertexAttribFeedback, VertexAttribFeedback, AnimatedFlag, GeometryShader, PixelLighting, shadowShader, SimplePassthrough, ToonShading, ShadersBrowser, MedicalDentalCurveUnfolding, MedicalMultiChannel, MedicalCutting, MedicalGammaCorrection, MedicalSimpleShader, MedicalMultiTransferFunctions, AmplitudeVelocity, SimpleShader, VolumeProjection, VolumeTransform

---

Constructor & Destructor Documentation

SoFragmentShader::SoFragmentShader

(

)

Constructor.

---

Member Function Documentation

static SoType SoFragmentShader::getClassTypeId

(

)

[static]

Returns the type identifier for this class.

Reimplemented from SoShaderObject.

static unsigned int SoFragmentShader::getMaxTextureImageUnit

(

)

[static]

Returns the maximum number of texture image units.

virtual ShaderType SoFragmentShader::getShaderType

(

)

const [inline, virtual]

Returns the shader type.

Implements SoShaderObject.

virtual SoType SoFragmentShader::getTypeId

(

)

const [virtual]

Returns the type identifier for this specific instance.

Reimplemented from SoShaderObject.

static SbBool SoFragmentShader::isSupported	(	SoShaderObject::SourceType	sourceType,
		SoState *	state = NULL
	)			[static]

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

When using a debug build of Open Inventor, some "no context available" warning messages 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/SoFragmentShader.h