SoShaderProgram Class Reference
[Shaders]

Shader program property node. More...

#include <Inventor/nodes/SoShaderProgram.h>

Inheritance diagram for SoShaderProgram:

List of all members.

Classes
struct	Members
	member variables
Public Types
enum	GeometryInputType {   POINTS_INPUT = GL_POINTS,   LINES_INPUT = GL_LINES,   TRIANGLES_INPUT = GL_TRIANGLES }
enum	GeometryOutputType {   POINTS_OUTPUT = GL_POINTS,   LINE_STRIP_OUTPUT = GL_LINE_STRIP,   TRIANGLE_STRIP_OUTPUT = GL_TRIANGLE_STRIP }
Public Member Functions
virtual SoType	getTypeId () const
	SoShaderProgram ()
SoFragmentShader *	getFragmentShader (int pos) const
SoVertexShader *	getVertexShader (int pos) const
SoGeometryShader *	getGeometryShader (int pos) const
virtual SoFragmentShader *	setFragmentShader (int pos, const SbString &filenameOrSource, SoShaderObject::SourceType sourceType=SoShaderObject::FILENAME)
virtual SoVertexShader *	setVertexShader (int pos, const SbString &filenameOrSource, SoShaderObject::SourceType sourceType=SoShaderObject::FILENAME)
virtual SoGeometryShader *	setGeometryShader (int pos, const SbString &filenameOrSource, SoShaderObject::SourceType sourceType=SoShaderObject::FILENAME)
virtual SoComputeShader *	setComputeShader (int pos, const SbString &filenameOrSource, SoShaderObject::SourceType sourceType=SoShaderObject::FILENAME)
SoTessellationControlShader *	getTessellationControlShader (int pos) const
SoTessellationEvaluationShader *	getTessellationEvaluationShader (int pos) const
virtual SoTessellationControlShader *	setTessellationControlShader (int pos, const SbString &filenameOrSource, SoShaderObject::SourceType sourceType=SoShaderObject::FILENAME)
virtual SoTessellationEvaluationShader *	setTessellationEvaluationShader (int pos, const SbString &filenameOrSource, SoShaderObject::SourceType sourceType=SoShaderObject::FILENAME)
SoShaderParameterImage *	addShaderParameterImage (const SbString &name, SoTexture *tex)
Static Public Member Functions
static SoType	getClassTypeId ()
static unsigned int	getNumReservedTextures ()
Public Attributes
SoMFNode	shaderObject
SoSFEnum	geometryInputType
SoSFEnum	geometryOutputType
SoSFBool	vertexProgramTwoSide
SoSFBool	shadowShader
SoSFInt32	maxGeometryOutputVertices
SoSFBool	generateTransparency
SoSFInt32	patchLength
SoMFNode	bufferObjects
SoMFNode	images
Friends
class	SoUniformShaderParameter

---

Detailed Description

Shader program property node.

This property node defines the complete shader program for all subsequent shapes. A complete shader program may contain vertex shaders (SoVertexShader), geometry shaders (SoGeometryShader) and/or fragment shaders (SoFragmentShaders). See SoShaderObject for information common to all these classes.

With some languages such as NVIDIA Cg or assembly language (ARB_vertex_program/ARB_fragment_program), only one vertex and one fragment program can be active at the same time. The field shaderObject contains the vertex, geometry and fragment shader objects which form the shader program. Each shader object should be of type SoShaderObject. Modifications that occur in shader objects are dynamically detected and the state is updated.

Uniform parameters may be set for each shader object. Uniform means, in the case of a vertex or geometry program, a value which is the same for all vertices in a primitive, and, in the case of a fragment program, a value which is the same for all fragments created by a primitive. Each uniform parameter is represented by an instance of a specific subclass of SoUniformShaderParameter. For example, an SoShaderParameter1i holds a single integer value.

Vertex parameters may be set for a vertex shader object. Vertex parameters are per-vertex data passed from the application to the vertex shader. Vertex parameters are represented by an instance of a specific subclass of SoVertexShaderParameter. For example, an SoVertexShaderParameter1f holds a set of floating point values and an SoVertexShaderParameter3f holds a set of SbVec3f values.

