Rechercher une page de manuel
SoShaderObject.3coin2
Langue: en
Version: 382547 (fedora - 01/12/10)
Section: 3 (Bibliothèques de fonctions)
Sommaire
- NAME
- SYNOPSIS
- Detailed Description
- Member Enumeration Documentation
- Constructor & Destructor Documentation
- Member Function Documentation
- void SoShaderObject::initClass (void) [static]Sets up initialization for data common to all instances of this class, like submitting necessary information to the Coin type system.
- void SoShaderObject::GLRender (SoGLRenderAction * action) [virtual]Action method for the SoGLRenderAction.
- void SoShaderObject::search (SoSearchAction * action) [virtual]Action method for SoSearchAction.
- void SoShaderObject::updateParameters (SoState * state)Used internally to update shader paramters.
- SoShaderObject::SourceType SoShaderObject::getSourceType (void) constReturns the shader type detected in sourceProgram.
- SbString SoShaderObject::getSourceProgram (void) constReturns the actual shader program.
- SbBool SoShaderObject::readInstance (SoInput * in, unsigned short flags) [protected, virtual]This method is mainly intended for internal use during file import operations.
- Member Data Documentation
- SoSFBool SoShaderObject::isActiveEnabled/disables the shader. Default value is TRUE.
- SoSFEnum SoShaderObject::sourceTypeThe type of shader.
- SoSFString SoShaderObject::sourceProgramThe shader program, or a file name if the shader should be loaded from a file. If the shader is loaded from a file, the shader type is identified by the file extension. .glsl for GLSL shaders, .cg for Cg shaders, and .vp and .fp for ARB shaders.
- SoMFNode SoShaderObject::parameterThe shader program parameters.
- Author
NAME
SoShaderObject -SYNOPSIS
#include <Inventor/nodes/SoShaderObject.h>
Inherits SoNode.
Inherited by SoFragmentShader, SoGeometryShader, and SoVertexShader.
Public Types
enum SourceType { ARB_PROGRAM, CG_PROGRAM, GLSL_PROGRAM, FILENAME }
Public Member Functions
virtual void GLRender (SoGLRenderAction *action)
virtual void search (SoSearchAction *action)
void updateParameters (SoState *state)
SourceType getSourceType (void) const
SbString getSourceProgram (void) const
Static Public Member Functions
static void initClass (void)
Public Attributes
SoSFBool isActive
SoSFEnum sourceType
SoSFString sourceProgram
SoMFNode parameter
Protected Member Functions
SoShaderObject (void)
virtual ~SoShaderObject ()
virtual SbBool readInstance (SoInput *in, unsigned short flags)
Detailed Description
The SoShaderObject class is the superclass for all shader classes in Coin.
See Shaders in Coin for more information on how to set up a scene graph with shaders.
See also:
- SoShaderProgram
Since:
- Coin 2.5
Member Enumeration Documentation
enum SoShaderObject::SourceTypeUsed for enumerating the shader types in sourceProgram.
Enumerator:
- ARB_PROGRAM
- Specifies an ARB shader.
- CG_PROGRAM
- Specifies a Cg shader program.
- GLSL_PROGRAM
- Specifies a GLSL program.
- FILENAME
- Shader should be loaded from the file in sourceProgram.
Constructor & Destructor Documentation
SoShaderObject::SoShaderObject (void) [protected]Constructor.
References ARB_PROGRAM, CG_PROGRAM, FILENAME, GLSL_PROGRAM, isActive, parameter, SoField::setDefault(), SoMField::setNum(), sourceProgram, and sourceType.
SoShaderObject::~SoShaderObject () [protected, virtual]Destructor
Member Function Documentation
void SoShaderObject::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.
Reimplemented in SoVertexShader, SoFragmentShader, and SoGeometryShader.
void SoShaderObject::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.
Reimplemented in SoGeometryShader.
Referenced by SoGeometryShader::GLRender().
void SoShaderObject::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.
References SoMField::getNum(), SoAction::getPathCode(), SoSearchAction::isFound(), parameter, SoAction::popCurPath(), SoAction::pushCurPath(), and SoNode::search().
void SoShaderObject::updateParameters (SoState * state)Used internally to update shader paramters.
References SoFieldContainer::get().
SoShaderObject::SourceType SoShaderObject::getSourceType (void) constReturns the shader type detected in sourceProgram.
SbString SoShaderObject::getSourceProgram (void) constReturns the actual shader program.
SbBool SoShaderObject::readInstance (SoInput * in, unsigned short flags) [protected, virtual]This method is mainly intended for internal use during file import operations.
It reads a definition of an instance from the input stream in. The input stream state points to the start of a serialized / persistant representation of an instance of this class type.
TRUE or FALSE is returned, depending on if the instantiation and configuration of the new object of this class type went ok or not. The import process should be robust and handle corrupted input streams by returning FALSE.
flags is used internally during binary import when reading user extension nodes, group nodes or engines.
Reimplemented from SoNode.
References SoInput::getDirectories(), and SoNode::readInstance().
Member Data Documentation
SoSFBool SoShaderObject::isActiveEnabled/disables the shader. Default value is TRUE.
Referenced by SoGeometryShader::GLRender(), and SoShaderObject().
SoSFEnum SoShaderObject::sourceTypeThe type of shader.
Referenced by SoShaderObject().
SoSFString SoShaderObject::sourceProgramThe shader program, or a file name if the shader should be loaded from a file. If the shader is loaded from a file, the shader type is identified by the file extension. .glsl for GLSL shaders, .cg for Cg shaders, and .vp and .fp for ARB shaders.
Referenced by SoShaderObject().
SoMFNode SoShaderObject::parameterThe shader program parameters.
Referenced by search(), and SoShaderObject().
Author
Generated automatically by Doxygen for Coin from the source code.
Contenus ©2006-2024 Benjamin Poulain
Design ©2006-2024 Maxime Vantorre