Graphic3d_ShaderVariable Class Reference

Describes custom uniform shader variable. More...

#include <Graphic3d_ShaderVariable.hxx>

Inheritance diagram for Graphic3d_ShaderVariable:

Public Member Functions
	~Graphic3d_ShaderVariable () override
	Releases resources of shader variable.
const TCollection_AsciiString &	Name () const
	Returns name of shader variable.
bool	IsDone () const
	Checks if the shader variable is valid or not.
Graphic3d_ValueInterface *	Value ()
	Returns interface of shader variable value.
Public Member Functions inherited from Standard_Transient
	Standard_Transient ()
	Empty constructor.
	Standard_Transient (const Standard_Transient &)
	Copy constructor – does nothing.
Standard_Transient &	operator= (const Standard_Transient &)
	Assignment operator, needed to avoid copying reference counter.
virtual	~Standard_Transient ()=default
	Destructor must be virtual.
virtual const opencascade::handle< Standard_Type > &	DynamicType () const
	Returns a type descriptor about this object.
bool	IsInstance (const opencascade::handle< Standard_Type > &theType) const
	Returns a true value if this is an instance of Type.
bool	IsInstance (const char *const theTypeName) const
	Returns a true value if this is an instance of TypeName.
bool	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.
bool	IsKind (const char *const 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.
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.
int	GetRefCount () const noexcept
	Get the reference counter of this object.
void	IncrementRefCounter () noexcept
	Increments the reference counter of this object. Uses relaxed memory ordering since incrementing only requires atomicity, not synchronization with other memory operations.
int	DecrementRefCounter () noexcept
	Decrements the reference counter of this object; returns the decremented value. Uses release ordering for the decrement to ensure all writes to the object are visible before the count reaches zero. An acquire fence is added only when the count reaches zero, ensuring proper synchronization before deletion. This is more efficient than using acq_rel for every decrement.
virtual void	Delete () const
	Memory deallocator for transient classes.

Static Public Member Functions
template<class T >
static Graphic3d_ShaderVariable *	Create (const TCollection_AsciiString &theName, const T &theValue)
	Creates new initialized shader variable.
Static Public Member Functions inherited from Standard_Transient
static constexpr const char *	get_type_name ()
	Returns a type descriptor about this object.
static const opencascade::handle< Standard_Type > &	get_type_descriptor ()
	Returns type descriptor of Standard_Transient class.

Protected Member Functions
	Graphic3d_ShaderVariable (const TCollection_AsciiString &theName)
	Creates new uninitialized shader variable.

Protected Attributes
TCollection_AsciiString	myName
	The name of uniform shader variable.
Graphic3d_ValueInterface *	myValue
	The generic value of shader variable.

Additional Inherited Members
Public Types inherited from Standard_Transient
typedef void	base_type
	Returns a type descriptor about this object.

Detailed Description

Describes custom uniform shader variable.

Constructor & Destructor Documentation

~Graphic3d_ShaderVariable()

Graphic3d_ShaderVariable::~Graphic3d_ShaderVariable ( )

override

Releases resources of shader variable.

Graphic3d_ShaderVariable()

Graphic3d_ShaderVariable::Graphic3d_ShaderVariable ( const TCollection_AsciiString & theName )

protected

Creates new uninitialized shader variable.

Member Function Documentation

Create()

template<class T >

static Graphic3d_ShaderVariable * Graphic3d_ShaderVariable::Create ( const TCollection_AsciiString & theName, const T & theValue )

static

Creates new initialized shader variable.

IsDone()

bool Graphic3d_ShaderVariable::IsDone

(

)

const

Checks if the shader variable is valid or not.

Name()

const TCollection_AsciiString & Graphic3d_ShaderVariable::Name

(

)

const

Returns name of shader variable.

Value()

Graphic3d_ValueInterface * Graphic3d_ShaderVariable::Value

(

)

Returns interface of shader variable value.

Field Documentation

myName

TCollection_AsciiString Graphic3d_ShaderVariable::myName

protected

The name of uniform shader variable.

myValue

Graphic3d_ValueInterface* Graphic3d_ShaderVariable::myValue

protected

The generic value of shader variable.

---

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

• Graphic3d_ShaderVariable.hxx