cesium-native  0.41.0
CesiumGltf::BufferView Struct Referencefinal

A view into a buffer generally representing a subset of the buffer. More...

#include <CesiumGltf/BufferView.h>

Inheritance diagram for CesiumGltf::BufferView:
CesiumGltf::NamedObject CesiumUtility::ExtensibleObject

Classes

struct  Target
 Known values for The hint representing the intended GPU buffer type to use with this buffer view. More...
 

Public Attributes

int32_t buffer = -1
 The index of the buffer.
 
int64_t byteOffset = 0
 The offset into the buffer in bytes.
 
int64_t byteLength = int64_t()
 The length of the bufferView in bytes.
 
std::optional< int64_t > byteStride
 The stride, in bytes. More...
 
std::optional< int32_t > target
 The hint representing the intended GPU buffer type to use with this buffer view. More...
 
- Public Attributes inherited from CesiumGltf::NamedObject
std::string name
 The user-defined name of this object. More...
 
- Public Attributes inherited from CesiumUtility::ExtensibleObject
std::unordered_map< std::string, std::any > extensions
 The extensions attached to this object. More...
 
JsonValue::Object extras
 Application-specific data. More...
 
JsonValue::Object unknownProperties
 Unknown properties that exist on this object but do not have any representation in the statically-typed classes. More...
 

Static Public Attributes

static constexpr const char * TypeName = "BufferView"
 

Additional Inherited Members

- Public Member Functions inherited from CesiumUtility::ExtensibleObject
template<typename T >
bool hasExtension () const noexcept
 Checks if an extension exists given its static type. More...
 
template<typename T >
const T * getExtension () const noexcept
 Gets an extension given its static type. More...
 
template<typename T >
T * getExtension () noexcept
 Gets an extension given its static type. More...
 
const JsonValuegetGenericExtension (const std::string &extensionName) const noexcept
 Gets a generic extension with the given name as a CesiumUtility::JsonValue. More...
 
JsonValuegetGenericExtension (const std::string &extensionName) noexcept
 Gets a generic extension with the given name as a CesiumUtility::JsonValue. More...
 
template<typename T , typename... ConstructorArgumentTypes>
T & addExtension (ConstructorArgumentTypes &&... constructorArguments)
 Adds a statically-typed extension to this object. More...
 
template<typename T >
void removeExtension ()
 Removes a statically-typed extension from this object. More...
 

Detailed Description

A view into a buffer generally representing a subset of the buffer.

Definition at line 15 of file BufferView.h.

Member Data Documentation

◆ byteStride

std::optional<int64_t> CesiumGltf::BufferView::byteStride

The stride, in bytes.

The stride, in bytes, between vertex attributes. When this is not defined, data is tightly packed. When two or more accessors use the same buffer view, this field MUST be defined.

Definition at line 50 of file BufferView.h.

◆ target

std::optional<int32_t> CesiumGltf::BufferView::target

The hint representing the intended GPU buffer type to use with this buffer view.

Known values are defined in Target.

Definition at line 59 of file BufferView.h.


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