Open CASCADE Technology 7.8.2.dev
OpenGl_ShadowMapArray Class Reference

Array of shadow maps. More...

#include <OpenGl_ShadowMap.hxx>

Inheritance diagram for OpenGl_ShadowMapArray:

Public Member Functions

 OpenGl_ShadowMapArray ()
 Empty constructor.
 
void Release (OpenGl_Context *theCtx)
 Releases all OpenGL resources.
 
bool IsValid () const
 Return TRUE if defined.
 
Standard_Size EstimatedDataSize () const
 Returns estimated GPU memory usage for holding data without considering overheads and allocation alignment rules.
 
- 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 ()
 Destructor must be virtual.
 
virtual const opencascade::handle< Standard_Type > & DynamicType () const
 Returns a type descriptor about this object.
 
Standard_Boolean IsInstance (const opencascade::handle< Standard_Type > &theType) const
 Returns a true value if this is an instance of Type.
 
Standard_Boolean IsInstance (const Standard_CString theTypeName) const
 Returns a true value if this is an instance of TypeName.
 
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.
 
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.
 
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.
 
Standard_Integer GetRefCount () const noexcept
 Get the reference counter of this object.
 
void IncrementRefCounter () noexcept
 Increments the reference counter of this object.
 
Standard_Integer DecrementRefCounter () noexcept
 Decrements the reference counter of this object; returns the decremented value.
 
virtual void Delete () const
 Memory deallocator for transient classes.
 
- Public Member Functions inherited from NCollection_Array1< Handle< OpenGl_ShadowMap > >
const_iterator begin () const
 
iterator begin ()
 
const_iterator cbegin () const
 
iterator end ()
 
const_iterator end () const
 
const_iterator cend () const
 
 NCollection_Array1 ()
 
 NCollection_Array1 (const Standard_Integer theLower, const Standard_Integer theUpper)
 
 NCollection_Array1 (const allocator_type &theAlloc, const Standard_Integer theLower, const Standard_Integer theUpper)
 
 NCollection_Array1 (const_reference theBegin, const Standard_Integer theLower, const Standard_Integer theUpper, const bool theUseBuffer=true)
 
 NCollection_Array1 (const NCollection_Array1 &theOther)
 Copy constructor.
 
 NCollection_Array1 (NCollection_Array1 &&theOther) noexcept
 Move constructor.
 
virtual ~NCollection_Array1 ()
 
void Init (const_reference theValue)
 Initialise the items with theValue.
 
Standard_Integer Size () const
 Size query.
 
Standard_Integer Length () const
 Length query (the same)
 
Standard_Boolean IsEmpty () const
 Return TRUE if array has zero length.
 
Standard_Integer Lower () const
 Lower bound.
 
Standard_Integer Upper () const
 Upper bound.
 
NCollection_Array1Assign (const NCollection_Array1 &theOther)
 Copies data of theOther array to this. This array should be pre-allocated and have the same length as theOther; otherwise exception Standard_DimensionMismatch is thrown.
 
NCollection_Array1Move (NCollection_Array1 &&theOther) noexcept
 Move assignment. This array will borrow all the data from theOther. The moved object will keep pointer to the memory buffer and range, but it will not free the buffer on destruction.
 
NCollection_Array1Move (NCollection_Array1 &theOther)
 
NCollection_Array1operator= (const NCollection_Array1 &theOther)
 Assignment operator;.
 
NCollection_Array1operator= (NCollection_Array1 &&theOther) noexcept
 Move assignment operator;.
 
const_reference First () const
 
reference ChangeFirst ()
 
const_reference Last () const
 
reference ChangeLast ()
 
const_reference Value (const Standard_Integer theIndex) const
 Constant value access.
 
const_reference operator() (const Standard_Integer theIndex) const
 operator() - alias to Value
 
reference operator() (const Standard_Integer theIndex)
 operator() - alias to ChangeValue
 
const_reference operator[] (const Standard_Integer theIndex) const
 operator[] - alias to Value
 
reference operator[] (const Standard_Integer theIndex)
 operator[] - alias to ChangeValue
 
reference ChangeValue (const Standard_Integer theIndex)
 Variable value access.
 
void SetValue (const Standard_Integer theIndex, const value_type &theItem)
 Set value.
 
void SetValue (const Standard_Integer theIndex, value_type &&theItem)
 Set value.
 
void UpdateLowerBound (const Standard_Integer theLower)
 Changes the lowest bound. Do not move data.
 
void UpdateUpperBound (const Standard_Integer theUpper)
 Changes the upper bound. Do not move data.
 
void Resize (const Standard_Integer theLower, const Standard_Integer theUpper, const Standard_Boolean theToCopyData)
 Resizes the array to specified bounds. No re-allocation will be done if length of array does not change, but existing values will not be discarded if theToCopyData set to FALSE.
 
bool IsDeletable () const
 

Additional Inherited Members

- Public Types inherited from Standard_Transient
typedef void base_type
 Returns a type descriptor about this object.
 
- Public Types inherited from NCollection_Array1< Handle< OpenGl_ShadowMap > >
typedef NCollection_Allocator< Handle< OpenGl_ShadowMap > > allocator_type
 Memory allocation.
 
using value_type
 
using size_type
 
using difference_type
 
using pointer
 
using const_pointer
 
using reference
 
using const_reference
 
using iterator
 
using const_iterator
 
using Iterator
 
- Static Public Member Functions inherited from Standard_Transient
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.
 
- Data Fields inherited from NCollection_Array1< Handle< OpenGl_ShadowMap > >
friend iterator
 
friend const_iterator
 
- Protected Member Functions inherited from NCollection_Array1< Handle< OpenGl_ShadowMap > >
const_reference at (const size_t theIndex) const
 
reference at (const size_t theIndex)
 
std::enable_if< std::is_arithmetic< U >::value, void >::type construct ()
 
std::enable_if<!std::is_arithmetic< U >::value, void >::type construct ()
 
std::enable_if< std::is_arithmetic< U >::value, void >::type construct (const size_t, const size_t)
 
std::enable_if<!std::is_arithmetic< U >::value, void >::type construct (const size_t theFrom, const size_t theTo)
 
std::enable_if< std::is_arithmetic< U >::value, void >::type destroy ()
 
std::enable_if<!std::is_arithmetic< U >::value, void >::type destroy ()
 
std::enable_if< std::is_arithmetic< U >::value, void >::type destroy (pointer, const size_t, const size_t)
 
std::enable_if<!std::is_arithmetic< U >::value, void >::type destroy (pointer theWhat, const size_t theFrom, const size_t theTo)
 
void copyConstruct (const pointer theFrom, const size_t theCount)
 
- Protected Attributes inherited from NCollection_Array1< Handle< OpenGl_ShadowMap > >
Standard_Integer myLowerBound
 
size_t mySize
 
pointer myPointer
 
bool myIsOwner
 
allocator_type myAllocator
 

Detailed Description

Array of shadow maps.

Constructor & Destructor Documentation

◆ OpenGl_ShadowMapArray()

OpenGl_ShadowMapArray::OpenGl_ShadowMapArray ( )
inline

Empty constructor.

Member Function Documentation

◆ EstimatedDataSize()

Standard_Size OpenGl_ShadowMapArray::EstimatedDataSize ( ) const

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

◆ IsValid()

bool OpenGl_ShadowMapArray::IsValid ( ) const
inline

Return TRUE if defined.

◆ Release()

void OpenGl_ShadowMapArray::Release ( OpenGl_Context * theCtx)

Releases all OpenGL resources.


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