UDocumentation UE5.7 10.02.2026 (Source)
API documentation for Unreal Engine 5.7
FShaderPermutationBool Struct Reference

#include <ShaderPermutation.h>

Public Types

using Type = bool
 

Static Public Member Functions

static int32 ToDimensionValueId (Type E)
 
static bool ToDefineValue (Type E)
 
static Type FromDimensionValueId (int32 PermutationId)
 

Static Public Attributes

static constexpr int32 PermutationCount = 2
 
static constexpr bool IsMultiDimensional = false
 

Detailed Description

Defines at compile time a boolean permutation dimension.

Member Typedef Documentation

◆ Type

Setup the dimension's type in permutation domain as boolean.

Member Function Documentation

◆ FromDimensionValueId()

static Type FShaderPermutationBool::FromDimensionValueId ( int32  PermutationId)
inlinestatic

Converts dimension's value id to dimension boolean value (exact reciprocal of ToDimensionValueId).

◆ ToDefineValue()

static bool FShaderPermutationBool::ToDefineValue ( Type  E)
inlinestatic

Pass down a boolean to FShaderCompilerEnvironment::SetDefine().

◆ ToDimensionValueId()

static int32 FShaderPermutationBool::ToDimensionValueId ( Type  E)
inlinestatic

Converts dimension boolean value to dimension's value id.

Member Data Documentation

◆ IsMultiDimensional

constexpr bool FShaderPermutationBool::IsMultiDimensional = false
staticconstexpr

Setup the dimension as non multi-dimensional, so that the ModifyCompilationEnvironement's define can conventily be set up in SHADER_PERMUTATION_BOOL.

◆ PermutationCount

constexpr int32 FShaderPermutationBool::PermutationCount = 2
staticconstexpr

Setup the dimension's number of permutation.


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