openscenegraph
Public Types | Public Member Functions | Protected Attributes | List of all members
osg::BindImageTexture Class Reference

#include <BindImageTexture>

Inheritance diagram for osg::BindImageTexture:
osg::StateAttribute osg::Object osg::Referenced

Public Types

enum  Access { NOT_USED = 0 , READ_ONLY = GL_READ_ONLY_ARB , WRITE_ONLY = GL_WRITE_ONLY_ARB , READ_WRITE = GL_READ_WRITE_ARB }
 
- Public Types inherited from osg::StateAttribute
enum  Values {
  OFF = 0x0 , ON = 0x1 , OVERRIDE = 0x2 , PROTECTED = 0x4 ,
  INHERIT = 0x8
}
 
enum  Type {
  TEXTURE , POLYGONMODE , POLYGONOFFSET , MATERIAL ,
  ALPHAFUNC , ANTIALIAS , COLORTABLE , CULLFACE ,
  FOG , FRONTFACE , LIGHT , POINT ,
  LINEWIDTH , LINESTIPPLE , POLYGONSTIPPLE , SHADEMODEL ,
  TEXENV , TEXENVFILTER , TEXGEN , TEXMAT ,
  LIGHTMODEL , BLENDFUNC , BLENDEQUATION , LOGICOP ,
  STENCIL , COLORMASK , DEPTH , VIEWPORT ,
  SCISSOR , BLENDCOLOR , MULTISAMPLE , CLIPPLANE ,
  COLORMATRIX , VERTEXPROGRAM , FRAGMENTPROGRAM , POINTSPRITE ,
  PROGRAM , CLAMPCOLOR , HINT , SAMPLEMASKI ,
  PRIMITIVERESTARTINDEX , CLIPCONTROL , VALIDATOR , VIEWMATRIXEXTRACTOR ,
  OSGNV_PARAMETER_BLOCK , OSGNVEXT_TEXTURE_SHADER , OSGNVEXT_VERTEX_PROGRAM , OSGNVEXT_REGISTER_COMBINERS ,
  OSGNVCG_PROGRAM , OSGNVSLANG_PROGRAM , OSGNVPARSE_PROGRAM_PARSER , UNIFORMBUFFERBINDING ,
  TRANSFORMFEEDBACKBUFFERBINDING , ATOMICCOUNTERBUFFERBINDING , PATCH_PARAMETER , FRAME_BUFFER_OBJECT ,
  VERTEX_ATTRIB_DIVISOR , SHADERSTORAGEBUFFERBINDING , INDIRECTDRAWBUFFERBINDING , VIEWPORTINDEXED ,
  DEPTHRANGEINDEXED , SCISSORINDEXED , BINDIMAGETEXTURE , SAMPLER ,
  CAPABILITY = 100
}
 
typedef GLenum GLMode
 
typedef unsigned int GLModeValue
 
typedef unsigned int OverrideValue
 
typedef std::pair< Type, unsigned int > TypeMemberPair
 
typedef std::vector< StateSet * > ParentList
 
typedef osg::StateAttributeCallback Callback
 
- Public Types inherited from osg::Object
enum  DataVariance { DYNAMIC , STATIC , UNSPECIFIED }
 

Public Member Functions

 BindImageTexture (GLuint imageunit=0, osg::Texture *target=0, Access access=READ_ONLY, GLenum format=GL_RGBA8, int level=0, bool layered=GL_FALSE, int layer=0)
 
 BindImageTexture (const BindImageTexture &o, osg::CopyOp op=osg::CopyOp::SHALLOW_COPY)
 
virtual ~BindImageTexture ()
 
 META_StateAttribute (osg, BindImageTexture, BINDIMAGETEXTURE) inline void setImageUnit(GLuint i)
 
GLuint getImageUnit () const
 
void setLevel (GLint i)
 
GLint getLevel () const
 
void setIsLayered (GLboolean i)
 
GLboolean getIsLayered () const
 
void setLayer (GLint i)
 
GLint getLayer () const
 
void setAccess (Access i)
 
Access getAccess () const
 
void setFormat (GLenum i)
 
GLenum getFormat () const
 
void setTexture (osg::Texture *target)
 
osg::TexturegetTexture ()
 
const osg::TexturegetTexture () const
 
virtual void apply (osg::State &state) const
 
virtual int compare (const osg::StateAttribute &sa) const
 
virtual unsigned getMember () const
 
- Public Member Functions inherited from osg::StateAttribute
 StateAttribute ()
 
 StateAttribute (const StateAttribute &sa, const CopyOp &copyop=CopyOp::SHALLOW_COPY)
 
virtual ObjectcloneType () const =0
 
virtual Objectclone (const CopyOp &) const =0
 
virtual bool isSameKindAs (const Object *obj) const
 
virtual const char * libraryName () const
 
virtual const char * className () const
 
virtual StateAttributeasStateAttribute ()
 
virtual const StateAttributeasStateAttribute () const
 
virtual TextureasTexture ()
 
virtual const TextureasTexture () const
 
virtual Type getType () const =0
 
