Diligent Engine API Reference
Public Member Functions | Public Attributes | List of all members
Diligent::BufferViewDesc Struct Reference

Buffer view description. More...

Inheritance diagram for Diligent::BufferViewDesc:
Diligent::DeviceObjectAttribs

Public Member Functions

 BufferViewDesc ()
 Initializes the structure members with default values. More...
 
bool operator== (const BufferViewDesc &RHS) const
 Comparison operator tests if two structures are equivalent. More...
 
- Public Member Functions inherited from Diligent::DeviceObjectAttribs
 DeviceObjectAttribs ()
 Constructor intializes the structure members with default values.
 

Public Attributes

BUFFER_VIEW_TYPE ViewType
 View type. See Diligent::BUFFER_VIEW_TYPE for details.
 
Uint32 ByteOffset
 Offset in bytes from the beginnig of the buffer to the start of the buffer region referenced by the view.
 
Uint32 ByteWidth
 Size in bytes of the referenced buffer region.
 
- Public Attributes inherited from Diligent::DeviceObjectAttribs
const Char * Name
 Object name.
 

Detailed Description

Buffer view description.

Constructor & Destructor Documentation

◆ BufferViewDesc()

Diligent::BufferViewDesc::BufferViewDesc ( )
inline

Initializes the structure members with default values.

Default values:

Member Default value
ViewType Diligent::BUFFER_VIEW_UNDEFINED
ByteOffset 0
ByteWidth 0

Member Function Documentation

◆ operator==()

bool Diligent::BufferViewDesc::operator== ( const BufferViewDesc RHS) const
inline

Comparison operator tests if two structures are equivalent.

Parameters
[in]RHS- reference to the structure to perform comparison with
Returns
  • True if all members of the two structures are equal.
  • False otherwise
Remarks
The operator ignores DeviceObjectAttribs::Name field.