CesiumMetadataEncodingDetails.h File Reference

#include "CesiumMetadataValueType.h"
#include <cstdlib>
#include <type_traits>
#include "CesiumMetadataEncodingDetails.generated.h"

Go to the source code of this file.

Classes
struct	FCesiumMetadataEncodingDetails
	Describes how a property from EXT_structural_metadata will be encoded for access in Unreal materials. More...

Enumerations
enum class	ECesiumEncodedMetadataComponentType : uint8 { None , Uint8 , Float }
	The component type that a metadata property's values will be encoded as. More...
enum class	ECesiumEncodedMetadataType : uint8 {   None , Scalar , Vec2 , Vec3 ,   Vec4 }
	The type that a metadata property's values will be encoded as. More...
enum class	ECesiumEncodedMetadataConversion : uint8 { None , Coerce , ParseColorFromString }
	Indicates how a property value from EXT_structural_metadata should be converted to a GPU-accessible type, if possible. More...

Functions
ECesiumEncodedMetadataComponentType	CesiumMetadataComponentTypeToEncodingType (ECesiumMetadataComponentType Type)
	Gets the best-fitting encoded type for the given metadata component type.
ECesiumEncodedMetadataType	CesiumMetadataTypeToEncodingType (ECesiumMetadataType Type)
	Gets the best-fitting encoded type for the given metadata type.
size_t	CesiumGetEncodedMetadataTypeComponentCount (ECesiumEncodedMetadataType Type)
	Gets the number of components associated with the given encoded type.

Enumeration Type Documentation

ECesiumEncodedMetadataComponentType

enum class ECesiumEncodedMetadataComponentType : uint8

strong

The component type that a metadata property's values will be encoded as.

These correspond to the pixel component types that are supported in Unreal textures.

Enumerator
None
Uint8
Float

Definition at line 19 of file CesiumMetadataEncodingDetails.h.

ECesiumEncodedMetadataConversion

enum class ECesiumEncodedMetadataConversion : uint8

strong

Indicates how a property value from EXT_structural_metadata should be converted to a GPU-accessible type, if possible.

Enumerator
None	Do nothing. This is typically used for property types that are completely unable to be coerced.
Coerce	Coerce the components of a property value to the specified component type. If the property contains string values, this attempts to parse numbers from the strings as uint8s.
ParseColorFromString	Attempt to parse a color from a string property value. This supports the following formats: rgb(R, G, B), where R, G, and B are values in the range [0, 255] hexcode colors, e.g. #ff0000

Definition at line 58 of file CesiumMetadataEncodingDetails.h.

ECesiumEncodedMetadataType

enum class ECesiumEncodedMetadataType : uint8

strong

The type that a metadata property's values will be encoded as.

Enumerator
None
Scalar
Vec2
Vec3
Vec4

Definition at line 32 of file CesiumMetadataEncodingDetails.h.

Function Documentation

CesiumGetEncodedMetadataTypeComponentCount()

size_t CesiumGetEncodedMetadataTypeComponentCount

(

ECesiumEncodedMetadataType

Type

)

Gets the number of components associated with the given encoded type.

Parameters

type	The encoded metadata type.

CesiumMetadataComponentTypeToEncodingType()

ECesiumEncodedMetadataComponentType CesiumMetadataComponentTypeToEncodingType

(

ECesiumMetadataComponentType

Type

)

Gets the best-fitting encoded type for the given metadata component type.

CesiumMetadataTypeToEncodingType()

ECesiumEncodedMetadataType CesiumMetadataTypeToEncodingType

(

ECesiumMetadataType

Type

)

Gets the best-fitting encoded type for the given metadata type.