manpages

SoUniformShaderParameter(3)

SoUniformShaderParameter(3) Coin SoUniformShaderParameter(3)

NAME

SoUniformShaderParameter - The SoUniformShaderParameter class is the base class for all uniform shader variables.

SYNOPSIS

#include <Inventor/nodes/SoShaderParameter.h>

Inherits SoShaderParameter.

Inherited by SoShaderParameter1f, SoShaderParameter1i, SoShaderParameter2f, SoShaderParameter2i, SoShaderParameter3f, SoShaderParameter3i, SoShaderParameter4f, SoShaderParameter4i, SoShaderParameterArray1f, SoShaderParameterArray1i, SoShaderParameterArray2f, SoShaderParameterArray2i, SoShaderParameterArray3f, SoShaderParameterArray3i, SoShaderParameterArray4f, SoShaderParameterArray4i, SoShaderParameterMatrix, SoShaderParameterMatrixArray, and SoShaderStateMatrixParameter.

Public Member Functions


virtual SoType getTypeId (void) const
Returns the type identification of an object derived from a class inheriting SoBase. This is used for run-time type checking and 'downward' casting. virtual void updateParameter (SoGLShaderObject *shaderObject)=0
Updates the shader parameter in the OpenGL state with the content of the value field.

Static Public Member Functions


static SoType getClassTypeId (void)
static void initClass (void)

Protected Member Functions


virtual const SoFieldData * getFieldData (void) const
SoGLShaderParameter * getGLShaderParameter (const uint32_t cachecontext)
void ensureParameter (SoGLShaderObject *shader)

Static Protected Member Functions


static const SoFieldData ** getFieldDataPtr (void)

Additional Inherited Members

Detailed Description

The SoUniformShaderParameter class is the base class for all uniform shader variables.

Uniform shader variables are used to pass parameters from the scene graph to the shader program.

In the shader program the variable is declared like this:

uniform float shininess;

See Shaders in Coin for more information.

Member Function Documentation

SoType SoUniformShaderParameter::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


  }
}

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.

Reimplemented from SoShaderParameter.

Reimplemented in SoShaderStateMatrixParameter, SoShaderParameterMatrixArray, SoShaderParameterMatrix, SoShaderParameterArray4i, SoShaderParameterArray4f, SoShaderParameterArray3i, SoShaderParameterArray3f, SoShaderParameterArray2i, SoShaderParameterArray2f, SoShaderParameterArray1i, SoShaderParameterArray1f, SoShaderParameter4i, SoShaderParameter4f, SoShaderParameter3i, SoShaderParameter3f, SoShaderParameter2i, SoShaderParameter2f, SoShaderParameter1i, and SoShaderParameter1f.

const SoFieldData * SoUniformShaderParameter::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 SoShaderParameter.

Reimplemented in SoShaderStateMatrixParameter, SoShaderParameterMatrixArray, SoShaderParameterMatrix, SoShaderParameterArray4i, SoShaderParameterArray4f, SoShaderParameterArray3i, SoShaderParameterArray3f, SoShaderParameterArray2i, SoShaderParameterArray2f, SoShaderParameterArray1i, SoShaderParameterArray1f, SoShaderParameter4i, SoShaderParameter4f, SoShaderParameter3i, SoShaderParameter3f, SoShaderParameter2i, SoShaderParameter2f, SoShaderParameter1i, and SoShaderParameter1f.

Author

Generated automatically by Doxygen for Coin from the source code.

Mon May 31 2021 Version 4.0.0