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

#include <CesiumGltf/BufferView.h>

Inheritance diagram for CesiumGltf::BufferView:

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

Public Member Functions
int64_t	getSizeBytes () const
	Calculates the size in bytes of this object, including the contents of all collections, pointers, and strings. This will NOT include the size of any extensions attached to the object. Calling this method may be slow as it requires traversing the object's entire structure.

Public Member Functions inherited from CesiumGltf::NamedObject
int64_t	getSizeBytes () const
	Calculates the size in bytes of this object, including the contents of all collections, pointers, and strings. Calling this method may be slow as it requires traversing the object's entire structure.

Public Member Functions inherited from CesiumUtility::ExtensibleObject
template<typename T >
bool	hasExtension () const noexcept
	Checks if an extension exists given its static type.

template<typename T >
const T *	getExtension () const noexcept
	Gets an extension given its static type.

template<typename T >
T *	getExtension () noexcept
	Gets an extension given its static type.

const JsonValue *	getGenericExtension (const std::string &extensionName) const noexcept
	Gets a generic extension with the given name as a `CesiumUtility::JsonValue`.

JsonValue *	getGenericExtension (const std::string &extensionName) noexcept
	Gets a generic extension with the given name as a `CesiumUtility::JsonValue`.

template<typename T , typename... ConstructorArgumentTypes>
T &	addExtension (ConstructorArgumentTypes &&... constructorArguments)
	Adds a statically-typed extension to this object.

template<typename T >
void	removeExtension ()
	Removes a statically-typed extension from this object.

int64_t	getSizeBytes () const
	Calculates the size in bytes of this ExtensibleObject, including all of its extras but NOT including its extensions. Calling this method may be slow as it requires traversing the entire object.

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.

std::optional< int32_t >	target
	The hint representing the intended GPU buffer type to use with this buffer view.

Public Attributes inherited from CesiumGltf::NamedObject
std::string	name
	The user-defined name of this object.

Public Attributes inherited from CesiumUtility::ExtensibleObject
std::unordered_map< std::string, std::any >	extensions
	The extensions attached to this object.

JsonValue::Object	extras
	Application-specific data.

JsonValue::Object	unknownProperties
	Unknown properties that exist on this object but do not have any representation in the statically-typed classes.

Static Public Attributes
static constexpr const char *	TypeName = "BufferView"
	The original name of this type.

Detailed Description

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

Definition at line 15 of file BufferView.h.

Member Function Documentation

◆ getSizeBytes()

int64_t CesiumGltf::BufferView::getSizeBytes ( ) const

inline

Calculates the size in bytes of this object, including the contents of all collections, pointers, and strings. This will NOT include the size of any extensions attached to the object. Calling this method may be slow as it requires traversing the object's entire structure.

Definition at line 72 of file BufferView.h.

Member Data Documentation

◆ buffer

int32_t CesiumGltf::BufferView::buffer = -1

The index of the buffer.

Definition at line 36 of file BufferView.h.

◆ byteLength

int64_t CesiumGltf::BufferView::byteLength = int64_t()

The length of the bufferView in bytes.

Definition at line 46 of file BufferView.h.

◆ byteOffset

int64_t CesiumGltf::BufferView::byteOffset = 0

The offset into the buffer in bytes.

Definition at line 41 of file BufferView.h.

◆ 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 55 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 64 of file BufferView.h.

◆ TypeName

const char* CesiumGltf::BufferView::TypeName = "BufferView"

staticconstexpr

The original name of this type.

Definition at line 19 of file BufferView.h.

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

/home/runner/work/cesium-native/cesium-native/CesiumGltf/generated/include/CesiumGltf/BufferView.h

Classes

Public Member Functions

Public Attributes

Static Public Attributes