OpenGl_Sampler Class Reference

Class implements OpenGL sampler object resource that stores the sampling parameters for a texture access. More...

#include <OpenGl_Sampler.hxx>

Inheritance diagram for OpenGl_Sampler:

Public Member Functions
	OpenGl_Sampler ()
	Creates new sampler object. More...
virtual	~OpenGl_Sampler ()
	Releases resources of sampler object. More...
virtual void	Release (OpenGl_Context *theContext) override
	Destroys object - will release GPU memory if any. More...
Standard_Boolean	Init (OpenGl_Context &theContext)
	Initializes sampler object. More...
Standard_Boolean	IsValid () const
	Returns true if current object was initialized. More...
void	Bind (OpenGl_Context &theContext, const GLuint theUnit=0)
	Binds sampler object to the given texture unit. More...
void	Unbind (OpenGl_Context &theContext, const GLuint theUnit=0)
	Unbinds sampler object from the given texture unit. More...
void	SetParameter (OpenGl_Context &theContext, const GLenum theParam, const GLint theValue)
	Sets specific sampler parameter. More...
GLuint	SamplerID () const
	Returns OpenGL sampler ID. More...
Public Member Functions inherited from OpenGl_Resource
	OpenGl_Resource ()
	Empty constructor. More...
virtual	~OpenGl_Resource ()
	Destructor. Inheritors should call Clean (NULL) within it. More...
Public Member Functions inherited from Standard_Transient
	Standard_Transient ()
	Empty constructor. More...
	Standard_Transient (const Standard_Transient &)
	Copy constructor – does nothing. More...
Standard_Transient &	operator= (const Standard_Transient &)
	Assignment operator, needed to avoid copying reference counter. More...
virtual	~Standard_Transient ()
	Destructor must be virtual. More...
virtual void	Delete () const
	Memory deallocator for transient classes. More...
virtual const opencascade::handle< Standard_Type > &	DynamicType () const
	Returns a type descriptor about this object. More...
Standard_Boolean	IsInstance (const opencascade::handle< Standard_Type > &theType) const
	Returns a true value if this is an instance of Type. More...
Standard_Boolean	IsInstance (const Standard_CString theTypeName) const
	Returns a true value if this is an instance of TypeName. More...
Standard_Boolean	IsKind (const opencascade::handle< Standard_Type > &theType) const
	Returns true if this is an instance of Type or an instance of any class that inherits from Type. Note that multiple inheritance is not supported by OCCT RTTI mechanism. More...
Standard_Boolean	IsKind (const Standard_CString theTypeName) const
	Returns true if this is an instance of TypeName or an instance of any class that inherits from TypeName. Note that multiple inheritance is not supported by OCCT RTTI mechanism. More...
Standard_Transient *	This () const
	Returns non-const pointer to this object (like const_cast). For protection against creating handle to objects allocated in stack or call from constructor, it will raise exception Standard_ProgramError if reference counter is zero. More...
Standard_Integer	GetRefCount () const
	Get the reference counter of this object. More...
void	IncrementRefCounter () const
	Increments the reference counter of this object. More...
Standard_Integer	DecrementRefCounter () const
	Decrements the reference counter of this object; returns the decremented value. More...

Static Public Attributes
static const GLuint	NO_SAMPLER = 0
	Helpful constant defining invalid sampler identifier. More...

Protected Member Functions
Standard_Boolean	isValidSampler () const
	Checks if sampler object is valid. More...

Protected Attributes
GLuint	mySamplerID
	OpenGL sampler object ID. More...

Additional Inherited Members
Public Types inherited from Standard_Transient
typedef void	base_type
	Returns a type descriptor about this object. More...
Static Public Member Functions inherited from Standard_Transient
static const char *	get_type_name ()
	Returns a type descriptor about this object. More...
static const opencascade::handle< Standard_Type > &	get_type_descriptor ()
	Returns type descriptor of Standard_Transient class. More...

Detailed Description

Class implements OpenGL sampler object resource that stores the sampling parameters for a texture access.

Constructor & Destructor Documentation

OpenGl_Sampler::OpenGl_Sampler

(

)

Creates new sampler object.

virtual OpenGl_Sampler::~OpenGl_Sampler ( )

virtual

Releases resources of sampler object.

Member Function Documentation

void OpenGl_Sampler::Bind	(	OpenGl_Context &	theContext,
		const GLuint	theUnit = 0
	)

Binds sampler object to the given texture unit.

Standard_Boolean OpenGl_Sampler::Init

(

OpenGl_Context &

theContext

)

Initializes sampler object.

Standard_Boolean OpenGl_Sampler::IsValid ( ) const

inline

Returns true if current object was initialized.

Standard_Boolean OpenGl_Sampler::isValidSampler ( ) const

inlineprotected

Checks if sampler object is valid.

virtual void OpenGl_Sampler::Release ( OpenGl_Context *  theContext )

overridevirtual

Destroys object - will release GPU memory if any.

Implements OpenGl_Resource.

GLuint OpenGl_Sampler::SamplerID ( ) const

inline

Returns OpenGL sampler ID.

void OpenGl_Sampler::SetParameter	(	OpenGl_Context &	theContext,
		const GLenum	theParam,
		const GLint	theValue
	)

Sets specific sampler parameter.

void OpenGl_Sampler::Unbind	(	OpenGl_Context &	theContext,
		const GLuint	theUnit = 0
	)

Unbinds sampler object from the given texture unit.

Field Documentation

GLuint OpenGl_Sampler::mySamplerID

protected

OpenGL sampler object ID.

const GLuint OpenGl_Sampler::NO_SAMPLER = 0

static

Helpful constant defining invalid sampler identifier.

---

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

• OpenGl_Sampler.hxx