Navigation
API > API/Developer > API/Developer/ShaderPreprocessor
Overloads
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
bool PreprocessShader
(
FShaderPreprocessOutput& Output, |
Preprocess a shader. | ShaderPreprocessor.h | |
bool PreprocessShader
(
FShaderPreprocessOutput& Output, |
Preprocess a shader. Preprocess a shader. | ShaderPreprocessor.h |
PreprocessShader(FShaderPreprocessOutput &, const FShaderCompilerInput &, const FShaderCompilerEnvironment &)
Description
Preprocess a shader.
| Name | PreprocessShader |
| Type | function |
| Header File | /Engine/Source/Developer/ShaderPreprocessor/Public/ShaderPreprocessor.h |
| Include Path | #include "ShaderPreprocessor.h" |
| Source | /Engine/Source/Developer/ShaderPreprocessor/Private/ShaderPreprocessor.cpp |
bool PreprocessShader
(
FShaderPreprocessOutput & Output,
const FShaderCompilerInput & Input,
const FShaderCompilerEnvironment & MergedEnvironment
)
true if the shader is preprocessed without error.
Parameters
| Name | Remarks |
|---|---|
| Output | Preprocess output struct. Source, directives and possibly errors will be populated. |
| Input | The shader compiler input. |
| MergedEnvironment | The result of merging the Environment and SharedEnvironment from the FShaderCompilerInput (it is assumed this overload is called outside of the worker process which merges this in-place, so this merge step must be performed by the caller) |
PreprocessShader(FShaderPreprocessOutput &, const FShaderCompilerInput &, const FShaderCompilerEnvironment &, const FShaderCompilerDefinitions &)
Description
Preprocess a shader. Preprocess a shader.
| Name | PreprocessShader |
| Type | function |
| Header File | /Engine/Source/Developer/ShaderPreprocessor/Public/ShaderPreprocessor.h |
| Include Path | #include "ShaderPreprocessor.h" |
| Source | /Engine/Source/Developer/ShaderPreprocessor/Private/ShaderPreprocessor.cpp |
bool PreprocessShader
(
FShaderPreprocessOutput & Output,
const FShaderCompilerInput & Input,
const FShaderCompilerEnvironment & MergedEnvironment,
const FShaderCompilerDefinitions & AdditionalDefines
)
true if the shader is preprocessed without error.
Parameters
| Name | Remarks |
|---|---|
| Output | Preprocess output struct. Source, directives and possibly errors will be populated. |
| Input | The shader compiler input. |
| MergedEnvironment | The result of merging the Environment and SharedEnvironment from the FShaderCompilerInput (it is assumed this overload is called outside of the worker process which merges this in-place, so this merge step must be performed by the caller) |
| AdditionalDefines | Additional defines with which to preprocess the shader. |
| OutPreprocessedShader | Upon return contains the preprocessed source code. |
| ShaderOutput | ShaderOutput to which errors can be added. |
| ShaderInput | The shader compiler input. |
| AdditionalDefines | Additional defines with which to preprocess the shader. |
| DefinesPolicy | Whether to add shader definitions as comments. |