FShaderCompilerInput

Struct that gathers all readonly inputs needed for the compilation of a single shader.

Windows
MacOS
Linux

References

Module

RenderCore

Header

/Engine/Source/Runtime/RenderCore/Public/ShaderCore.h

Include

#include "ShaderCore.h"

Syntax

struct FShaderCompilerInput

Remarks

Struct that gathers all readonly inputs needed for the compilation of a single shader.

Variables

Name Description

Public variable

bool

 

bCompilingForShaderPipeline

Shader pipeline information.

Public variable

bool

 

bGenerateDirectCompileFile

Public variable

bool

 

bIncludeUsedOutputs

Public variable

bool

 

bSkipPreprocessedCache

Skips the preprocessor and instead loads the usf file directly.

Public variable

FString

 

DebugDescription

Description of the configuration used when compiling.

Public variable

FString

 

DebugGroupName

Materialname or "Global" "for debugging and better error messages

Public variable

FString

 

DumpDebugInfoPath

Only used if enabled by r.DumpShaderDebugInfo (platform/groupname) e.g. ""

Public variable

FString

 

DumpDebugInfoRootPath

Dump debug path (up to platform) e.g. "D:/MMittring-Z3941-A/UE4-Orion/OrionGame/Saved/ShaderDebugInfo/PCD3D_SM5".

Public variable

FString

 

EntryPointName

Public variable

FShaderCompiler...

 

Environment

Compilation Environment.

Public variable

FExtraShaderCom...

 

ExtraSettings

Additional compilation settings that can be filled by FMaterial::SetupExtaCompilationSettingsFMaterial::SetupExtaCompilationSettings is usually called by each (*)MaterialShaderType::BeginCompileShader() function

Public variable

TArray< FRootPa...

 

RootParameterBindings

Public variable

FName

 

ShaderFormat

Public variable

TRefCountPtr< F...

 

SharedEnvironment

Public variable

FString

 

SourceFilePrefix

Public variable

FShaderTarget

 

Target

Public variable

TArray< FString...

 

UsedOutputs

Public variable

FString

 

VirtualSourceFilePath

Constructors

Name Description

Public function

FShaderCompilerInput()

Functions

Name Description

Public function

void

 

DeserializeSharedInputs

(
    FArchive& Ar,
    const TMap< FString, TSharedPtr< FS...,
    const TArray< FShaderCompilerEnviro...
)

Public function

void

 

GatherSharedInputs

(
    TMap< FString, FString >& External...,
    TArray< FShaderCompilerEnvironment ...
)

Public function Const

FString

 

GenerateShaderName()

Generate human readable name for debugging

Public function Const

FString

 

GetSourceFilename()

Public function

void

 

SerializeSharedInputs

(
    FArchive& Ar,
    const TArray< FShaderCompilerEnviro...
)

Classes

Name

Description

Public struct

FRootParameterBinding

Help shape the future of Unreal Engine documentation! Tell us how we're doing so we can serve you better.
Take our survey
Dismiss