className
stringlengths 1
167
| headerPath
stringlengths 14
166
| description
stringlengths 0
1.62k
| module
stringlengths 0
76
| code
stringlengths 0
11.4k
| variables
listlengths 0
395
|
|---|---|---|---|---|---|
FHlslccHeaderWriter | /Engine/Source/Developer/ShaderCompilerCommon/Public/HlslccHeaderWriter.h | ShaderCompilerCommon | class FHlslccHeaderWriter | [] |
|
FHlslShaderModel::operator== | /Engine/Source/Developer/ShaderCompilerCommon/Public/ShaderConductorContext.h | ShaderCompilerCommon | bool operator== ( const [FHlslShaderModel](API\Developer\ShaderCompilerCommon\FHlslShaderModel) & Rhs ) const | [] |
|
FHlslShaderModel::operator>= | /Engine/Source/Developer/ShaderCompilerCommon/Public/ShaderConductorContext.h | ShaderCompilerCommon | bool operator>= ( const [FHlslShaderModel](API\Developer\ShaderCompilerCommon\FHlslShaderModel) & Rhs ) const | [] |
|
FHlslShaderModel::operator> | /Engine/Source/Developer/ShaderCompilerCommon/Public/ShaderConductorContext.h | ShaderCompilerCommon | bool operator> ( const [FHlslShaderModel](API\Developer\ShaderCompilerCommon\FHlslShaderModel) & Rhs ) const | [] |
|
FHlslShaderModel::operator< | /Engine/Source/Developer/ShaderCompilerCommon/Public/ShaderConductorContext.h | ShaderCompilerCommon | bool operator< ( const [FHlslShaderModel](API\Developer\ShaderCompilerCommon\FHlslShaderModel) & Rhs ) const | [] |
|
FHlslShaderModel::operator<= | /Engine/Source/Developer/ShaderCompilerCommon/Public/ShaderConductorContext.h | ShaderCompilerCommon | bool operator<= ( const [FHlslShaderModel](API\Developer\ShaderCompilerCommon\FHlslShaderModel) & Rhs ) const | [] |
|
FHlslShaderModel::operator!= | /Engine/Source/Developer/ShaderCompilerCommon/Public/ShaderConductorContext.h | ShaderCompilerCommon | bool operator!= ( const [FHlslShaderModel](API\Developer\ShaderCompilerCommon\FHlslShaderModel) & Rhs ) const | [] |
|
FindOffsetToSpirvEntryPoint | /Engine/Source/Developer/ShaderCompilerCommon/Public/SpirvCommon.h | Returns word offset to the entry point (OpEntryPoint) and name of the entry point (OpName). If the respective entry has not been found, the output offset is 0. | ShaderCompilerCommon | void FindOffsetToSpirvEntryPoint ( const [FSpirv](API\Developer\ShaderCompilerCommon\FSpirv) & Spirv, const ANSICHAR * EntryPointName, uint32 & OutWordOffsetToEntryPoint, uint32 & OutWordOffsetToMainName ) | [] |
FHlslShaderModel | /Engine/Source/Developer/ShaderCompilerCommon/Public/ShaderConductorContext.h | Shader model version for HLSL input language. | ShaderCompilerCommon | struct FHlslShaderModel | [
{
"type": "uint16",
"name": "Major",
"description": "Major shader model version (e.g. 6 in SM6.2)."
},
{
"type": "uint16",
"name": "Minor",
"description": "Minor shader model version (e.g. 2 in SM6.2)."
}
] |
FMinifiedShader::Success | /Engine/Source/Developer/ShaderCompilerCommon/Public/ShaderMinifier.h | ShaderCompilerCommon | bool Success() const | [] |
|
FMinifiedShader | /Engine/Source/Developer/ShaderCompilerCommon/Public/ShaderMinifier.h | ShaderCompilerCommon | struct FMinifiedShader | [
{
"type": "FString",
"name": "Code",
"description": ""
},
{
"type": "FDiagnostics",
"name": "Diagnostics",
"description": ""
}
] |
|
FShaderConductorContext::CompileHlslToSpirv | /Engine/Source/Developer/ShaderCompilerCommon/Public/ShaderConductorContext.h | Compiles the specified HLSL shader source code to SPIR-V. | ShaderCompilerCommon | bool CompileHlslToSpirv ( const [FShaderConductorOptions](API\Developer\ShaderCompilerCommon\FShaderConductorOptions) & Options, [TArray](API\Runtime\Core\Containers\TArray)< uint32 > & OutSpirv ) | [] |
FShaderConductorContext::CompileSpirvToSourceAnsi | /Engine/Source/Developer/ShaderCompilerCommon/Public/ShaderConductorContext.h | Compiles the specified SPIR-V shader binary code to high level source code (Metal or GLSL) stored as null terminated ANSI string. | ShaderCompilerCommon | bool CompileSpirvToSourceAnsi ( const [FShaderConductorOptions](API\Developer\ShaderCompilerCommon\FShaderConductorOptions) & Options, const [FShaderConductorTarget](API\Developer\ShaderCompilerCommon\FShaderConductorTarget) & Target, const void * InSpirv, uint32 InSpirvByteSize, [TArray](API\Runtime\Core\Containers\TArray)< ANSICHAR > & OutSource ) | [] |
FShaderConductorContext::CompileSpirvToSourceBuffer | /Engine/Source/Developer/ShaderCompilerCommon/Public/ShaderConductorContext.h | Compiles the specified SPIR-V shader binary code to high level source code (Metal or GLSL) stored as byte buffer (without null terminator as it comes from ShaderConductor). | ShaderCompilerCommon | bool CompileSpirvToSourceBuffer ( const [FShaderConductorOptions](API\Developer\ShaderCompilerCommon\FShaderConductorOptions) & Options, const [FShaderConductorTarget](API\Developer\ShaderCompilerCommon\FShaderConductorTarget) & Target, const void * InSpirv, uint32 InSpirvByteSize, const [TFunction](API\Runtime\Core\GenericPlatform\TFunction)< void(const void *Data, uint32 Size)> & OutputCallback ) | [] |
FShaderConductorContext::CompileSpirvToSource | /Engine/Source/Developer/ShaderCompilerCommon/Public/ShaderConductorContext.h | Compiles the specified SPIR-V shader binary code to high level source code (Metal or GLSL). | ShaderCompilerCommon | bool CompileSpirvToSource ( const [FShaderConductorOptions](API\Developer\ShaderCompilerCommon\FShaderConductorOptions) & Options, const [FShaderConductorTarget](API\Developer\ShaderCompilerCommon\FShaderConductorTarget) & Target, const void * InSpirv, uint32 InSpirvByteSize, [FString](API\Runtime\Core\Containers\FString) & OutSource ) | [] |
FShaderConductorContext::ConvertCompileErrors | /Engine/Source/Developer/ShaderCompilerCommon/Public/ShaderConductorContext.h | Convert array of error string lines into array of. | ShaderCompilerCommon | static void ConvertCompileErrors ( [TArray](API\Runtime\Core\Containers\TArray)< [FString](API\Runtime\Core\Containers\FString) > && ErrorStringLines, [TArray](API\Runtime\Core\Containers\TArray)< [FShaderCompilerError](API\Runtime\RenderCore\FShaderCompilerError) > & OutErrors ) | [] |
FShaderConductorContext::Disassemble | /Engine/Source/Developer/ShaderCompilerCommon/Public/ShaderConductorContext.h | Disassembles the specified SPIR-V module and returns its assembly as text representation. | ShaderCompilerCommon | static bool Disassemble ( [EShaderConductorIR](API\Developer\ShaderCompilerCommon\CrossCompiler__EShaderConductorI-) Language, const void * Binary, uint32 BinaryByteSize, [TArray](API\Runtime\Core\Containers\TArray)< ANSICHAR > & OutAssemblyText ) | [] |
FShaderConductorContext::GetErrors | /Engine/Source/Developer/ShaderCompilerCommon/Public/ShaderConductorContext.h | Returns the list of current compile errors. | ShaderCompilerCommon | const [TArray](API\Runtime\Core\Containers\TArray)< [FShaderCompilerError](API\Runtime\RenderCore\FShaderCompilerError) > & GetErrors() const | [] |
FShaderConductorContext::FlushErrors | /Engine/Source/Developer/ShaderCompilerCommon/Public/ShaderConductorContext.h | Flushes the list of current compile errors and moves the ownership to the caller. | ShaderCompilerCommon | void FlushErrors ( [TArray](API\Runtime\Core\Containers\TArray)< [FShaderCompilerError](API\Runtime\RenderCore\FShaderCompilerError) > & OutErrors ) | [] |
FShaderConductorContext::GetIdentifierTable | /Engine/Source/Developer/ShaderCompilerCommon/Public/ShaderConductorContext.h | Returns the table of special identifiers generated by ShaderConductor. | ShaderCompilerCommon | static const [FShaderConductorIdentifierTable](API\Developer\ShaderCompilerCommon\FShaderConductorIdentifierTable) & GetIdentifierTable() | [] |
FShaderConductorContext::GetShaderFileExt | /Engine/Source/Developer/ShaderCompilerCommon/Public/ShaderConductorContext.h | Returns a filename extension for the specified shading language and shader stage, e.g. "frag" for a GLSL pixel shader. | ShaderCompilerCommon | static const TCHAR * GetShaderFileExt ( [EShaderConductorLanguage](API\Developer\ShaderCompilerCommon\CrossCompiler__EShaderConductorL-) Language, EShaderFrequency ShaderStage ) | [] |
FShaderConductorContext::GetSourceLength | /Engine/Source/Developer/ShaderCompilerCommon/Public/ShaderConductorContext.h | Returns a length of the internal loaded sources (excluding the null terminator). This is automatically updated whenRewriteHlsl()is called. | ShaderCompilerCommon | int32 GetSourceLength() const | [] |
FShaderConductorContext::GetSourceString | /Engine/Source/Developer/ShaderCompilerCommon/Public/ShaderConductorContext.h | Returns a pointer to a null terminated ANSI string of the internal loaded sources, or null if no source has been loaded yet. This is automatically updated whenRewriteHlsl()is called. | ShaderCompilerCommon | const ANSICHAR * GetSourceString() const | [] |
FShaderConductorContext::IsIntermediateSpirvOutputVariable | /Engine/Source/Developer/ShaderCompilerCommon/Public/ShaderConductorContext.h | Returns whether the specified variable name denotes an intermediate output variable. This is only true for a special identifiers generated by DXC to communicate patch constant data in the Hull Shader. | ShaderCompilerCommon | static bool IsIntermediateSpirvOutputVariable ( const ANSICHAR * SpirvVariableName ) | [] |
FShaderConductorContext::LoadSource | /Engine/Source/Developer/ShaderCompilerCommon/Public/ShaderConductorContext.h | Loads the shader source and converts the input descriptor to a format suitable for ShaderConductor. If 'Definitions' is null, the previously loaded definitions are not modified. | ShaderCompilerCommon | bool LoadSource ( const [FString](API\Runtime\Core\Containers\FString) & ShaderSource, const [FString](API\Runtime\Core\Containers\FString) & Filename, const [FString](API\Runtime\Core\Containers\FString) & EntryPoint, EShaderFrequency ShaderStage, const [FShaderCompilerDefinitions](API\Runtime\RenderCore\FShaderCompilerDefinitions) * Definitions, const [TArray](API\Runtime\Core\Containers\TArray)< [FString](API\Runtime\Core\Containers\FString) > * ExtraDxcArgs ) | [] |
FShaderConductorContext::LoadSource | /Engine/Source/Developer/ShaderCompilerCommon/Public/ShaderConductorContext.h | Loads the shader source and converts the input descriptor to a format suitable for ShaderConductor. If 'Definitions' is null, the previously loaded definitions are not modified. | ShaderCompilerCommon | bool LoadSource ( const ANSICHAR * ShaderSource, const ANSICHAR * Filename, const ANSICHAR * EntryPoint, EShaderFrequency ShaderStage, const [FShaderCompilerDefinitions](API\Runtime\RenderCore\FShaderCompilerDefinitions) * Definitions, const [TArray](API\Runtime\Core\Containers\TArray)< [FString](API\Runtime\Core\Containers\FString) > * ExtraDxcArgs ) | [] |
FShaderConductorContext::OptimizeSpirv | /Engine/Source/Developer/ShaderCompilerCommon/Public/ShaderConductorContext.h | Performs the specified optimization passes (e.g. "-O" or "--strip-reflect") on the SPIR-V module. | ShaderCompilerCommon | bool OptimizeSpirv ( [TArray](API\Runtime\Core\Containers\TArray)< uint32 > & Spirv, const ANSICHAR *const * OptConfigs, int32 OptConfigCount ) | [] |
FShaderConductorContext::operator= | /Engine/Source/Developer/ShaderCompilerCommon/Public/ShaderConductorContext.h | ShaderCompilerCommon | [FShaderConductorContext](API\Developer\ShaderCompilerCommon\FShaderConductorContext) & operator= ( const [FShaderConductorContext](API\Developer\ShaderCompilerCommon\FShaderConductorContext) & ) | [] |
|
FShaderConductorContext::operator= | /Engine/Source/Developer/ShaderCompilerCommon/Public/ShaderConductorContext.h | Move operator to take ownership of internal buffers from 'Rhs'. | ShaderCompilerCommon | [FShaderConductorContext](API\Developer\ShaderCompilerCommon\FShaderConductorContext) & operator= ( [FShaderConductorContext](API\Developer\ShaderCompilerCommon\FShaderConductorContext) && Rhs ) | [] |
FShaderConductorContext::RewriteHlsl | /Engine/Source/Developer/ShaderCompilerCommon/Public/ShaderConductorContext.h | Rewrites the specified HLSL shader source code. This allows to reduce the HLSL code by removing unused global resources for instance. This will update the internally loaded source (see 'LoadSource'), so the output parameter 'OutSource' is optional. | ShaderCompilerCommon | bool RewriteHlsl ( const [FShaderConductorOptions](API\Developer\ShaderCompilerCommon\FShaderConductorOptions) & Options, [FString](API\Runtime\Core\Containers\FString) * OutSource ) | [] |
FShaderConductorContext::Shutdown | /Engine/Source/Developer/ShaderCompilerCommon/Public/ShaderConductorContext.h | Explicitly shut down ShaderConductor and DXC shared libraries. Only used for Linux to prevent dangling mutex on exit. | ShaderCompilerCommon | static void Shutdown() | [] |
FShaderConductorContext::FShaderConductorContext | /Engine/Source/Developer/ShaderCompilerCommon/Public/ShaderConductorContext.h | Initializes the context with internal buffers used for the conversion of input and option descriptors between UE and ShaderConductor. | ShaderCompilerCommon | FShaderConductorContext() | [] |
FShaderConductorContext::FShaderConductorContext | /Engine/Source/Developer/ShaderCompilerCommon/Public/ShaderConductorContext.h | Move constructor to take ownership of internal buffers from 'Rhs'. | ShaderCompilerCommon | FShaderConductorContext ( [FShaderConductorContext](API\Developer\ShaderCompilerCommon\FShaderConductorContext) && Rhs ) | [] |
FShaderConductorContext::FShaderConductorContext | /Engine/Source/Developer/ShaderCompilerCommon/Public/ShaderConductorContext.h | ShaderCompilerCommon | FShaderConductorContext ( const [FShaderConductorContext](API\Developer\ShaderCompilerCommon\FShaderConductorContext) & ) | [] |
|
FShaderConductorContext::~FShaderConductorContext | /Engine/Source/Developer/ShaderCompilerCommon/Public/ShaderConductorContext.h | Release the internal buffers. | ShaderCompilerCommon | ~FShaderConductorContext() | [] |
FShaderConductorContext | /Engine/Source/Developer/ShaderCompilerCommon/Public/ShaderConductorContext.h | Wrapper class to handle interface between UE and ShaderConductor. Use to compile HLSL shaders to SPIR-V or high-level languages such as Metal. | ShaderCompilerCommon | class FShaderConductorContext | [] |
FShaderConductorIdentifierTable | /Engine/Source/Developer/ShaderCompilerCommon/Public/ShaderConductorContext.h | Container for all special case SPIR-V identifiers generated by ShaderConductor. | ShaderCompilerCommon | struct FShaderConductorIdentifierTable | [
{
"type": "const ANSICHAR ...",
"name": "DummySampler",
"description": "Identifier for dummy samplers used for platforms where samplers are required"
},
{
"type": "const ANSICHAR ...",
"name": "GlobalsUniformBuffer",
"description": "Identifier for globals uniform buffers: \"$Globals\"."
},
{
"type": "const ANSICHAR ...",
"name": "InputAttribute",
"description": "Identifier for vertex input attributes: \"in.var.ATTRIBUTE\"."
},
{
"type": "const ANSICHAR ...",
"name": "IntermediateTessControlOutput",
"description": "Identifier for the intermediate output variable in a tessellation-control shader."
}
] |
FShaderConductorModuleWrapper::GetModuleVersionHash | /Engine/Source/Developer/ShaderCompilerCommon/Public/DXCWrapper.h | ShaderCompilerCommon | uint32 GetModuleVersionHash() const | [] |
|
FShaderConductorModuleWrapper::FShaderConductorModuleWrapper | /Engine/Source/Developer/ShaderCompilerCommon/Public/DXCWrapper.h | ShaderCompilerCommon | FShaderConductorModuleWrapper() | [] |
|
FShaderConductorModuleWrapper::~FShaderConductorModuleWrapper | /Engine/Source/Developer/ShaderCompilerCommon/Public/DXCWrapper.h | ShaderCompilerCommon | virtual ~FShaderConductorModuleWrapper() | [] |
|
FShaderConductorModuleWrapper | /Engine/Source/Developer/ShaderCompilerCommon/Public/DXCWrapper.h | ShaderCompilerCommon | class FShaderConductorModuleWrapper : private [FDxcModuleWrapper](API\Developer\ShaderCompilerCommon\FDxcModuleWrapper) | [] |
|
ETargetEnvironment | /Engine/Source/Developer/ShaderCompilerCommon/Public/ShaderConductorContext.h | ShaderCompilerCommon | enum ETargetEnvironment { Vulkan_1_0, Vulkan_1_1, Vulkan_1_2, Vulkan_1_3, } | [] |
|
FShaderConductorOptions | /Engine/Source/Developer/ShaderCompilerCommon/Public/ShaderConductorContext.h | Wrapper structure to pass options descriptor to ShaderConductor. This is mapped to. | ShaderCompilerCommon | struct FShaderConductorOptions | [
{
"type": "bool",
"name": "bDisableOptimizations",
"description": "Force to turn off optimizations. Ignore optimizationLevel below."
},
{
"type": "bool",
"name": "bDisableScalarBlockLayout",
"description": "Disables scalar block layout for structured buffers."
},
{
"type": "bool",
"name": "bEnable16bitTypes",
"description": "Enable 16-bit types, such as half, uint16_t. Requires shader model 6.2+."
},
{
"type": "bool",
"name": "bEnableDebugInfo",
"description": "Embed debug info into the binary."
},
{
"type": "bool",
"name": "bEnableFMAPass",
"description": "Enable a pass that converts floating point MUL+ADD pairs into FMAs to avoid re-association."
},
{
"type": "bool",
"name": "bEnableSeparateSamplersInGlsl",
"description": "Enables separate samplers in GLSL via extensions."
},
{
"type": "bool",
"name": "bForceStorageImageFormat",
"description": ""
},
{
"type": "bool",
"name": "bPackMatricesInRowMajor",
"description": "Experimental: Decide how a matrix get packed."
},
{
"type": "bool",
"name": "bPreserveStorageInput",
"description": "Preserve storage inputs used for OpenGL"
},
{
"type": "bool",
"name": "bRemapAttributeLocations",
"description": "Enables re-mapping of input/output attribute locations to include padding for arrays."
},
{
"type": "bool",
"name": "bRemoveUnusedGlobals",
"description": "Removes unused global variables and resources."
},
{
"type": "bool",
"name": "bSvPositionImplicitInvariant",
"description": "Decorate SV_Position implicitly as invariant."
},
{
"type": "uint32",
"name": "HlslVersion",
"description": "HLSL language input version: 2015, 2016, 2017, 2018 (Default), 2021 (Breaking changes in short-circuiting evaluation)."
},
{
"type": "FHlslShaderMode...",
"name": "ShaderModel",
"description": "Shader model version of the input language.Bydefault SM6.2."
},
{
"type": "ETargetEnvironm...",
"name": "TargetEnvironment",
"description": ""
}
] |
FShaderConductorTarget | /Engine/Source/Developer/ShaderCompilerCommon/Public/ShaderConductorContext.h | Shader conductor output target descriptor. | ShaderCompilerCommon | struct FShaderConductorTarget | [
{
"type": "FShaderCompiler...",
"name": "CompileFlags",
"description": "Cross compilation flags."
},
{
"type": "EShaderConducto...",
"name": "Language",
"description": "Target shader semantics, e.g. \"macOS\" or \"iOS\" for Metal GPU semantics."
},
{
"type": "TFunction< bool...",
"name": "VariableTypeRenameCallback",
"description": "Optional callback to rename certain variable types."
},
{
"type": "int32",
"name": "Version",
"description": "Target shader version."
}
] |
FSpirv::begin | /Engine/Source/Developer/ShaderCompilerCommon/Public/SpirvCommon.h | Returns a constant iterator to the first instruction in this SPIR-V module. | ShaderCompilerCommon | [FSpirvConstIterator](API\Developer\ShaderCompilerCommon\FSpirvConstIterator) begin() const | [] |
FSpirv::begin | /Engine/Source/Developer/ShaderCompilerCommon/Public/SpirvCommon.h | Returns an iterator to the first instruction in this SPIR-V module. | ShaderCompilerCommon | [FSpirvIterator](API\Developer\ShaderCompilerCommon\FSpirvIterator) begin() | [] |
FSpirv::cbegin | /Engine/Source/Developer/ShaderCompilerCommon/Public/SpirvCommon.h | Returns a constant iterator to the first instruction in this SPIR-V module. | ShaderCompilerCommon | [FSpirvConstIterator](API\Developer\ShaderCompilerCommon\FSpirvConstIterator) cbegin() const | [] |
FSpirv::cend | /Engine/Source/Developer/ShaderCompilerCommon/Public/SpirvCommon.h | Returns a constant iterator to the end of this SPIR-V module. | ShaderCompilerCommon | [FSpirvConstIterator](API\Developer\ShaderCompilerCommon\FSpirvConstIterator) cend() const | [] |
FSpirv::end | /Engine/Source/Developer/ShaderCompilerCommon/Public/SpirvCommon.h | Returns an iterator to the end of this SPIR-V module. | ShaderCompilerCommon | [FSpirvIterator](API\Developer\ShaderCompilerCommon\FSpirvIterator) end() | [] |
FSpirv::end | /Engine/Source/Developer/ShaderCompilerCommon/Public/SpirvCommon.h | Returns a constant iterator to the end of this SPIR-V module. | ShaderCompilerCommon | [FSpirvConstIterator](API\Developer\ShaderCompilerCommon\FSpirvConstIterator) end() const | [] |
FSpirv::GetByteData | /Engine/Source/Developer/ShaderCompilerCommon/Public/SpirvCommon.h | Returns a byte pointer to the SPIR-V data. | ShaderCompilerCommon | int8 * GetByteData() | [] |
FSpirv::GetByteData | /Engine/Source/Developer/ShaderCompilerCommon/Public/SpirvCommon.h | Returns a byte pointer to the SPIR-V data. | ShaderCompilerCommon | const int8 * GetByteData() const | [] |
FSpirv::GetByteSize | /Engine/Source/Developer/ShaderCompilerCommon/Public/SpirvCommon.h | Returns the size of this SPIR-V module in bytes. | ShaderCompilerCommon | int32 GetByteSize() const | [] |
FSpirv::GetWordOffset | /Engine/Source/Developer/ShaderCompilerCommon/Public/SpirvCommon.h | Returns the word offset to the instruction the specified iterator points to plus additional operand word offset. | ShaderCompilerCommon | uint32 GetWordOffset ( const [FSpirvConstIterator](API\Developer\ShaderCompilerCommon\FSpirvConstIterator) & Iter, uint32 OperandWordOffset ) const | [] |
FSpirv | /Engine/Source/Developer/ShaderCompilerCommon/Public/SpirvCommon.h | Base structure for SPIR-V modules in the shader backends. | ShaderCompilerCommon | struct FSpirv | [
{
"type": "TArray< uint32 ...",
"name": "Data",
"description": ""
}
] |
FSpirvConstIterator | /Engine/Source/Developer/ShaderCompilerCommon/Public/SpirvCommon.h | ShaderCompilerCommon | typedef [TSpirvForwardIterator](API\Developer\ShaderCompilerCommon\TSpirvForwardIterator)< const uint32 > FSpirvConstIterator | [] |
|
FSpirvIterator | /Engine/Source/Developer/ShaderCompilerCommon/Public/SpirvCommon.h | ShaderCompilerCommon | typedef [TSpirvForwardIterator](API\Developer\ShaderCompilerCommon\TSpirvForwardIterator)< uint32 > FSpirvIterator | [] |
|
FSpirvReflectBindings::AddDescriptorBinding | /Engine/Source/Developer/ShaderCompilerCommon/Public/SpirvReflectCommon.h | Adds the specified descriptor binding to the corresponding container iff the descriptor is marked as being accessed. | ShaderCompilerCommon | void AddDescriptorBinding ( SpvReflectDescriptorBinding * InBinding ) | [] |
FSpirvReflectBindings::AssignInputAttributeLocationsBySemanticIndex | /Engine/Source/Developer/ShaderCompilerCommon/Public/SpirvReflectCommon.h | Assigns the binding location for all input attributes by its semantic index if their name is equal to 'SemanticName'. Used for vertex shaders where all input attributes have the "ATTRIBUTE" semantic. | ShaderCompilerCommon | void AssignInputAttributeLocationsBySemanticIndex ( spv_reflect::ShaderModule & SpirvReflection, const ANSICHAR * SemanticName ) | [] |
FSpirvReflectBindings::GatherDescriptorBindings | /Engine/Source/Developer/ShaderCompilerCommon/Public/SpirvReflectCommon.h | Gathers all descriptor bindings from the specified SPIRV-Reflect module. | ShaderCompilerCommon | void GatherDescriptorBindings ( const spv_reflect::ShaderModule & SpirvReflection ) | [] |
FSpirvReflectBindings::GatherInputAttributes | /Engine/Source/Developer/ShaderCompilerCommon/Public/SpirvReflectCommon.h | Gathers all input interface variables from the specified SPIRV-Reflect module. | ShaderCompilerCommon | void GatherInputAttributes ( const spv_reflect::ShaderModule & SpirvReflection ) | [] |
FSpirvReflectBindings::GatherOutputAttributes | /Engine/Source/Developer/ShaderCompilerCommon/Public/SpirvReflectCommon.h | Gathers all output interface variables from the specified SPIRV-Reflect module. | ShaderCompilerCommon | void GatherOutputAttributes ( const spv_reflect::ShaderModule & SpirvReflection ) | [] |
GetNumUniformBuffersUsed | /Engine/Source/Developer/ShaderCompilerCommon/Public/ShaderCompilerCommon.h | Finds the number of used uniform buffers in a resource map. | ShaderCompilerCommon | int16 GetNumUniformBuffersUsed ( const [FShaderCompilerResourceTable](API\Runtime\RenderCore\FShaderCompilerResourceTable) & InSRT ) | [] |
FSpirvReflectBindings | /Engine/Source/Developer/ShaderCompilerCommon/Public/SpirvReflectCommon.h | Container structure for all SPIR-V reflection resources and in/out attributes. | ShaderCompilerCommon | struct FSpirvReflectBindings | [
{
"type": "TArray< SpvRefl...",
"name": "AccelerationStructures",
"description": ""
},
{
"type": "TSet< SpvReflec...",
"name": "AtomicCounters",
"description": ""
},
{
"type": "TArray< SpvRefl...",
"name": "InputAttachments",
"description": ""
},
{
"type": "TArray< SpvRefl...",
"name": "InputAttributes",
"description": ""
},
{
"type": "TArray< SpvRefl...",
"name": "OutputAttributes",
"description": ""
},
{
"type": "TArray< SpvRefl...",
"name": "Samplers",
"description": ""
},
{
"type": "TArray< SpvRefl...",
"name": "SBufferSRVs",
"description": ""
},
{
"type": "TArray< SpvRefl...",
"name": "SBufferUAVs",
"description": ""
},
{
"type": "TArray< SpvRefl...",
"name": "TBufferSRVs",
"description": ""
},
{
"type": "TArray< SpvRefl...",
"name": "TBufferUAVs",
"description": ""
},
{
"type": "TArray< SpvRefl...",
"name": "TextureSRVs",
"description": ""
},
{
"type": "TArray< SpvRefl...",
"name": "TextureUAVs",
"description": ""
},
{
"type": "TArray< SpvRefl...",
"name": "UniformBuffers",
"description": ""
}
] |
HandleReflectedGlobalConstantBufferMember | /Engine/Source/Developer/ShaderCompilerCommon/Public/ShaderCompilerCommon.h | ShaderCompilerCommon | void HandleReflectedGlobalConstantBufferMember ( const [FString](API\Runtime\Core\Containers\FString) & MemberName, uint32 ConstantBufferIndex, int32 ReflectionOffset, int32 ReflectionSize, [FShaderCompilerOutput](API\Runtime\RenderCore\FShaderCompilerOutput) & CompilerOutput ) | [] |
|
HandleReflectedRootConstantBufferMember | /Engine/Source/Developer/ShaderCompilerCommon/Public/ShaderCompilerCommon.h | ShaderCompilerCommon | void HandleReflectedRootConstantBufferMember ( const [FShaderCompilerInput](API\Runtime\RenderCore\FShaderCompilerInput) & Input, const [FShaderParameterParser](API\Runtime\RenderCore\FShaderParameterParser) & ShaderParameterParser, const [FString](API\Runtime\Core\Containers\FString) & MemberName, int32 ReflectionOffset, int32 ReflectionSize, [FShaderCompilerOutput](API\Runtime\RenderCore\FShaderCompilerOutput) & CompilerOutput ) | [] |
|
HandleReflectedRootConstantBuffer | /Engine/Source/Developer/ShaderCompilerCommon/Public/ShaderCompilerCommon.h | ShaderCompilerCommon | void HandleReflectedRootConstantBuffer ( int32 ConstantBufferSize, [FShaderCompilerOutput](API\Runtime\RenderCore\FShaderCompilerOutput) & CompilerOutput ) | [] |
|
HandleReflectedShaderResource | /Engine/Source/Developer/ShaderCompilerCommon/Public/ShaderCompilerCommon.h | ShaderCompilerCommon | void HandleReflectedShaderResource ( const [FString](API\Runtime\Core\Containers\FString) & ResourceName, int32 ReflectionSlot, [FShaderCompilerOutput](API\Runtime\RenderCore\FShaderCompilerOutput) & CompilerOutput ) | [] |
|
HandleReflectedShaderResource | /Engine/Source/Developer/ShaderCompilerCommon/Public/ShaderCompilerCommon.h | ShaderCompilerCommon | void HandleReflectedShaderResource ( const [FString](API\Runtime\Core\Containers\FString) & ResourceName, int32 ReflectionSlot, int32 BindCount, [FShaderCompilerOutput](API\Runtime\RenderCore\FShaderCompilerOutput) & CompilerOutput ) | [] |
|
HandleReflectedShaderResource | /Engine/Source/Developer/ShaderCompilerCommon/Public/ShaderCompilerCommon.h | ShaderCompilerCommon | void HandleReflectedShaderResource ( const [FString](API\Runtime\Core\Containers\FString) & ResourceName, int32 BindOffset, int32 ReflectionSlot, int32 BindCount, [FShaderCompilerOutput](API\Runtime\RenderCore\FShaderCompilerOutput) & CompilerOutput ) | [] |
|
HandleReflectedShaderSampler | /Engine/Source/Developer/ShaderCompilerCommon/Public/ShaderCompilerCommon.h | ShaderCompilerCommon | void HandleReflectedShaderSampler ( const [FString](API\Runtime\Core\Containers\FString) & SamplerName, int32 ReflectionSlot, [FShaderCompilerOutput](API\Runtime\RenderCore\FShaderCompilerOutput) & CompilerOutput ) | [] |
|
HandleReflectedShaderSampler | /Engine/Source/Developer/ShaderCompilerCommon/Public/ShaderCompilerCommon.h | ShaderCompilerCommon | void HandleReflectedShaderSampler ( const [FString](API\Runtime\Core\Containers\FString) & SamplerName, int32 ReflectionSlot, int32 BindCount, [FShaderCompilerOutput](API\Runtime\RenderCore\FShaderCompilerOutput) & CompilerOutput ) | [] |
|
HandleReflectedShaderSampler | /Engine/Source/Developer/ShaderCompilerCommon/Public/ShaderCompilerCommon.h | ShaderCompilerCommon | void HandleReflectedShaderSampler ( const [FString](API\Runtime\Core\Containers\FString) & SamplerName, int32 BindOffset, int32 ReflectionSlot, int32 BindCount, [FShaderCompilerOutput](API\Runtime\RenderCore\FShaderCompilerOutput) & CompilerOutput ) | [] |
|
HandleReflectedShaderUAV | /Engine/Source/Developer/ShaderCompilerCommon/Public/ShaderCompilerCommon.h | ShaderCompilerCommon | void HandleReflectedShaderUAV ( const [FString](API\Runtime\Core\Containers\FString) & UAVName, int32 ReflectionSlot, [FShaderCompilerOutput](API\Runtime\RenderCore\FShaderCompilerOutput) & CompilerOutput ) | [] |
|
HandleReflectedShaderUAV | /Engine/Source/Developer/ShaderCompilerCommon/Public/ShaderCompilerCommon.h | ShaderCompilerCommon | void HandleReflectedShaderUAV ( const [FString](API\Runtime\Core\Containers\FString) & UAVName, int32 ReflectionSlot, int32 BindCount, [FShaderCompilerOutput](API\Runtime\RenderCore\FShaderCompilerOutput) & CompilerOutput ) | [] |
|
HandleReflectedShaderUAV | /Engine/Source/Developer/ShaderCompilerCommon/Public/ShaderCompilerCommon.h | ShaderCompilerCommon | void HandleReflectedShaderUAV ( const [FString](API\Runtime\Core\Containers\FString) & UAVName, int32 BindOffset, int32 ReflectionSlot, int32 BindCount, [FShaderCompilerOutput](API\Runtime\RenderCore\FShaderCompilerOutput) & CompilerOutput ) | [] |
|
HandleReflectedUniformBufferConstantBufferMember | /Engine/Source/Developer/ShaderCompilerCommon/Public/ShaderCompilerCommon.h | ShaderCompilerCommon | void HandleReflectedUniformBufferConstantBufferMember ( int32 UniformBufferSlot, const [FString](API\Runtime\Core\Containers\FString) & MemberName, int32 ReflectionOffset, int32 ReflectionSize, [FShaderCompilerOutput](API\Runtime\RenderCore\FShaderCompilerOutput) & CompilerOutput ) | [] |
|
HandleReflectedUniformBuffer | /Engine/Source/Developer/ShaderCompilerCommon/Public/ShaderCompilerCommon.h | ShaderCompilerCommon | void HandleReflectedUniformBuffer ( const [FString](API\Runtime\Core\Containers\FString) & UniformBufferName, int32 ReflectionSlot, [FShaderCompilerOutput](API\Runtime\RenderCore\FShaderCompilerOutput) & CompilerOutput ) | [] |
|
HandleReflectedUniformBuffer | /Engine/Source/Developer/ShaderCompilerCommon/Public/ShaderCompilerCommon.h | ShaderCompilerCommon | void HandleReflectedUniformBuffer ( const [FString](API\Runtime\Core\Containers\FString) & UniformBufferName, int32 ReflectionSlot, int32 BufferSize, [FShaderCompilerOutput](API\Runtime\RenderCore\FShaderCompilerOutput) & CompilerOutput ) | [] |
|
HandleReflectedUniformBuffer | /Engine/Source/Developer/ShaderCompilerCommon/Public/ShaderCompilerCommon.h | ShaderCompilerCommon | void HandleReflectedUniformBuffer ( const [FString](API\Runtime\Core\Containers\FString) & UniformBufferName, int32 ReflectionSlot, int32 BaseIndex, int32 BufferSize, [FShaderCompilerOutput](API\Runtime\RenderCore\FShaderCompilerOutput) & CompilerOutput ) | [] |
|
PatchSpirvEntryPointWithCRC | /Engine/Source/Developer/ShaderCompilerCommon/Public/SpirvCommon.h | Renames the fixed-size entry point name (which must be "main_00000000_00000000") to the formatted name including a CRC over the module. Returns the new entry point name. | ShaderCompilerCommon | const ANSICHAR * PatchSpirvEntryPointWithCRC ( [FSpirv](API\Developer\ShaderCompilerCommon\FSpirv) & Spirv, uint32 & OutCRC ) | [] |
RemoveUnusedInputs | /Engine/Source/Developer/ShaderCompilerCommon/Public/ShaderCompilerCommon.h | ShaderCompilerCommon | bool RemoveUnusedInputs ( [FString](API\Runtime\Core\Containers\FString) & InOutSourceCode, const [TArray](API\Runtime\Core\Containers\TArray)< [FString](API\Runtime\Core\Containers\FString) > & InUsedInputs, [FString](API\Runtime\Core\Containers\FString) & InOutEntryPoint, [TArray](API\Runtime\Core\Containers\TArray)< [FString](API\Runtime\Core\Containers\FString) > & OutErrors ) | [] |
|
RemoveUniformBuffersFromSource | /Engine/Source/Developer/ShaderCompilerCommon/Public/ShaderCompilerCommon.h | The cross compiler doesn't yet support struct initializers needed to construct static structs for uniform buffers Replace all uniform buffer struct member references (View.WorldToClip) with a flattened name that removes the struct dependency (View_WorldToClip) | ShaderCompilerCommon | void RemoveUniformBuffersFromSource ( const [FShaderCompilerEnvironment](API\Runtime\RenderCore\FShaderCompilerEnvironment) & Environment, [FString](API\Runtime\Core\Containers\FString) & PreprocessedShaderSource ) | [] |
RemoveUnusedOutputs | /Engine/Source/Developer/ShaderCompilerCommon/Public/ShaderCompilerCommon.h | ShaderCompilerCommon | bool RemoveUnusedOutputs ( [FString](API\Runtime\Core\Containers\FString) & InOutSourceCode, const [TArray](API\Runtime\Core\Containers\TArray)< [FString](API\Runtime\Core\Containers\FString) > & InUsedOutputs, const [TArray](API\Runtime\Core\Containers\TArray)< [FString](API\Runtime\Core\Containers\FString) > & InExceptions, [FString](API\Runtime\Core\Containers\FString) & InOutEntryPoint, [TArray](API\Runtime\Core\Containers\TArray)< [FString](API\Runtime\Core\Containers\FString) > & OutErrors ) | [] |
|
TransformStringIntoCharacterArray | /Engine/Source/Developer/ShaderCompilerCommon/Public/ShaderCompilerCommon.h | Processes TEXT macros. | ShaderCompilerCommon | void TransformStringIntoCharacterArray ( [FString](API\Runtime\Core\Containers\FString) & PreprocessedShaderSource ) | [] |
TSpirvForwardIterator::Opcode | /Engine/Source/Developer/ShaderCompilerCommon/Public/SpirvCommon.h | Returns the opcode of the current instruction. | ShaderCompilerCommon | SpvOp Opcode() const | [] |
TSpirvForwardIterator::Operand | /Engine/Source/Developer/ShaderCompilerCommon/Public/SpirvCommon.h | Dereferences the value the current operand points to. | ShaderCompilerCommon | uint32 Operand ( int32 WordOffset ) const | [] |
TSpirvForwardIterator::OperandAs | /Engine/Source/Developer/ShaderCompilerCommon/Public/SpirvCommon.h | Returns the operand as the specified reinterpreted type. | ShaderCompilerCommon | template<typename TDst> TDst OperandAs ( int32 WordOffset ) const | [] |
TSpirvForwardIterator::OperandAsString | /Engine/Source/Developer/ShaderCompilerCommon/Public/SpirvCommon.h | Returns the operand pointer as ANSI C string. | ShaderCompilerCommon | const ANSICHAR * OperandAsString ( int32 WordOffset ) const | [] |
TSpirvForwardIterator::operator= | /Engine/Source/Developer/ShaderCompilerCommon/Public/SpirvCommon.h | ShaderCompilerCommon | [TSpirvForwardIterator](API\Developer\ShaderCompilerCommon\TSpirvForwardIterator) & operator= ( const [TSpirvForwardIterator](API\Developer\ShaderCompilerCommon\TSpirvForwardIterator) & Other ) | [] |
|
TSpirvForwardIterator::operator== | /Engine/Source/Developer/ShaderCompilerCommon/Public/SpirvCommon.h | Returns whether this iterator points to the same address as the other iterator. | ShaderCompilerCommon | bool operator== ( const [TSpirvForwardIterator](API\Developer\ShaderCompilerCommon\TSpirvForwardIterator) & Other ) const | [] |
TSpirvForwardIterator::operator!= | /Engine/Source/Developer/ShaderCompilerCommon/Public/SpirvCommon.h | Returns whether this iterator does not point to the same address as the other iterator. | ShaderCompilerCommon | bool operator!= ( const [TSpirvForwardIterator](API\Developer\ShaderCompilerCommon\TSpirvForwardIterator) & Other ) const | [] |
TSpirvForwardIterator::operator++ | /Engine/Source/Developer/ShaderCompilerCommon/Public/SpirvCommon.h | Increments the iterator to point to the next SPIR-V instruction and returns the previous iterator state. | ShaderCompilerCommon | [TSpirvForwardIterator](API\Developer\ShaderCompilerCommon\TSpirvForwardIterator) operator++ ( int ) | [] |
TSpirvForwardIterator::operator* | /Engine/Source/Developer/ShaderCompilerCommon/Public/SpirvCommon.h | Returns a pointer to the beginning of the SPIR-V instruction this iterator currently points to. | ShaderCompilerCommon | T * operator*() const | [] |
TSpirvForwardIterator::operator++ | /Engine/Source/Developer/ShaderCompilerCommon/Public/SpirvCommon.h | Increments the iterator to point to the next SPIR-V instruction. | ShaderCompilerCommon | [TSpirvForwardIterator](API\Developer\ShaderCompilerCommon\TSpirvForwardIterator) & operator++() | [] |
TSpirvForwardIterator::WordCount | /Engine/Source/Developer/ShaderCompilerCommon/Public/SpirvCommon.h | Returns the word count of the current instruction. A valid SPIR-V instruction must have a word count greater zero. | ShaderCompilerCommon | uint32 WordCount() const | [] |
TSpirvForwardIterator::TSpirvForwardIterator | /Engine/Source/Developer/ShaderCompilerCommon/Public/SpirvCommon.h | Initializes the iterator with a null pointer. | ShaderCompilerCommon | TSpirvForwardIterator() | [] |
TSpirvForwardIterator::TSpirvForwardIterator | /Engine/Source/Developer/ShaderCompilerCommon/Public/SpirvCommon.h | ShaderCompilerCommon | TSpirvForwardIterator ( const [TSpirvForwardIterator](API\Developer\ShaderCompilerCommon\TSpirvForwardIterator) & Other ) | [] |
|
TSpirvForwardIterator::TSpirvForwardIterator | /Engine/Source/Developer/ShaderCompilerCommon/Public/SpirvCommon.h | Initializes the iterator with the specified pointer. | ShaderCompilerCommon | TSpirvForwardIterator ( T * InPtr, bool bPointsAtHeader ) | [] |
TSpirvForwardIterator | /Engine/Source/Developer/ShaderCompilerCommon/Public/SpirvCommon.h | Template forward iterator for SPIR-V instructions. | ShaderCompilerCommon | template<typename T> class TSpirvForwardIterator | [] |
Subsets and Splits
No community queries yet
The top public SQL queries from the community will appear here once available.