class Material

The FidelityFX Cauldron Framework material representation.

File location: framework/cauldron/framework/inc/render/material.h

Construction

Return type	Description
	Material () Construction.

Methods

Return type	Description
const TextureInfo *	GetTextureInfo (TextureClass tableEntry) const Returns the TextureInfo associated with a TextureClass in the material (if present).
bool	HasPBRMetalRough () const Returns true if the material has metal-rough data. A material can not be both metal-rough and spec-gloss simultaneously.
bool	HasPBRSpecGloss () const Returns true if the material has spec-gloss data. A material can not be both metal-rough and spec-gloss simultaneously.
bool	HasPBRInfo () const Returns true if the material has PBR information (high-level check).
bool	HasDoubleSided () const Returns true if the material represents double-sided geometry.
void	SetDoubleSided (bool flag) Set the double-sided state of a material.
Vec4	GetAlbedoColor () const Gets the material’s albedo color.
Vec4	GetEmissiveColor () const Gets the material’s emissive color.
Vec4	GetPBRInfo () const Gets the material’s PBR information. Values depend on if material is spec-gloss or metal-rough.
MaterialBlend	GetBlendMode () const Gets the material’s blend mode.
float	GetAlphaCutOff () const Gets the material’s alpha cutoff value.
void	InitFromGLTFData ( const json& materialData, const json& textureData, std::vector<bool>& textureSRGBMap, std::vector<SamplerDesc >& textureSamplers ) Initializes a material from loaded json glTF data.

Detailed description

The FidelityFX Cauldron Framework material representation.

Construction

Material

Copied!

Material ()

Construction.

Methods

GetTextureInfo

Copied!

const TextureInfo * GetTextureInfo (TextureClass  tableEntry) const

Returns the TextureInfo associated with a TextureClass in the material (if present).

HasPBRMetalRough

Copied!

bool HasPBRMetalRough () const

Returns true if the material has metal-rough data. A material can not be both metal-rough and spec-gloss simultaneously.

HasPBRSpecGloss

Copied!

bool HasPBRSpecGloss () const

Returns true if the material has spec-gloss data. A material can not be both metal-rough and spec-gloss simultaneously.

HasPBRInfo

Copied!

bool HasPBRInfo () const

Returns true if the material has PBR information (high-level check).

HasDoubleSided

Copied!

bool HasDoubleSided () const

Returns true if the material represents double-sided geometry.

SetDoubleSided

Copied!

void SetDoubleSided (bool flag)

Set the double-sided state of a material.

GetAlbedoColor

Copied!

Vec4  GetAlbedoColor () const

Gets the material’s albedo color.

GetEmissiveColor

Copied!

Vec4  GetEmissiveColor () const

Gets the material’s emissive color.

GetPBRInfo

Copied!

Vec4  GetPBRInfo () const

Gets the material’s PBR information. Values depend on if material is spec-gloss or metal-rough.

GetBlendMode

Copied!

MaterialBlend  GetBlendMode () const

Gets the material’s blend mode.

GetAlphaCutOff

Copied!

float GetAlphaCutOff () const

Gets the material’s alpha cutoff value.

InitFromGLTFData

Copied!

void InitFromGLTFData (
    const json& materialData,
    const json& textureData,
    std::vector<bool>& textureSRGBMap,
    std::vector<SamplerDesc >& textureSamplers
)