osg::Uniform

osg::Uniform Class Reference

Uniform encapsulates glUniform values. More...

Inheritance diagram for osg::Uniform:

Inheritance graph
[legend]
List of all members.

Public Types

typedef std::vector< StateSet * > ParentList
 A vector of osg::StateSet pointers which is used to store the parent(s) of this Uniform, the parents could be osg::Node or osg::Drawable.
 FLOAT = GL_FLOAT
 FLOAT_VEC2 = GL_FLOAT_VEC2
 FLOAT_VEC3 = GL_FLOAT_VEC3
 FLOAT_VEC4 = GL_FLOAT_VEC4
 INT = GL_INT
 INT_VEC2 = GL_INT_VEC2
 INT_VEC3 = GL_INT_VEC3
 INT_VEC4 = GL_INT_VEC4
 BOOL = GL_BOOL
 BOOL_VEC2 = GL_BOOL_VEC2
 BOOL_VEC3 = GL_BOOL_VEC3
 BOOL_VEC4 = GL_BOOL_VEC4
 FLOAT_MAT2 = GL_FLOAT_MAT2
 FLOAT_MAT3 = GL_FLOAT_MAT3
 FLOAT_MAT4 = GL_FLOAT_MAT4
 SAMPLER_1D = GL_SAMPLER_1D
 SAMPLER_2D = GL_SAMPLER_2D
 SAMPLER_3D = GL_SAMPLER_3D
 SAMPLER_CUBE = GL_SAMPLER_CUBE
 SAMPLER_1D_SHADOW = GL_SAMPLER_1D_SHADOW
 SAMPLER_2D_SHADOW = GL_SAMPLER_2D_SHADOW
 SAMPLER_1D_ARRAY = GL_SAMPLER_1D_ARRAY_EXT
 SAMPLER_2D_ARRAY = GL_SAMPLER_2D_ARRAY_EXT
 SAMPLER_1D_ARRAY_SHADOW = GL_SAMPLER_1D_ARRAY_SHADOW_EXT
 SAMPLER_2D_ARRAY_SHADOW = GL_SAMPLER_2D_ARRAY_SHADOW_EXT
 FLOAT_MAT2x3 = GL_FLOAT_MAT2x3
 FLOAT_MAT2x4 = GL_FLOAT_MAT2x4
 FLOAT_MAT3x2 = GL_FLOAT_MAT3x2
 FLOAT_MAT3x4 = GL_FLOAT_MAT3x4
 FLOAT_MAT4x2 = GL_FLOAT_MAT4x2
 FLOAT_MAT4x3 = GL_FLOAT_MAT4x3
 SAMPLER_BUFFER = GL_SAMPLER_BUFFER_EXT
 SAMPLER_CUBE_SHADOW = GL_SAMPLER_CUBE_SHADOW_EXT
 UNSIGNED_INT_VEC2 = GL_UNSIGNED_INT_VEC2_EXT
 UNSIGNED_INT_VEC3 = GL_UNSIGNED_INT_VEC3_EXT
 UNSIGNED_INT_VEC4 = GL_UNSIGNED_INT_VEC4_EXT
 INT_SAMPLER_1D = GL_INT_SAMPLER_1D_EXT
 INT_SAMPLER_2D = GL_INT_SAMPLER_2D_EXT
 INT_SAMPLER_3D = GL_INT_SAMPLER_3D_EXT
 INT_SAMPLER_CUBE = GL_INT_SAMPLER_CUBE_EXT
 INT_SAMPLER_2D_RECT = GL_INT_SAMPLER_2D_RECT_EXT
 INT_SAMPLER_1D_ARRAY = GL_INT_SAMPLER_1D_ARRAY_EXT
 INT_SAMPLER_2D_ARRAY = GL_INT_SAMPLER_2D_ARRAY_EXT
 INT_SAMPLER_BUFFER = GL_INT_SAMPLER_BUFFER_EXT
 UNSIGNED_INT_SAMPLER_1D = GL_UNSIGNED_INT_SAMPLER_1D_EXT
 UNSIGNED_INT_SAMPLER_2D = GL_UNSIGNED_INT_SAMPLER_2D_EXT
 UNSIGNED_INT_SAMPLER_3D = GL_UNSIGNED_INT_SAMPLER_3D_EXT
 UNSIGNED_INT_SAMPLER_CUBE = GL_UNSIGNED_INT_SAMPLER_CUBE_EXT
 UNSIGNED_INT_SAMPLER_2D_RECT = GL_UNSIGNED_INT_SAMPLER_2D_RECT_EXT
 UNSIGNED_INT_SAMPLER_1D_ARRAY = GL_UNSIGNED_INT_SAMPLER_1D_ARRAY_EXT
 UNSIGNED_INT_SAMPLER_2D_ARRAY = GL_UNSIGNED_INT_SAMPLER_2D_ARRAY_EXT
 UNSIGNED_INT_SAMPLER_BUFFER = GL_UNSIGNED_INT_SAMPLER_BUFFER_EXT
 UNDEFINED = 0x0
enum  Type {
  FLOAT = GL_FLOAT, FLOAT_VEC2 = GL_FLOAT_VEC2, FLOAT_VEC3 = GL_FLOAT_VEC3, FLOAT_VEC4 = GL_FLOAT_VEC4,
  INT = GL_INT, INT_VEC2 = GL_INT_VEC2, INT_VEC3 = GL_INT_VEC3, INT_VEC4 = GL_INT_VEC4,
  BOOL = GL_BOOL, BOOL_VEC2 = GL_BOOL_VEC2, BOOL_VEC3 = GL_BOOL_VEC3, BOOL_VEC4 = GL_BOOL_VEC4,
  FLOAT_MAT2 = GL_FLOAT_MAT2, FLOAT_MAT3 = GL_FLOAT_MAT3, FLOAT_MAT4 = GL_FLOAT_MAT4, SAMPLER_1D = GL_SAMPLER_1D,
  SAMPLER_2D = GL_SAMPLER_2D, SAMPLER_3D = GL_SAMPLER_3D, SAMPLER_CUBE = GL_SAMPLER_CUBE, SAMPLER_1D_SHADOW = GL_SAMPLER_1D_SHADOW,
  SAMPLER_2D_SHADOW = GL_SAMPLER_2D_SHADOW, SAMPLER_1D_ARRAY = GL_SAMPLER_1D_ARRAY_EXT, SAMPLER_2D_ARRAY = GL_SAMPLER_2D_ARRAY_EXT, SAMPLER_1D_ARRAY_SHADOW = GL_SAMPLER_1D_ARRAY_SHADOW_EXT,
  SAMPLER_2D_ARRAY_SHADOW = GL_SAMPLER_2D_ARRAY_SHADOW_EXT, FLOAT_MAT2x3 = GL_FLOAT_MAT2x3, FLOAT_MAT2x4 = GL_FLOAT_MAT2x4, FLOAT_MAT3x2 = GL_FLOAT_MAT3x2,
  FLOAT_MAT3x4 = GL_FLOAT_MAT3x4, FLOAT_MAT4x2 = GL_FLOAT_MAT4x2, FLOAT_MAT4x3 = GL_FLOAT_MAT4x3, SAMPLER_BUFFER = GL_SAMPLER_BUFFER_EXT,
  SAMPLER_CUBE_SHADOW = GL_SAMPLER_CUBE_SHADOW_EXT, UNSIGNED_INT_VEC2 = GL_UNSIGNED_INT_VEC2_EXT, UNSIGNED_INT_VEC3 = GL_UNSIGNED_INT_VEC3_EXT, UNSIGNED_INT_VEC4 = GL_UNSIGNED_INT_VEC4_EXT,
  INT_SAMPLER_1D = GL_INT_SAMPLER_1D_EXT, INT_SAMPLER_2D = GL_INT_SAMPLER_2D_EXT, INT_SAMPLER_3D = GL_INT_SAMPLER_3D_EXT, INT_SAMPLER_CUBE = GL_INT_SAMPLER_CUBE_EXT,
  INT_SAMPLER_2D_RECT = GL_INT_SAMPLER_2D_RECT_EXT, INT_SAMPLER_1D_ARRAY = GL_INT_SAMPLER_1D_ARRAY_EXT, INT_SAMPLER_2D_ARRAY = GL_INT_SAMPLER_2D_ARRAY_EXT, INT_SAMPLER_BUFFER = GL_INT_SAMPLER_BUFFER_EXT,
  UNSIGNED_INT_SAMPLER_1D = GL_UNSIGNED_INT_SAMPLER_1D_EXT, UNSIGNED_INT_SAMPLER_2D = GL_UNSIGNED_INT_SAMPLER_2D_EXT, UNSIGNED_INT_SAMPLER_3D = GL_UNSIGNED_INT_SAMPLER_3D_EXT, UNSIGNED_INT_SAMPLER_CUBE = GL_UNSIGNED_INT_SAMPLER_CUBE_EXT,
  UNSIGNED_INT_SAMPLER_2D_RECT = GL_UNSIGNED_INT_SAMPLER_2D_RECT_EXT, UNSIGNED_INT_SAMPLER_1D_ARRAY = GL_UNSIGNED_INT_SAMPLER_1D_ARRAY_EXT, UNSIGNED_INT_SAMPLER_2D_ARRAY = GL_UNSIGNED_INT_SAMPLER_2D_ARRAY_EXT, UNSIGNED_INT_SAMPLER_BUFFER = GL_UNSIGNED_INT_SAMPLER_BUFFER_EXT,
  UNDEFINED = 0x0
}

