Buffer of vertex attributes. More...

#include <Graphic3d_Buffer.hxx>

Inheritance diagram for Graphic3d_Buffer:

[legend]

Public Member Functions
	Graphic3d_Buffer (const occ::handle< NCollection_BaseAllocator > &theAlloc)
	Empty constructor.

int	NbMaxElements () const
	Return number of initially allocated elements which can fit into this buffer, while NbElements can be overwritten to smaller value.

const Graphic3d_Attribute *	AttributesArray () const

const Graphic3d_Attribute &	Attribute (const int theAttribIndex) const

Graphic3d_Attribute &	ChangeAttribute (const int theAttribIndex)

int	FindAttribute (Graphic3d_TypeOfAttribute theAttrib) const
	Find attribute index.

data accessors for interleaved array
int	AttributeOffset (const int theAttribIndex) const

const uint8_t *	Data (const int theAttribIndex) const

uint8_t *	ChangeData (const int theAttribIndex)

const uint8_t *	value (const int theElem) const
	Access specified element.

uint8_t *	changeValue (const int theElem)
	Access specified element.

template<typename Type_t >
const Type_t &	Value (const int theElem) const
	Access element with specified position and type.

template<typename Type_t >
Type_t &	ChangeValue (const int theElem)
	Access element with specified position and type.

Public Member Functions inherited from NCollection_Buffer
	NCollection_Buffer (const occ::handle< NCollection_BaseAllocator > &theAlloc, const size_t theSize=0, uint8_t *theData=nullptr)
	Default constructor. When theData is NULL but theSize is not 0 than buffer of specified size will be allocated.

	~NCollection_Buffer () override
	Destructor.

const uint8_t *	Data () const noexcept

uint8_t *	ChangeData () noexcept

bool	IsEmpty () const noexcept

size_t	Size () const noexcept
	Return buffer length in bytes.

const occ::handle< NCollection_BaseAllocator > &	Allocator () const noexcept

void	SetAllocator (const occ::handle< NCollection_BaseAllocator > &theAlloc)
	Assign new buffer allocator with de-allocation of buffer.

bool	Allocate (const size_t theSize)
	Allocate the buffer.

void	Free ()
	De-allocate buffer.

Public Member Functions inherited from Standard_Transient
	Standard_Transient ()
	Empty constructor.

	Standard_Transient (const Standard_Transient &)
	Copy constructor – does nothing.

