OpenSceneGraph
Public Member Functions | Static Public Member Functions | Protected Attributes | List of all members
osg::Sampler Class Reference

OpenGL Sampler OpenGL 3.3 required https://www.khronos.org/registry/OpenGL/extensions/ARB/ARB_sampler_objects.txt State Attribute controllig sampling instead of Texture Sampler is prioritary over Texture sample parameter (don't play with both) More...

Inheritance diagram for osg::Sampler:
Inheritance graph
[legend]

Public Member Functions

 Sampler ()
 
 Sampler (const Sampler &text, const CopyOp &copyop=CopyOp::SHALLOW_COPY)
 Copy constructor using CopyOp to manage deep vs shallow copy. More...
 
 META_StateAttribute (osg, Sampler, SAMPLER) virtual bool isTextureAttribute() const
 
void setWrap (Texture::WrapParameter which, Texture::WrapMode wrap)
 Sets the texture wrap mode. More...
 
Texture::WrapMode getWrap (Texture::WrapParameter which) const
 Gets the texture wrap mode. More...
 
void setFilter (Texture::FilterParameter which, Texture::FilterMode filter)
 Sets the texture filter mode. More...
 
Texture::FilterMode getFilter (Texture::FilterParameter which) const
 Gets the texture filter mode. More...
 
void setShadowCompareFunc (Texture::ShadowCompareFunc func)
 Sets shadow texture comparison function. More...
 
Texture::ShadowCompareFunc getShadowCompareFunc () const
 
void setShadowTextureMode (Texture::ShadowTextureMode mode)
 Sets shadow texture mode after comparison. More...
 
Texture::ShadowTextureMode getShadowTextureMode () const
 
void setBorderColor (const Vec4d &color)
 Sets the border color. More...
 
const Vec4dgetBorderColor () const
 Gets the border color. More...
 
void setMaxAnisotropy (float anis)
 Sets the maximum anisotropy value, default value is 1.0 for no anisotropic filtering. More...
 
float getMaxAnisotropy () const
 Gets the maximum anisotropy value. More...
 
void setMinLOD (float anis)
 
float getMinLOD () const
 Gets the maximum anisotropy value. More...
 
void setMaxLOD (float anis)
 
float getMaxLOD () const
 Gets the maximum anisotropy value. More...
 
void setLODBias (float anis)
 
float getLODBias () const
 Gets the maximum anisotropy value. More...
 
virtual void apply (State &state) const
 apply the OpenGL state attributes. More...
 
virtual void compileGLObjects (State &) const
 Default to nothing to compile - all state is applied immediately. More...
 
virtual void releaseGLObjects (State *state=0) const
 release state's SamplerObject More...
 
virtual int compare (const StateAttribute &sa) const
 Return -1 if *this < *rhs, 0 if *this==*rhs, 1 if *this>*rhs. More...
 
- Public Member Functions inherited from osg::StateAttribute
 StateAttribute ()
 
 StateAttribute (const StateAttribute &sa, const CopyOp &copyop=CopyOp::SHALLOW_COPY)
 
virtual ObjectcloneType () const =0
 Clone the type of an attribute, with Object* return type. More...
 
virtual Objectclone (const CopyOp &) const =0
 Clone an attribute, with Object* return type. More...
 
virtual bool isSameKindAs (const Object *obj) const
 Return true if this and obj are of the same kind of object. More...
 
virtual const char * libraryName () const
 Return the name of the attribute's library. More...
 
virtual const char * className () const
 Return the name of the attribute's class type. More...
 
virtual StateAttributeasStateAttribute ()
 Convert 'this' into a StateAttribute pointer if Object is a StateAttribute, otherwise return 0. More...
 
virtual const StateAttributeasStateAttribute () const
 convert 'const this' into a const StateAttribute pointer if Object is a StateAttribute, otherwise return 0. More...
 
virtual TextureasTexture ()
 Fast alternative to dynamic_cast<> for determining if state attribute is a Texture. More...
 
virtual const TextureasTexture () const
 Fast alternative to dynamic_cast<> for determining if state attribute is a Texture. More...
 
virtual Type getType () const =0
 Return the Type identifier of the attribute's class type. More...
 
virtual unsigned int getMember () const
 Return the member identifier within the attribute's class type. More...
 
TypeMemberPair getTypeMemberPair () const
 Return the TypeMemberPair that uniquely identifies this type member. More...
 
virtual bool isTextureAttribute () const
 Return true if StateAttribute is a type which controls texturing and needs to be issued w.r.t to specific texture unit. More...
 