Public Member Functions

 Uniform ()
 Uniform (Type type, const std::string &name, int numElements=1)
 Uniform (const Uniform &rhs, const CopyOp &copyop=CopyOp::SHALLOW_COPY)
 Copy constructor using CopyOp to manage deep vs shallow copy.
 META_Object (osg, Uniform)
bool setType (Type t)
 Set the type of glUniform, ensuring it is only set once.
Type getType () const
 Get the type of glUniform as enum.
void setName (const std::string &name)
 Set the name of the glUniform, ensuring it is only set once.
void setNumElements (unsigned int numElements)
 Set the length of a uniform, ensuring it is only set once (1==scalar).
unsigned int getNumElements () const
 Get the number of GLSL elements of the osg::Uniform (1==scalar).
unsigned int getInternalArrayNumElements () const
 Get the number of elements required for the internal data array.
 Uniform (const char *name, float f)
 convenient scalar (non-array) constructors w/ assignment
 Uniform (const char *name, int i)
 Uniform (const char *name, bool b)
 Uniform (const char *name, const osg::Vec2 &v2)
 Uniform (const char *name, const osg::Vec3 &v3)
 Uniform (const char *name, const osg::Vec4 &v4)
 Uniform (const char *name, const osg::Matrix2 &m2)
 Uniform (const char *name, const osg::Matrix3 &m3)
 Uniform (const char *name, const osg::Matrixf &m4)
 Uniform (const char *name, const osg::Matrixd &m4)
 Uniform (const char *name, int i0, int i1)
 Uniform (const char *name, int i0, int i1, int i2)
 Uniform (const char *name, int i0, int i1, int i2, int i3)
 Uniform (const char *name, bool b0, bool b1)
 Uniform (const char *name, bool b0, bool b1, bool b2)
 Uniform (const char *name, bool b0, bool b1, bool b2, bool b3)
virtual int compare (const Uniform &rhs) const
 return -1 if *this < *rhs, 0 if *this==*rhs, 1 if *this>*rhs.
virtual int compareData (const Uniform &rhs) const
bool operator< (const Uniform &rhs) const
bool operator== (const Uniform &rhs) const
bool operator!= (const Uniform &rhs) const
void copyData (const Uniform &rhs)
const ParentList & getParents () const
 Get the parent list of this Uniform.
ParentList getParents ()
 Get the a copy of parent list of node.
StateSet * getParent (unsigned int i)
const StateSet * getParent (unsigned int i) const
 Get a single const parent of this Uniform.
unsigned int getNumParents () const
 Get the number of parents of this Uniform.
bool set (float f)
 convenient scalar (non-array) value assignment
bool set (int i)
bool set (bool b)
bool set (const osg::Vec2 &v2)
bool set (const osg::Vec3 &v3)
bool set (const osg::Vec4 &v4)
bool set (const osg::Matrix2 &m2)
bool set (const osg::Matrix3 &m3)
bool set (const osg::Matrixf &m4)
bool set (const osg::Matrixd &m4)
bool set (int i0, int i1)
bool set (int i0, int i1, int i2)
bool set (int i0, int i1, int i2, int i3)
bool set (bool b0, bool b1)
bool set (bool b0, bool b1, bool b2)
bool set (bool b0, bool b1, bool b2, bool b3)
bool get (float &f) const
 convenient scalar (non-array) value query
