Open CASCADE Technology  7.4.1.dev
Public Member Functions
OpenGl_Resource Class Referenceabstract

Interface for OpenGl resource with following meaning: More...

#include <OpenGl_Resource.hxx>

Inheritance diagram for OpenGl_Resource:
Inheritance graph
[legend]

Public Member Functions

 OpenGl_Resource ()
 Empty constructor. More...
 
virtual ~OpenGl_Resource ()
 Destructor. Inheritors should call Clean (NULL) within it. More...
 
virtual void Release (OpenGl_Context *theGlCtx)=0
 Release GPU resources. Notice that implementation should be SAFE for several consecutive calls (thus should invalidate internal structures / ids to avoid multiple-free errors). More...
 
virtual Standard_Size EstimatedDataSize () const =0
 Returns estimated GPU memory usage for holding data without considering overheads and allocation alignment rules. More...
 
virtual void DumpJson (Standard_OStream &theOStream, Standard_Integer theDepth=-1) const
 Dumps the content of me into the stream. More...
 
- Public Member Functions inherited from Standard_Transient
 Standard_Transient ()
 Empty constructor. More...
 
 Standard_Transient (const Standard_Transient &)
 Copy constructor – does nothing. More...
 
Standard_Transientoperator= (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_TransientThis () 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...
 

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

Interface for OpenGl resource with following meaning:

Constructor & Destructor Documentation

◆ OpenGl_Resource()

OpenGl_Resource::OpenGl_Resource ( )

Empty constructor.

◆ ~OpenGl_Resource()

virtual OpenGl_Resource::~OpenGl_Resource ( )
virtual

Destructor. Inheritors should call Clean (NULL) within it.

Member Function Documentation

◆ DumpJson()

virtual void OpenGl_Resource::DumpJson ( Standard_OStream theOStream,
Standard_Integer  theDepth = -1 
) const
inlinevirtual

Dumps the content of me into the stream.

Reimplemented in OpenGl_VertexBuffer, and OpenGl_IndexBuffer.

◆ EstimatedDataSize()

virtual Standard_Size OpenGl_Resource::EstimatedDataSize ( ) const
pure virtual

Returns estimated GPU memory usage for holding data without considering overheads and allocation alignment rules.

Implemented in OpenGl_VertexBuffer, OpenGl_FrameBuffer, OpenGl_ShaderProgram, OpenGl_Texture, OpenGl_ShaderObject, OpenGl_PBREnvironment, OpenGl_Font, OpenGl_LineAttributes, OpenGl_CappingPlaneResource, and OpenGl_Sampler.

◆ Release()

virtual void OpenGl_Resource::Release ( OpenGl_Context theGlCtx)
pure virtual

Release GPU resources. Notice that implementation should be SAFE for several consecutive calls (thus should invalidate internal structures / ids to avoid multiple-free errors).

Parameters
theGlCtx- bound GL context, shouldn't be NULL.

Implemented in OpenGl_ShaderProgram, OpenGl_ShaderObject, OpenGl_PBREnvironment, OpenGl_Texture, OpenGl_VertexBuffer, OpenGl_FrameBuffer, OpenGl_Font, OpenGl_TextureBufferArb, OpenGl_LineAttributes, OpenGl_CappingPlaneResource, OpenGl_VertexBufferCompat, OpenGl_Sampler, and OpenGl_PointSprite.


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