bool operator< (const StateAttribute &rhs) const
 
bool operator== (const StateAttribute &rhs) const
 
bool operator!= (const StateAttribute &rhs) const
 
const ParentListgetParents () const
 Get the parent list of this StateAttribute. More...
 
StateSetgetParent (unsigned int i)
 
const StateSetgetParent (unsigned int i) const
 Get a single const parent of this StateAttribute. More...
 
unsigned int getNumParents () const
 Get the number of parents of this StateAttribute. More...
 
void setShaderComponent (ShaderComponent *sc)
 
ShaderComponentgetShaderComponent ()
 
const ShaderComponentgetShaderComponent () const
 
virtual bool getModeUsage (ModeUsage &) const
 Return the modes associated with this StateAttribute. More...
 
virtual bool checkValidityOfAssociatedModes (osg::State &) const
 Check the modes associated with this StateAttribute are supported by current OpenGL drivers, and if not set the associated mode in osg::State to be black listed/invalid. More...
 
void setUpdateCallback (StateAttributeCallback *uc)
 Set the UpdateCallback which allows users to attach customize the updating of an object during the update traversal. More...
 
StateAttributeCallbackgetUpdateCallback ()
 Get the non const UpdateCallback. More...
 
const StateAttributeCallbackgetUpdateCallback () const
 Get the const UpdateCallback. More...
 
void setEventCallback (StateAttributeCallback *ec)
 Set the EventCallback which allows users to attach customize the updating of an object during the Event traversal. More...
 
StateAttributeCallbackgetEventCallback ()
 Get the non const EventCallback. More...
 
const StateAttributeCallbackgetEventCallback () const
 Get the const EventCallback. More...
 
virtual void resizeGLObjectBuffers (unsigned int)
 Resize any per context GLObject buffers to specified size. More...
 
- Public Member Functions inherited from osg::Object
 Object ()
 Construct an object. More...
 
 Object (bool threadSafeRefUnref)
 
 Object (const Object &, const CopyOp &copyop=CopyOp::SHALLOW_COPY)
 Copy constructor, optional CopyOp object can be used to control shallow vs deep copying of dynamic data. More...
 
std::string getCompoundClassName () const
 return the compound class name that combines the library name and class name. More...
 
virtual NodeasNode ()
 Convert 'this' into a Node pointer if Object is a Node, otherwise return 0. More...
 
virtual const NodeasNode () const
 convert 'const this' into a const Node pointer if Object is a Node, otherwise return 0. More...
 
virtual NodeVisitorasNodeVisitor ()
 Convert 'this' into a NodeVisitor pointer if Object is a NodeVisitor, otherwise return 0. More...
 
virtual const NodeVisitorasNodeVisitor () const
 convert 'const this' into a const NodeVisitor pointer if Object is a NodeVisitor, otherwise return 0. More...
 
virtual StateSetasStateSet ()
 Convert 'this' into a StateSet pointer if Object is a StateSet, otherwise return 0. More...
 
virtual const StateSetasStateSet () const
 convert 'const this' into a const StateSet pointer if Object is a StateSet, otherwise return 0. More...
 
virtual Uniform * asUniform ()
 Convert 'this' into a Uniform pointer if Object is a Uniform, otherwise return 0. More...
 
virtual const UniformBaseasUniformBase () const
 convert 'const this' into a const Uniform pointer if Object is a Uniform, otherwise return 0. More...
 
virtual UniformBaseasUniformBase ()
 Convert 'this' into a Uniform pointer if Object is a Uniform, otherwise return 0. More...
 
virtual const Uniform * asUniform () const
 convert 'const this' into a const Uniform pointer if Object is a Uniform, otherwise return 0. More...
 
virtual CameraasCamera ()
 Convert 'this' into a Camera pointer if Node is a Camera, otherwise return 0. More...
 
virtual const CameraasCamera () const
 convert 'const this' into a const Camera pointer if Node is a Camera, otherwise return 0. More...
 
virtual DrawableasDrawable ()
 Convert 'this' into a Drawable pointer if Object is a Drawable, otherwise return 0. More...
 
virtual const DrawableasDrawable () const
 convert 'const this' into a const Drawable pointer if Object is a Drawable, otherwise return 0. More...
 
virtual CallbackasCallback ()
 Convert 'this' into a Callback pointer if Object is a Callback, otherwise return 0. More...
 
virtual const CallbackasCallback () const
 convert 'const this' into a const Callback pointer if Object is a Callback, otherwise return 0. More...
 
