A buffer points to binary geometry, animation, or skins. More...

#include <CesiumGltf/BufferSpec.h>

Inheritance diagram for CesiumGltf::BufferSpec:

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	chunk = -1
	The index of the chunk that contains the buffer data.

std::optional< std::string >	uri
	The URI (or IRI) of the buffer.

int64_t	byteLength = int64_t()
	The length of the buffer in bytes.

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 = "Buffer"
	The original name of this type.

Protected Member Functions
	BufferSpec ()=default
	This class is not meant to be instantiated directly. Use Buffer instead.

Friends
struct	Buffer

Detailed Description

A buffer points to binary geometry, animation, or skins.

Definition at line 16 of file BufferSpec.h.

Member Function Documentation

◆ getSizeBytes()

int64_t CesiumGltf::BufferSpec::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 50 of file BufferSpec.h.

Friends And Related Symbol Documentation

◆ Buffer

friend struct Buffer

friend

Definition at line 67 of file BufferSpec.h.

Member Data Documentation

◆ byteLength

int64_t CesiumGltf::BufferSpec::byteLength = int64_t()

The length of the buffer in bytes.

Definition at line 42 of file BufferSpec.h.

◆ chunk

int32_t CesiumGltf::BufferSpec::chunk = -1

The index of the chunk that contains the buffer data.

If neither chunk nor uri is defined on buffer 0, then buffer 0 implicitly refers to chunk 1. There is no default chunk index for other buffers.

Definition at line 29 of file BufferSpec.h.

◆ TypeName

const char* CesiumGltf::BufferSpec::TypeName = "Buffer"

staticconstexpr

The original name of this type.

Definition at line 20 of file BufferSpec.h.

◆ uri

std::optional<std::string> CesiumGltf::BufferSpec::uri

The URI (or IRI) of the buffer.

Relative paths are relative to the current glTF asset. Instead of referencing an external file, this field MAY contain a data:-URI.

Definition at line 37 of file BufferSpec.h.

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

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

Public Member Functions

Public Attributes

Static Public Attributes

Protected Member Functions

Friends