SoShaderProgram has specialized subclasses for volume visualization. If you are using the VolumeViz extension, see SoVolumeShader and SoVolumeRenderingQuality nodes.

Notes:

• For geometry shaders: the EXT_geometry_shader4 OpenGL extension must be supported by your graphics board.

• For tesselation shaders: the GL_ARB_tessellation_shader OpenGL extensions must be supported by your graphics board.

• Since Open Inventor 10.0, when writing geometry shaders, the input and output primitive types must be specified in the shader code. See https://developer.openinventor.com/index.php/general-documentation/how-to-write-shaders-with-oiv-10/#geomshader for more information.

• Transparency and fast editing are compatible with shader modified geometry, but most actions use the vertices of the basic shape (the vertices stored in the scene graph). This includes, for example, SoGetBoundingBoxAction, SoGetPrimitiveCountAction and SoRayPickAction.

Tips:

• To see the output from the GLSL compiler/linker, set the environment variable OIV_GLSL_DEBUG.

• If you set the environment variable OIV_SHADER_CHECK_INTERVAL, the shader source file is checked for a change every n seconds, where n is the value specified by the variable. This allows you to edit the shader source code without needing to restart your application after each shader modification.

• If your shader makes geometry transparent (sets alpha values < 1), you should set the generateTransparency field to TRUE. This ensures that Open Inventor knows to apply the correct handling for the current transparency mode.

• Since the GLSL specification doesn't currently provide a "#include" directive, Open Inventor provides this service through a comment directive. This provides greater flexibility in implementing complex GLSL shaders. Included files are loaded using SoInput and respect the same search path order. For example:

        //!oiv_include <MyShaderDirectory/common.h>
  

FILE FORMAT/DEFAULT

SoShaderProgram {

shaderObject	NULL
geometryInputType	TRIANGLES_INPUT
geometryOutputType	TRIANGLE_STRIP_OUTPUT
vertexProgramTwoSide	FALSE
shadowShader	FALSE
maxGeometryOutputVertices	-1
generateTransparency	FALSE
patchLength	0

}

EXAMPLE

Shader program with one fragment shader with one uniform parameter.

   // First load the fragment shader code
   SoFragmentShader* fragmentShader = new SoFragmentShader();
   fragmentShader->sourceProgram = "filename.glsl";

   // Set a shader parameter
   // The addShaderParameter1i method is equivalent to:
   //     SoShaderParameter1i *parameter = new SoShaderParameter1i;
   //     parameter->name  = "data1";
   //     parameter->value = 1;
   //     fragmentShader->parameter.set1Value(0, parameter);
   fragmentShader->addShaderParameter1i( "data1", 1 );

   // Associate fragment shader with a shader program node
   SoShaderProgram* shaderProgram = new SoShaderProgram();
   shaderProgram->shaderObject.set1Value(0, fragmentShader);
   root->addChild( shaderProgram );

ACTION BEHAVIOR

SoGLRenderAction
Sets the Open Inventor state with the active shader program. Sets: SoGLShaderProgramElement

SEE ALSO

SoFragmentShader, SoGeometryShader, SoShaderObject, SoTessellationControlShader, SoTessellationEvaluationShader, SoUniformShaderParameter, SoVertexShader, SoVertexShaderParameter

See related examples:

GPUGeometry, InterleavedVertexAttribFeedback, SimpleVertexAttribFeedback, VertexAttribFeedback, PointCloud, AnimatedFlag, GeometryShader, PixelLighting, shadowShader, SimplePassthrough, TessellationShader, ToonShading, ShadersBrowser, MultiTransferFunctions

---

Member Enumeration Documentation

enum SoShaderProgram::GeometryInputType

Geometry input type.

Used with field geometryInputType.

Enumerator:

POINTS_INPUT	The input geometry should be interpreted as points. Geometry shaders that operate on points are valid only for the SoPointSet and SoIndexedPointSet nodes. There is only a single vertex available for each geometry shader invocation.
LINES_INPUT	The input geometry should be interpreted as lines. Geometry shaders that operate on line segments are valid only for the SoLineSet or SoIndexedLineSet nodes. There are two vertices available for each geometry shader invocation. The first vertex refers to the vertex at the beginning of the line segment and the second vertex refers to the vertex at the end of the line segment.
TRIANGLES_INPUT	The input geometry should be interpreted as triangles. Geometry shaders that operate on triangles are valid only for geometry nodes that generate triangles, for example, SoTriangleStripSet. There are three vertices available for each program invocation. The first, second and third vertices refer to attributes of the first, second and third vertex of the triangle, respectively. Default.

enum SoShaderProgram::GeometryOutputType

Geometry ouput type.

Used with field geometryOutputType.

Enumerator:

POINTS_OUTPUT
LINE_STRIP_OUTPUT
TRIANGLE_STRIP_OUTPUT	Default.

---

Constructor & Destructor Documentation

SoShaderProgram::SoShaderProgram

(

)

Constructor.

---

Member Function Documentation

SoShaderParameterImage* SoShaderProgram::addShaderParameterImage	(	const SbString &	name,
		SoTexture *	tex
	)

Convenience method to create an SoShaderParameterImage with the specified name and value and add it to this shader program.

static SoType SoShaderProgram::getClassTypeId

(

)

[static]

Returns the type identifier for this class.

Reimplemented from SoNode.

Reimplemented in SoVolumeIsosurface, SoVolumeRenderingQuality, and SoVolumeShader.

SoFragmentShader * SoShaderProgram::getFragmentShader

(

int

pos

)

const [inline]

Returns the fragment shader at the specified position.

SoGeometryShader * SoShaderProgram::getGeometryShader

(

int

pos

)

const [inline]

Returns the geometry shader at the specified position.

static unsigned int SoShaderProgram::getNumReservedTextures

(

)

[static]

Returns the number of reserved texture units.

SoTessellationControlShader * SoShaderProgram::getTessellationControlShader

(

int

pos

)

const [inline]

Returns the tessellation control shader at the specified position.

SoTessellationEvaluationShader * SoShaderProgram::getTessellationEvaluationShader

(

int

pos

)

const [inline]

Returns the tessellation evaluation shader at the specified position.

virtual SoType SoShaderProgram::getTypeId

(

)

const [virtual]

Returns the type identifier for this specific instance.

Reimplemented from SoNode.

Reimplemented in SoVolumeIsosurface, SoVolumeRenderingQuality, and SoVolumeShader.

SoVertexShader * SoShaderProgram::getVertexShader

(

int

pos

)

const [inline]

Returns the vertex shader at the specified position.

virtual SoComputeShader* SoShaderProgram::setComputeShader	(	int	pos,
		const SbString &	filenameOrSource,
		SoShaderObject::SourceType	sourceType = SoShaderObject::FILENAME
	)			[virtual]

Convenience method to create a compute shader with the specified filename and add it at the specified position.

Return value is the new compute shader.

virtual SoFragmentShader* SoShaderProgram::setFragmentShader	(	int	pos,
		const SbString &	filenameOrSource,
		SoShaderObject::SourceType	sourceType = SoShaderObject::FILENAME
	)			[virtual]

Convenience method to create a fragment shader with the specified filename and add it at the specified position.

Return value is the new fragment shader.

Reimplemented in SoVolumeShader.

virtual SoGeometryShader* SoShaderProgram::setGeometryShader	(	int	pos,
		const SbString &	filenameOrSource,
		SoShaderObject::SourceType	sourceType = SoShaderObject::FILENAME
	)			[virtual]

Convenience method to create a geometry shader with the specified filename and add it at the specified position.

Return value is the new geometry shader.

virtual SoTessellationControlShader* SoShaderProgram::setTessellationControlShader	(	int	pos,
		const SbString &	filenameOrSource,
		SoShaderObject::SourceType	sourceType = SoShaderObject::FILENAME
	)			[virtual]

Convenience method to create a tessellation control shader with the specified filename and add it at the specified position.

Return value is the new tessellation control shader.

virtual SoTessellationEvaluationShader* SoShaderProgram::setTessellationEvaluationShader	(	int	pos,
		const SbString &	filenameOrSource,
		SoShaderObject::SourceType	sourceType = SoShaderObject::FILENAME
	)			[virtual]

Convenience method to create a tessellation evaluation shader with the specified filename and add it at the specified position.

Return value is the new tessellation evaluation shader.

virtual SoVertexShader* SoShaderProgram::setVertexShader	(	int	pos,
		const SbString &	filenameOrSource,
		SoShaderObject::SourceType	sourceType = SoShaderObject::FILENAME
	)			[virtual]

Convenience method to create a vertex shader with the specified filename and add it at the specified position.

Return value is the new vertex shader.

Reimplemented in SoVolumeShader.

---

Friends And Related Function Documentation

friend class SoUniformShaderParameter [friend]

---

Member Data Documentation

SoMFNode SoShaderProgram::bufferObjects

Specifies a list of SoShaderParameterBufferObject to use with this shader.

Default is empty. NOTE: field available since Open Inventor 9.8

SoSFBool SoShaderProgram::generateTransparency

If set to TRUE, then shapes affected by this shader will be considered transparent.

Otherwise, the shape transparency is deducted from the state.

This allows Open Inventor to apply the correct handling for the current transparency mode.

Default is FALSE.

NOTE: field available since Open Inventor 9.0

SoSFEnum SoShaderProgram::geometryInputType

Specifies the input primitive type of the current geometry shader if any (not used otherwise).

Use enum GeometryInputType. Default is TRIANGLES_INPUT.

NOTE: field available since Open Inventor 7.0

SoSFEnum SoShaderProgram::geometryOutputType

Specifies the output primitive type of the current geometry shader if any (not used otherwise).

Use enum GeometryOutputType. Default is TRIANGLE_STRIP_OUTPUT.

NOTE: field available since Open Inventor 7.0

SoMFNode SoShaderProgram::images

Specifies a list of SoShaderParameterImage nodes to use with this shader.

Default is empty. NOTE: field available since Open Inventor 10.10

SoSFInt32 SoShaderProgram::maxGeometryOutputVertices

Set the maximum number of vertices the geometry shader will emit in one invocation.

Default is -1 which means it is set to the hardware limit.

NOTE: field available since Open Inventor 8.1

SoSFInt32 SoShaderProgram::patchLength

Set the length of the fixed-size collection of vertices used by tessellation shaders.

Default is 0.

NOTE: field available since Open Inventor 9.3

SoMFNode SoShaderProgram::shaderObject

Specifies the list of shader objects (i.e., vertex shaders, geometry and fragment shaders) which form the shader program.

Be careful, with some languages (CG_PROGRAM or ARB_PROGRAM), only one vertex program and one fragment program can be active at the same time. In this case, only the first vertex shader and the first fragment shader are used.

SoSFBool SoShaderProgram::shadowShader

Only used when an SoShadowGroup is active.

Default is FALSE. If set to FALSE, a default shader will be used during the shadowmap generation pass. If TRUE, the shader will be used as is and must handle the shadowmap pass correctly:

• If the uniform OivShadowPass is true, call OivGenerateShadowMap() and output nothing into gl_FragColor, but discard fragments if needed.
• If the uniform OivShadowPass is false, follow the normal render path If the shader doesn't modify the depth (with a discard or an alpha test), Open Inventor will handle the shadowmap generation pass automatically. Default is FALSE
  See also: SoShadowGroup

NOTE: field available since Open Inventor 8.1

SoSFBool SoShaderProgram::vertexProgramTwoSide

If set to TRUE, vertex shaders will operate in two-sided color mode.

Default is FALSE.

NOTE: field available since Open Inventor 7.2

---

The documentation for this class was generated from the following file:

• Inventor/nodes/SoShaderProgram.h