soshaderprogram(3)
NAME
SoShaderProgram
SYNOPSIS
#include <Inventor/nodes/SoShaderProgram.h> Inherits SoNode.
Detailed Description
The SoShaderProgram class is used to specify a set of
vertex/geometry/fragment objects.
This node can store one of each of SoVertexShader, SoGeometryShader and
SoFragmentShader in its shaderObject field. Coin will load all shader
objects specified there, and attach all objects into a program before
binding it as the current shader program.
See Shaders in Coin for more information on how to set up a scene
graph with shaders.
- FILE FORMAT/DEFAULTS:
- ShaderProgram {
shaderObject []
- }
- See also:
- SoShaderObject
- SoShaderProgram
- Since:
- Coin 2.5
- Public Member Functions
- virtual SoType getTypeId (void) const
SoShaderProgram (void)
void setEnableCallback (SoShaderProgramEnableCB *cb, void *closure) virtual void GLRender (SoGLRenderAction *action) virtual void search (SoSearchAction *action) - Static Public Member Functions
- static SoType getClassTypeId (void) static void initClass ()
- Public Attributes
- SoMFNode shaderObject
- Protected Member Functions
- virtual const SoFieldData * getFieldData (void) const virtual ~SoShaderProgram ()
- Static Protected Member Functions
- static const SoFieldData ** getFieldDataPtr (void)
Constructor & Destructor Documentation
- SoShaderProgram::SoShaderProgram (void)
- Constructor.
- SoShaderProgram::~SoShaderProgram () [protected, virtual]
- Destructor.
Member Function Documentation
- SoType SoShaderProgram::getClassTypeId (void) [static]
- This static method returns the SoType object associated with objects of this class.
- Reimplemented from SoNode.
- SoType SoShaderProgram::getTypeId (void) const [virtual]
- Returns the type identification of an object derived from a class
inheriting SoBase. This is used for run-time type checking and 'downward' casting. - Usage example:
void foo(SoNode * node)
{if (node->getTypeId() == SoFile::getClassTypeId()) {SoFile * filenode = (SoFile *)node; // safe downward cast, knows the type}
else if (node->getTypeId().isOfType(SoGroup::getClassTypeId())) {SoGroup * group = (SoGroup *)node; // safe downward cast, knows the type}} - For application programmers wanting to extend the library with new
nodes, engines, nodekits, draggers or others: this method needs to be
overridden in all subclasses. This is typically done as part of setting up the full type system for extension classes, which is usually
accomplished by using the pre-defined macros available through for
instance Inventor/nodes/SoSubNode.h (SO_NODE_INIT_CLASS and
SO_NODE_CONSTRUCTOR for node classes), Inventor/engines/SoSubEngine.h (for engine classes) and so on. - For more information on writing Coin extensions, see the class
documentation of the toplevel superclasses for the various class
groups. - Implements SoBase.
- const SoFieldData ** SoShaderProgram::getFieldDataPtr (void) [static,
- protected]
This API member is considered internal to the library, as it is not likely to be of interest to the application programmer. - Reimplemented from SoNode.
- const SoFieldData * SoShaderProgram::getFieldData (void) const [protected,
- virtual]
Returns a pointer to the class-wide field data storage object for this instance. If no fields are present, returns NULL. - Reimplemented from SoFieldContainer.
- void SoShaderProgram::setEnableCallback (SoShaderProgramEnableCB * cb, void
- * closure)
Adds a callback which is called every time this program is
enabled/disabled. - void SoShaderProgram::GLRender (SoGLRenderAction * action) [virtual]
- Action method for the SoGLRenderAction.
- This is called during rendering traversals. Nodes influencing the
rendering state in any way or who wants to throw geometry primitives at OpenGL overrides this method. - Reimplemented from SoNode.
- References SoSearchAction::isFound(), and SoNode::search().
- void SoShaderProgram::search (SoSearchAction * action) [virtual]
- Action method for SoSearchAction.
- Compares the search criteria from the action to see if this node is a match. Searching is done by matching up all criteria set up in the SoSearchAction -- if any of the requested criteria is a miss, the search is not deemed successful for the node.
- See also:
SoSearchAction
- Reimplemented from SoNode.
- void SoShaderProgram::initClass (void) [static]
- Sets up initialization for data common to all instances of this class, like submitting necessary information to the Coin type system.
- Reimplemented from SoNode.
Member Data Documentation
- SoMFNode SoShaderProgram::shaderObject
- The shader objects.
Author
- Generated automatically by Doxygen for Coin from the source code.