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

> Unreal Engine API Reference > Runtime > Engine > FShaderCompilingManager

Light Theme

Dark Theme

FShaderCompilingManager

Manager of asynchronous and parallel shader compilation.

Windows

MacOS

Linux

References

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

Syntax

class FShaderCompilingManager

Remarks

Manager of asynchronous and parallel shader compilation. This class contains an interface to enqueue and retreive asynchronous shader jobs, and manages a FShaderCompileThreadRunnable.

Constructors

	Name	Description
	FShaderCompilingManager()

Functions

	Name	Description
bool	AllowAsynchronousShaderCompiling()
bool	AreWarningsSuppressed ( const EShaderPlatform Platform )
void	CancelCompilation ( const TCHAR* MaterialName, const TArray< int32 >& ShaderMapId... )	Removes all outstanding compile jobs for the passed shader maps.
FString	CreateShaderDebugInfoPath ( const FShaderCompilerInput& Shader... )
void	FinishAllCompilation()	Blocks until completion of all async shader compiling, and assigns shader maps to relevant materials.
void	FinishCompilation ( const TCHAR* MaterialName, const TArray< int32 >& ShaderMapId... )	Blocks until completion of the requested shader maps.
const FStrin...	GetAbsoluteShaderDebugInfoDirectory()
EDumpShaderD...	GetDumpShaderDebugInfo()
int32	GetNumOutstandingJobs()
int32	GetNumPendingJobs()
int32	GetNumRemainingJobs()	Returns the number of outstanding compile jobs.
bool	HasShaderJobs()	Return true if we have shader jobs in any state shader jobs are removed when they are applied to the gamethreadshadermap accessable from gamethread
bool	IsCompiling()	Returns whether async compiling is happening.
bool	IsShaderCompilationSkipped()
bool	IsShaderCompilerWorkerRunning ( FProcHandle& WorkerHandle )	Returns true if the given shader compile worker is still running.
FShaderPipel...	PreparePipelineCompileJob ( uint32 Id, const FShaderPipelineCompileJobKey ..., EShaderCompileJobPriority Priority )
FShaderCompi...	PrepareShaderCompileJob ( uint32 Id, const FShaderCompileJobKey& Key, EShaderCompileJobPriority Priority )	Prepares a job of the given type for compilation.
void	ProcessAsyncResults ( bool bLimitExecutionTime, bool bBlockOnGlobalShaderCompletion )	Processes completed asynchronous shader maps, and assigns them to relevant materials.
void	ProcessFinishedJob ( FShaderCommonCompileJob* Finis... )	This is an entry point for all jobs that have finished the compilation.
void	SetExternalJobs ( int32 NumJobs )
bool	ShouldDisplayCompilingNotification()	Returns whether to display a notification that shader compiling is happening in the background.
bool	ShouldRecompileToDumpShaderDebugInfo ( const FShaderCompileJob& Job )
bool	ShouldRecompileToDumpShaderDebugInfo ( const FShaderCompilerInput& Input, const FShaderCompilerOutput& Outpu..., bool bSucceeded )
void	Shutdown()	Shutdown the shader compiler manager, this will shutdown immediately and not process any more shader compile requests.
void	SkipShaderCompilation ( bool toggle )
void	SubmitJobs ( TArray< FShaderCommonCompileJobPtr ..., const FString MaterialBasePath, FString PermutationString )	Adds shader jobs to be asynchronously compiled.
void	SuppressWarnings ( const EShaderPlatform Platform )

Enums

	Name	Description
	EDumpShaderDebugInfo

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

Take our survey

Dismiss