CesiumGltf::Image Struct Reference

This class is not meant to be instantiated directly. Use Image instead. More...

#include <CesiumGltf/Image.h>

Inheritance diagram for CesiumGltf::Image:

Public Attributes
CesiumUtility::IntrusivePointer< ImageAsset >	pAsset
	The loaded image asset. When an image is loaded from a URL, multiple Image instances may all point to the same ImageAsset instance.
Public Attributes inherited from CesiumGltf::ImageSpec
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.

Additional Inherited Members
Public Member Functions inherited from CesiumGltf::ImageSpec
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.
Static Public Attributes inherited from CesiumGltf::ImageSpec
static constexpr const char *	TypeName = "Image"
	The original name of this type.
Protected Member Functions inherited from CesiumGltf::ImageSpec
	ImageSpec ()=default
	This class is not meant to be instantiated directly. Use Image instead.

Detailed Description

This class is not meant to be instantiated directly. Use Image instead.

Definition at line 10 of file Image.h.

Member Data Documentation

pAsset

CesiumUtility::IntrusivePointer<ImageAsset> CesiumGltf::Image::pAsset

The loaded image asset. When an image is loaded from a URL, multiple Image instances may all point to the same ImageAsset instance.

Definition at line 17 of file Image.h.

---

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

• /home/runner/work/cesium-native/cesium-native/CesiumGltf/include/CesiumGltf/Image.h