Diligent Engine
 
Loading...
Searching...
No Matches
Diligent::BufferViewDesc Struct Reference

Buffer view description. More...

#include <BufferView.h>

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

Public Member Functions

constexpr bool operator== (const BufferViewDesc &RHS) const
 Tests if two buffer view descriptions are equal.
 

Public Attributes

BUFFER_VIEW_TYPE ViewType = BUFFER_VIEW_UNDEFINED
 View type. See Diligent::BUFFER_VIEW_TYPE for details.
 
struct BufferFormat Format
 
Uint64 ByteOffset = 0
 
Uint64 ByteWidth = 0
 Size in bytes of the referenced buffer region.
 
- Public Attributes inherited from Diligent::DeviceObjectAttribs
const Char * Name = nullptr
 Object name.
 

Detailed Description

Buffer view description.

Member Function Documentation

◆ operator==()

bool Diligent::BufferViewDesc::operator== ( const BufferViewDesc & RHS) const
inlineconstexpr

Tests if two buffer view descriptions are equal.

Parameters
[in]RHS- reference to the structure to compare with.
Returns
true if all members of the two structures except for the Name are equal, and false otherwise.
Note
The operator ignores the Name field as it is used for debug purposes and doesn't affect the buffer view properties.

Member Data Documentation

◆ ByteOffset

Uint64 Diligent::BufferViewDesc::ByteOffset = 0

Offset in bytes from the beginning of the buffer to the start of the buffer region referenced by the view.

◆ Format

struct BufferFormat Diligent::BufferViewDesc::Format

Format of the view. This member is only used for formatted and raw buffers. To create raw view of a raw buffer, set Format.ValueType member to VT_UNDEFINED (default value).