Standard_Transient &	operator= (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_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.

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.

Static Public Member Functions
static const occ::handle< NCollection_BaseAllocator > &	DefaultAllocator ()
	Return default vertex data allocator.

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.

general accessors
int	Stride
	the distance to the attributes of the next vertex within interleaved array

int	NbElements
	number of the elements (

int	NbAttributes
	number of vertex attributes

uint8_t *	ChangeAttributeData (Graphic3d_TypeOfAttribute theAttrib, int &theAttribIndex, size_t &theAttribStride)
	Return the attribute data with stride size specific to this attribute.

const uint8_t *	AttributeData (Graphic3d_TypeOfAttribute theAttrib, int &theAttribIndex, size_t &theAttribStride) const
	Return the attribute data with stride size specific to this attribute.

void	release ()
	Release buffer.

bool	Init (const int theNbElems, const Graphic3d_Attribute *theAttribs, const int theNbAttribs)
	Allocates new empty array.

bool	Init (const int theNbElems, const NCollection_Array1< Graphic3d_Attribute > &theAttribs)
	Allocates new empty array.

virtual bool	IsInterleaved () const
	Flag indicating that attributes in the buffer are interleaved; TRUE by default. Requires sub-classing for creating a non-interleaved buffer (advanced usage).

virtual bool	IsMutable () const
	Return TRUE if data can be invalidated; FALSE by default. Requires sub-classing for creating a mutable buffer (advanced usage).

virtual Graphic3d_BufferRange	InvalidatedRange () const
	Return invalidated range; EMPTY by default. Requires sub-classing for creating a mutable buffer (advanced usage).

virtual void	Validate ()
	Reset invalidated range. Requires sub-classing for creating a mutable buffer (advanced usage).

virtual void	Invalidate ()
	Invalidate entire buffer.

void	DumpJson (Standard_OStream &theOStream, int theDepth=-1) const override
	Dumps the content of me into the stream.

uint8_t *	ChangeData () noexcept

const uint8_t *	Data () const noexcept

Additional Inherited Members
Public Types inherited from Standard_Transient
typedef void	base_type
	Returns a type descriptor about this object.

Protected Attributes inherited from NCollection_Buffer
uint8_t *	myData
	data pointer

size_t	mySize
	buffer length in bytes

occ::handle< NCollection_BaseAllocator >	myAllocator
	buffer allocator

Detailed Description

Buffer of vertex attributes.

Constructor & Destructor Documentation

◆ Graphic3d_Buffer()

Graphic3d_Buffer::Graphic3d_Buffer ( const occ::handle< NCollection_BaseAllocator > & theAlloc )

inline

Empty constructor.

Member Function Documentation

◆ Attribute()

const Graphic3d_Attribute & Graphic3d_Buffer::Attribute ( const int theAttribIndex ) const

inline

Returns: attribute definition

◆ AttributeData()

const uint8_t * Graphic3d_Buffer::AttributeData	(	Graphic3d_TypeOfAttribute	theAttrib,
		int &	theAttribIndex,
		size_t &	theAttribStride ) const

inline

Return the attribute data with stride size specific to this attribute.

Parameters

theAttrib	attribute to find
theAttribIndex	index of found attribute
theAttribStride	stride in bytes between values of this attribute within returned data pointer

◆ AttributeOffset()

int Graphic3d_Buffer::AttributeOffset ( const int theAttribIndex ) const

inline

Returns: data offset to specified attribute

◆ AttributesArray()

const Graphic3d_Attribute * Graphic3d_Buffer::AttributesArray ( ) const

inline

Returns: array of attributes definitions

◆ ChangeAttribute()

Graphic3d_Attribute & Graphic3d_Buffer::ChangeAttribute ( const int theAttribIndex )

inline

Returns: attribute definition

◆ ChangeAttributeData()

uint8_t * Graphic3d_Buffer::ChangeAttributeData	(	Graphic3d_TypeOfAttribute	theAttrib,
		int &	theAttribIndex,
		size_t &	theAttribStride )

inline

Return the attribute data with stride size specific to this attribute.

Parameters

theAttrib	attribute to find
theAttribIndex	index of found attribute
theAttribStride	stride in bytes between values of this attribute within returned data pointer

◆ ChangeData() [1/2]

uint8_t * NCollection_Buffer::ChangeData ( )

inlinenoexcept

Returns: buffer data

◆ ChangeData() [2/2]

uint8_t * Graphic3d_Buffer::ChangeData ( const int theAttribIndex )

inline

Returns: data for specified attribute

◆ changeValue()

uint8_t * Graphic3d_Buffer::changeValue ( const int theElem )

inline

Access specified element.

◆ ChangeValue()

template<typename Type_t >

Type_t & Graphic3d_Buffer::ChangeValue ( const int theElem )

inline

Access element with specified position and type.

◆ Data() [1/2]

const uint8_t * NCollection_Buffer::Data ( ) const

inlinenoexcept

Returns: buffer data

◆ Data() [2/2]

const uint8_t * Graphic3d_Buffer::Data ( const int theAttribIndex ) const

inline

Returns: data for specified attribute

◆ DefaultAllocator()

static const occ::handle< NCollection_BaseAllocator > & Graphic3d_Buffer::DefaultAllocator ( )

static

Return default vertex data allocator.

◆ DumpJson()

void Graphic3d_Buffer::DumpJson	(	Standard_OStream &	theOStream,
		int	theDepth = -1 ) const

overridevirtual

Dumps the content of me into the stream.

Reimplemented from NCollection_Buffer.

Reimplemented in Graphic3d_IndexBuffer.

◆ FindAttribute()

int Graphic3d_Buffer::FindAttribute ( Graphic3d_TypeOfAttribute theAttrib ) const

inline

Find attribute index.

Parameters

theAttrib attribute to find

Returns: attribute index or -1 if not found

◆ Init() [1/2]

bool Graphic3d_Buffer::Init	(	const int	theNbElems,
		const Graphic3d_Attribute *	theAttribs,
		const int	theNbAttribs )

inline

Allocates new empty array.

◆ Init() [2/2]

bool Graphic3d_Buffer::Init	(	const int	theNbElems,
		const NCollection_Array1< Graphic3d_Attribute > &	theAttribs )

inline

Allocates new empty array.

◆ Invalidate()

virtual void Graphic3d_Buffer::Invalidate ( )

inlinevirtual

Invalidate entire buffer.

Reimplemented in Graphic3d_AttribBuffer, and Graphic3d_MutableIndexBuffer.

◆ InvalidatedRange()

virtual Graphic3d_BufferRange Graphic3d_Buffer::InvalidatedRange ( ) const

inlinevirtual

Return invalidated range; EMPTY by default. Requires sub-classing for creating a mutable buffer (advanced usage).

Reimplemented in Graphic3d_AttribBuffer, and Graphic3d_MutableIndexBuffer.

◆ IsInterleaved()

virtual bool Graphic3d_Buffer::IsInterleaved ( ) const

inlinevirtual

Flag indicating that attributes in the buffer are interleaved; TRUE by default. Requires sub-classing for creating a non-interleaved buffer (advanced usage).

Reimplemented in Graphic3d_AttribBuffer.

◆ IsMutable()

virtual bool Graphic3d_Buffer::IsMutable ( ) const

inlinevirtual

Return TRUE if data can be invalidated; FALSE by default. Requires sub-classing for creating a mutable buffer (advanced usage).

Reimplemented in Graphic3d_AttribBuffer, and Graphic3d_MutableIndexBuffer.

◆ NbMaxElements()

int Graphic3d_Buffer::NbMaxElements ( ) const

inline

Return number of initially allocated elements which can fit into this buffer, while NbElements can be overwritten to smaller value.

◆ release()

void Graphic3d_Buffer::release ( )

inline

Release buffer.

◆ Validate()

virtual void Graphic3d_Buffer::Validate ( )

inlinevirtual

Reset invalidated range. Requires sub-classing for creating a mutable buffer (advanced usage).

Reimplemented in Graphic3d_AttribBuffer, and Graphic3d_MutableIndexBuffer.

◆ value()

const uint8_t * Graphic3d_Buffer::value ( const int theElem ) const

inline

Access specified element.

◆ Value()

template<typename Type_t >

const Type_t & Graphic3d_Buffer::Value ( const int theElem ) const

inline

Access element with specified position and type.

Field Documentation

◆ NbAttributes

int Graphic3d_Buffer::NbAttributes

number of vertex attributes

◆ NbElements

int Graphic3d_Buffer::NbElements

number of the elements (

See also: NbMaxElements() specifying the number of initially allocated number of elements)

◆ Stride

int Graphic3d_Buffer::Stride

the distance to the attributes of the next vertex within interleaved array

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

Graphic3d_Buffer.hxx

Public Member Functions

Static Public Member Functions

general accessors

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ Graphic3d_Buffer()

Member Function Documentation

◆ Attribute()

◆ AttributeData()

◆ AttributeOffset()

◆ AttributesArray()

◆ ChangeAttribute()

◆ ChangeAttributeData()

◆ ChangeData() [1/2]

◆ ChangeData() [2/2]

◆ changeValue()

◆ ChangeValue()

◆ Data() [1/2]

◆ Data() [2/2]

◆ DefaultAllocator()

◆ DumpJson()

◆ FindAttribute()

◆ Init() [1/2]

◆ Init() [2/2]

◆ Invalidate()

◆ InvalidatedRange()

◆ IsInterleaved()

◆ IsMutable()

◆ NbMaxElements()

◆ release()

◆ Validate()

◆ value()

◆ Value()

Field Documentation

◆ NbAttributes

◆ NbElements

◆ Stride