bool get (int &i) const
bool get (bool &b) const
bool get (osg::Vec2 &v2) const
bool get (osg::Vec3 &v3) const
bool get (osg::Vec4 &v4) const
bool get (osg::Matrix2 &m2) const
bool get (osg::Matrix3 &m3) const
bool get (osg::Matrixf &m4) const
bool get (osg::Matrixd &m4) const
bool get (int &i0, int &i1) const
bool get (int &i0, int &i1, int &i2) const
bool get (int &i0, int &i1, int &i2, int &i3) const
bool get (bool &b0, bool &b1) const
bool get (bool &b0, bool &b1, bool &b2) const
bool get (bool &b0, bool &b1, bool &b2, bool &b3) const
bool setElement (unsigned int index, float f)
 value assignment for array uniforms
bool setElement (unsigned int index, int i)
bool setElement (unsigned int index, bool b)
bool setElement (unsigned int index, const osg::Vec2 &v2)
bool setElement (unsigned int index, const osg::Vec3 &v3)
bool setElement (unsigned int index, const osg::Vec4 &v4)
bool setElement (unsigned int index, const osg::Matrix2 &m2)
bool setElement (unsigned int index, const osg::Matrix3 &m3)
bool setElement (unsigned int index, const osg::Matrixf &m4)
bool setElement (unsigned int index, const osg::Matrixd &m4)
bool setElement (unsigned int index, int i0, int i1)
bool setElement (unsigned int index, int i0, int i1, int i2)
bool setElement (unsigned int index, int i0, int i1, int i2, int i3)
bool setElement (unsigned int index, bool b0, bool b1)
bool setElement (unsigned int index, bool b0, bool b1, bool b2)
bool setElement (unsigned int index, bool b0, bool b1, bool b2, bool b3)
bool getElement (unsigned int index, float &f) const
 value query for array uniforms
bool getElement (unsigned int index, int &i) const
bool getElement (unsigned int index, bool &b) const
bool getElement (unsigned int index, osg::Vec2 &v2) const
bool getElement (unsigned int index, osg::Vec3 &v3) const
bool getElement (unsigned int index, osg::Vec4 &v4) const
bool getElement (unsigned int index, osg::Matrix2 &m2) const
bool getElement (unsigned int index, osg::Matrix3 &m3) const
bool getElement (unsigned int index, osg::Matrixf &m4) const
bool getElement (unsigned int index, osg::Matrixd &m4) const
bool getElement (unsigned int index, int &i0, int &i1) const
bool getElement (unsigned int index, int &i0, int &i1, int &i2) const
bool getElement (unsigned int index, int &i0, int &i1, int &i2, int &i3) const
bool getElement (unsigned int index, bool &b0, bool &b1) const
bool getElement (unsigned int index, bool &b0, bool &b1, bool &b2) const
bool getElement (unsigned int index, bool &b0, bool &b1, bool &b2, bool &b3) const
void setUpdateCallback (Callback *uc)
 Set the UpdateCallback which allows users to attach customize the updating of an object during the update traversal.
Callback * getUpdateCallback ()
 Get the non const UpdateCallback.
const Callback * getUpdateCallback () const
 Get the const UpdateCallback.
void setEventCallback (Callback *ec)
 Set the EventCallback which allows users to attach customize the updating of an object during the Event traversal.
Callback * getEventCallback ()
 Get the non const EventCallback.
const Callback * getEventCallback () const
 Get the const EventCallback.
void dirty ()
 Increment the modified count on the Uniform so Programs watching it know it update themselves.
bool setArray (FloatArray *array)
 Set the internal data array for a osg::Uniform.
bool setArray (IntArray *array)
FloatArray * getFloatArray ()
 Get the internal data array for a float osg::Uniform.
const FloatArray * getFloatArray () const
IntArray * getIntArray ()
 Get the internal data array for an int osg::Uniform.
const IntArray * getIntArray () const
void setModifiedCount (unsigned int mc)
unsigned int getModifiedCount () const
void apply (const GL2Extensions *ext, GLint location) const

