cesium-native  0.41.0
CesiumGltf::ImageSpec Struct Reference

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:
CesiumGltf::NamedObject CesiumUtility::ExtensibleObject CesiumGltf::Image

Classes

struct  MimeType
 Known values for The image's media type. This field MUST be defined when bufferView is defined. More...
 

Public Attributes

std::optional< std::string > uri
 The URI (or IRI) of the image. More...
 
std::optional< std::string > mimeType
 The image's media type. This field MUST be defined when bufferView is defined. More...
 
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. 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 = "Image"
 

Friends

struct Image
 

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

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 Data Documentation

◆ 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 46 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 37 of file ImageSpec.h.


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