virtual CallbackObjectasCallbackObject ()
 Convert 'this' into a CallbackObject pointer if Object is a CallbackObject, otherwise return 0. More...
 
virtual const CallbackObjectasCallbackObject () const
 convert 'const this' into a const CallbackObject pointer if Object is a CallbackObject, otherwise return 0. More...
 
virtual UserDataContainerasUserDataContainer ()
 Convert 'this' into a UserDataContainer pointer if Object is a UserDataContainer, otherwise return 0. More...
 
virtual const UserDataContainerasUserDataContainer () const
 convert 'const this' into a const UserDataContainer pointer if Object is a UserDataContainer, otherwise return 0. More...
 
virtual ValueObjectasValueObject ()
 Convert 'this' into a ValueObject pointer if Object is a ValueObject, otherwise return 0. More...
 
virtual const ValueObjectasValueObject () const
 Convert 'this' into a ValueObject pointer if Object is a ValueObject, otherwise return 0. More...
 
virtual ImageasImage ()
 Convert 'this' into a Image pointer if Object is a Image, otherwise return 0. More...
 
virtual const ImageasImage () const
 Convert 'this' into a Image pointer if Object is a Image, otherwise return 0. More...
 
virtual void setThreadSafeRefUnref (bool threadSafe)
 Set whether to use a mutex to ensure ref() and unref() are thread safe. More...
 
virtual void setName (const std::string &name)
 Set the name of object using C++ style string. More...
 
void setName (const char *name)
 Set the name of object using a C style string. More...
 
const std::string & getName () const
 Get the name of object. More...
 
void setDataVariance (DataVariance dv)
 Set the data variance of this object. More...
 
DataVariance getDataVariance () const
 Get the data variance of this object. More...
 
virtual void computeDataVariance ()
 Compute the DataVariance based on an assessment of callback etc. More...
 
void setUserDataContainer (osg::UserDataContainer *udc)
 set the UserDataContainer object. More...
 
template<class T >
void setUserDataContainer (const ref_ptr< T > &udc)
 
osg::UserDataContainergetUserDataContainer ()
 get the UserDataContainer attached to this object. More...
 
const osg::UserDataContainergetUserDataContainer () const
 get the const UserDataContainer attached to this object. More...
 
osg::UserDataContainergetOrCreateUserDataContainer ()
 Convenience method that returns the UserDataContainer, and if one doesn't already exist creates and assigns a DefaultUserDataContainer to the Object and then return this new UserDataContainer. More...
 
virtual void setUserData (Referenced *obj)
 Set user data, data must be subclassed from Referenced to allow automatic memory handling. More...
 
template<class T >
void setUserData (const ref_ptr< T > &ud)
 
virtual ReferencedgetUserData ()
 Get user data. More...
 
virtual const ReferencedgetUserData () const
 Get const user data. More...
 
template<typename T >
bool getUserValue (const std::string &name, T &value) const
 Convenience method that casts the named UserObject to osg::TemplateValueObject<T> and gets the value. More...
 
template<typename T >
void setUserValue (const std::string &name, const T &value)
 Convenience method that creates the osg::TemplateValueObject<T> to store the specified value and adds it as a named UserObject. More...
 
template<typename T >
BoolValueObject UCharValueObject UShortValueObject UIntValueObject DoubleValueObject Vec3fValueObject Vec2dValueObject Vec4dValueObject PlaneValueObject MatrixdValueObject BoundingBoxdValueObject BoundingSpheredValueObject bool getUserValue (const std::string &name, T &value) const
 provide implementation of osg::Object::getUserValue(..) template More...
 
- Public Member Functions inherited from osg::Referenced
 Referenced ()
 
 Referenced (bool threadSafeRefUnref)
 Deprecated, Referenced is now always uses thread safe ref/unref, use default Referenced() constructor instead. More...
 
 Referenced (const Referenced &)
 
Referencedoperator= (const Referenced &)
 
bool getThreadSafeRefUnref () const
 Get whether a mutex is used to ensure ref() and unref() are thread safe. More...
 
OpenThreads::MutexgetRefMutex () const
 Get the mutex used to ensure thread safety of ref()/unref(). More...
 
int ref () const
 Increment the reference count by one, indicating that this object has another pointer which is referencing it. More...
 
int unref () const
 Decrement the reference count by one, indicating that a pointer to this object is no longer referencing it. More...
 
int unref_nodelete () const
 Decrement the reference count by one, indicating that a pointer to this object is no longer referencing it. More...
 