Static Public Member Functions

static const char * getTypename (Type t)
 Return the name of a Type enum as string.
static int getTypeNumComponents (Type t)
 Return the the number of components for a GLSL type.
static Uniform::Type getTypeId (const std::string &tname)
 Return the Type enum of a Uniform typename string.
static Type getGlApiType (Type t)
 Return the GL API type corresponding to a GLSL type.
static GLenum getInternalArrayType (Type t)
 Return the internal data array type corresponding to a GLSL type.

Protected Member Functions

virtual ~Uniform ()
Uniform & operator= (const Uniform &)
bool isCompatibleType (Type t) const
bool isScalar () const
void allocateDataArray ()
void addParent (osg::StateSet *object)
void removeParent (osg::StateSet *object)

Protected Attributes

ParentList _parents
Type _type
unsigned int _numElements
ref_ptr< FloatArray > _floatArray
ref_ptr< IntArray > _intArray
ref_ptr< Callback > _updateCallback
ref_ptr< Callback > _eventCallback
unsigned int _modifiedCount

Friends

class osg::StateSet

Classes

struct  Callback

Detailed Description

Uniform encapsulates glUniform values.

Member Typedef Documentation

typedef std::vector<StateSet*> osg::Uniform::ParentList

A vector of osg::StateSet pointers which is used to store the parent(s) of this Uniform, the parents could be osg::Node or osg::Drawable.

Member Enumeration Documentation

enum osg::Uniform::Type

Enumerator:
FLOAT 
FLOAT_VEC2 
FLOAT_VEC3 
FLOAT_VEC4 
INT 
INT_VEC2 
INT_VEC3 
INT_VEC4 
BOOL 
BOOL_VEC2 
BOOL_VEC3 
BOOL_VEC4 
FLOAT_MAT2 
FLOAT_MAT3 
FLOAT_MAT4 
SAMPLER_1D 
SAMPLER_2D 
SAMPLER_3D 
SAMPLER_CUBE 
SAMPLER_1D_SHADOW 
SAMPLER_2D_SHADOW 
SAMPLER_1D_ARRAY 
SAMPLER_2D_ARRAY 
SAMPLER_1D_ARRAY_SHADOW 
SAMPLER_2D_ARRAY_SHADOW 
FLOAT_MAT2x3 
FLOAT_MAT2x4 
FLOAT_MAT3x2 
FLOAT_MAT3x4 
FLOAT_MAT4x2 
FLOAT_MAT4x3 
SAMPLER_BUFFER 
SAMPLER_CUBE_SHADOW 
UNSIGNED_INT_VEC2 
UNSIGNED_INT_VEC3 
UNSIGNED_INT_VEC4 
INT_SAMPLER_1D 
INT_SAMPLER_2D 
INT_SAMPLER_3D 
INT_SAMPLER_CUBE 
INT_SAMPLER_2D_RECT 
INT_SAMPLER_1D_ARRAY 
INT_SAMPLER_2D_ARRAY 
INT_SAMPLER_BUFFER 
UNSIGNED_INT_SAMPLER_1D 
UNSIGNED_INT_SAMPLER_2D 
UNSIGNED_INT_SAMPLER_3D 
UNSIGNED_INT_SAMPLER_CUBE 
UNSIGNED_INT_SAMPLER_2D_RECT 
UNSIGNED_INT_SAMPLER_1D_ARRAY 
UNSIGNED_INT_SAMPLER_2D_ARRAY 
UNSIGNED_INT_SAMPLER_BUFFER 
UNDEFINED 

Constructor & Destructor Documentation

osg::Uniform::Uniform (  ) 

osg::Uniform::Uniform ( Type  type,
const std::string &  name,
int  numElements = 1 
)

osg::Uniform::Uniform ( const Uniform &  rhs,
const CopyOp &  copyop = CopyOp::SHALLOW_COPY 
)

Copy constructor using CopyOp to manage deep vs shallow copy.

osg::Uniform::Uniform ( const char *  name,
float  f 
) [explicit]

convenient scalar (non-array) constructors w/ assignment

osg::Uniform::Uniform ( const char *  name,
int  i 
) [explicit]

