Open Inventor Release 2024.1.1
 
Loading...
Searching...
No Matches
SoShaderParameterBufferObject Class Reference

VSG extension Shader parameter node storing a buffer object. More...

#include <Inventor/nodes/SoShaderParameterBufferObject.h>

+ Inheritance diagram for SoShaderParameterBufferObject:

Public Types

enum  BufferType {
  SHADER_STORAGE_BUFFER = SbEnums::SHADER_STORAGE_BUFFER ,
  UNIFORM_BUFFER = SbEnums::UNIFORM_BUFFER
}
 List of buffer object types supported as shader parameter. More...
 

Public Member Functions

virtual SoType getTypeId () const
 Returns the type identifier for this specific instance.
 
 SoShaderParameterBufferObject ()
 
- Public Member Functions inherited from SoNode
virtual void setOverride (const SbBool state)
 Turns the override flag on or off.
 
virtual SbBool isOverride () const
 Returns the state of the override flag.
 
virtual SoNodecopy (SbBool copyConnections=FALSE) const
 Creates and returns an exact copy of the node.
 
virtual SbBool affectsState () const
 Returns TRUE if a node has an effect on the state during traversal.
 
virtual void touch ()
 Marks an instance as modified, simulating a change to it.
 
- Public Member Functions inherited from SoFieldContainer
void setToDefaults ()
 Sets all fields in this object to their default values.
 
SbBool hasDefaultValues () const
 Returns TRUE if all of the object's fields have their default values.
 
SbBool fieldsAreEqual (const SoFieldContainer *fc) const
 Returns TRUE if this object's fields are exactly equal to fc's fields.
 
void copyFieldValues (const SoFieldContainer *fc, SbBool copyConnections=FALSE)
 Copies the contents of fc's fields into this object's fields.
 
SoNONUNICODE SbBool set (const char *fieldDataString)
 Sets one or more fields in this object to the values specified in the given string, which should be a string in the Open Inventor file format.
 
SbBool set (const SbString &fieldDataString)
 Sets one or more fields in this object to the values specified in the given string, which should be a string in the Open Inventor file format.
 
void get (SbString &fieldDataString)
 Returns the values of the fields of this object in the Open Inventor ASCII file format in the given string.
 
virtual int getFields (SoFieldList &list) const
 Appends references to all of this object's fields to resultList, and returns the number of fields appended.
 
virtual int getAllFields (SoFieldList &list) const
 Returns a list of fields, including the eventIn's and eventOut's.
 
virtual SoFieldgetField (const SbName &fieldName) const
 Returns a the field of this object whose name is fieldName.
 
virtual SoFieldgetEventIn (const SbName &fieldName) const
 Returns a the eventIn with the given name.
 
virtual SoFieldgetEventOut (const SbName &fieldName) const
 Returns the eventOut with the given name.
 
SbBool getFieldName (const SoField *field, SbName &fieldName) const
 Returns the name of the given field in the fieldName argument.
 
SbBool enableNotify (SbBool flag)
 Notification at this Field Container is enabled (if flag == TRUE) or disabled (if flag == FALSE).
 
SbBool isNotifyEnabled () const
 Notification is the process of telling interested objects that this object has changed.
 
virtual void setUserData (void *data)
 Sets application data.
 
void * getUserData (void) const
 Gets user application data.
 
- Public Member Functions inherited from SoBase
virtual SbName getName () const
 Returns the name of an instance.
 
virtual void setName (const SbName &name)
 Sets the name of an instance.
 
void setSynchronizable (const bool b)
 Sets this to be a ScaleViz synchronizable object.
 
bool isSynchronizable () const
 Gets the ScaleViz synchronizable state of this object.
 
- Public Member Functions inherited from SoRefCounter
void ref () const
 Adds a reference to an instance.
 
void unref () const
 Removes a reference from an instance.
 
void unrefNoDelete () const
 unrefNoDelete() should be called when it is desired to decrement the reference count, but not delete the instance if this brings the reference count to zero.
 
int getRefCount () const
 Returns current reference count.
 
void lock () const
 lock this instance.
 
void unlock () const
 unlock this instance.
 
- Public Member Functions inherited from SoTypedObject
SbBool isOfType (const SoType &type) const
 Returns TRUE if this object is of the type specified in type or is derived from that type.
 
template<typename TypedObjectClass >
SbBool isOfType () const
 Returns TRUE if this object is of the type of class TypedObjectClass or is derived from that class.
 

Static Public Member Functions

static SoType getClassTypeId ()
 Returns the type identifier for this class.
 
- Static Public Member Functions inherited from SoShaderParameter
static SoType getClassTypeId ()
 Returns the type identifier for this class.
 
- Static Public Member Functions inherited from SoNode
static SoType getClassTypeId ()
 Returns the type identifier for this class.
 
static SoNodegetByName (const SbName &name)
 A node's name can be set using SoBase::setName().
 
static int getByName (const SbName &name, SoNodeList &list)
 A node's name can be set using SoBase::setName().
 
- Static Public Member Functions inherited from SoFieldContainer
static SoType getClassTypeId ()
 Returns the type of this class.
 
- Static Public Member Functions inherited from SoBase
static SoType getClassTypeId ()
 Returns type identifier for this class.
 
- Static Public Member Functions inherited from SoTypedObject
static SoType getClassTypeId ()
 Returns the type identifier for this class.
 

Public Attributes

SoSFBufferObject buffer
 An SoBufferObject containing data.
 
SoSFEnum bufferType
 The buffer type.
 
- Public Attributes inherited from SoShaderParameter
SoSFString name
 Specifies the parameter's string name which is declared and used within high-level shading programs.
 
SoSFInt32 identifier
 Specifies the parameter's integer name which is declared and used within low-level shading programs.
 

Detailed Description

VSG extension Shader parameter node storing a buffer object.

This node allows the application to provide a buffer object to a shader program. The shader program can access this buffer as a GLSL Shader Storage Buffer Object.

SoShaderParameterBufferObject nodes are usually added to the shader program's bufferObjects field to affect only that specific shader program, but can also be inserted in the scene graph and affect all subsequent shader programs.

NOTE: If inserted directly in the scene graph, SoShaderParameterBufferObject is not cacheable. This means that all parent SoSeparator nodes will not be able to create render caches. This may reduce rendering performance.

FILE FORMAT/DEFAULT

SEE ALSO

SoShaderParameter, SoUniformShaderParameter. SoShaderObject, SoShaderProgram.

NOTE: node available since Open Inventor 9.8

Definition at line 66 of file SoShaderParameterBufferObject.h.

Member Enumeration Documentation

◆ BufferType

List of buffer object types supported as shader parameter.

Enumerator
SHADER_STORAGE_BUFFER 
UNIFORM_BUFFER 

Definition at line 77 of file SoShaderParameterBufferObject.h.

Constructor & Destructor Documentation

◆ SoShaderParameterBufferObject()

SoShaderParameterBufferObject::SoShaderParameterBufferObject ( )

Member Function Documentation

◆ getClassTypeId()

static SoType SoShaderParameterBufferObject::getClassTypeId ( )
static

Returns the type identifier for this class.


◆ getTypeId()

virtual SoType SoShaderParameterBufferObject::getTypeId ( ) const
virtual

Returns the type identifier for this specific instance.

Reimplemented from SoShaderParameter.

Member Data Documentation

◆ buffer

SoSFBufferObject SoShaderParameterBufferObject::buffer

An SoBufferObject containing data.

In order to avoid a CPU to GPU copy, it is recommended to use an SoGpuBufferObject. Default is null.

Definition at line 86 of file SoShaderParameterBufferObject.h.

◆ bufferType

SoSFEnum SoShaderParameterBufferObject::bufferType

The buffer type.

Default is SHADER_STORAGE_BUFFER. The only legal values are SHADER_STORAGE_BUFFER and UNIFORM_BUFFER.

Definition at line 90 of file SoShaderParameterBufferObject.h.


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