Class ShaderFunctionMeta

Shader function metadata

ShaderFunctionMeta
Assembly: FlaxEngine.dll
File: Engine/ShadersCompilation/Parser/ShaderMeta.h
Syntax
public class ShaderFunctionMeta

Constructors

~ShaderFunctionMeta()

Virtual destructor

Declaration
public virtual ~ShaderFunctionMeta() = default

Fields

Flags

Function flags.

Declaration
public ShaderFlags Flags
Field Value
ShaderFlags

MinFeatureLevel

The minimum graphics platform feature level to support this shader.

Declaration
public FeatureLevel MinFeatureLevel
Field Value
FeatureLevel

Name

Function name

Declaration
public StringAnsi Name
Field Value
StringAnsi

Permutations

All possible values for the permutations and it's values to generate different permutation of this function

Declaration
public Array<ShaderPermutation> Permutations
Field Value
Array<ShaderPermutation>

Methods

GetDefinitionsForPermutation(int32 permutationIndex, Array<ShaderMacro>& macros)

Gets all macros for given shader permutation

Declaration
public void GetDefinitionsForPermutation(int32 permutationIndex, Array<ShaderMacro>& macros) const
Parameters
int32 permutationIndex

Shader permutation index
Array<ShaderMacro> macros

Output array with permutation macros

GetStage()

Gets shader function meta stage type.

Declaration
public virtual ShaderStage GetStage() const = 0
Returns
ShaderStage

HasDefinition(const StringAnsi& defineName)

Checks if definition name has been added to the permutations collection

Declaration
public bool HasDefinition(const StringAnsi& defineName) const
Parameters
StringAnsi defineName

Name of the definition to check
Returns
bool

True if definition of given name has been registered for the permutations, otherwise false

HasDefinition(int32 permutationIndex, const StringAnsi& defineName)

Checks if definition name has been added to the given permutation

Declaration
public bool HasDefinition(int32 permutationIndex, const StringAnsi& defineName) const
Parameters
int32 permutationIndex

Shader permutation index
StringAnsi defineName

Name of the definition to check
Returns
bool

True if definition of given name has been registered for the permutations, otherwise false