Image data used to create a texture. Image MAY be referenced by an URI (or IRI) or a buffer view index. More...

#include <CesiumGltf/ImageSpec.h>

Inheritance diagram for CesiumGltf::ImageSpec:

Classes
struct	MimeType
	Known values for The image's media type. This field MUST be defined when `bufferView` is defined. 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
std::optional< std::string >	uri
	The URI (or IRI) of the image.

std::optional< std::string >	mimeType
	The image's media type. This field MUST be defined when `bufferView` is defined.

int32_t	bufferView = -1
	The index of the bufferView that contains the image. This field MUST NOT be defined when `uri` is defined.

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

Protected Member Functions
	ImageSpec ()=default
	This class is not meant to be instantiated directly. Use `Image` instead.

Friends
struct	Image

Detailed Description

Image data used to create a texture. Image MAY be referenced by an URI (or IRI) or a buffer view index.

Definition at line 17 of file ImageSpec.h.

Member Function Documentation

◆ getSizeBytes()

int64_t CesiumGltf::ImageSpec::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 65 of file ImageSpec.h.

Friends And Related Symbol Documentation

◆ Image

friend struct Image

friend

Definition at line 81 of file ImageSpec.h.

Member Data Documentation

◆ bufferView

int32_t CesiumGltf::ImageSpec::bufferView = -1

The index of the bufferView that contains the image. This field MUST NOT be defined when uri is defined.

Definition at line 57 of file ImageSpec.h.

◆ mimeType

std::optional<std::string> CesiumGltf::ImageSpec::mimeType

The image's media type. This field MUST be defined when bufferView is defined.

Known values are defined in MimeType.

Definition at line 51 of file ImageSpec.h.

◆ TypeName

const char* CesiumGltf::ImageSpec::TypeName = "Image"

staticconstexpr

The original name of this type.

Definition at line 21 of file ImageSpec.h.

◆ uri

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

The URI (or IRI) of the image.

Relative paths are relative to the current glTF asset. Instead of referencing an external file, this field MAY contain a data:-URI. This field MUST NOT be defined when bufferView is defined.

Definition at line 42 of file ImageSpec.h.

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

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

Classes

Public Member Functions

Public Attributes

Static Public Attributes

Protected Member Functions

Friends