1. Epic GamesDeveloper
  3. FShaderCompilingManager

FShaderCompilingManager

Manager of asynchronous and parallel shader compilation.

Unreal Engine C++ API Reference > Runtime > Engine

Inheritance Hierarchy

References

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

Syntax

class FShaderCompilingManager : private IAssetCompilingManager

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

  Type Name Description
Public function    

Destructors

  Type Name Description
Public function    

Functions

  Type Name Description
Public function Const bool  
Public function Const bool

AreWarningsSuppressed ( const EShaderPlatform Platform
)

  
Public function void

CancelCompilation ( const TCHAR* MaterialName,
const TArray< int32 >& ShaderMapIdsToCancel
)

 Removes all outstanding compile jobs for the passed shader maps.
Public function Const FString

CreateShaderDebugInfoPath ( const FShaderCompilerInput& ShaderCompilerInput
)

  
Public function void

FinishCompilation ( const TCHAR* MaterialName,
const TArray< int32 >& ShaderMapIdsToFinishCompiling
)

 Blocks until completion of the requested shader maps.
Public function Const void  
Public function Const const FString &  
Public function Const EDumpShaderDebugInfo  
Public function Const EShaderDebugInfoFlags  
Public function Const int32 Returns the (current) number of local workers.
Public function Const int32  
Public function Const int32  
Public function Const int32 Returns the number of outstanding compile jobs.
Public function Static FName Get the name of the asset type this compiler handles
Public function Const bool Return true if we have shader jobs in any state shader jobs are removed when they are applied to the gamethreadshadermap accessable from gamethread
Public function Const bool Returns whether normal throttling settings should be ignored because shader compilation is at the moment the only action blocking the critical path.
Public function void  
Public function Const bool Returns whether async compiling is happening.
Public function bool

IsCompilingShaderMap ( uint32 Id
)

  
Public function Const bool  
Public function Static bool Returns true if the given shader compile worker is still running.
Public function void

OnMachineResourcesChanged ( int32 NumberOfCores,
int32 NumberOfCoresIncludingHyperthreads
)

 Called by external systems that have updated the number of worker threads available.
Public function FShaderPipelineCompileJob *

PreparePipelineCompileJob ( uint32 Id,
const FShaderPipelineCompileJobKey& Key,
EShaderCompileJobPriority Priority
)

  
Public function FShaderCompileJob *

PrepareShaderCompileJob ( uint32 Id,
const FShaderCompileJobKey& Key,
EShaderCompileJobPriority Priority
)

 Prepares a job of the given type for compilation.
Public function void

PrintStats ( bool bForceLogIgnoringTimeInverval
)

 Prints stats related to shader compilation to the log.
Public function void

ProcessAsyncResults ( bool bLimitExecutionTime,
bool bBlockOnGlobalShaderCompletion
)

 Version of ProcessAsyncResults that specifies use of ProcessGameThreadTargetTime for the timeslice.
Public function void

ProcessAsyncResults ( float TimeSlice,
bool bBlockOnGlobalShaderCompletion
)

 Processes completed asynchronous shader maps, and assigns them to relevant materials.
Public function void This is an entry point for all jobs that have finished the compilation.
Public function void

SetExternalJobs ( int32 NumJobs
)

  
Public function Const bool Returns whether to display a notification that shader compiling is happening in the background.
Public function Const bool  
Public function Const bool

ShouldRecompileToDumpShaderDebugInfo ( const FShaderCompilerInput& Input,
const FShaderCompilerOutput& Output,
bool bSucceeded
)

  
Public function void

SkipShaderCompilation ( bool toggle
)

  
Public function void

SubmitJobs ( TArray< FShaderCommonCompileJobPtr >& NewJobs,
const FString MaterialBasePath,
FString PermutationString
)

 Adds shader jobs to be asynchronously compiled.
Public function void

SuppressWarnings ( const EShaderPlatform Platform
)

  

Overridden from IAssetCompilingManager

  Type Name Description
Public function Virtual void Blocks until completion of all async shader compiling, and assigns shader maps to relevant materials.
Public function Virtual void Shutdown the shader compiler manager, this will shutdown immediately and not process any more shader compile requests.

Enums

  Type Name Description
Public enum EDumpShaderDebugInfo    

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page