int referenceCount () const
 Return the number of pointers currently referencing this object. More...
 
ObserverSetgetObserverSet () const
 Get the ObserverSet if one is attached, otherwise return NULL. More...
 
ObserverSetgetOrCreateObserverSet () const
 Get the ObserverSet if one is attached, otherwise create an ObserverSet, attach it, then return this newly created ObserverSet. More...
 
void addObserver (Observer *observer) const
 Add a Observer that is observing this object, notify the Observer when this object gets deleted. More...
 
void removeObserver (Observer *observer) const
 Remove Observer that is observing this object. More...
 

Static Public Member Functions

static void generateSamplerObjects (StateSet &)
 helper method to generate Sampler from Texture's sampling parameters (except shadow_texture_mode left to NONE) More...
 
- Static Public Member Functions inherited from osg::Referenced
static OpenThreads::MutexgetGlobalReferencedMutex ()
 Get the optional global Referenced mutex, this can be shared between all osg::Referenced. More...
 
static void setDeleteHandler (DeleteHandler *handler)
 Set a DeleteHandler to which deletion of all referenced counted objects will be delegated. More...
 
static DeleteHandlergetDeleteHandler ()
 Get a DeleteHandler. More...
 

Protected Attributes

Texture::WrapMode _wrap_s
 
Texture::WrapMode _wrap_t
 
Texture::WrapMode _wrap_r
 
Texture::ShadowCompareFunc _shadow_compare_func
 
Texture::ShadowTextureMode _shadow_texture_mode
 
Vec4d _borderColor
 
Texture::FilterMode _min_filter
 
Texture::FilterMode _mag_filter
 
float _maxAnisotropy
 
float _minlod
 
float _maxlod
 
float _lodbias
 
buffered_value< GLuint > _PCsampler
 
buffered_value< uint8_t > _PCdirtyflags
 
- 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

- Public Types inherited from osg::StateAttribute
enum  Values {
  OFF = 0x0, ON = 0x1, OVERRIDE = 0x2, PROTECTED = 0x4,
  INHERIT = 0x8
}
 list values which can be used to set either GLModeValues or OverrideValues. More...
 
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
}
 Type identifier to differentiate between different state types. More...
 
typedef GLenum GLMode
 GLMode is the value used in glEnable/glDisable(mode) More...
 
typedef unsigned int GLModeValue
 GLModeValue is used to specify whether a mode is enabled (ON) or disabled (OFF). More...
 
typedef unsigned int OverrideValue
 Override is used to specify the override behavior of StateAttributes from parent to children. More...
 
typedef std::pair< Type, unsigned int > TypeMemberPair
 Simple pairing between an attribute type and the member within that attribute type group. More...
 
typedef std::vector< StateSet * > ParentList
 A vector of osg::StateSet pointers which is used to store the parent(s) of this StateAttribute. More...
 
typedef osg::StateAttributeCallback Callback
 
- Public Types inherited from osg::Object
enum  DataVariance { DYNAMIC, STATIC, UNSPECIFIED }
 
- 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 ()
 Object destructor. More...
 
- Protected Member Functions inherited from osg::Referenced
virtual ~Referenced ()
 
void signalObserversAndDelete (bool signalDelete, bool doDelete) const
 
void deleteUsingDeleteHandler () const
 

Detailed Description

OpenGL Sampler OpenGL 3.3 required https://www.khronos.org/registry/OpenGL/extensions/ARB/ARB_sampler_objects.txt State Attribute controllig sampling instead of Texture Sampler is prioritary over Texture sample parameter (don't play with both)

Constructor & Destructor Documentation

◆ Sampler() [1/2]

osg::Sampler::Sampler ( )

◆ Sampler() [2/2]

osg::Sampler::Sampler ( const Sampler text,
const CopyOp copyop = CopyOp::SHALLOW_COPY 
)

Copy constructor using CopyOp to manage deep vs shallow copy.

Member Function Documentation

◆ apply()