TypeMemberPair getTypeMemberPair () const
 
virtual bool isTextureAttribute () const
 
bool operator< (const StateAttribute &rhs) const
 
bool operator== (const StateAttribute &rhs) const
 
bool operator!= (const StateAttribute &rhs) const
 
const ParentListgetParents () const
 
StateSetgetParent (unsigned int i)
 
const StateSetgetParent (unsigned int i) const
 
unsigned int getNumParents () const
 
void setShaderComponent (ShaderComponent *sc)
 
ShaderComponentgetShaderComponent ()
 
const ShaderComponentgetShaderComponent () const
 
virtual bool getModeUsage (ModeUsage &) const
 
virtual bool checkValidityOfAssociatedModes (osg::State &) const
 
void setUpdateCallback (StateAttributeCallback *uc)
 
StateAttributeCallbackgetUpdateCallback ()
 
const StateAttributeCallbackgetUpdateCallback () const
 
void setEventCallback (StateAttributeCallback *ec)
 
StateAttributeCallbackgetEventCallback ()
 
const StateAttributeCallbackgetEventCallback () const
 
virtual void compileGLObjects (State &) const
 
virtual void resizeGLObjectBuffers (unsigned int)
 
virtual void releaseGLObjects (State *=0) const
 
- Public Member Functions inherited from osg::Object
 Object ()
 
 Object (bool threadSafeRefUnref)
 
 Object (const Object &, const CopyOp &copyop=CopyOp::SHALLOW_COPY)
 
std::string getCompoundClassName () const
 
virtual NodeasNode ()
 
virtual const NodeasNode () const
 
virtual NodeVisitorasNodeVisitor ()
 
virtual const NodeVisitorasNodeVisitor () const
 
virtual StateSetasStateSet ()
 
virtual const StateSetasStateSet () const
 
virtual UniformasUniform ()
 
virtual const UniformasUniform () const
 
virtual CameraasCamera ()
 
virtual const CameraasCamera () const
 
virtual DrawableasDrawable ()
 
virtual const DrawableasDrawable () const
 
virtual CallbackasCallback ()
 
virtual const CallbackasCallback () const
 
virtual CallbackObjectasCallbackObject ()
 
virtual const CallbackObjectasCallbackObject () const
 
virtual UserDataContainerasUserDataContainer ()
 
virtual const UserDataContainerasUserDataContainer () const
 
virtual ValueObjectasValueObject ()
 
virtual const ValueObjectasValueObject () const
 
virtual ImageasImage ()
 
virtual const ImageasImage () const
 
virtual void setThreadSafeRefUnref (bool threadSafe)
 
virtual void setName (const std::string &name)
 
void setName (const char *name)
 
const std::string & getName () const
 
void setDataVariance (DataVariance dv)
 
DataVariance getDataVariance () const
 
virtual void computeDataVariance ()
 
void setUserDataContainer (osg::UserDataContainer *udc)
 
template<class T >
void setUserDataContainer (const ref_ptr< T > &udc)
 
osg::UserDataContainergetUserDataContainer ()
 
const osg::UserDataContainergetUserDataContainer () const
 
osg::UserDataContainergetOrCreateUserDataContainer ()
 
virtual void setUserData (Referenced *obj)
 
template<class T >
void setUserData (const ref_ptr< T > &ud)
 
virtual ReferencedgetUserData ()
 
virtual const ReferencedgetUserData () const
 
template<typename T >
bool getUserValue (const std::string &name, T &value) const
 
template<typename T >
void setUserValue (const std::string &name, const T &value)
 
template<typename T >
BoolValueObject UCharValueObject UShortValueObject UIntValueObject DoubleValueObject Vec3fValueObject Vec2dValueObject Vec4dValueObject PlaneValueObject MatrixdValueObject BoundingBoxdValueObject BoundingSpheredValueObject bool getUserValue (const std::string &name, T &value) const
 
- Public Member Functions inherited from osg::Referenced
 Referenced ()
 
 Referenced (bool threadSafeRefUnref)
 
 Referenced (const Referenced &)
 
Referencedoperator= (const Referenced &)
 
bool getThreadSafeRefUnref () const
 
OpenThreads::MutexgetRefMutex () const
 
int ref () const
 
int unref () const
 
int unref_nodelete () const
 
int referenceCount () const
 
ObserverSetgetObserverSet () const
 
ObserverSetgetOrCreateObserverSet () const
 
void addObserver (Observer *observer) const
 
void removeObserver (Observer *observer) const
 

Protected Attributes

osg::ref_ptr< osg::Texture_target
 
GLuint _imageunit
 
GLint _level
 
GLboolean _layered
 
GLint _layer
 
Access _access
 
GLenum _format
 
- Protected Attributes inherited from osg::StateAttribute
ParentList _parents
 
ref_ptr< ShaderComponent_shaderComponent
 
ref_ptr< StateAttributeCallback_updateCallback
 
ref_ptr< StateAttributeCallback_eventCallback
 
- Protected Attributes inherited from osg::Object
std::string _name
 
