1. Epic GamesDeveloper
  3. FShaderCompilerEnvironment

FShaderCompilerEnvironment

The environment used to compile a shader.

Unreal Engine C++ API Reference > Runtime > RenderCore

Inheritance Hierarchy

References

   
Module RenderCore
Header /Engine/Source/Runtime/RenderCore/Public/ShaderCore.h
Include #include "ShaderCore.h"

Syntax

struct FShaderCompilerEnvironment

Remarks

The environment used to compile a shader.

Variables

  Type Name Description
Public variable FShaderCompilerFlags CompilerFlags  
Public variable bool FullPrecisionInPS Used for mobile platforms to allow per shader/material precision modes.
Public variable TMap< FString, FString > IncludeVirtualPathToContentsMap Map of the virtual file path -> content.
Public variable TMap< FString, FThreadSafeSharedStringPtr > IncludeVirtualPathToExternalContentsMap  
Public variable TMap< FString, FThreadSafeSharedAnsiStringPtr > IncludeVirtualPathToSharedContentsMap  
Public variable TMap< uint32, uint8 > RenderTargetOutputFormatsMap  
Public variable FShaderResourceTableMap ResourceTableMap  
Public variable FRHIShaderBindingLayout RHIShaderBindingLayout Serialized version of the shader binding layout which can be used during platform specific shader code generation and serialization.
Public variable const FShaderBindingLayout * ShaderBindingLayout Optional shader binding layout which can be used build the Uniform buffer map.
Public variable const ITargetPlatform * TargetPlatform  
Public variable TMap< FString, FUniformBufferEntry > UniformBufferMap  

Constructors

  Type Name Description
Public function   Default constructor.
Public function   Constructor used when enviroment is constructed temporarily purely for the purpose of hashing for inclusion in DDC keys.
Public function PRAGMA_DISABLE_DEPRECATION_WARNINGS

FShaderCompilerEnvironment ( const FShaderCompilerDefinitions& InDefinitions
)

 Initialization constructor. Initialization constructor.
Public function   Explicitly default assignment operator and copy constructor operator with warnings disabled to avoid warnings in implicitly-generated functions due to deprecation of IncludeVirtualPathToExternalContentsMap.

Destructors

  Type Name Description
Public function Virtual PRAGMA_ENABLE_DEPRECATION_WARNINGS virtual PRAGMA_DISABLE_DEPRECATION_WARNINGS Used as a baseclass, make sure we're not incorrectly destroyed through a baseclass pointer This will be expensive to destroy anyway, additional vcall overhead should be small Temporarily disable deprecation warnings for this default destructor triggering due to the deprecated RemoteServerData field.

Functions

  Type Name Description
Public function Const bool  
Public function Const ValueType

GetCompileArgument ( const TCHAR* Name,
const ValueType& DefaultValue
)

 If a compile argument with the given name exists and is of the specified type, returns its value.
Public function Const bool

GetCompileArgument ( const TCHAR* Name,
ValueType& OutValue
)

 If a compile argument with the given name exists and is of the specified type, its value will be assigned to OutValue and the function will return true.
Public function Const FString  
Public function Const Please use Get SetCompileArgument mechanism for additional properties required by compilation int32

GetIntegerValue ( FShaderCompilerDefineNameCache& NameCache,
int32 ResultIfNotFound
)

  
Public function Const Please use Get SetCompileArgument mechanism for additional properties required by compilation int32  
Public function Const bool

HasCompileArgument ( const TCHAR* Name
)

 If a compile argument with the given name exists, returns true.
Public function void  
Public function void Serializes the portions of the environment that are used as input to the backend compilation process (i.e. after all preprocessing)
Public function void This "core" serialization is also used for the hashing the compiler job (where files are handled differently).
Public function void

SetCompileArgument ( const TCHAR* Name,
TVariant< bool, float, int32, uint32, FString > Value
)

 Like above, but this overload takes in the define value variant explicitly.
Public function void

SetCompileArgument ( const TCHAR* Name,
ValueType Value
)

 Sets a generic parameter which can be read in the various shader format backends to modify compilation behaviour.
Public function void

SetDefine ( FName Name,
const FString& Value
)

  
Public function void  
Public function void  
Public function void  
Public function void  
Public function void

SetDefine ( FName Name,
float Value
)

  
Public function void

SetDefine ( FName Name,
bool Value
)

  
Public function void

SetDefine ( FName Name,
int32 Value
)

  
Public function void

SetDefine ( FName Name,
uint32 Value
)

  
Public function void

SetDefine ( FShaderCompilerDefineNameCache& Name,
float Value
)

  
Public function void

SetDefine ( const TCHAR* Name,
float Value
)

  
Public function void

SetDefine ( const TCHAR* Name,
bool Value
)

  
Public function void

SetDefine ( const TCHAR* Name,
int32 Value
)

  
Public function void

SetDefine ( const TCHAR* Name,
uint32 Value
)

  
Public function void

SetDefine ( const TCHAR* Name,
const FString& Value
)

  
Public function PRAGMA_ENABLE_DEPRECATION_WARNINGS void

SetDefine ( const TCHAR* Name,
const TCHAR* Value
)

 Works for TCHAR e.g. SetDefine(TEXT("NAME"), TEXT("Test")); e.g. SetDefine(TEXT("NUM_SAMPLES"), 1); e.g. SetDefine(TEXT("DOIT"), true);
Public function void  
Public function void

SetDefine ( FName Name,
const TCHAR* Value
)

  
Public function void

SetDefineAndCompileArgument ( const TCHAR* Name,
ValueType Value
)

 Helper to set both a define and a compile argument to the same value.
Public function void

SetDefineIfUnset ( const TCHAR* Name,
ValueType Value
)

  
Public function void

SetRenderTargetOutputFormat ( uint32 RenderTargetIndex,
EPixelFormat PixelFormat
)

  

Operators

  Type Name Description
Public function FShaderCompilerEnvironment &  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page