public

Inheritance Graph

graph BT
	AttributeFormat
	click AttributeFormat "classUtil_1_1AttributeFormat"

Description

AttributeFormat

Public Functions

   
   
  AttributeFormat()
   
  AttributeFormat(const StringIdentifier & _nameId, TypeConstant _dataType, uint32_t _components, bool _normalized, uint32_t _internalType, size_t _offset)
   
bool operator==(const AttributeFormat & other) const
   
bool operator!=(const AttributeFormat & other) const
   
bool operator<(const AttributeFormat & other) const
   
std::string getName() const
Returns the name of the attribute.
   
StringIdentifier getNameId() const
Returns the name of the attribute as a [StringIdentifier](classUtil_1_1StringIdentifier) .
   
TypeConstant getDataType() const
Returns the base type of each component.
   
size_t getDataSize() const
Returns the size (in bytes) of the entire attribute.
   
uint32_t getComponentCount() const
Returns the number of components of the attribute.
   
bool isNormalized() const
Specifies if the underlying type is automatically converted to/from float value in the range [-1.0,1.0] or [0.0,1.0].
   
uint32_t getInternalType() const
Returns the user defined internal type id of the attribute (e.g., for compressed data).
   
size_t getOffset() const
Returns the byte offset of the attribute within a [ResourceFormat](classUtil_1_1ResourceFormat) .
   
bool isValid() const
Returnstrue, if the attribute has at least one value.
   
std::string toString() const
Returns a string representation of this attribute.
   
TypeConstant getValueType() const
deprecated alias
   
uint16_t getBytesPerPixel() const
deprecated alias
   
uint32_t getNumValues() const
deprecated alias
   
uint32_t getNumComponents() const
deprecated alias
   
bool empty() const
deprecated alias

Documentation

function
Util::AttributeFormat::AttributeFormat

public
   
   
AttributeFormat( )

Defined in Util/Resources/AttributeFormat.h:28


function
Util::AttributeFormat::AttributeFormat

public
     
     
AttributeFormat( const StringIdentifier & _nameId,
  TypeConstant _dataType,
  uint32_t _components,
  bool _normalized,
  uint32_t _internalType,
  size_t _offset
)    

Defined in Util/Resources/AttributeFormat.h:29


function
Util::AttributeFormat::operator==

public const
     
     
bool operator==( const AttributeFormat & other ) const

Defined in Util/Resources/AttributeFormat.h:31


function
Util::AttributeFormat::operator!=

public const inline
     
     
bool operator!=( const AttributeFormat & other ) const

Defined in Util/Resources/AttributeFormat.h:32


function
Util::AttributeFormat::operator<

public const
     
     
bool operator<( const AttributeFormat & other ) const

Defined in Util/Resources/AttributeFormat.h:33


function
Util::AttributeFormat::getName

public const inline
   
   
std::string getName( ) const

Returns the name of the attribute.

Defined in Util/Resources/AttributeFormat.h:36


function
Util::AttributeFormat::getNameId

public const inline
   
   
StringIdentifier getNameId( ) const

Returns the name of the attribute as a [StringIdentifier](classUtil_1_1StringIdentifier) .

Defined in Util/Resources/AttributeFormat.h:38


function
Util::AttributeFormat::getDataType

public const inline
   
   
TypeConstant getDataType( ) const

Returns the base type of each component.

Defined in Util/Resources/AttributeFormat.h:40


function
Util::AttributeFormat::getDataSize

public const inline
   
   
size_t getDataSize( ) const

Returns the size (in bytes) of the entire attribute.

Defined in Util/Resources/AttributeFormat.h:42


function
Util::AttributeFormat::getComponentCount

public const inline
   
   
uint32_t getComponentCount( ) const

Returns the number of components of the attribute.

Defined in Util/Resources/AttributeFormat.h:44


function
Util::AttributeFormat::isNormalized

public const inline
   
   
bool isNormalized( ) const

Specifies if the underlying type is automatically converted to/from float value in the range [-1.0,1.0] or [0.0,1.0].

Defined in Util/Resources/AttributeFormat.h:46


function
Util::AttributeFormat::getInternalType

public const inline
   
   
uint32_t getInternalType( ) const

Returns the user defined internal type id of the attribute (e.g., for compressed data).

Defined in Util/Resources/AttributeFormat.h:48


function
Util::AttributeFormat::getOffset

public const inline
   
   
size_t getOffset( ) const

Returns the byte offset of the attribute within a [ResourceFormat](classUtil_1_1ResourceFormat) .

Defined in Util/Resources/AttributeFormat.h:50


function
Util::AttributeFormat::isValid

public const inline
   
   
bool isValid( ) const

Returnstrue, if the attribute has at least one value.

Defined in Util/Resources/AttributeFormat.h:53


function
Util::AttributeFormat::toString

public const
   
   
std::string toString( ) const

Returns a string representation of this attribute.

Defined in Util/Resources/AttributeFormat.h:55


function
Util::AttributeFormat::getValueType

public const inline
   
   
TypeConstant getValueType( ) const

deprecated alias

Defined in Util/Resources/AttributeFormat.h:58


function
Util::AttributeFormat::getBytesPerPixel

public const inline
   
   
uint16_t getBytesPerPixel( ) const

deprecated alias

Defined in Util/Resources/AttributeFormat.h:60


function
Util::AttributeFormat::getNumValues

public const inline
   
   
uint32_t getNumValues( ) const

deprecated alias

Defined in Util/Resources/AttributeFormat.h:62


function
Util::AttributeFormat::getNumComponents

public const inline
   
   
uint32_t getNumComponents( ) const

deprecated alias

Defined in Util/Resources/AttributeFormat.h:64


function
Util::AttributeFormat::empty

public const inline
   
   
bool empty( ) const

deprecated alias

Defined in Util/Resources/AttributeFormat.h:66