Navigation
API > API/Runtime > API/Runtime/RenderCore
Stores all of the input and output information used to compile a single shader.
| Name | FShaderCompileJob |
| Type | class |
| Header File | /Engine/Source/Runtime/RenderCore/Public/ShaderCompilerJobTypes.h |
| Include Path | #include "ShaderCompilerJobTypes.h" |
Syntax
class FShaderCompileJob : public FShaderCommonCompileJob
Inheritance Hierarchy
- FShaderCommonCompileJob → FShaderCompileJob
Constructors
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
| ShaderCompilerJobTypes.h | |||
FShaderCompileJob
(
uint32 InHash, |
ShaderCompilerJobTypes.h |
Constants
| Name | Type | Remarks | Include Path |
|---|---|---|---|
| Type | const EShaderCompileJobType | ShaderCompilerJobTypes.h |
Variables
Public
| Name | Type | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|---|
| Input | FShaderCompilerInput | Input for the shader compile | ShaderCompilerJobTypes.h | |
| Key | FShaderCompileJobKey | ShaderCompilerJobTypes.h | ||
| Output | FShaderCompilerOutput | ShaderCompilerJobTypes.h | ||
| PreprocessOutput | FShaderPreprocessOutput | ShaderCompilerJobTypes.h | ||
| SecondaryOutput | TUniquePtr< FShaderCompilerOutput > | ShaderCompilerJobTypes.h | ||
| SecondaryPreprocessOutput | TUniquePtr< FShaderPreprocessOutput > | ShaderCompilerJobTypes.h | ||
| ShaderParameters | TSharedPtr< const FShaderType::FParameters, ESPMode::ThreadSafe > | Additional parameters that can be supplied to the compile job such that it is available from the compilation begins to when the FShader is created. | ShaderCompilerJobTypes.h | |
| SharingPipelines | TMap< const FVertexFactoryType *, TArray< const FShaderPipelineType * > > | List of pipelines that are sharing this job. | ShaderCompilerJobTypes.h |
Functions
Public
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
FStringView GetFinalSourceView() |
ShaderCompilerJobTypes.h | ||
void SerializeArtifact
(
FArchive& Ar |
Serializes the compile job for a cook artifact for later analysis in a commandlet. | ShaderCompilerJobTypes.h | |
void SerializeOutput
(
FShaderCacheSerializeContext& Ctx, |
ShaderCompilerJobTypes.h | ||
void SerializeWorkerInput
(
FArchive& Ar |
Serializes only the subset of data written by ShaderCompiler and read from SCW when using worker processes. | ShaderCompilerJobTypes.h | |
void SerializeWorkerInputNoSource
(
FArchive& Ar |
ShaderCompilerJobTypes.h | ||
void SerializeWorkerOutput
(
FArchive& Ar |
Serializes only the subset of data written by SCW/read back from ShaderCompiler when using worker processes. | ShaderCompilerJobTypes.h |
Overridden from FShaderCommonCompileJob
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual void AppendDebugName
(
FStringBuilderBase& OutName |
ShaderCompilerJobTypes.h | ||
virtual void AppendDiagnostics
(
FString& OutDiagnostics, |
Generates a diagnostics string for this compile job suitable for the output log. | ShaderCompilerJobTypes.h | |
virtual FShaderCompilerInputHash GetInputHash() |
Returns hash of all inputs for this job (needed for caching). | ShaderCompilerJobTypes.h | |
virtual void OnComplete () |
ShaderCompilerJobTypes.h | ||
virtual void OnComplete
(
FShaderDebugDataContext& Ctx |
Executed for all jobs (including those read from cache) on completion. | ShaderCompilerJobTypes.h | |
virtual void SerializeOutput
(
FShaderCacheSerializeContext& Ctx |
Serializes (and deserializes) the output for caching purposes. | ShaderCompilerJobTypes.h |