osg::Uniform::Uniform ( const char *  name,
bool  b 
) [explicit]

osg::Uniform::Uniform ( const char *  name,
const osg::Vec2 &  v2 
)

osg::Uniform::Uniform ( const char *  name,
const osg::Vec3 &  v3 
)

osg::Uniform::Uniform ( const char *  name,
const osg::Vec4 &  v4 
)

osg::Uniform::Uniform ( const char *  name,
const osg::Matrix2 &  m2 
)

osg::Uniform::Uniform ( const char *  name,
const osg::Matrix3 &  m3 
)

osg::Uniform::Uniform ( const char *  name,
const osg::Matrixf &  m4 
)

osg::Uniform::Uniform ( const char *  name,
const osg::Matrixd &  m4 
)

osg::Uniform::Uniform ( const char *  name,
int  i0,
int  i1 
)

osg::Uniform::Uniform ( const char *  name,
int  i0,
int  i1,
int  i2 
)

osg::Uniform::Uniform ( const char *  name,
int  i0,
int  i1,
int  i2,
int  i3 
)

osg::Uniform::Uniform ( const char *  name,
bool  b0,
bool  b1 
)

osg::Uniform::Uniform ( const char *  name,
bool  b0,
bool  b1,
bool  b2 
)

osg::Uniform::Uniform ( const char *  name,
bool  b0,
bool  b1,
bool  b2,
bool  b3 
)

virtual osg::Uniform::~Uniform (  )  [protected, virtual]

Member Function Documentation

void osg::Uniform::addParent ( osg::StateSet *  object  )  [protected]

void osg::Uniform::allocateDataArray (  )  [protected]

void osg::Uniform::apply ( const GL2Extensions *  ext,
GLint  location 
) const

virtual int osg::Uniform::compare ( const Uniform &  rhs  )  const [virtual]

return -1 if *this < *rhs, 0 if *this==*rhs, 1 if *this>*rhs.

virtual int osg::Uniform::compareData ( const Uniform &  rhs  )  const [virtual]

void osg::Uniform::copyData ( const Uniform &  rhs  ) 

void osg::Uniform::dirty (  )  [inline]

Increment the modified count on the Uniform so Programs watching it know it update themselves.

NOTE: automatically called during osg::Uniform::set*(); you must call if modifying the internal data array directly.

bool osg::Uniform::get ( bool &  b0,
bool &  b1,
bool &  b2,
bool &  b3 
) const

bool osg::Uniform::get ( bool &  b0,
bool &  b1,
bool &  b2 
) const

bool osg::Uniform::get ( bool &  b0,
bool &  b1 
) const

bool osg::Uniform::get ( int &  i0,
int &  i1,
int &  i2,
int &  i3 
) const

bool osg::Uniform::get ( int &  i0,
int &  i1,
int &  i2 
) const

bool osg::Uniform::get ( int &  i0,
int &  i1 
) const

bool osg::Uniform::get ( osg::Matrixd &  m4  )  const

bool osg::Uniform::get ( osg::Matrixf &  m4  )  const

bool osg::Uniform::get ( osg::Matrix3 &  m3  )  const

bool osg::Uniform::get ( osg::Matrix2 &  m2  )  const

bool osg::Uniform::get ( osg::Vec4 &  v4  )  const

bool osg::Uniform::get ( osg::Vec3 &  v3  )  const

bool osg::Uniform::get ( osg::Vec2 &  v2  )  const

bool osg::Uniform::get ( bool &  b  )  const

bool osg::Uniform::get ( int &  i  )  const

bool osg::Uniform::get ( float &  f  )  const

convenient scalar (non-array) value query

bool osg::Uniform::getElement ( unsigned int  index,
bool &  b0,
bool &  b1,
bool &  b2,
bool &  b3 
) const

bool osg::Uniform::getElement ( unsigned int  index,
bool &  b0,
bool &  b1,
bool &  b2 
) const

bool osg::Uniform::getElement ( unsigned int  index,
bool &  b0,
bool &  b1 
) const

bool osg::Uniform::getElement ( unsigned int  index,
int &  i0,
int &  i1,
int &  i2,
int &  i3 
) const

bool osg::Uniform::getElement ( unsigned int  index,
int &  i0,
int &  i1,
int &  i2 
) const