OpenGl_ShaderObject Class Reference

Wrapper for OpenGL shader object. More...

#include <OpenGl_ShaderObject.hxx>

Inheritance diagram for OpenGl_ShaderObject:

Public Member Functions
	OpenGl_ShaderObject (GLenum theType)
	Creates uninitialized shader object.
	~OpenGl_ShaderObject () override
	Releases resources of shader object.
bool	LoadSource (const occ::handle< OpenGl_Context > &theCtx, const TCollection_AsciiString &theSource)
	Loads shader source code.
bool	Compile (const occ::handle< OpenGl_Context > &theCtx)
	Compiles the shader object.
bool	LoadAndCompile (const occ::handle< OpenGl_Context > &theCtx, const TCollection_AsciiString &theId, const TCollection_AsciiString &theSource, bool theIsVerbose=true, bool theToPrintSource=true)
	Wrapper for compiling shader object with verbose printing on error.
void	DumpSourceCode (const occ::handle< OpenGl_Context > &theCtx, const TCollection_AsciiString &theId, const TCollection_AsciiString &theSource) const
	Print source code of this shader object to messenger.
bool	FetchInfoLog (const occ::handle< OpenGl_Context > &theCtx, TCollection_AsciiString &theLog)
	Fetches information log of the last compile operation.
bool	Create (const occ::handle< OpenGl_Context > &theCtx)
	Creates new empty shader object of specified type.
void	Release (OpenGl_Context *theCtx) override
	Destroys shader object.
size_t	EstimatedDataSize () const override
	Returns estimated GPU memory usage - not implemented.
GLenum	Type () const
	Returns type of shader object.
bool	updateDebugDump (const occ::handle< OpenGl_Context > &theCtx, const TCollection_AsciiString &theId, const TCollection_AsciiString &theFolder, bool theToBeautify, bool theToReset)
	Update the shader object from external file in the following way: 1) If external file does not exist, then it will be created (current source code will be dumped, no recompilation) and FALSE will be returned. 2) If external file exists and it has the same timestamp as myDumpDate, nothing will be done and FALSE will be returned. 3) If external file exists and it has newer timestamp than myDumpDate, shader will be recompiled and TRUE will be returned.
Public Member Functions inherited from OpenGl_Resource
	OpenGl_Resource ()
	Empty constructor.
	~OpenGl_Resource () override
	Destructor. Inheritors should call Clean (NULL) within it.
virtual void	DumpJson (Standard_OStream &theOStream, int theDepth=-1) const
	Dumps the content of me into the stream.
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 Attributes
static const GLuint	NO_SHADER = 0
	Non-valid shader name.

Protected Attributes
Quantity_Date	myDumpDate
	The recent date of the shader dump.
GLenum	myType
	Type of OpenGL shader object.
GLuint	myShaderID
	Handle of OpenGL shader object.

Additional Inherited Members
typedef void	base_type
	Returns a type descriptor about this object.
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.

Detailed Description

Wrapper for OpenGL shader object.

Constructor & Destructor Documentation

OpenGl_ShaderObject()

OpenGl_ShaderObject::OpenGl_ShaderObject

(

GLenum

theType

)

Creates uninitialized shader object.

~OpenGl_ShaderObject()

OpenGl_ShaderObject::~OpenGl_ShaderObject ( )

override

Releases resources of shader object.

Member Function Documentation

Compile()

bool OpenGl_ShaderObject::Compile

(

const occ::handle< OpenGl_Context > &

theCtx

)

Compiles the shader object.

Create()

bool OpenGl_ShaderObject::Create

(

const occ::handle< OpenGl_Context > &

theCtx

)

Creates new empty shader object of specified type.

DumpSourceCode()

void OpenGl_ShaderObject::DumpSourceCode	(	const occ::handle< OpenGl_Context > &	theCtx,
		const TCollection_AsciiString &	theId,
		const TCollection_AsciiString &	theSource ) const

Print source code of this shader object to messenger.

EstimatedDataSize()

size_t OpenGl_ShaderObject::EstimatedDataSize ( ) const

inlineoverridevirtual

Returns estimated GPU memory usage - not implemented.

Implements OpenGl_Resource.

FetchInfoLog()

bool OpenGl_ShaderObject::FetchInfoLog	(	const occ::handle< OpenGl_Context > &	theCtx,
		TCollection_AsciiString &	theLog )

Fetches information log of the last compile operation.

LoadAndCompile()

bool OpenGl_ShaderObject::LoadAndCompile	(	const occ::handle< OpenGl_Context > &	theCtx,
		const TCollection_AsciiString &	theId,
		const TCollection_AsciiString &	theSource,
		bool	theIsVerbose = true,
		bool	theToPrintSource = true )

Wrapper for compiling shader object with verbose printing on error.

Parameters

theCtx	bound OpenGL context
theId	GLSL program id to define file name
theSource	source code to load
theIsVerbose	flag to print log on error
theToPrintSource	flag to print source code on error

LoadSource()

bool OpenGl_ShaderObject::LoadSource	(	const occ::handle< OpenGl_Context > &	theCtx,
		const TCollection_AsciiString &	theSource )

Loads shader source code.

Release()

void OpenGl_ShaderObject::Release ( OpenGl_Context * theCtx )

overridevirtual

Destroys shader object.

Implements OpenGl_Resource.

Type()

GLenum OpenGl_ShaderObject::Type ( ) const

inline

Returns type of shader object.

updateDebugDump()

bool OpenGl_ShaderObject::updateDebugDump	(	const occ::handle< OpenGl_Context > &	theCtx,
		const TCollection_AsciiString &	theId,
		const TCollection_AsciiString &	theFolder,
		bool	theToBeautify,
		bool	theToReset )

Update the shader object from external file in the following way: 1) If external file does not exist, then it will be created (current source code will be dumped, no recompilation) and FALSE will be returned. 2) If external file exists and it has the same timestamp as myDumpDate, nothing will be done and FALSE will be returned. 3) If external file exists and it has newer timestamp than myDumpDate, shader will be recompiled and TRUE will be returned.

Parameters

theCtx	OpenGL context bound to this working thread
theId	GLSL program id to define file name
theFolder	folder to store files
theToBeautify	flag improving formatting (add extra newlines)
theToReset	when TRUE, existing dumps will be overridden

Field Documentation

myDumpDate

Quantity_Date OpenGl_ShaderObject::myDumpDate

protected

The recent date of the shader dump.

myShaderID

GLuint OpenGl_ShaderObject::myShaderID

protected

Handle of OpenGL shader object.

myType

GLenum OpenGl_ShaderObject::myType

protected

Type of OpenGL shader object.

NO_SHADER

const GLuint OpenGl_ShaderObject::NO_SHADER = 0

static

Non-valid shader name.

---

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

• OpenGl_ShaderObject.hxx