DataVariance _dataVariance
 
osg::UserDataContainer_userDataContainer
 
- Protected Attributes inherited from osg::Referenced
OpenThreads::AtomicPtr _observerSet
 
OpenThreads::Atomic _refCount
 

Additional Inherited Members

- Static Public Member Functions inherited from osg::Referenced
static OpenThreads::MutexgetGlobalReferencedMutex ()
 
static void setDeleteHandler (DeleteHandler *handler)
 
static DeleteHandlergetDeleteHandler ()
 
- Protected Member Functions inherited from osg::StateAttribute
virtual ~StateAttribute ()
 
void addParent (osg::StateSet *object)
 
void removeParent (osg::StateSet *object)
 
- Protected Member Functions inherited from osg::Object
virtual ~Object ()
 
- Protected Member Functions inherited from osg::Referenced
virtual ~Referenced ()
 
void signalObserversAndDelete (bool signalDelete, bool doDelete) const
 
void deleteUsingDeleteHandler () const
 

Detailed Description

Bind texture to an image unit (available only if GL version is 4.2 or greater) The format parameter for the image unit need not exactly match the texture internal format, but if it is set to 0, the texture internal format will be used. See http://www.opengl.org/registry/specs/ARB/shader_image_load_store.txt void bindToImageUnit(unsigned int unit, GLenum access, GLenum format=0, int level=0, bool layered=false, int layer=0);

Member Enumeration Documentation

◆ Access

Type of access that will be performed on the texture image.

Enumerator
NOT_USED 
READ_ONLY 
WRITE_ONLY 
READ_WRITE 

Constructor & Destructor Documentation

◆ BindImageTexture() [1/2]

osg::BindImageTexture::BindImageTexture ( GLuint  imageunit = 0,
osg::Texture target = 0,
Access  access = READ_ONLY,
GLenum  format = GL_RGBA8,
int  level = 0,
bool  layered = GL_FALSE,
int  layer = 0 
)
inline

◆ BindImageTexture() [2/2]

osg::BindImageTexture::BindImageTexture ( const BindImageTexture o,
osg::CopyOp  op = osg::CopyOp::SHALLOW_COPY 
)
inline

◆ ~BindImageTexture()

virtual osg::BindImageTexture::~BindImageTexture ( )
inlinevirtual

Member Function Documentation

◆ apply()

virtual void osg::BindImageTexture::apply ( osg::State ) const
virtual

apply the OpenGL state attributes. The render info for the current OpenGL context is passed in to allow the StateAttribute to obtain details on the the current context and state.

Reimplemented from osg::StateAttribute.

◆ compare()

virtual int osg::BindImageTexture::compare ( const osg::StateAttribute sa) const
virtual

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

Implements osg::StateAttribute.

◆ getAccess()

Access osg::BindImageTexture::getAccess ( ) const
inline

◆ getFormat()

GLenum osg::BindImageTexture::getFormat ( ) const
inline

◆ getImageUnit()

GLuint osg::BindImageTexture::getImageUnit ( ) const
inline

◆ getIsLayered()

GLboolean osg::BindImageTexture::getIsLayered ( ) const
inline

◆ getLayer()

GLint osg::BindImageTexture::getLayer ( ) const
inline

◆ getLevel()

GLint osg::BindImageTexture::getLevel ( ) const
inline

◆ getMember()

virtual unsigned osg::BindImageTexture::getMember ( ) const
inlinevirtual

Return the member identifier within the attribute's class type. Used for light number/clip plane number etc.

Reimplemented from osg::StateAttribute.

◆ getTexture() [1/2]

osg::Texture * osg::BindImageTexture::getTexture ( )
inline

◆ getTexture() [2/2]

const osg::Texture * osg::BindImageTexture::getTexture ( ) const
inline

◆ META_StateAttribute()

osg::BindImageTexture::META_StateAttribute ( osg  ,
BindImageTexture  ,
BINDIMAGETEXTURE   
)
inline

◆ setAccess()

void osg::BindImageTexture::setAccess ( Access  i)
inline

◆ setFormat()

void osg::BindImageTexture::setFormat ( GLenum  i)
inline

◆ setIsLayered()

void osg::BindImageTexture::setIsLayered ( GLboolean  i)
inline

◆ setLayer()

void osg::BindImageTexture::setLayer ( GLint  i)
inline

◆ setLevel()

void osg::BindImageTexture::setLevel ( GLint  i)
inline

◆ setTexture()

void osg::BindImageTexture::setTexture ( osg::Texture target)
inline

Member Data Documentation

◆ _access

Access osg::BindImageTexture::_access
protected

◆ _format

GLenum osg::BindImageTexture::_format
protected

◆ _imageunit

GLuint osg::BindImageTexture::_imageunit
protected

◆ _layer

GLint osg::BindImageTexture::_layer
protected

◆ _layered

GLboolean osg::BindImageTexture::_layered
protected

◆ _level

GLint osg::BindImageTexture::_level
protected

◆ _target

osg::ref_ptr<osg::Texture> osg::BindImageTexture::_target
protected

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