virtual void osg::Sampler::apply ( 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::Sampler::compare ( const StateAttribute sa) const
virtual

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

Implements osg::StateAttribute.

◆ compileGLObjects()

virtual void osg::Sampler::compileGLObjects ( State ) const
virtual

Default to nothing to compile - all state is applied immediately.

Reimplemented from osg::StateAttribute.

◆ generateSamplerObjects()

static void osg::Sampler::generateSamplerObjects ( StateSet )
static

helper method to generate Sampler from Texture's sampling parameters (except shadow_texture_mode left to NONE)

◆ getBorderColor()

const Vec4d& osg::Sampler::getBorderColor ( ) const
inline

Gets the border color.

◆ getFilter()

Texture::FilterMode osg::Sampler::getFilter ( Texture::FilterParameter  which) const

Gets the texture filter mode.

◆ getLODBias()

float osg::Sampler::getLODBias ( ) const
inline

Gets the maximum anisotropy value.

References osg::releaseGLObjects().

◆ getMaxAnisotropy()

float osg::Sampler::getMaxAnisotropy ( ) const
inline

Gets the maximum anisotropy value.

◆ getMaxLOD()

float osg::Sampler::getMaxLOD ( ) const
inline

Gets the maximum anisotropy value.

◆ getMinLOD()

float osg::Sampler::getMinLOD ( ) const
inline

Gets the maximum anisotropy value.

◆ getShadowCompareFunc()

Texture::ShadowCompareFunc osg::Sampler::getShadowCompareFunc ( ) const
inline

◆ getShadowTextureMode()

Texture::ShadowTextureMode osg::Sampler::getShadowTextureMode ( ) const
inline

◆ getWrap()

Texture::WrapMode osg::Sampler::getWrap ( Texture::WrapParameter  which) const

Gets the texture wrap mode.

◆ META_StateAttribute()

osg::Sampler::META_StateAttribute ( osg  ,
Sampler  ,
SAMPLER   
) const
inline

◆ releaseGLObjects()

virtual void osg::Sampler::releaseGLObjects ( State state = 0) const
virtual

release state's SamplerObject

Reimplemented from osg::StateAttribute.

◆ setBorderColor()

void osg::Sampler::setBorderColor ( const Vec4d color)

Sets the border color.

Only used when wrap mode is CLAMP_TO_BORDER. The border color will be casted to the appropriate type to match the internal pixel format of the texture.

◆ setFilter()

void osg::Sampler::setFilter ( Texture::FilterParameter  which,
Texture::FilterMode  filter 
)

Sets the texture filter mode.

◆ setLODBias()

void osg::Sampler::setLODBias ( float  anis)

◆ setMaxAnisotropy()

void osg::Sampler::setMaxAnisotropy ( float  anis)

Sets the maximum anisotropy value, default value is 1.0 for no anisotropic filtering.

If hardware does not support anisotropic filtering, use normal filtering (equivalent to a max anisotropy value of 1.0. Valid range is 1.0f upwards. The maximum value depends on the graphics system.

◆ setMaxLOD()

void osg::Sampler::setMaxLOD ( float  anis)

◆ setMinLOD()

void osg::Sampler::setMinLOD ( float  anis)

◆ setShadowCompareFunc()

void osg::Sampler::setShadowCompareFunc ( Texture::ShadowCompareFunc  func)

Sets shadow texture comparison function.

◆ setShadowTextureMode()

void osg::Sampler::setShadowTextureMode ( Texture::ShadowTextureMode  mode)

Sets shadow texture mode after comparison.

◆ setWrap()

void osg::Sampler::setWrap ( Texture::WrapParameter  which,
Texture::WrapMode  wrap 
)

Sets the texture wrap mode.

Member Data Documentation

◆ _borderColor

Vec4d osg::Sampler::_borderColor
protected

◆ _lodbias

float osg::Sampler::_lodbias
protected

◆ _mag_filter

Texture::FilterMode osg::Sampler::_mag_filter
protected

◆ _maxAnisotropy

float osg::Sampler::_maxAnisotropy
protected

◆ _maxlod

float osg::Sampler::_maxlod
protected

◆ _min_filter

Texture::FilterMode osg::Sampler::_min_filter
protected

◆ _minlod

float osg::Sampler::_minlod
protected

◆ _PCdirtyflags

buffered_value<uint8_t> osg::Sampler::_PCdirtyflags
mutableprotected

◆ _PCsampler

buffered_value<GLuint> osg::Sampler::_PCsampler
mutableprotected

◆ _shadow_compare_func

Texture::ShadowCompareFunc osg::Sampler::_shadow_compare_func
protected

◆ _shadow_texture_mode

Texture::ShadowTextureMode osg::Sampler::_shadow_texture_mode
protected

◆ _wrap_r

Texture::WrapMode osg::Sampler::_wrap_r
protected

◆ _wrap_s

Texture::WrapMode osg::Sampler::_wrap_s
protected

◆ _wrap_t

Texture::WrapMode osg::Sampler::_wrap_t
protected

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