Unreal Engine 4.26 Documentation

Unreal Engine 4.27 Documentation

Unreal Engine 5.0 Documentation

Unreal Engine 5.1 Documentation

Unreal Engine 5.2 Documentation

Unreal Engine 5.3 Documentation

Light Theme

Dark Theme

FShaderCompilerEnvironment

The environment used to compile a shader.

Windows

MacOS

Linux

Inheritance Hierarchy

FRefCountedObject

FShaderCompilerEnvironment

References

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

Syntax

struct FShaderCompilerEnvironment : public FRefCountedObject

Remarks

The environment used to compile a shader.

Variables

	Name	Description
TArray< uint32 ...	CompilerFlags
TMap< FString, ...	IncludeVirtualPathToContentsMap	Map of the virtual file path -> content.
TMap< FString, ...	IncludeVirtualPathToExternalContentsMap
TMap< FString, ...	RemoteServerData
TMap< uint32, u...	RenderTargetOutputFormatsMap
TMap< FString, ...	ResourceTableLayoutHashes
TMap< FString, ...	ResourceTableLayoutSlots
TMap< FString, ...	ResourceTableMap
TMap< FString, ...	ShaderFormatCVars
const ITargetPl...	TargetPlatform

Constructors

	Name	Description
	FShaderCompilerEnvironment()	Default constructor.
	FShaderCompilerEnvironment ( const FShaderCompilerDefinitions& ... )	Initialization constructor.

Functions

	Name	Description
const TMap< ...	GetDefinitions()
void	Merge ( const FShaderCompilerEnvironment& ... )
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);
void	SetDefine ( const TCHAR* Name, uint32 Value )
void	SetDefine ( const TCHAR* Name, int32 Value )
void	SetDefine ( const TCHAR* Name, bool Value )
void	SetDefine ( const TCHAR* Name, float Value )
void	SetRenderTargetOutputFormat ( uint32 RenderTargetIndex, EPixelFormat PixelFormat )

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

Take our survey

Dismiss