Struct ShaderCompilationOptions

Shader compilation options container

Assembly: FlaxEngine.dll

File: Engine/ShadersCompilation/Config.h

Syntax

public struct ShaderCompilationOptions

Fields

GenerateDebugData

Enables shader debug data generation (depends on the target platform rendering backend).

Declaration

public bool GenerateDebugData = false

Field Value

bool

Macros

Custom macros for the shader compilation

Declaration

public Array<ShaderMacro> Macros

Field Value

Array<ShaderMacro>

NoOptimize

Disables shaders compiler optimizations. Can be used to debug shaders on a target platform or to speed up the shaders compilation time.

Declaration

public bool NoOptimize = false

Field Value

bool

Output

Output stream to write compiled shader cache to

Declaration

public MemoryWriteStream* Output = nullptr

Field Value

MemoryWriteStream

Profile

Target shader profile

Declaration

public ShaderProfile Profile = ShaderProfile::Unknown

Field Value

ShaderProfile

Source

Shader source code (null terminated)

Declaration

public char* Source = nullptr

Field Value

char

SourceLength

Shader source code length

Declaration

public uint32 SourceLength = 0

Field Value

uint32

TargetID

Unique ID of the target object

Declaration

public Guid TargetID = Guid::Empty

Field Value

Guid

TargetName

Name of the target object (name of the shader or material for better logging readability)

Declaration

public String TargetName

Field Value

String

TreatWarningsAsErrors

Enable/disable promoting warnings to compilation errors

Declaration

public bool TreatWarningsAsErrors = false

Field Value

bool