Array of shadow maps. More...
#include <OpenGl_ShadowMap.hxx>
Inheritance diagram for OpenGl_ShadowMapArray:
Public Member Functions | |
| OpenGl_ShadowMapArray () | |
| Empty constructor. More... | |
| void | Release (OpenGl_Context *theCtx) |
| Releases all OpenGL resources. More... | |
| bool | IsValid () const |
| Return TRUE if defined. More... | |
| Standard_Size | EstimatedDataSize () const |
| Returns estimated GPU memory usage for holding data without considering overheads and allocation alignment rules. 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... | |
| Public Member Functions inherited from NCollection_Array1< Handle< OpenGl_ShadowMap > > | |
| iterator | begin () const |
| Returns an iterator pointing to the first element in the array. More... | |
| iterator | end () const |
| Returns an iterator referring to the past-the-end element in the array. More... | |
| const_iterator | cbegin () const |
| Returns a const iterator pointing to the first element in the array. More... | |
| const_iterator | cend () const |
| Returns a const iterator referring to the past-the-end element in the array. More... | |
| NCollection_Array1 () | |
| Empty constructor; should be used with caution. More... | |
| NCollection_Array1 (const Standard_Integer theLower, const Standard_Integer theUpper) | |
| Constructor. More... | |
| NCollection_Array1 (const NCollection_Array1 &theOther) | |
| Copy constructor. More... | |
| NCollection_Array1 (NCollection_Array1 &&theOther) | |
| Move constructor. More... | |
| NCollection_Array1 (const Handle< OpenGl_ShadowMap > &theBegin, const Standard_Integer theLower, const Standard_Integer theUpper) | |
| C array-based constructor. More... | |
| void | Init (const Handle< OpenGl_ShadowMap > &theValue) |
| Initialise the items with theValue. More... | |
| Standard_Integer | Size (void) const |
| Size query. More... | |
| Standard_Integer | Length (void) const |
| Length query (the same) More... | |
| Standard_Boolean | IsEmpty () const |
| Return TRUE if array has zero length. More... | |
| Standard_Integer | Lower (void) const |
| Lower bound. More... | |
| Standard_Integer | Upper (void) const |
| Upper bound. More... | |
| Standard_Boolean | IsDeletable (void) const |
| myDeletable flag More... | |
| Standard_Boolean | IsAllocated (void) const |
| IsAllocated flag - for naming compatibility. More... | |
| NCollection_Array1 & | Assign (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. More... | |
| NCollection_Array1 & | Move (NCollection_Array1 &theOther) |
| 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. More... | |
| NCollection_Array1 & | operator= (const NCollection_Array1 &theOther) |
| Assignment operator;. More... | |
| NCollection_Array1 & | operator= (NCollection_Array1 &&theOther) |
| Move assignment operator;. More... | |
| const Handle< OpenGl_ShadowMap > & | First () const |
| Handle< OpenGl_ShadowMap > & | ChangeFirst () |
| const Handle< OpenGl_ShadowMap > & | Last () const |
| Handle< OpenGl_ShadowMap > & | ChangeLast () |
| const Handle< OpenGl_ShadowMap > & | Value (const Standard_Integer theIndex) const |
| Constant value access. More... | |
| const Handle< OpenGl_ShadowMap > & | operator() (const Standard_Integer theIndex) const |
| operator() - alias to Value More... | |
| Handle< OpenGl_ShadowMap > & | operator() (const Standard_Integer theIndex) |
| operator() - alias to ChangeValue More... | |
| const Handle< OpenGl_ShadowMap > & | operator[] (Standard_Integer theIndex) const |
| operator[] - alias to Value More... | |
| Handle< OpenGl_ShadowMap > & | operator[] (Standard_Integer theIndex) |
| operator[] - alias to ChangeValue More... | |
| Handle< OpenGl_ShadowMap > & | ChangeValue (const Standard_Integer theIndex) |
| Variable value access. More... | |
| void | SetValue (const Standard_Integer theIndex, const Handle< OpenGl_ShadowMap > &theItem) |
| Set value. More... | |
| 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. More... | |
| ~NCollection_Array1 (void) | |
| Destructor - releases the memory. More... | |
Additional Inherited Members | |
| Public Types inherited from Standard_Transient | |
| typedef void | base_type |
| Returns a type descriptor about this object. More... | |
| Public Types inherited from NCollection_Array1< Handle< OpenGl_ShadowMap > > | |
| typedef Handle< OpenGl_ShadowMap > | value_type |
| STL-compliant typedef for value type. More... | |
| typedef NCollection_StlIterator< std::random_access_iterator_tag, Iterator, Handle< OpenGl_ShadowMap >, false > | iterator |
| Shorthand for a regular iterator type. More... | |
| typedef NCollection_StlIterator< std::random_access_iterator_tag, Iterator, Handle< OpenGl_ShadowMap >, true > | const_iterator |
| Shorthand for a constant iterator type. 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... | |
| Protected Attributes inherited from NCollection_Array1< Handle< OpenGl_ShadowMap > > | |
| Standard_Integer | myLowerBound |
| Standard_Integer | myUpperBound |
| Standard_Boolean | myDeletable |
| Flag showing who allocated the array. More... | |
| Handle< OpenGl_ShadowMap > * | myData |
| Pointer to '0'th array item. More... | |
Detailed Description
Array of shadow maps.
Constructor & Destructor Documentation
◆ 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()
|
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:
