Interface for OpenGl resource with following meaning: More...
#include <OpenGl_Resource.hxx>
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_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... | |
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:
- object can be constructed at any time;
- should be explicitly Initialized within active OpenGL context;
- should be explicitly Released within active OpenGL context (virtual Release() method);
- can be destroyed at any time. Destruction of object with unreleased GPU resources will cause leaks which will be ignored in release mode and will immediately stop program execution in debug mode using assert.
Constructor & Destructor Documentation
◆ OpenGl_Resource()
| OpenGl_Resource::OpenGl_Resource | ( | ) |
Empty constructor.
◆ ~OpenGl_Resource()
|
virtual |
Destructor. Inheritors should call Clean (NULL) within it.
Member Function Documentation
◆ DumpJson()
|
inlinevirtual |
Dumps the content of me into the stream.
Reimplemented in OpenGl_Buffer, and OpenGl_IndexBuffer.
◆ EstimatedDataSize()
|
pure virtual |
Returns estimated GPU memory usage for holding data without considering overheads and allocation alignment rules.
Implemented in OpenGl_FrameBuffer, OpenGl_ShaderProgram, OpenGl_Texture, OpenGl_Buffer, OpenGl_PBREnvironment, OpenGl_ShaderObject, OpenGl_Font, OpenGl_CappingPlaneResource, OpenGl_Sampler, OpenGl_LineAttributes, OpenGl_ShadowMap, and OpenGl_DepthPeeling.
◆ Release()
|
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_PBREnvironment, OpenGl_Texture, OpenGl_ShaderObject, OpenGl_Buffer, OpenGl_FrameBuffer, OpenGl_Font, OpenGl_TextureBuffer, OpenGl_CappingPlaneResource, OpenGl_Sampler, OpenGl_LineAttributes, OpenGl_ShadowMap, OpenGl_PointSprite, D3DHost_FrameBuffer, and OpenGl_DepthPeeling.
The documentation for this class was generated from the following file:
