OCCT3D OCCT 8.0.1
OCCT documentation

Search guides and API reference

Enter at least two characters.

    Open CASCADE Technology Reference Manual 8.0.1
    OpenGl_NamedResource Class Reference

    Named resource object. More...

    #include <OpenGl_NamedResource.hxx>

    Inheritance diagram for OpenGl_NamedResource:

    Public Member Functions

     OpenGl_NamedResource (const TCollection_AsciiString &theId)
     Empty constructor.
    const TCollection_AsciiStringResourceId () const
     Return resource name.
    Public Member Functions inherited from OpenGl_Resource
     OpenGl_Resource ()
     Empty constructor.
     ~OpenGl_Resource () override
     Destructor. Inheritors should call Clean (NULL) within it.
    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).
    virtual size_t EstimatedDataSize () const =0
     Returns estimated GPU memory usage for holding data without considering overheads and allocation alignment rules.
    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_Transientoperator= (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_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.
    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.

    Protected Attributes

    TCollection_AsciiString myResourceId
     resource name

    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

    Named resource object.

    Constructor & Destructor Documentation

    ◆ OpenGl_NamedResource()

    OpenGl_NamedResource::OpenGl_NamedResource ( const TCollection_AsciiString & theId)
    inline

    Empty constructor.

    Member Function Documentation

    ◆ ResourceId()

    const TCollection_AsciiString & OpenGl_NamedResource::ResourceId ( ) const
    inline

    Return resource name.

    Field Documentation

    ◆ myResourceId

    TCollection_AsciiString OpenGl_NamedResource::myResourceId
    protected

    resource name


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