cesium-native 0.43.0
Loading...
Searching...
No Matches
CesiumGltf::Sampler Struct Referencefinal

Texture sampler properties for filtering and wrapping modes. More...

#include <CesiumGltf/Sampler.h>

Inheritance diagram for CesiumGltf::Sampler:
CesiumGltf::NamedObject CesiumUtility::ExtensibleObject

Classes

struct  MagFilter
 Known values for Magnification filter. More...
 
struct  MinFilter
 Known values for Minification filter. More...
 
struct  WrapS
 Known values for S (U) wrapping mode. More...
 
struct  WrapT
 Known values for T (V) wrapping mode. 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 JsonValuegetGenericExtension (const std::string &extensionName) const noexcept
 Gets a generic extension with the given name as a CesiumUtility::JsonValue.
 
JsonValuegetGenericExtension (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< int32_t > magFilter
 Magnification filter.
 
std::optional< int32_t > minFilter
 Minification filter.
 
int32_t wrapS = WrapS::REPEAT
 S (U) wrapping mode.
 
int32_t wrapT = WrapT::REPEAT
 T (V) wrapping mode.
 
- 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 = "Sampler"
 The original name of this type.
 

Detailed Description

Texture sampler properties for filtering and wrapping modes.

Definition at line 14 of file Sampler.h.

Member Function Documentation

◆ getSizeBytes()

int64_t CesiumGltf::Sampler::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 122 of file Sampler.h.

Member Data Documentation

◆ magFilter

std::optional<int32_t> CesiumGltf::Sampler::magFilter

Magnification filter.

Known values are defined in MagFilter.

Definition at line 88 of file Sampler.h.

◆ minFilter

std::optional<int32_t> CesiumGltf::Sampler::minFilter

Minification filter.

Known values are defined in MinFilter.

Definition at line 96 of file Sampler.h.

◆ TypeName

const char* CesiumGltf::Sampler::TypeName = "Sampler"
staticconstexpr

The original name of this type.

Definition at line 18 of file Sampler.h.

◆ wrapS

int32_t CesiumGltf::Sampler::wrapS = WrapS::REPEAT

S (U) wrapping mode.

Known values are defined in WrapS.

All valid values correspond to WebGL enums.

Definition at line 106 of file Sampler.h.

◆ wrapT

int32_t CesiumGltf::Sampler::wrapT = WrapT::REPEAT

T (V) wrapping mode.

Known values are defined in WrapT.

Definition at line 114 of file Sampler.h.


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