Graphic3d_ShaderObject Class Reference

This class is responsible for managing shader objects. More...

#include <Graphic3d_ShaderObject.hxx>

Inheritance diagram for Graphic3d_ShaderObject:

Public Member Functions
virtual	~Graphic3d_ShaderObject ()
	Releases resources of shader object. More...
virtual Standard_Boolean	IsDone () const
	Checks if the shader object is valid or not. More...
const OSD_Path &	Path () const
	Returns the full path to the shader source. More...
const TCollection_AsciiString &	Source () const
	Returns the source code of the shader object. More...
Graphic3d_TypeOfShaderObject	Type () const
	Returns type of the shader object. More...
const TCollection_AsciiString &	GetId () const
	Returns unique ID used to manage resource in graphic driver. 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 Handle_Standard_Type &	DynamicType () const
	Returns a type information object about this object. More...
Standard_Boolean	IsInstance (const 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 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...
virtual Handle_Standard_Transient	This () const
	Returns a Handle which references this object. Must never be called to objects created in stack. More...
Standard_Integer	GetRefCount () const
	Get the reference counter of this object. More...

Static Public Member Functions
static Handle < Graphic3d_ShaderObject >	CreateFromFile (const Graphic3d_TypeOfShaderObject theType, const TCollection_AsciiString &thePath)
	Creates new shader object from specified file. More...
static Handle < Graphic3d_ShaderObject >	CreateFromSource (const Graphic3d_TypeOfShaderObject theType, const TCollection_AsciiString &theSource)
	Creates new shader object from specified source. More...

Protected Attributes
TCollection_AsciiString	myID
	the ID of shader object More...
TCollection_AsciiString	mySource
	the source code of shader object More...
OSD_Path	myPath
	the path to shader source (may be empty) More...

Detailed Description

This class is responsible for managing shader objects.

Constructor & Destructor Documentation

virtual Graphic3d_ShaderObject::~Graphic3d_ShaderObject ( )

virtual

Releases resources of shader object.

Member Function Documentation

static Handle< Graphic3d_ShaderObject > Graphic3d_ShaderObject::CreateFromFile ( const Graphic3d_TypeOfShaderObject  theType, const TCollection_AsciiString &  thePath  )

static

Creates new shader object from specified file.

static Handle< Graphic3d_ShaderObject > Graphic3d_ShaderObject::CreateFromSource ( const Graphic3d_TypeOfShaderObject  theType, const TCollection_AsciiString &  theSource  )

static

Creates new shader object from specified source.

const TCollection_AsciiString& Graphic3d_ShaderObject::GetId ( ) const

inline

Returns unique ID used to manage resource in graphic driver.

virtual Standard_Boolean Graphic3d_ShaderObject::IsDone ( ) const

virtual

Checks if the shader object is valid or not.

const OSD_Path& Graphic3d_ShaderObject::Path ( ) const

inline

Returns the full path to the shader source.

const TCollection_AsciiString& Graphic3d_ShaderObject::Source ( ) const

inline

Returns the source code of the shader object.

Graphic3d_TypeOfShaderObject Graphic3d_ShaderObject::Type ( ) const

inline

Returns type of the shader object.

Field Documentation

TCollection_AsciiString Graphic3d_ShaderObject::myID

protected

the ID of shader object

OSD_Path Graphic3d_ShaderObject::myPath

protected

the path to shader source (may be empty)

TCollection_AsciiString Graphic3d_ShaderObject::mySource

protected

the source code of shader object

---

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

• Graphic3d_ShaderObject.hxx