RenderCore

Choose your operating system:

Windows

macOS

Linux

Filters

Classes

Name

Description

Public struct

DispatchContext

Public struct

FAdaptiveVTDescription

Describes an adaptive virtual texture.

Public struct

FAllocatedVTDescription

Parameters needed to create an IAllocatedVirtualTexture Describes both page table and physical texture size, format, and layout

Public class

FAYUVConvertPS

Pixel shader to convert an AYUV texture to RGBA.

Public struct

FBaseShaderResourceTable

Public class

FBMPConvertPS

Pixel shader to convert a Windows Bitmap texture.

Public class

FBufferWithRDG

Public struct

FCachedUniformBufferDeclaration

Public struct

FClearQuadCallbacks

Public class

FClearVertexBuffer

Public struct

FCompactFullName

Public class

FCompareShaderPipelineNameTypes

Used to compare two shader pipeline types by name.

Public class

FCompareShaderTypes

Used to compare two shader types by name.

Public class

FCompareVertexFactoryTypes

Used to compare two Vertex Factory types by name.

Public struct

FCompressedTransform

Public struct

FComputeShaderUtils

All utils for compute shaders.

Public class

FCopyRectPS

Pixel shader to copy pixels from src to dst performing a format change that works on all platforms.

Public class

FCopyTextureCS

Public class

FCubeIndexBuffer

Public class

FDeferredCleanupInterface

Deferred cleanup.

Public class

FDeprecatedSerializedPackedNormal

Public struct

FDepthStencilBinding

Render graph information about how to bind a depth-stencil render target.

Public struct

FDummyResolveParameter

Public struct

FDynamicAllocReadBuffer

Public class

FEmptyShaderParameters

An empty shader parameter structure ready to be used anywhere.

Public class

FEmptyVertexDeclaration

The empty vertex declaration resource type.

Public struct

FExtraShaderCompilerSettings

Additional compilation settings that can be configured by each FMaterial instance before compilation

Public class

FFillTextureCS

Compute shader for writing values

Public struct

FFilterVertex

The vertex data used to filter a texture.

Public class

FFilterVertexDeclaration

The filter vertex declaration resource type.

Public struct

FGBufferBinding

Public struct

FGBufferCompressionInfo

Public struct

FGBufferInfo

Public struct

FGBufferItem

The texture positions in the GBuffer

Public struct

FGBufferPacking

Public struct

FGBufferParams

Public struct

FGBufferTarget

Public class

FGenerateMips

Public struct

FGenerateMipsParams

Public struct

FGlobalBoundShaderState

Public struct

FGlobalBoundShaderStateArgs

Public class

FGlobalBoundShaderStateResource

FGlobalBoundShaderState

Public struct

FGlobalBoundShaderStateWorkArea

Public class

FGlobalDynamicIndexBuffer

A system for dynamically allocating GPU memory for indices.

Public class

FGlobalDynamicReadBuffer

A system for dynamically allocating GPU memory for rendering.

Public class

FGlobalDynamicVertexBuffer

A system for dynamically allocating GPU memory for vertices.

Public class

FGlobalShader

FGlobalShader

Public struct

FGlobalShaderBackupData

Container for Backup/RestoreGlobalShaderMap functions.

Public class

FGlobalShaderMap

Public class

FGlobalShaderMapContent

Public class

FGlobalShaderMapId

Class that encapsulates logic to create a DDC key for the global shader map.

Public class

FGlobalShaderMapSection

Public struct

FGlobalShaderPermutationParameters

Public class

FGlobalShaderType

A shader meta type for the simplest shaders; shaders which are not material or vertex factory linked.

Public class

FHandler

Base class persistent handler for receiving messages.

Public class

FIndexBuffer

An index buffer resource.

Public struct

FInputLatencyTimer

Encapsulates a latency timer that measures the time from when mouse input is read on the gamethread until that frame is fully displayed by the GPU.

Public class

FIoStoreShaderCodeArchive

Public struct

FIoStoreShaderCodeEntry

Public struct

FIoStoreShaderMapEntry

Public class

FLongGPUTaskPS

Public struct

FMediaElementVertex

Stores media drawing vertices.

Public class

FMediaShadersVS

Media vertex shader (shared by all media shaders).

Public class

FMediaVertexDeclaration

The simple element vertex declaration resource type.

Public struct

FMemcpyResourceParams

Public struct

FMemsetResourceParams

Can store arbitrary data so long as it follows alignment restrictions.

Public struct

FMipBiasFade

Functionality for fading in/out texture mip-levels.

Public struct

FMipFadeSettings

Mip fade settings, selectable by chosing a different EMipFadeSettings.

Public class

FModifyAlphaSwizzleRgbaPS

Pixel shader to swizzle R G B A components, set alpha to 1 or inverts alpha

Public class

FNullColorVertexBuffer

A vertex buffer with a single color component.

Public class

FNULLPS

An internal dummy pixel shader to use when the user calls RHISetPixelShader(NULL).

Public class

FNullVertexBuffer

A vertex buffer with a single zero float3 component.

Public class

FNV12ConvertAsBytesPS

Pixel shader to convert a NV12 frame to RGBA (NV12 data; texture viewed as G8)

Public class

FNV12ConvertPS

Pixel shader to convert a NV12 frame to RGBA.

Public class

FNV21ConvertPS

Pixel shader to convert a NV21 frame to RGBA.

Public class

FOculusAlphaInverseShader

Public class

FOculusBlackShader

Public class

FOculusCubemapPS

A pixel shader for rendering a textured screen element.

Public class

FOculusVertexShader

Public class

FOculusWhiteShader

Public class

FOneColorPS

Pixel shader for rendering a single, constant color.

Public struct

FPackedArrayInfo

Public struct

FPackedNormal

A normal vector, quantized and packed into 32-bits.

Public struct

FPackedPosition

A 3x1 of xyz(11:11:10) format.

Public struct

FPackedRGB10A2N

A vector, quantized and packed into 32-bits.

Public struct

FPackedRGBA16N

A vector, quantized and packed into 32-bits.

Public struct

FParameterAllocation

Public class

FParameters

Shader parameters used to write to write a GPU message.

Public class

FPendingCleanupObjects

A set of cleanup objects which are pending deletion.

Public struct

FPermsPerPSO

Describes a PSO with an array of other stable shaders that could be used with it.

Public struct

FPermutation

Describes a particular combination of shaders.

Public class

FPixelInspectorRequest

Class use to add FScene pixel inspect request

Public struct

FPixelShaderUtils

All utils for pixel shaders.

Public struct

FPooledRenderTarget

The reference to a pooled render target, use like this: TRefCountPtr

Public struct

FPooledRenderTargetDesc

All necessary data to create a render target from the pooled render targets.

Public class

FPostOpaqueRenderParameters

Public class

FPrimitiveIdDummyBuffer

Default PrimitiveId vertex buffer.

Public class

FPrimitiveIdDummyBufferMobile

Public struct

FRayGenShaderUtils

All utils for ray generation shaders.

Public class

FRayTracingGeometry

A ray tracing geometry resource

Public class

FRDGAllocator

Private allocator used by RDG to track its internal memory.

Public class

FRDGAllocatorScope

Base class for RDG builder which scopes the allocations and releases them in the destructor.

Public class

FRDGAsyncComputeBudgetScopeGuard

Public class

FRDGBarrierBatchBegin

Public struct

FRDGBarrierBatchBeginId

Public class

FRDGBarrierBatchEnd

Public struct

FRDGBarrierBatchEndId

Public class

FRDGBarrierValidation

This class validates and logs barriers submitted by the graph.

Public class

FRDGBlackboard

The blackboard is a map of struct instances with a lifetime tied to a render graph allocator.

Public class

FRDGBuffer

A render graph tracked buffer.

Public class

FRDGBufferAccess

Public struct

FRDGBufferDesc

Descriptor for render graph tracked Buffer.

Public class

FRDGBufferSRV

Render graph tracked buffer SRV.

Public struct

FRDGBufferSRVDesc

Public class

FRDGBufferUAV

Render graph tracked buffer UAV.

Public struct

FRDGBufferUAVDesc

Public class

FRDGBuilder

Use the render graph builder to build up a graph of passes and then call Execute() to process them.

Public class

FRDGEventName

GPU Events - Named hierarchical events emitted to external profiling tools.

Public class

FRDGEventScope

Public class

FRDGEventScopeGuard

Public class

FRDGEventScopeOpArray

Public class

FRDGEventScopeStack

Manages a stack of event scopes.

Public struct

FRDGGPUScopeOpArrays

Public struct

FRDGGPUScopes

Public struct

FRDGGPUScopeStacks

The complete set of scope stack implementations.

Public struct

FRDGGPUScopeStacksByPipeline

Public class

FRDGGPUStatScope

GPU Stats - Aggregated counters emitted to the runtime 'stat GPU' profiler.

Public class

FRDGGPUStatScopeGuard

Public class

FRDGGPUStatScopeOp

Public class

FRDGGPUStatScopeOpArray

Public class

FRDGGPUStatScopeStack

Public class

FRDGLogFile

Public class

FRDGParameter

A helper class for identifying and accessing a render graph pass parameter.

Public class

FRDGParameterStruct

Wraps a pass parameter struct payload and provides helpers for traversing members.

Public class

FRDGParentResource

A render graph resource with an allocation lifetime tracked by the graph.

Public class

FRDGPass

Base class of a render graph pass.

Public class

FRDGPooledBuffer

Public class

FRDGPooledTexture

Public struct

FRDGProducerState

Used for tracking pass producer / consumer edges in the graph for culling and pipe fencing.

Public class

FRDGResource

Generic graph resource.

Public class

FRDGResourceAccessFinalizer

Batches up RDG resource access finalizations and submits them all at once to RDG.

Public class

FRDGSentinelPass

Render graph pass used for the prologue / epilogue passes.

Public class

FRDGShaderResourceView

Render graph tracked SRV.

Public struct

FRDGSubresourceState

Used for tracking the state of an individual subresource during execution.

Public class

FRDGTexture

Render graph tracked Texture.

Public class

FRDGTextureAccess

Public struct

FRDGTextureMSAA

Simple pair of RDG textures used for MSAA.

Public class

FRDGTextureSRV

Render graph tracked SRV.

Public class

FRDGTextureSRVDesc

Descriptor for render graph tracked SRV.

Public struct

FRDGTextureSubresource

Public struct

FRDGTextureSubresourceLayout

Public struct

FRDGTextureSubresourceRange

Public class

FRDGTextureUAV

Render graph tracked texture UAV.

Public class

FRDGTextureUAVDesc

Descriptor for render graph tracked UAV.

Public class

FRDGUniformBuffer

Public class

FRDGUniformBufferBinding

Public class

FRDGUnorderedAccessView

Render graph tracked UAV.

Public struct

FRDGUploadData

Helper class to allocate data from a GraphBuilder in order to upload said data to an RDG resource.

Public class

FRDGUserValidation

Used by the render graph builder to validate correct usage of the graph API from setup to execution.

Public class

FRDGView

A render graph resource (e.g. a view) which references a single parent resource (e.g. a texture / buffer).

Public class

FRDGWaitForTasksScope

Scope used to wait for outstanding tasks when the scope destructor is called.

Public class

FReadbackBufferParameters

Public class

FReadbackTextureParameters

Public class

FReader

Interface for the handelr to read data from the GPU buffer during readback.

Public class

FReadTextureExternalPS

Pixel shader to read from TextureExternal source

Public struct

FRenderBounds

Public class

FRenderCommand

Render commands.

Public class

FRenderCommandFence

Render fences.

Public class

FRenderResource

A rendering resource which is owned by the rendering thread.

Public struct

FRenderTargetBinding

Render graph information about how to bind a render target.

Public struct

FRenderTargetBindingSlots

Special shader parameters type for a pass parameter to setup render targets.

Public class

FRenderTargetParameters

Useful parameter struct that only have render targets.

Public class

FRenderTargetPool

Encapsulates the render targets pools that allows easy sharing (mostly used on the render thread side)

Public class

FRenderThreadScope

RenderThread scoped work.

Public struct

FRenderTransform

TODO: Further compress data size with tighter encoding LWC_TODO: Rebasing support (no 64bit types in here) TODO: Optimization (avoid full 4x4 math)

Public struct

FResizeResourceSOAParams

Public class

FResolveDepth2XPS

Public class

FResolveDepth4XPS

Public class

FResolveDepth8XPS

Public class

FResolveDepthPS

Public class

FResolveSingleSamplePS

Public class

FResolveVS

A vertex shader for rendering a textured screen element.

Public struct

FResourceTableEntry

Each entry in a resource table is provided to the shader compiler for creating mappings.

Public class

FRGB10toYUVv210ConvertPS

Pixel shader to convert RGB 10 bits to YUV v210

Public class

FRGB8toUYVY8ConvertPS

Pixel shader to convert RGB 8 bits to UYVY 8 bits

Public class

FRGB8toY8ConvertPS

Pixel shader to convert RGB 8 bits to Y 8 bits

Public class

FRGBConvertPS

Pixel shader to resize an RGB texture.

Public class

FRWShaderParameter

A class that binds either a UAV or SRV of a resource.

Public class

FScatterUploadBuffer

Public struct

FScenePrimitiveRenderingContextScopeHelper

Public struct

FSceneRenderTargetItem

Single render target item consists of a render surface and its resolve texture, Render thread side

Public class

FScope

RAII object for controlling a new GPU message scope.

Public class

FScopedCapture

Helper for capturing within a scope.

Public class

FScreenRectangleIndexBuffer

Public class

FScreenRectangleVertexBuffer

Static vertex and index buffer used for 2D screen rectangles.

Public class

FScreenSpaceVertexBuffer

Public class

FScreenVertexShaderVS

Vertex shader to draw a screen quad that works on all platforms.

Public class

FSerializationHistory

Encapsulates information about a shader's serialization behavior, used to detect when C++ serialization changes to auto-recompile.

Public class

FSerializationHistoryTraversalState

Tracks state when traversing a FSerializationHistory.

Public class

FSerializedShaderArchive

Portion of shader code archive that's serialize to disk.

Public class

FShader

A compiled shader and its parameter bindings.

Public struct

FShaderBindingInOutMask

Public struct

FShaderBindings

Public class

FShaderCode

Public class

FShaderCodeArchive

Public struct

FShaderCodeEntry

Public struct

FShaderCodeFeatures

Public struct

FShaderCodeLibrary

Collection of unique shader code Populated at cook time

Public struct

FShaderCodeLibraryPipeline

Public struct

FShaderCodeName

If this changes you need to make sure all shaders get invalidated

Public struct

FShaderCodePackedResourceCounts

If this changes you need to make sure all shaders get invalidated

Public class

FShaderCodeReader

Later we can transform that to the actual class passed around at the RHI level

Public struct

FShaderCodeResourceMasks

Public struct

FShaderCodeUniformBuffers

Public struct

FShaderCodeVendorExtension

If this changes you need to make sure all shaders get invalidated

Public struct

FShaderCompiledShaderInitializerType

Public struct

FShaderCompilerDefines

These are also the platform defines.

Public class

FShaderCompilerDefinitions

Container for shader compiler definitions.

Public struct

FShaderCompilerEnvironment

The environment used to compile a shader.

Public struct

FShaderCompilerError

A shader compiler error or warning.

Public class

FShaderCompilerFlags

Simple wrapper for a uint64 bitfield; doesn't use TBitArray as it is fixed size and doesn't need dynamic memory allocations.

Public struct

FShaderCompilerInput

Struct that gathers all readonly inputs needed for the compilation of a single shader.

Public struct

FShaderCompilerOutput

The output of the shader compiler.

Public struct

FShaderCompilerResourceTable

Public struct

FShaderGlobalDefines

Public class

FShaderId

Uniquely identifies an FShader instance.

Public class

FShaderKey

Public struct

FShaderLibraryCooker

Public struct

FShaderLightmapPropertyDefines

Maybe should renamt this to VertexFactoryDefines?

Public class

FShaderLooseParameterBufferInfo

Public class

FShaderMapBase

Public class

FShaderMapContent

A collection of shaders of different types

Public struct

FShaderMapEntry

Public class

FShaderMapPointerTable

Public class

FShaderMapResource

Public class

FShaderMapResource_InlineCode

Public class

FShaderMapResourceCode

Public struct

FShaderMaterialDerivedDefines

Public struct

FShaderMaterialPropertyDefines

Public class

FShaderParameter

A shader parameter's register binding. e.g. float1/2/3/4, can be an array, UAV

Public class

FShaderParameterBindings

Stores all shader parameter bindings and their corresponding offset and size in the shader's parameters struct.

Public class

FShaderParameterInfo

Public class

FShaderParameterMap

A map of shader parameter names to registers allocated to that parameter.

Public class

FShaderParameterMapInfo

Public class

FShaderParametersMetadata

A uniform buffer struct.

Public class

FShaderParametersMetadataBuilder

Public struct

FShaderPermutationBool

Defines at compile time a boolean permutation dimension.

Public struct

FShaderPermutationParameters

Public class

FShaderPipeline

A Shader Pipeline instance with compiled stages.

Public class

FShaderPipelineCache

FShaderPipelineCache: The FShaderPipelineCache provides the new Pipeline State Object (PSO) logging, serialisation & precompilation mechanism that replaces FShaderCache.

Public class

FShaderPipelineRef

Public class

FShaderPipelineType

Binding of a set of shader stages in a single pipeline.

Public class

FShaderPipelineTypeDependency

Public struct

FShaderPlatformCachedIniValue

Public class

FShaderResourceParameter

A shader resource binding (textures or samplerstates).

Public class

FShaderSaveArchive

Archive used when saving shaders, which generates data used to detect serialization mismatches on load.

Public struct

FShaderTarget

Public class

FShaderType

An object which is used to serialize/deserialize, compile, and cache a particular shader class.

Public class

FShaderTypeDependency

Encapsulates a dependency on a shader type and saved state from that shader type.

Public class

FShaderUniformBufferParameter

Public struct

FShaderUsageVisualizer

Run-time only debugging facility

Public struct

FSharedShaderCompilerEnvironment

Public class

FSocket

A socket object mapped to a persistently registered handler.

Public struct

FStableShaderKeyAndValue

Public class

FSuspendRenderingThread

Render thread suspension.

Public class

FTexture

A textures resource.

Public class

FTextureReference

A texture reference resource.

Public struct

FTextureRenderTargetBinding

Public class

FTextureWithSRV

A textures resource that includes an SRV.

Public class

FTickableObjectRenderThread

This class provides common registration for render thread tickable objects.

Public class

FTileVertexDeclaration

Public class

FTimer

The scene rendering stats.The scene update stats.

Public class

FTwoTrianglesIndexBuffer

Public class

FUniformBufferBinding

Public struct

FUniformBufferCopyInfo

Information for copying members from uniform buffers to packed.

Public struct

FUniformBufferEntry

Minimal information about each uniform buffer entry fed to the shader compiler.

Public struct

FUniformBufferNameSortOrder

Public class

FUniformBufferStaticSlotRegistrar

Simple class that registers a uniform buffer static slot in the constructor.

Public class

FUniformBufferStaticSlotRegistry

Registry for uniform buffer static slots.

Public class

FUYVYConvertPS

Pixel shader to convert a UYVY (Y422, UYNV) frame to RGBA.

Public class

FVertexBuffer

A vertex buffer resource

Public class

FVertexBufferWithSRV

Public class

FVertexFactory

Encapsulates a vertex data source which can be linked into a vertex shader.

Public class

FVertexFactoryShaderParameters

An interface to the parameter bindings for the vertex factory used by a shader.

Public class

FVertexFactoryType

An object used to represent the type of a vertex factory.

Public class

FVertexFactoryTypeDependency

Encapsulates a dependency on a vertex factory type and saved state from that vertex factory type.

Public struct

FVertexInputStream

Public struct

FVertexStreamComponent

A typed data source for a vertex factory which streams data from a vertex buffer.

Public struct

FVirtualTextureLocalTile

Identifies a VT tile within a given producer

Public struct

FVirtualTextureProducerHandle

Public struct

FVirtualTextureUniformData

Struct containing all data the GPU needs to perform a lookup/feedback request

Public class

FVisualizeTexture

Public struct

FVTProducerDescription

Public struct

FVTProduceTargetLayer

Describes a location to write a single layer of a VT tile

Public struct

FVTRequestPageResult

Public class

FYCbCrConvertPS

Pixel shader to convert a PS4 YCbCr texture to RGBA.

Public class

FYCbCrConvertPS_4x4Matrix

Public class

FYUVConvertPS

Pixel shader to convert Y, U, and V planes to RGBA.

Public class

FYUVv210ConvertPS

Pixel shader to convert YUV v210 to RGB

Public class

FYUVY416ConvertPS

Pixel shader to convert YUV Y416 to RGB

Public class

FYUY2ConvertPS

Pixel shader to convert a YUY2 frame to RGBA.

Public class

FYVYUConvertPS

Pixel shader to convert a YVYU frame to RGBA.

Public class

IAdaptiveVirtualTexture

Interface for adaptive virtual textures.

Public class

IAllocatedVirtualTexture

This interface represents a chunk of VT data allocated and owned by the renderer module, backed by both a page table texture, and a physical texture cache for each layer.

Public class

ICustomCulling

Public class

ICustomResourcePool

Public class

ICustomVisibilityQuery

Public class

IPersistentViewUniformBufferExtension

Public struct

IPooledRenderTarget

Render thread side, use TRefCountPtr, allows sharing and VisualizeTexture

Public class

IRenderCaptureProvider

Public class

IRendererModule

The public interface of the renderer module.

Public class

IScenePrimitiveRenderingContext

Public class

IVirtualTexture

This is the interface that can produce tiles of virtual texture data This can be extended to represent different ways of generating VT, such as disk streaming, runtime compositing, or whatever It's provided to the renderer module

Public class

IVirtualTextureFinalizer

Public class

SceneRenderingBitArrayAllocator

Public class

SceneRenderingSetAllocator

Public class

SceneRenderingSparseArrayAllocator

Public class

TAlignedShaderParameterPtr

PLATFORM_64BITS.

Public class

TAlignedTypedef

Alignements tools because alignas() does not work on type in clang.

Public class

TBoundShaderStateHistory

A list of the most recently used bound shader states.

Public struct

TClearReplacementBase

Public class

TClearReplacementCS

Public class

TClearReplacementPS

Public struct

TClearReplacementTypeSelector

Public class

TClearReplacementVS

Public class

TCompareShaderTypePermutation

Used to compare order shader types permutation deterministically.

Public class

TCopyResourceCS

Public class

TEnqueueUniqueRenderCommandType

Public class

TGlobalResource

Used to declare a render resource that is initialized/released by static initialization/destruction.

Public class

TLambdaHandler

Lambda persistent handler which calls the provided lambda when a message is received.

Public class

TOneColorPixelShaderMRT

Pixel shader for rendering a single, constant color to MRTs.

Public class

TOneColorVS

Vertex shader for rendering a single, constant color.

Public class

TOptionalShaderMapRef

A reference to an optional shader, initialized with a shader type from a shader map if it is available or nullptr if it is not.

Public class

TRDGArrayAllocator

A container allocator that allocates from a global RDG allocator instance.

Public class

TRDGBufferAccess

Public class

TRDGEmptyLambdaPass

Public class

TRDGHandle

HANDLE UTILITIES Handle helper class for internal tracking of RDG types.

Public class

TRDGHandleBitArray

Specialization of bit array with compile-time type checking for handles and a pre-configured allocator.

Public class

TRDGHandleRegistry

Helper handle registry class for internal tracking of RDG types.

Public class

TRDGHandleUniqueFilter

Esoteric helper class which accumulates handles and will return a valid handle only if a single unique handle was added.

Public class

TRDGLambdaPass

Render graph pass with lambda execute function.

Public class

TRDGParameterStruct

Public class

TRDGResourceAccessArray

Public struct

TRDGResourceAccessTypeInfo

Public class

TRDGScopeOp

Public class

TRDGScopeOpArray

Public class

TRDGScopeStack

A helper profiler class for tracking and evaluating hierarchical scopes in the context of render graph.

Public class

TRDGScopeStackHelper

Public class

TRDGTextureAccess

Public class

TRDGUniformBuffer

Public class

TRDGUniformBufferBinding

Public class

TShaderMap

Public class

TShaderMapRef

A reference which is initialized with the requested shader type from a shader map.

Public struct

TShaderParameterScalarArrayTypeInfo

Upgrade the scalar type to a vector for storage.

Public struct

TShaderParameterStructTypeInfo

Public struct

TShaderParameterTypeInfo

Template to transcode some meta data information for a type not specific to shader parameters API.

Public struct

TShaderPermutationDomain

Variadic template that defines an arbitrary multi-dimensional permutation domain, that can be instantiated to represent a vector within the domain.

Public class

TShaderPermutationDomainSpetialization

C++11 doesn't allow partial specialization of templates method or function.

Public struct

TShaderPermutationInt

Defines at compile time a permutation dimension made of int32 from 0 to N -1.

Public struct

TShaderPermutationSparseInt

Defines at compile time a permutation dimension made of specific int32.

Public class

TShaderRefBase

Public class

TShaderResourceParameterArray

Static array of shader resource shader that is initialized to nullptr.

Public struct

TShaderResourceParameterTypeInfo

Public struct

TShaderTypePermutation

Define a shader permutation uniquely according to its type, and permutation id.

Public class

TShaderUniformBufferParameter

A shader uniform buffer binding with a specific structure.

Public struct

TThreadGroupSize

Public struct

TThreadGroupSize

Public class

TUniformBuffer

A uniform buffer resource.

Public class

TUniformBufferBinding

Public class

TUniformBufferRef

A reference to a uniform buffer RHI resource with a specific structure.

Public struct

TVertexFactoryParameterTraits

Constants

Name

Description

DebugUtilColor

Typedefs

Name

Description

ERDGTextureMetaDataAccess

FClearReplacementBase_Float_Bounds

FClearReplacementBase_Float4

FClearReplacementBase_Float4_Bounds

FClearReplacementBase_Float4_Zero

FClearReplacementBase_Float4_Zero_Bounds

FClearReplacementBase_Sint4_Bounds

FClearReplacementBase_Uint

Not all combinations are defined here. Add more if required. Type NC Zero Bounds

FClearReplacementBase_Uint_Bounds

FClearReplacementBase_Uint_Zero

FClearReplacementBase_Uint4

FClearReplacementBase_Uint4_Bounds

FClearReplacementCS_Buffer_Float_Bounds

FClearReplacementCS_Buffer_Float4_Bounds

FClearReplacementCS_Buffer_Sint4_Bounds

FClearReplacementCS_Buffer_Uint

FClearReplacementCS_Buffer_Uint_Bounds

Compute shaders for clearing each resource type, with a min/max bounds enabled.

FClearReplacementCS_Buffer_Uint_Zero

Compute shaders for clearing each resource type. No bounds checks enabled.

FClearReplacementCS_Buffer_Uint4

FClearReplacementCS_Buffer_Uint4_Bounds

FClearReplacementCS_LargeBuffer_Float_Bounds

FClearReplacementCS_LargeBuffer_Float4_Bounds

FClearReplacementCS_LargeBuffer_Sint4_Bounds

FClearReplacementCS_LargeBuffer_Uint

FClearReplacementCS_LargeBuffer_Uint_Bounds

FClearReplacementCS_LargeBuffer_Uint4

FClearReplacementCS_LargeBuffer_Uint4_Bounds

FClearReplacementCS_StructuredBuffer_Float_Bounds

FClearReplacementCS_StructuredBuffer_Float4_Bounds

FClearReplacementCS_StructuredBuffer_Sint4_Bounds

FClearReplacementCS_StructuredBuffer_Uint

FClearReplacementCS_StructuredBuffer_Uint_Bounds

FClearReplacementCS_StructuredBuffer_Uint_Zero

FClearReplacementCS_StructuredBuffer_Uint4

FClearReplacementCS_StructuredBuffer_Uint4_Bounds

FClearReplacementCS_Texture2D_Float4

FClearReplacementCS_Texture2D_Float4_Bounds

FClearReplacementCS_Texture2D_Sint4_Bounds

FClearReplacementCS_Texture2D_Uint4

FClearReplacementCS_Texture2D_Uint4_Bounds

FClearReplacementCS_Texture2DArray_Float4

FClearReplacementCS_Texture2DArray_Float4_Bounds

FClearReplacementCS_Texture2DArray_Sint4_Bounds

FClearReplacementCS_Texture2DArray_Uint

FClearReplacementCS_Texture2DArray_Uint_Zero

FClearReplacementCS_Texture2DArray_Uint4

FClearReplacementCS_Texture2DArray_Uint4_Bounds

FClearReplacementCS_Texture3D_Float4

FClearReplacementCS_Texture3D_Float4_Bounds

FClearReplacementCS_Texture3D_Sint4_Bounds

FClearReplacementCS_Texture3D_Uint4

Used by ClearUAV_T in ClearQuad.cpp.

FClearReplacementCS_Texture3D_Uint4_Bounds

FClearReplacementPS

Simple pixel shader which outputs a specified solid color to MRT0.

FClearReplacementPS_128

FClearReplacementPS_Zero

Simple pixel shader which outputs zero to MRT0.

FClearReplacementVS

Simple vertex shaders for generating screen quads. Optionally with a min/max bounds in NDC space, and depth value.

FClearReplacementVS_Bounds

FClearReplacementVS_Depth

FGlobalBoundShaderState_Internal

FMessageId

FOnPostOpaqueRender

FPostOpaqueRenderDelegate

FRDGArrayAllocator

FRDGBitArrayAllocator

FRDGBufferAccessArray

FRDGBufferBitArray

FRDGBufferHandle

FRDGBufferInitialDataCallback

FRDGBufferInitialDataFreeCallback

FRDGBufferInitialDataSizeCallback

FRDGBufferNumElementsCallback

FRDGBufferRef

FRDGBufferRegistry

FRDGBufferSRVRef

FRDGBufferUAVRef

FRDGDispatchGroupCountCallback

FRDGEventScopeOp

FRDGParentResourceRef

FRDGPassBitArray

FRDGPassesByPipeline

FRDGPassHandle

FRDGPassHandleArray

FRDGPassHandlesByPipeline

FRDGPassRef

FRDGPassRegistry

FRDGPooledBufferArray

FRDGPooledTextureArray

FRDGProducerStatesByPipeline

FRDGResourceRef

FRDGSetAllocator

FRDGShaderResourceViewRef

FRDGSparseArrayAllocator

FRDGTextureAccessArray

FRDGTextureBitArray

FRDGTextureDesc

FORWARD DECLARATIONS

FRDGTextureHandle

FRDGTextureRef

FRDGTextureRegistry

FRDGTextureSRVRef

FRDGTextureSubresourceState

FRDGTextureTransientSubresourceState

FRDGTextureTransientSubresourceStateIndirect

FRDGTextureUAVRef

FRDGTransitionCreateQueue

FRDGTransitionQueue

FRDGUniformBufferBitArray

FRDGUniformBufferHandle

FRDGUniformBufferRef

FRDGUniformBufferRegistry

FRDGUnorderedAccessViewRef

FRDGViewHandle

FRDGViewRef

FRDGViewRegistry

FRDGViewUniqueFilter

FShadereCompiledShaderInitializerType

FShaderMapAssetPaths

FShaderPermutation

FShaderPermutationNone

Global shader permutation domain with no dimension.

FSharedShaderCodeRelease

FSharedShaderCodeRequest

FStopRenderingThread

FStopRenderingThreadDelegate

FThreadSafeSharedStringPtr

FVertexInputStreamArray

Number of vertex input bindings to allocate inline within a FMeshDrawCommand.

FVTProducerDestroyedFunction

SceneRenderingAllocator

Shortcut for the allocator used by scene rendering.

TRDGBufferArrayCallback

TRDGTextureSubresourceArray

TRDGUniformBufferRef

TShaderRef

unaligned_int32

unaligned_uint32

Enums

Name

Description

Public enum

CrossCompiler::

Cross compiler support/common functionality.

Public enum

CrossCompiler::EPackedTypeIndex

Cross compiler support/common functionality.

Public enum

CrossCompiler::EPackedTypeName

Make sure these enums match hlslcc EArray on Engine\Source\ThirdParty\hlslcc\hlslcc\src\hlslcc_lib\glsl_parser_extras.h.

Public enum

CrossCompiler::EShaderStage

Cross compiler support/common functionality.

Public enum

EClearReplacementResourceType

Public enum

EClearReplacementValueType

Public enum

ECompilerFlags

Public enum

EConstructTextureFlags

Flags that control ConstructTexture2D

Public enum

ECopyTextureResourceType

Public enum

ECopyTextureValueType

Public enum

EDrawRectangleFlags

Use r.DrawDenormalizedQuadMode to override the function call setting (quick way to see if an artifact is caused by this optimization)

Public enum

EGBufferChecker

Public enum

EGBufferCompression

Public enum

EGBufferSlot

Public enum

EGBufferType

The actual format of the output texture

Public enum

EGenerateMipsPass

Public enum

EMipFadeSettings

Public enum

ERDGBarrierLocation

Barrier location controls where the barrier is 'Ended' relative to the pass lambda being executed.

Public enum

ERDGBufferFlags

Flags to annotate a render graph buffer.

Public enum

ERDGBuilderFlags

ENUMS

Public enum

ERDGHandleRegistryDestructPolicy

Public enum

ERDGInitialDataFlags

Public enum

ERDGParentResourceType

The set of concrete parent resource types.

Public enum

ERDGPassFlags

Flags to annotate a pass with when calling AddPass.

Public enum

ERDGResourceExtractionFlags

Public enum

ERDGTextureFlags

Flags to annotate a render graph texture.

Public enum

ERDGUnorderedAccessViewFlags

Flags to annotate a view with when calling CreateUAV.

Public enum

ERDGViewType

The set of concrete view types.

Public enum

ERenderTargetTexture

Enum to select between the two RHI textures on a pooled render target.

Public enum

ERenderThreadIdleTypes::Type

Public enum

ERTAccelerationStructureBuildPriority

Public enum

ESCWErrorCode

Public enum

EShaderCodeFeatures

If this changes you need to make sure all shaders get invalidated

Public enum

EShaderParameterFlags

Public enum

EShaderParameterType

Public enum

EShaderPermutationFlags

Flags that can specialize shader permutations compiled for specific platforms.

Public enum

EShaderPrecisionModifier::Type

Public enum

EVertexFactoryFlags

Public enum

EVertexInputStreamType

Public enum

EVertexStreamUsage

Public enum

EVTPageTableFormat

Public enum

EVTProducePageFlags

Public enum

EVTRequestPagePriority

Public enum

EVTRequestPageStatus

Functions

Name Description

Public function

void

 

AddBeginUAVOverlapPass

(
    FRDGBuilder& GraphBuilder
)

AddBeginUAVOverlapPass is deprecated.

Public function

void

 

AddBeginUAVOverlapPass

(
    FRDGBuilder& GraphBuilder,
    TArrayView< FRHIUnorderedAccessView...
)

AddBeginUAVOverlapPass is deprecated.

Public function

void

 

AddBeginUAVOverlapPass

(
    FRDGBuilder& GraphBuilder,
    FRHIUnorderedAccessView* UAV
)

AddBeginUAVOverlapPass is deprecated.

Public function

void

 

AddBufferUploadPass

(
    FRDGBuilder& GraphBuilder,
    FRDGBufferRef Buffer,
    const void* InitialData,
    uint64 InitialDataSize,
    ERDGInitialDataFlags InitialDataFla...
)

Please use GraphBuilder.QueueBufferUpload to perform an upload.

Public function

void

 

AddClearDepthStencilPass

(
    FRDGBuilder& GraphBuilder,
    FRDGTextureRef Texture,
    ERenderTargetLoadAction DepthLoadAc...,
    ERenderTargetLoadAction StencilLoad...
)

Adds a render graph pass to clear a depth stencil target to its optimized clear value using a raster pass.

Public function

void

 

AddClearDepthStencilPass

(
    FRDGBuilder& GraphBuilder,
    FRDGTextureRef Texture,
    bool bClearDepth,
    float Depth,
    bool bClearStencil,
    uint8 Stencil
)

Adds a render graph pass to clear a depth stencil target. Prefer to use clear actions if possible.

Public function

void

 

AddClearRenderTargetPass

(
    FRDGBuilder& GraphBuilder,
    FRDGTextureRef Texture
)

Adds a render graph pass to clear a render target to its clear value.

Public function

void

 

AddClearRenderTargetPass

(
    FRDGBuilder& GraphBuilder,
    FRDGTextureRef Texture,
    const FLinearColor& ClearColor
)

Adds a render graph pass to clear a render target.

Public function

void

 

AddClearRenderTargetPass

(
    FRDGBuilder& GraphBuilder,
    FRDGTextureRef Texture,
    const FLinearColor& ClearColor,
    FIntRect Viewport
)

Adds a render graph pass to clear a render target. Draws a quad to the requested viewport.

Public function

void

 

AddClearStencilPass

(
    FRDGBuilder& GraphBuilder,
    FRDGTextureRef Texture
)

Adds a render graph pass to clear the stencil portion of a depth / stencil target to its fast clear value.

Public function

void

 

AddClearUAVFloatPass

(
    FRDGBuilder& GraphBuilder,
    FRDGBufferUAVRef BufferUAV,
    float Value
)

Public function

void

 

AddClearUAVPass

(
    FRDGBuilder& GraphBuilder,
    FRDGTextureUAVRef TextureUAV,
    uint32 ClearValue
)

Public function

void

 

AddClearUAVPass

(
    FRDGBuilder& GraphBuilder,
    FRDGBufferUAVRef BufferUAV,
    uint32 Value
)

Adds a render graph pass to clear a texture or buffer UAV with a single typed value.

Public function

void

 

AddClearUAVPass

(
    FRDGBuilder& GraphBuilder,
    FRDGTextureUAVRef TextureUAV,
    float ClearValue
)

Public function

void

 

AddClearUAVPass

(
    FRDGBuilder& GraphBuilder,
    FRDGTextureUAVRef TextureUAV,
    const FVector2D& ClearValue
)

Public function

void

 

AddClearUAVPass

(
    FRDGBuilder& GraphBuilder,
    FRDGTextureUAVRef TextureUAV,
    const FIntPoint& ClearValue
)

Public function

void

 

AddClearUAVPass

(
    FRDGBuilder& GraphBuilder,
    FRDGTextureUAVRef TextureUAV,
    const FVector& ClearValue
)

Public function

void

 

AddClearUAVPass

(
    FRDGBuilder& GraphBuilder,
    FRDGTextureUAVRef TextureUAV,
    const FUintVector4& ClearValues
)

Public function

void

 

AddClearUAVPass

(
    FRDGBuilder& GraphBuilder,
    FRDGTextureUAVRef TextureUAV,
    const FVector4& ClearValues
)

Public function

void

 

AddClearUAVPass

(
    FRDGBuilder& GraphBuilder,
    FRDGTextureUAVRef TextureUAV,
    const float(&) ClearValues
)

Public function

void

 

AddClearUAVPass

(
    FRDGBuilder& GraphBuilder,
    FRDGTextureUAVRef TextureUAV,
    const uint32 ClearValues
)

Public function

void

 

AddClearUAVPass

(
    FRDGBuilder& GraphBuilder,
    FRDGTextureUAVRef TextureUAV,
    const FLinearColor& ClearColor
)

Public function

void

 

AddClearUAVPass

(
    FRDGBuilder& GraphBuilder,
    FRDGTextureUAVRef TextureUAV,
    const uint32 ClearValues,
    FRDGBufferSRVRef RectMinMaxBufferSR...,
    uint32 NumRects
)

Clears parts of UAV specified by an array of screen rects.

Public function

void

 

AddCopyBufferPass

(
    FRDGBuilder& GraphBuilder,
    FRDGBufferRef DstBuffer,
    FRDGBufferRef SrcBuffer
)

Adds a render graph pass to copy SrcBuffer content into DstBuffer.

Public function

void

 

AddCopyTexturePass

(
    FRDGBuilder& GraphBuilder,
    FRDGTextureRef InputTexture,
    FRDGTextureRef OutputTexture,
    FIntPoint InputPosition,
    FIntPoint OutputPosition,
    FIntPoint Size
)

Simpler variant of the above function for 2D textures.

Public function

void

 

AddCopyTexturePass

(
    FRDGBuilder& GraphBuilder,
    FRDGTextureRef InputTexture,
    FRDGTextureRef OutputTexture,
    const FRHICopyTextureInfo& CopyInf...
)

Adds a render graph pass to copy a region from one texture to another.

Public function

void

 

AddCopyToResolveTargetPass

(
    FRDGBuilder& GraphBuilder,
    FRDGTextureRef InputTexture,
    FRDGTextureRef OutputTexture,
    const FResolveParams& ResolveParam...
)

Adds a render graph pass to resolve from one texture to another.

Public function

void

 

AddDispatchToRHIThreadPass

(
    FRDGBuilder& GraphBuilder
)

Public function

void

 

AddEndUAVOverlapPass

(
    FRDGBuilder& GraphBuilder,
    TArrayView< FRHIUnorderedAccessView...
)

AddEndUAVOverlapPass is deprecated.

Public function

void

 

AddEndUAVOverlapPass

(
    FRDGBuilder& GraphBuilder,
    FRHIUnorderedAccessView* UAV
)

AddEndUAVOverlapPass is deprecated.

Public function

void

 

AddEndUAVOverlapPass

(
    FRDGBuilder& GraphBuilder
)

AddEndUAVOverlapPass is deprecated.

Public function

void

 

AddEnqueueCopyPass

(
    FRDGBuilder& GraphBuilder,
    FRHIGPUTextureReadback* Readba...,
    FRDGTextureRef SourceTexture,
    FResolveRect Rect
)

Adds a pass to readback contents of an RDG texture.

Public function

void

 

AddEnqueueCopyPass

(
    FRDGBuilder& GraphBuilder,
    FRHIGPUBufferReadback* Readbac...,
    FRDGBufferRef SourceBuffer,
    uint32 NumBytes
)

Adds a pass to readback contents of an RDG buffer.

Public function

void

 

AddPass

(
    FRDGBuilder& GraphBuilder,
    ExecuteLambdaType&& ExecuteLambda
)

AddPass without an RDG_EVENT_NAME is deprecated. Use the named version instead.

Public function

void

 

AddPass

(
    FRDGBuilder& GraphBuilder,
    FRDGEventName&& Name,
    ExecuteLambdaType&& ExecuteLambda
)

Helper functions to add parameterless passes to the graph.

Public function

void

 

AddPassIfDebug

(
    FRDGBuilder& GraphBuilder,
    ExecuteLambdaType&& ExecuteLambda
)

AddPassIfDebug without an RDG_EVENT_NAME is deprecated. Use the named version instead.

Public function

void

 

AddPassIfDebug

(
    FRDGBuilder& GraphBuilder,
    FRDGEventName&& Name,
    ExecuteLambdaType&& ExecuteLambda
)

Public function

void

 

AddReadbackBufferPass

(
    FRDGBuilder& GraphBuilder,
    FRDGEventName&& Name,
    FRDGBufferRef Buffer,
    ExecuteLambdaType&& ExecuteLambda
)

Public function

void

 

AddReadbackTexturePass

(
    FRDGBuilder& GraphBuilder,
    FRDGEventName&& Name,
    FRDGTextureRef Texture,
    ExecuteLambdaType&& ExecuteLambda
)

Public function

void

 

AddResummarizeHTilePass

(
    FRDGBuilder& GraphBuilder,
    FRDGTextureRef DepthTexture
)

Adds a render graph pass to resummarize the htile plane.

Public function

void

 

AddSetCurrentStatPass

(
    FRDGBuilder& GraphBuilder,
    TStatId StatId
)

AddSetCurrentStatPass is deprecated. Use GraphBuilder.SetCommandListStat instead.

Public function

void

 

AddShaderSourceDirectoryMapping

(
    const FString& VirtualShaderDirect...,
    const FString& RealShaderDirectory
)

Maps a real shader directory existing on disk to a virtual shader directory.

Public function

void

 

AddShaderSourceFileEntry

(
    TArray< FString >& OutVirtualFileP...,
    FString VirtualFilePath,
    EShaderPlatform ShaderPlatform
)

Add a new entry to the list of shader source files Only unique entries which can be loaded are added as well as their #include files

Public function

void

 

AdvanceRenderingThreadStatsGT

(
    bool bDiscardCallstack,
    int64 StatsFrame,
    int32 MasterDisableChangeTagStartFr...
)

Advances stats for the rendering thread. Called from the game thread.

Public function

bool

 

AllowDebugViewmodes()

Returns true if debug viewmodes are allowed for the current platform.

Public function

bool

 

AllowDebugViewmodes

(
    EShaderPlatform Platform
)

Returns true if debug viewmodes are allowed for the given platform.

Public function

bool

 

AllowGlobalShaderLoad()

Returns true if the global shader cache should be loaded (and potentially compiled if allowed/needed

Public function

bool

 

AllowPerPixelShadingModels

(
    const FStaticShaderPlatform Platfor...
)

Public function

bool

 

AllowPixelDepthOffset

(
    const FStaticShaderPlatform Platfor...
)

Public function

bool

 

AllowShaderCompiling()

Returns true is shader compiling is allowed

Public function

const TMap< ...

 

AllShaderSourceDirectoryMappings()

Returns the map virtual shader directory path -> real shader directory path.

Public function

bool

 

AreSkinCacheShadersEnabled

(
    EShaderPlatform Platform
)

Checks if skin cache shaders are enabled for the platform (via r.SkinCache.CompileShaders)

Public function

void

 

BackupGlobalShaderMap

(
    FGlobalShaderBackupData& OutGlobal...
)

Backs up all global shaders to memory through serialization, and removes all references to FShaders from the global shader map.

Public function

void

 

BeginCleanup

(
    FDeferredCleanupInterface* Cle...
)

Adds the specified deferred cleanup object to the current set of pending cleanup objects.

Public function

void

 

BeginInitResource

(
    FRenderResource* Resource
)

Sends a message to the rendering thread to initialize a resource.

Public function

void

 

BeginReleaseResource

(
    FRenderResource* Resource
)

Sends a message to the rendering thread to release a resource. This is called in the game thread.

Public function

void

 

BeginSetUniformBufferContents

(
    TUniformBuffer< TBufferStruct >& U...,
    const TBufferStruct& Struct
)

Sends a message to the rendering thread to set the contents of a uniform buffer.

Public function

void

 

BeginUpdateResourceRHI

(
    FRenderResource* Resource
)

Sends a message to the rendering thread to update a resource. This is called in the game thread.

Public function

void

 

BindForLegacyShaderParameters

(
    FShader* Shader,
    int32 PermutationId,
    const FShaderParameterMap& Paramet...,
    bool bShouldBindEverything
)

Public function

void

 

BuildShaderFileToUniformBufferMap

(
    TMap< FString, TArray< const TCHAR ...
)

Public function

bool

 

CacheRenderTarget

(
    FRHITexture* Texture,
    const TCHAR* Name,
    TRefCountPtr< IPooledRenderTarget >...
)

Creates an untracked pooled render target from the RHI texture, but only if the pooled render target is empty or doesn't match the input texture.

Public function

void

 

CacheUniformBufferIncludes

(
    TMap< const TCHAR*, struct FCa...,
    EShaderPlatform Platform
)

Public function

FIntPoint

 

CalcMipMapExtent

(
    uint32 TextureSizeX,
    uint32 TextureSizeY,
    EPixelFormat Format,
    uint32 MipIndex
)

Calculates the extent of a mip.

Public function

void

 

CalcMipMapExtent3D

(
    uint32 TextureSizeX,
    uint32 TextureSizeY,
    uint32 TextureSizeZ,
    EPixelFormat Format,
    uint32 MipIndex,
    uint32& OutXExtent,
    uint32& OutYExtent,
    uint32& OutZExtent
)

Calculates the extent of a mip.

Public function

constexpr ui...

 

CalcPackedArrayIndex

(
    uint32 ElementIndex
)

Public function

constexpr ui...

 

CalcPackedArraySize

(
    uint32 NumElements
)

Public function

constexpr ui...

 

CalcPackedComponentIndex

(
    uint32 ElementIndex
)

Public function

SIZE_T

 

CalcTextureMipHeightInBlocks

(
    uint32 TextureSizeY,
    EPixelFormat Format,
    uint32 MipIndex
)

Calculates the height of a mip, in blocks.

Public function

SIZE_T

 

CalcTextureMipMapSize

(
    uint32 TextureSizeX,
    uint32 TextureSizeY,
    EPixelFormat Format,
    uint32 MipIndex
)

Calculates the amount of memory used for a single mip-map of a texture.

Public function

SIZE_T

 

CalcTextureMipMapSize3D

(
    uint32 TextureSizeX,
    uint32 TextureSizeY,
    uint32 TextureSizeZ,
    EPixelFormat Format,
    uint32 MipIndex
)

Calculates the amount of memory used for a single mip-map of a texture 3D.

Public function

SIZE_T

 

CalcTextureMipWidthInBlocks

(
    uint32 TextureSizeX,
    EPixelFormat Format,
    uint32 MipIndex
)

Calculates the width of a mip, in blocks.

Public function

SIZE_T

 

CalcTextureSize

(
    uint32 SizeX,
    uint32 SizeY,
    EPixelFormat Format,
    uint32 MipCount
)

Calculates the amount of memory used for a texture.

Public function

SIZE_T

 

CalcTextureSize3D

(
    uint32 SizeX,
    uint32 SizeY,
    uint32 SizeZ,
    EPixelFormat Format,
    uint32 MipCount
)

Calculates the amount of memory used for a texture.

Public function

FShaderMater...

 

CalculateDerivedMaterialParameters

(
    const FShaderMaterialPropertyDefine...,
    const FShaderLightmapPropertyDefine...,
    const FShaderGlobalDefines& SrcGlo...,
    const FShaderCompilerDefines& Comp...,
    ERHIFeatureLevel::Type FEATURE_LEVE...
)

Public function Static

void

 

CheckNotBlockedOnRenderThread()

Asserts if called from the main thread when the main thread is blocked on the rendering thread.

Public function

void

 

CheckRenderingThreadHealth()

Checks if the rendering thread is healthy and running.

Public function

void

 

CheckShaderHashCacheInclude

(
    const FString& VirtualFilePath,
    EShaderPlatform ShaderPlatform
)

Checks if shader include isn't skipped by a shader hash cache.

Public function

bool

 

CheckVirtualShaderFilePath

(
    FStringView VirtualPath,
    TArray< FShaderCompilerError >*...
)

Validates the format of a virtual shader file path.

Public function

void

 

ClearUAV

(
    FRHICommandList& RHICmdList,
    FRHIUnorderedAccessView* Buffe...,
    uint32 NumBytes,
    uint32 Value,
    bool bBarriers
)

Public function

void

 

ClearUAVShader_T

(
    FRHIComputeCommandList& RHICmdList,
    FRHIUnorderedAccessView* UAV,
    uint32 SizeX,
    uint32 SizeY,
    uint32 SizeZ,
    const void* ClearValues,
    EClearReplacementValueType ValueTyp...
)

Helper version of ClearUAVShader_T for determining float vs uint32 at runtime. Uses the above default implementation.

Public function

void

 

ClearUAVShader_T

(
    FRHIComputeCommandList& RHICmdList,
    FRHIUnorderedAccessView* UAV,
    uint32 SizeX,
    uint32 SizeY,
    uint32 SizeZ,
    const typename TClearReplacementTyp...,
    TFunctionRef< void...
)

Helper functions for running the clear replacement shader for specific resource types, values types and number of channels.

Public function

void

 

ClearUAVShader_T

(
    FRHIComputeCommandList& RHICmdList,
    FRHIUnorderedAccessView* UAV,
    uint32 SizeX,
    uint32 SizeY,
    uint32 SizeZ,
    const typename TClearReplacementTyp...
)

Default implementation of ClearUAVShader_T which simply binds the UAV to the compute shader via RHICmdList.SetUAVParameter.

Public function

void

 

ClearUnusedGraphResources

(
    const TShaderRef< TShaderClassA >&...,
    const TShaderRef< TShaderClassB >&...,
    TPassParameterStruct* InoutPar...,
    std::initializer_list< FRDGResource...
)

Public function

void

 

ClearUnusedGraphResources

(
    const TShaderRef< TShaderClass >& ...,
    typename TShaderClass::FParameters ...,
    std::initializer_list< FRDGResource...
)

Public function

void

 

ClearUnusedGraphResources

(
    const TShaderRef< TShaderClass >& ...,
    const FShaderParametersMetadata...,
    typename TShaderClass::FParameters ...,
    std::initializer_list< FRDGResource...
)

Public function

void

 

ClearUnusedGraphResourcesImpl

(
    const FShaderParameterBindings& Sh...,
    const FShaderParametersMetadata...,
    void* InoutParameters,
    std::initializer_list< FRDGResource...
)

Clears all render graph tracked resources that are not bound by a shader.

Public function

void

 

ClearUnusedGraphResourcesImpl

(
    TArrayView< const FShaderParameterB...,
    const FShaderParametersMetadata...,
    void* InoutParameters,
    std::initializer_list< FRDGResource...
)

Similar to the function above, but takes a list of shader bindings and only clears if none of the shaders contain the resource.

Public function Static

FVertexFacto...

 

ConstructVertexFactoryParameters

(
    EShaderFrequency ShaderFrequency,
    const FShaderParameterMap& Paramet...
)

Public function

void

 

ConvertToExternalBuffer

(
    FRDGBuilder& GraphBuilder,
    FRDGBufferRef Buffer,
    TRefCountPtr< FRDGPooledBuffer >& ...
)

ConvertToExternalBuffer has been refactored to FRDGBuilder::ConvertToExternalBuffer.

Public function

void

 

ConvertToExternalTexture

(
    FRDGBuilder& GraphBuilder,
    FRDGTextureRef Texture,
    TRefCountPtr< IPooledRenderTarget >...
)

ConvertToExternalTexture has been refactored to FRDGBuilder::ConvertToExternalTexture.

Public function

const TRefCo...

 

ConvertToFinalizedExternalBuffer

(
    FRDGBuilder& GraphBuilder,
    FRDGBufferRef Buffer,
    ERHIAccess AccessFinal
)

Public function

const TRefCo...

 

ConvertToFinalizedExternalBuffer

(
    FRDGBuilder& GraphBuilder,
    FRDGResourceAccessFinalizer& Resou...,
    FRDGBufferRef Buffer,
    ERHIAccess AccessFinal
)

Public function

const TRefCo...

 

ConvertToFinalizedExternalTexture

(
    FRDGBuilder& GraphBuilder,
    FRDGTextureRef Texture,
    ERHIAccess AccessFinal
)

Public function

const TRefCo...

 

ConvertToFinalizedExternalTexture

(
    FRDGBuilder& GraphBuilder,
    FRDGResourceAccessFinalizer& Resou...,
    FRDGTextureRef Texture,
    ERHIAccess AccessFinal
)

Public function

void

 

ConvertToUntrackedExternalBuffer

(
    FRDGBuilder& GraphBuilder,
    FRDGBufferRef Buffer,
    TRefCountPtr< FRDGPooledBuffer >& ...,
    ERHIAccess AccessFinal
)

ConvertToUntrackedExternalTexture has been refactored to ConvertToFinalizedExternalBuffer.

Public function

void

 

ConvertToUntrackedExternalTexture

(
    FRDGBuilder& GraphBuilder,
    FRDGTextureRef Texture,
    TRefCountPtr< IPooledRenderTarget >...,
    ERHIAccess AccessFinal
)

ConvertToUntrackedExternalTexture has been refactored to ConvertToFinalizedExternalTexture.

Public function

void

 

CopyTextureData2D

(
    const void* Source,
    void* Dest,
    uint32 SizeY,
    EPixelFormat Format,
    uint32 SourceStride,
    uint32 DestStride
)

Copies the data for a 2D texture between two buffers with potentially different strides.

Public function

void

 

CreateClearReplacementShaders()

Force creation of the above clear replacement shaders.

Public function

TRefCountPtr...

 

CreateRenderTarget

(
    FRHITexture* Texture,
    const TCHAR* Name
)

Creates an untracked pooled render target from an RHI texture.

Public function

FRDGBufferRe...

 

CreateStructuredBuffer

(
    FRDGBuilder& GraphBuilder,
    const TCHAR* Name,
    GetArrayRefCallback&& ArrayCallbac...
)

Same as the previous function but where the type of the array is automatically inferred, so we can do : TArray Array; CreateStructuredBuffer(..., [&]() -> auto&{ return Array; });

Public function

FRDGBufferRe...

 

CreateStructuredBuffer

(
    FRDGBuilder& GraphBuilder,
    const TCHAR* Name,
    const FRDGUploadData< ElementType >...
)

Public function

FRDGBufferRe...

 

CreateStructuredBuffer

(
    FRDGBuilder& GraphBuilder,
    const TCHAR* Name,
    TConstArrayView< ElementType > Init...,
    ERDGInitialDataFlags InitialDataFla...
)

Helper to create a structured buffer with initial data from a TConstArrayView.

Public function

FRDGBufferRe...

 

CreateStructuredBuffer

(
    FRDGBuilder& GraphBuilder,
    const TCHAR* Name,
    uint32 BytesPerElement,
    FRDGBufferNumElementsCallback&& Nu...,
    FRDGBufferInitialDataCallback&& In...,
    FRDGBufferInitialDataSizeCallback&...
)

A variant where NumElements, InitialData, and InitialDataSize are supplied through callbacks.

Public function

FRDGBufferRe...

 

CreateStructuredBuffer

(
    FRDGBuilder& GraphBuilder,
    const TCHAR* Name,
    uint32 BytesPerElement,
    uint32 NumElements,
    const void* InitialData,
    uint64 InitialDataSize,
    ERDGInitialDataFlags InitialDataFla...
)

Creates a structured buffer with initial data by creating an upload pass.

Public function

FRDGBufferRe...

 

CreateStructuredBuffer

(
    FRDGBuilder& GraphBuilder,
    const TCHAR* Name,
    const TArray< ElementType, Allocato...,
    ERDGInitialDataFlags InitialDataFla...
)

Helper to create a structured buffer with initial data from a TArray.

Public function

FRDGBufferRe...

 

CreateStructuredBuffer_Impl

(
    FRDGBuilder& GraphBuilder,
    const TCHAR* Name,
    TRDGBufferArrayCallback< ArrayType ...
)

A variant where the TArray is supplied through callbacks.

Public function

FBufferRHIRe...

 

CreateTempMediaVertexBuffer

(
    float ULeft,
    float URight,
    float VTop,
    float VBottom
)

Public function

FRDGTextureM...

 

CreateTextureMSAA

(
    FRDGBuilder& GraphBuilder,
    FRDGTextureDesc Desc,
    const TCHAR* Name,
    ETextureCreateFlags ResolveFlagsToA...
)

Public function

TUniformBuff...

 

CreateUniformBufferImmediate

(
    const TBufferStruct& Value,
    EUniformBufferUsage Usage,
    EUniformBufferValidation Validation
)

Creates a uniform buffer with the given value, and returns a structured reference to it.

Public function

void

 

CreateUniformBufferShaderDeclaration

(
    const TCHAR* Name,
    const FShaderParametersMetadata& U...,
    EShaderPlatform Platform,
    FString& OutDeclaration
)

Creates a shader code declaration of this struct for the given shader platform.

Public function

FRDGBufferRe...

 

CreateUploadBuffer

(
    FRDGBuilder& GraphBuilder,
    const TCHAR* Name,
    TConstArrayView< ElementType > Init...,
    ERDGInitialDataFlags InitialDataFla...
)

Public function

FRDGBufferRe...

 

CreateUploadBuffer

(
    FRDGBuilder& GraphBuilder,
    const TCHAR* Name,
    const FRDGUploadData< ElementType >...
)

Public function

FRDGBufferRe...

 

CreateUploadBuffer

(
    FRDGBuilder& GraphBuilder,
    const TCHAR* Name,
    uint32 BytesPerElement,
    uint32 NumElements,
    const void* InitialData,
    uint64 InitialDataSize,
    ERDGInitialDataFlags InitialDataFla...
)

Public function

FRDGBufferRe...

 

CreateUploadBuffer

(
    FRDGBuilder& GraphBuilder,
    const TCHAR* Name,
    uint32 BytesPerElement,
    uint32 NumElements,
    const FRDGUploadData< ElementType >...
)

Public function

FRDGBufferRe...

 

CreateVertexBuffer

(
    FRDGBuilder& GraphBuilder,
    const TCHAR* Name,
    const FRDGBufferDesc& Desc,
    const void* InitialData,
    uint64 InitialDataSize,
    ERDGInitialDataFlags InitialDataFla...
)

Creates a vertex buffer with initial data by creating an upload pass.

Public function Static

bool

 

CrossCompiler::IsValidPackedTypeName

(
    EPackedTypeName TypeName
)

Public function Static

EPackedTypeN...

 

CrossCompiler::PackedTypeIndexToTypeName

(
    EPackedTypeIndex TypeIndex
)

Public function Static

uint8

 

CrossCompiler::PackedTypeIndexToTypeName

(
    uint8 ArrayType
)

Public function Static

EPackedTypeI...

 

CrossCompiler::PackedTypeNameToTypeIndex

(
    EPackedTypeName TypeName
)

Public function Static

uint8

 

CrossCompiler::PackedTypeNameToTypeIndex

(
    uint8 ArrayName
)

Public function Static

uint8

 

CrossCompiler::ShaderStageIndexToTypeName

(
    uint8 ShaderStage
)

Public function

void

 

DispatchComputeShader

(
    FRHIComputeCommandList& RHICmdList,
    const TShaderRef< FShader >& Shade...,
    uint32 ThreadGroupCountX,
    uint32 ThreadGroupCountY,
    uint32 ThreadGroupCountZ
)

Public function

void

 

DispatchComputeShader

(
    FRHIComputeCommandList& RHICmdList,
    FShader* Shader,
    uint32 ThreadGroupCountX,
    uint32 ThreadGroupCountY,
    uint32 ThreadGroupCountZ
)

Helper function to dispatch a compute shader while checking that parameters have been set correctly.

Public function

void

 

DispatchIndirectComputeShader

(
    FRHIComputeCommandList& RHICmdList,
    FShader* Shader,
    FRHIBuffer* ArgumentBuffer,
    uint32 ArgumentOffset
)

Helper function to dispatch a compute shader indirectly while checking that parameters have been set correctly.

Public function

bool

 

DoesPlatformSupportNanite

(
    EShaderPlatform Platform,
    bool bCheckForProjectSetting
)

Public function

void

 

DrawClearQuad

(
    FRHICommandList& RHICmdList,
    const FLinearColor& Color
)

Public function

void

 

DrawClearQuad

(
    FRHICommandList& RHICmdList,
    const FLinearColor& Color,
    FClearQuadCallbacks ClearQuadCallba...
)

Public function

void

 

DrawClearQuad

(
    FRHICommandList& RHICmdList,
    bool bClearColor,
    const FLinearColor& Color,
    bool bClearDepth,
    float Depth,
    bool bClearStencil,
    uint32 Stencil
)

Public function

void

 

DrawClearQuad

(
    FRHICommandList& RHICmdList,
    bool bClearColor,
    const FLinearColor& Color,
    bool bClearDepth,
    float Depth,
    bool bClearStencil,
    uint32 Stencil,
    FIntPoint ViewSize,
    FIntRect ExcludeRect
)

Public function

void

 

DrawClearQuadMRT

(
    FRHICommandList& RHICmdList,
    bool bClearColor,
    int32 NumClearColors,
    const FLinearColor* ClearColor...,
    bool bClearDepth,
    float Depth,
    bool bClearStencil,
    uint32 Stencil
)

Public function

void

 

DrawClearQuadMRT

(
    FRHICommandList& RHICmdList,
    bool bClearColor,
    int32 NumClearColors,
    const FLinearColor* ClearColor...,
    bool bClearDepth,
    float Depth,
    bool bClearStencil,
    uint32 Stencil,
    FClearQuadCallbacks ClearQuadCallba...
)

Public function

void

 

DrawClearQuadMRT

(
    FRHICommandList& RHICmdList,
    bool bClearColor,
    int32 NumClearColors,
    const FLinearColor* ClearColor...,
    bool bClearDepth,
    float Depth,
    bool bClearStencil,
    uint32 Stencil,
    FIntPoint ViewSize,
    FIntRect ExcludeRect
)

Public function

void

 

DumpShaderPipelineStats

(
    EShaderPlatform Platform
)

Dumps shader pipeline stats to the log.

Public function

void

 

DumpShaderStats

(
    EShaderPlatform Platform,
    EShaderFrequency Frequency
)

Dumps shader stats to the log. Will also print some shader pipeline information.

Public function

void

 

EmitNullShaderParameterFatalError

(
    const TShaderRef< FShader >& Shade...,
    const FShaderParametersMetadata...,
    uint16 MemberOffset
)

Raise fatal error when a required shader parameter has not been set.

Public function

void

 

EndBatchedRelease()

Disables the batching of calls to BeginReleaseResource This is called in the game thread.

Public function

void

 

EnqueueUniqueRenderCommand

(
    LAMBDA& Lambda
)

Public function

void

 

EnqueueUniqueRenderCommand

(
    LAMBDA&& Lambda
)

Public function

void

 

EnumerateSubresourceRange

(
    TRDGTextureSubresourceArray< Elemen...,
    const FRDGTextureSubresourceLayout ...,
    const FRDGTextureSubresourceRange&...,
    FunctionType Function
)

Public function

void

 

EnumerateSubresourceRange

(
    const TRDGTextureSubresourceArray< ...,
    const FRDGTextureSubresourceLayout ...,
    const FRDGTextureSubresourceRange&...,
    FunctionType Function
)

Public function

bool

 

ExcludeNonPipelinedShaderTypes

(
    EShaderPlatform ShaderPlatform
)

Checks if the non-pipeline shaders will not be compild and ones from FShaderPipeline used instead.

Public function

FGraphicsPip...

 

ExtractRenderTargetsInfo

(
    const FRDGParameterStruct& Paramet...
)

Public function

FGraphicsPip...

 

ExtractRenderTargetsInfo

(
    const FRDGParameterStruct& Paramet...
)

Public function

FGBufferInfo

 

FetchFullGBufferInfo

(
    const FGBufferParams& Params
)

Public function

FGBufferInfo

 

FetchLegacyGBufferInfo

(
    const FGBufferParams& Params
)

FGBufferInfo FetchLegacyGBufferInfo(bool bHasVelocity, bool bHasTangent, bool bHasPrecShadowFactor, int LegacyFormatIndex, bool bUsesVelocityDepth); FGBufferInfo FetchFullGBufferInfo(bool bHasVelocity, bool bHasTangent, bool bHasPrecShadowFactor, int LegacyFormatIndex, bool bUsesVelocityDepth);

Public function

FGBufferBind...

 

FindGBufferBindingByName

(
    const FGBufferInfo& GBufferInfo,
    const FString& Name
)

Public function

int32

 

FindGBufferTargetByName

(
    const FGBufferInfo& GBufferInfo,
    const FString& Name
)

Public function

FShaderType ...

 

FindShaderTypeByName

(
    const FHashedName& ShaderTypeName
)

Finds the shader type with a given name.

Public function

FShaderParam...

 

FindUniformBufferStructByFName

(
    FName StructName
)

Public function

FShaderParam...

 

FindUniformBufferStructByLayoutHash

(
    uint32 Hash
)

Finds the FShaderParameterMetadata corresponding to the given uniform buffer layout hash, or null if not found.

Public function

FShaderParam...

 

FindUniformBufferStructByName

(
    const TCHAR* StructName
)

Finds the FShaderParametersMetadata corresponding to the given name, or NULL if not found.

Public function

FShaderParam...

 

FindUniformBufferStructByShaderVariableName

(
    const FHashedName& Name
)

Public function

FVertexFacto...

 

FindVertexFactoryType

(
    const FHashedName& TypeName
)

Find the vertex factory type with the given name.

Public function

void

 

FlushPendingDeleteRHIResources_GameThread()

Public function

void

 

FlushPendingDeleteRHIResources_RenderThread()

Public function

void

 

FlushRenderingCommands()

Waits for the rendering thread to finish executing all pending rendering commands.

Public function

void

 

FlushShaderFileCache()

Flushes the shader file and CRC cache, and regenerates the binary shader files if necessary.

Public function

bool

 

ForceSimpleSkyDiffuse

(
    const FStaticShaderPlatform Platfor...
)

Public function

void

 

Freeze::IntrinsicToString

(
    const TIndexedPtr< FVertexFactoryTy...,
    const FTypeLayoutDesc& TypeDesc,
    const FPlatformTypeLayoutParameters...,
    FMemoryToStringContext& OutContext
)

Public function

void

 

Freeze::IntrinsicToString

(
    const TIndexedPtr< FShaderType >& ...,
    const FTypeLayoutDesc& TypeDesc,
    const FPlatformTypeLayoutParameters...,
    FMemoryToStringContext& OutContext
)

Public function

void

 

GenerateReferencedUniformBuffers

(
    const TCHAR* SourceFilename,
    const TCHAR* ShaderTypeName,
    const TMap< FString, TArray< const ...,
    TMap< const TCHAR*, FCachedUni...
)

Parses the given source file and its includes for references of uniform buffers, which are then stored in UniformBufferEntries.

Public function

FVector

 

GenerateYAxis

(
    const VectorType& XAxis,
    const VectorType& ZAxis
)

Given 2 axes of a basis stored as a packed type, regenerates the y-axis tangent vector and scales by z.W

Public function

void

 

GetAllVirtualShaderSourcePaths

(
    TArray< FString >& OutVirtualFileP...,
    EShaderPlatform ShaderPlatform
)

Generates a list of virtual paths of all shader source that engine needs to load.

Public function

float

 

GetBasisDeterminantSign

(
    const FVector& XAxis,
    const FVector& YAxis,
    const FVector& ZAxis
)

Constructs a basis matrix for the axis vectors and returns the sign of the determinant

Public function

int8

 

GetBasisDeterminantSignByte

(
    const FPackedNormal& XAxis,
    const FPackedNormal& YAxis,
    const FPackedNormal& ZAxis
)

Constructs a basis matrix for the axis vectors and returns the sign of the determinant

Public function

const TCHAR ...

 

GetBufferUnderlyingTypeName

(
    FRDGBufferDesc::EUnderlyingType Buf...
)

Public function

ECubeFace

 

GetCubeFaceFromName

(
    const FString& Name
)

Convert from text string to ECubeFace

Public function

const TCHAR ...

 

GetCubeFaceName

(
    ECubeFace Face
)

Convert from ECubeFace to text string

Public function

uint16

 

GetCubeVertexIndex

(
    uint32 X,
    uint32 Y,
    uint32 Z
)

Maps from an X,Y,Z cube vertex coordinate to the corresponding vertex index.

Public function

int32

 

GetCVarForceLOD()

Shared by renderer and engine, compiles down to a constant in final release

Public function

int32

 

GetCVarForceLOD_AnyThread()

Shared by renderer and engine, compiles down to a constant in final release

Public function

int32

 

GetCVarForceLODShadow()

Public function

int32

 

GetCVarForceLODShadow_AnyThread()

Public function

bool

 

GetEmitRDGEvents()

Returns whether the current frame is emitting render graph events.

Public function

FGlobalShade...

 

GetGlobalShaderMap

(
    EShaderPlatform Platform
)

Accesses the global shader map.

Public function

FGlobalShade...

 

GetGlobalShaderMap

(
    ERHIFeatureLevel::Type FeatureLevel
)

Overload for the above GetGlobalShaderMap which takes a feature level and translates to the appropriate shader platform

Public function

void

 

GetHemiOrthoBasis

(
    FVector3f& BasisX,
    FVector3f& BasisY,
    const FVector3f& BasisZ
)

[Frisvad 2012, "Building an Orthonormal Basis from a 3D Unit Vector Without Normalization"]

Public function

FRDGTextureR...

 

GetIfProduced

(
    FRDGTextureRef Texture,
    FRDGTextureRef FallbackTexture
)

Returns the texture if it was produced by a prior pass, or null otherwise.

Public function

FRDGBufferRe...

 

GetIfProduced

(
    FRDGBufferRef Buffer,
    FRDGBufferRef FallbackBuffer
)

Returns the buffer if has been produced by a prior pass, or null otherwise.

Public function

FRHICommandL...

 

GetImmediateCommandList_ForRenderCommand()

Macros for using render commands.

Public function

ERenderTarge...

 

GetLoadActionIfProduced

(
    FRDGTextureRef Texture,
    ERenderTargetLoadAction ActionIfNot...
)

Returns 'Load' if the texture has already been produced by a prior pass, or the requested initial action.

Public function

FRenderTarge...

 

GetLoadBindingIfProduced

(
    FRDGTextureRef Texture,
    ERenderTargetLoadAction ActionIfNot...
)

Returns a binding with the requested initial action, or a load action if the resource has been produced by a prior pass.

Public function

TStatId

 

GetMemoryStatType

(
    EShaderFrequency ShaderFrequency
)

Controls whether shader related logs are visible.

Public function

ERDGParentRe...

 

GetParentResourceType

(
    ERDGViewType ViewType
)

Returns the equivalent parent resource type for a view type.

Public function

FPendingClea...

 

GetPendingCleanupObjects()

Transfers ownership of the current set of pending cleanup objects to the caller.

Public function

EPixelFormat

 

GetPixelFormatFromString

(
    const TCHAR* InPixelFormatStr
)

String to enum (not case sensitive)

Public function

const TCHAR ...

 

GetPixelFormatString

(
    EPixelFormat InPixelFormat
)

Enum to string

Public function

EPixelFormat...

 

GetPixelFormatValidChannels

(
    EPixelFormat InPixelFormat
)

Returns the valid channels for this pixel format

Public function

bool

 

GetPooledFreeBuffer

(
    FRHICommandList& RHICmdList,
    const FRDGBufferDesc& Desc,
    TRefCountPtr< FRDGPooledBuffer >& ...,
    const TCHAR* InDebugName
)

Allocates an RDG pooled buffer instance. Attempts to reuse allocation if Out has a value. Returns true a new instance was allocated, or false if the existing allocation was reused.

Public function

FString

 

GetRDGEventPath

(
    const FRDGEventScope* Scope,
    const FRDGEventName& Event
)

Public function Static

FRHIRenderPa...

 

GetRenderPassInfo

(
    TParameterStruct* Parameters
)

Helper function to get RHI render pass info from a pass parameter struct.

Public function

FRenderTarge...

 

GetRenderTargetBindings

(
    ERenderTargetLoadAction ColorLoadAc...,
    TArrayView< FRDGTextureRef > ColorT...
)

Public function

FRenderTarge...

 

GetRenderTargetBindings

(
    ERenderTargetLoadAction ColorLoadAc...,
    TArrayView< FTextureRenderTargetBin...
)

Public function

int32

 

GetResourceTransitionPlaneForMetadataAccess

(
    ERDGTextureMetaDataAccess Metadata
)

Returns the associated FRHITransitionInfo plane index.

Public function

TUniformBuff...

 

GetShaderBinding

(
    const TUniformBufferRef< TBufferStr...
)

Public function

TRDGUniformB...

 

GetShaderBinding

(
    TRDGUniformBuffer< TBufferStruct > ...
)

Constructs a uniform buffer binding that will utilize the shader binding model.

Public function

const TCHAR ...

 

GetShaderCodeResourceBindingTypeName

(
    EShaderCodeResourceBindingType Bind...
)

Public function

FName

 

GetShaderCompressionFormat

(
    const FName& ShaderFormat
)

Returns the shader compression format (passing ShaderFormat for future proofing, but as of now the setting is global for all formats).

Public function

void

 

GetShaderCompressionOodleSettings

(
    FOodleDataCompression::ECompressor ...,
    FOodleDataCompression::ECompression...,
    const FName& ShaderFormat
)

Returns Oodle-specific shader compression format settings (passing ShaderFormat for future proofing, but as of now the setting is global for all formats).

Public function

const FSHAHa...

 

GetShaderFileHash

(
    const TCHAR* VirtualFilePath,
    EShaderPlatform ShaderPlatform
)

Calculates a Hash for the given filename if it does not already exist in the Hash cache.

Public function

const FSHAHa...

 

GetShaderFilesHash

(
    const TArray< FString >& VirtualFi...,
    EShaderPlatform ShaderPlatform
)

Calculates a Hash for the list of filenames if it does not already exist in the Hash cache.

Public function

void

 

GetShaderIncludes

(
    const TCHAR* EntryPointVirtual...,
    const TCHAR* VirtualFilePath,
    TArray< FString >& IncludeVirtualF...,
    EShaderPlatform ShaderPlatform,
    uint32 DepthLimit
)

Recursively populates IncludeFilenames with the include filenames from Filename

Public function

const TCHAR ...

 

GetShaderParameterMacroName

(
    EUniformBufferBaseType ShaderParame...
)

Returns the name of the macro that should be used for a given shader parameter base type.

Public function

FRHIResource...

 

GetShaderParameterResourceRHI

(
    const void* Contents,
    uint16 MemberOffset,
    EUniformBufferBaseType MemberType
)

Dereferences the RHI resource from a shader parameter struct.

Public function

EShaderPermu...

 

GetShaderPermutationFlags

(
    const FPlatformTypeLayoutParameters...
)

Public function

FString

 

GetShaderSourceFilePath

(
    const FString& VirtualFilePath,
    TArray< struct FShaderCompilerError...
)

Convert the virtual shader path to an actual file system path.

Public function

bool

 

GetShaderSymbolPathOverride

(
    FString& OutPathOverride,
    FName ShaderFormat
)

Returns true if the shader symbol path is overriden and OutPathOverride contains the override path.

Public function

TUniformBuff...

 

GetStaticBinding

(
    const TUniformBufferRef< TBufferStr...
)

Public function

TRDGUniformB...

 

GetStaticBinding

(
    TRDGUniformBuffer< TBufferStruct > ...
)

Constructs a uniform buffer binding that will utilize the static binding model.

Public function Static

FUniformBuff...

 

GetStaticUniformBuffers

(
    TParameterStruct* Parameters
)

Helper function to get RHI global uniform buffers out of a pass parameters struct.

Public function

ElementType ...

 

GetSubresource

(
    TRDGTextureSubresourceArray< Elemen...,
    const FRDGTextureSubresourceLayout ...,
    FRDGTextureSubresource Subresource
)

Public function

const Elemen...

 

GetSubresource

(
    const TRDGTextureSubresourceArray< ...,
    const FRDGTextureSubresourceLayout ...,
    FRDGTextureSubresource Subresource
)

Public function

uint64

 

GetTypeHash

(
    const FVirtualTextureLocalTile& T
)

Public function

uint32

 

GetTypeHash

(
    const TShaderTypePermutation< MetaS...
)

Public function

uint32

 

GetTypeHash

(
    TRDGHandle< ObjectType, IndexType >...
)

Public function

uint32

 

GetTypeHash

(
    const FAllocatedVTDescription& Des...
)

Public function

const FTypeL...

 

GetTypeLayoutDesc

(
    const FPointerTableBase* PtrTa...,
    const FShader& Shader
)

Public function

FBufferRHIRe...

 

GetUnitCubeIndexBuffer()

Unit cube index buffer

Public function

FBufferRHIRe...

 

GetUnitCubeVertexBuffer()

Unit cube vertex buffer (VertexDeclarationFVector4)

Public function

FVertexDecla...

 

GetVertexDeclarationFVector2()

Public function

FVertexDecla...

 

GetVertexDeclarationFVector3()

Public function

FVertexDecla...

 

GetVertexDeclarationFVector4()

Public function Static

void

 

GetVertexFactoryParametersElementShaderBindings

(
    EShaderFrequency ShaderFrequency,
    const FVertexFactoryShaderParameter...,
    const FSceneInterface* Scene,
    const FSceneView* View,
    const FMeshMaterialShader* Sha...,
    const EVertexInputStreamType InputS...,
    ERHIFeatureLevel::Type FeatureLevel,
    const FVertexFactory* VertexFa...,
    const FMeshBatchElement& BatchElem...,
    FMeshDrawSingleShaderBindings& Sha...,
    FVertexInputStreamArray& VertexStr...
)

Public function Static

const FTypeL...

 

GetVertexFactoryParametersLayout

(
    EShaderFrequency ShaderFrequency
)

Public function

ElementType ...

 

GetWholeResource

(
    TRDGTextureSubresourceArray< Elemen...
)

Public function

const Elemen...

 

GetWholeResource

(
    const TRDGTextureSubresourceArray< ...
)

Public function

FSocket

 

GPUMessage::RegisterHandler

(
    const TCHAR* MessageDebugId,
    LambdaType&& Lambda
)

Registers a lambda function as a message handler.

Public function

bool

 

HasBeenProduced

(
    FRDGParentResourceRef Resource
)

Returns whether the resource was produced by a prior pass.

Public function

FVector3f

 

HemiOctahedronToUnitVector

(
    const FVector2f& Oct
)

Public function

void

 

InitAsSubresources

(
    TRDGTextureSubresourceArray< Elemen...,
    const FRDGTextureSubresourceLayout ...,
    const ElementType& Element
)

Public function

void

 

InitAsWholeResource

(
    TRDGTextureSubresourceArray< Elemen...,
    const ElementType& Element
)

Public function

void

 

InitializeShaderHashCache()

Initializes shader hash cache from IShaderFormatModules.

Public function

void

 

InitializeShaderTypes()

Initializes cached shader type data.

Public function

bool

 

IsAnyForwardShadingEnabled

(
    const FStaticShaderPlatform Platfor...
)

Returns if ForwardShading or SimpleForwardShading is enabled. Only valid for the current platform.

Public function

bool

 

IsDxcEnabledForPlatform

(
    EShaderPlatform Platform
)

Returns whether DirectXShaderCompiler (DXC) is enabled for the specified shader platform.

Public function

bool

 

IsForwardShadingEnabled

(
    const FStaticShaderPlatform Platfor...
)

Returns if ForwardShading is enabled.

Public function

bool

 

IsGBufferInfoEqual

(
    const FGBufferInfo& Lhs,
    const FGBufferInfo& Rhs
)

Public function

bool

 

IsHDRAllowed()

Public function

bool

 

IsHDREnabled()

Public function

bool

 

IsMobileDeferredShadingEnabled

(
    const FStaticShaderPlatform Platfor...
)

Public function

bool

 

IsMobileDistanceFieldEnabled

(
    const FStaticShaderPlatform Platfor...
)

Public function

bool

 

IsRayTracingEnabled()

Returns `true_ when running on RT-capable machine, RT support is enabled for the project and by game graphics options.

Public function

bool

 

IsRayTracingEnabledForProject

(
    EShaderPlatform ShaderPlatform
)

Public function

bool

 

IsRenderingThreadHealthy()

Checks if the rendering thread is healthy and running, without crashing

Public function

bool

 

IsSimpleForwardShadingEnabled

(
    const FStaticShaderPlatform Platfor...
)

Public function

bool

 

IsSubresources

(
    const TRDGTextureSubresourceArray< ...
)

Public function

void

 

IssueScalableLongGPUTask

(
    FRHICommandListImmediate& RHICmdLi...,
    int32 NumIteration
)

Public function

bool

 

IsUsingBasePassVelocity

(
    const FStaticShaderPlatform Platfor...
)

Returns whether the base pass should output to the velocity buffer is enabled for a given shader platform

Public function

bool

 

IsUsingDBuffers

(
    const FStaticShaderPlatform Platfor...
)

Returns whether DBuffer decals are enabled for a given shader platform

Public function

bool

 

IsUsingDistanceFields

(
    const FStaticShaderPlatform Platfor...
)

Returns whether distance fields are enabled for a given shader platform

Public function

bool

 

IsUsingEmulatedUniformBuffers

(
    EShaderPlatform Platform
)

Returns whether the platform is using emulated uniform buffers

Public function

bool

 

IsUsingGBuffers

(
    const FStaticShaderPlatform Platfor...
)

Returns if the GBuffer is used. Only valid for the current platform.

Public function

bool

 

IsUsingSelectiveBasePassOutputs

(
    const FStaticShaderPlatform Platfor...
)

Returns whether the base pass should use selective outputs for a given shader platform

Public function

bool

 

IsWholeResource

(
    const TRDGTextureSubresourceArray< ...
)

Public function

bool

 

LoadShaderSourceFile

(
    const TCHAR* VirtualFilePath,
    EShaderPlatform ShaderPlatform,
    FString* OutFileContents,
    TArray< FShaderCompilerError >*...
)

Loads the shader file with the given name.

Public function

void

 

LoadShaderSourceFileChecked

(
    const TCHAR* VirtualFilePath,
    EShaderPlatform ShaderPlatform,
    FString& OutFileContents
)

Loads the shader file with the given name.

Public function

FString

 

MakeInjectedShaderCodeBlock

(
    const TCHAR* BlockName,
    const FString& CodeToInject
)

Create a block of source code to be injected in the preprocessed shader code.

Public function

bool

 

MaskedInEarlyPass

(
    const FStaticShaderPlatform Platfor...
)

Public function

void

 

MeasureLongGPUTaskExecutionTime

(
    FRHICommandListImmediate& RHICmdLi...
)

Public function

void

 

MemcpyResource

(
    FRHICommandList& RHICmdList,
    const ResourceType& DstBuffer,
    const ResourceType& SrcBuffer,
    const FMemcpyResourceParams& Param...,
    bool bAlreadyInUAVOverlap
)

Public function

void

 

MemsetResource

(
    FRHICommandList& RHICmdList,
    const ResourceType& DstBuffer,
    const FMemsetResourceParams& Param...
)

Public function

bool

 

MobileBasePassAlwaysUsesCSM

(
    const FStaticShaderPlatform Platfor...
)

Public function

bool

 

MobileRequiresSceneDepthAux

(
    const FStaticShaderPlatform Platfor...
)

Public function

bool

 

MobileSupportsGPUScene()

Public function

constexpr bo...

 

operator!

(
    ERDGUnorderedAccessViewFlags E
)

Public function

constexpr bo...

 

operator!

(
    ERDGBuilderFlags E
)

Public function

constexpr bo...

 

operator!

(
    ERDGPassFlags E
)

Public function

constexpr bo...

 

operator!

(
    ERDGBufferFlags E
)

Public function

constexpr bo...

 

operator!

(
    ERDGTextureFlags E
)

Public function

constexpr bo...

 

operator!

(
    EVertexFactoryFlags E
)

Public function

constexpr bo...

 

operator!

(
    EShaderPermutationFlags E
)

Public function

constexpr bo...

 

operator!

(
    EShaderCodeFeatures E
)

Public function

constexpr bo...

 

operator!

(
    EVertexStreamUsage E
)

Public function

constexpr bo...

 

operator!

(
    EVTProducePageFlags E
)

Public function

constexpr bo...

 

operator!

(
    ERDGInitialDataFlags E
)

Public function

constexpr bo...

 

operator!

(
    FVisualizeTexture::EFlags E
)

Public function

constexpr bo...

 

operator!

(
    ERDGResourceExtractionFlags E
)

Public function

bool

 

operator!=

(
    const TShaderRefBase< ShaderType0, ...,
    const TShaderRefBase< ShaderType1, ...
)

Public function

bool

 

operator!=

(
    const FVirtualTextureLocalTile& Lh...,
    const FVirtualTextureLocalTile& Rh...
)

Public function

bool

 

operator!=

(
    const FAllocatedVTDescription& Lhs,
    const FAllocatedVTDescription& Rhs
)

Public function

bool

 

operator!=

(
    const FParameterAllocation& A,
    const FParameterAllocation& B
)

Public function

bool

 

operator!=

(
    const FShaderCodeVendorExtension& ...,
    const FShaderCodeVendorExtension& ...
)

Public function

bool

 

operator!=

(
    const FVirtualTextureProducerHandle...,
    const FVirtualTextureProducerHandle...
)

Public function

constexpr FV...

 

operator&

(
    FVisualizeTexture::EFlags Lhs,
    FVisualizeTexture::EFlags Rhs
)

Public function

constexpr EV...

 

operator&

(
    EVTProducePageFlags Lhs,
    EVTProducePageFlags Rhs
)

Public function

constexpr EV...

 

operator&

(
    EVertexStreamUsage Lhs,
    EVertexStreamUsage Rhs
)

Public function

constexpr ES...

 

operator&

(
    EShaderPermutationFlags Lhs,
    EShaderPermutationFlags Rhs
)

Public function

constexpr ER...

 

operator&

(
    ERDGInitialDataFlags Lhs,
    ERDGInitialDataFlags Rhs
)

Public function

constexpr EV...

 

operator&

(
    EVertexFactoryFlags Lhs,
    EVertexFactoryFlags Rhs
)

Public function

constexpr ER...

 

operator&

(
    ERDGUnorderedAccessViewFlags Lhs,
    ERDGUnorderedAccessViewFlags Rhs
)

Public function

constexpr ER...

 

operator&

(
    ERDGTextureFlags Lhs,
    ERDGTextureFlags Rhs
)

Public function

constexpr ER...

 

operator&

(
    ERDGBufferFlags Lhs,
    ERDGBufferFlags Rhs
)

Public function

constexpr ER...

 

operator&

(
    ERDGPassFlags Lhs,
    ERDGPassFlags Rhs
)

Public function

constexpr ER...

 

operator&

(
    ERDGBuilderFlags Lhs,
    ERDGBuilderFlags Rhs
)

Public function

constexpr ER...

 

operator&

(
    ERDGResourceExtractionFlags Lhs,
    ERDGResourceExtractionFlags Rhs
)

Public function

constexpr ES...

 

operator&

(
    EShaderCodeFeatures Lhs,
    EShaderCodeFeatures Rhs
)

Public function

EShaderCodeF...

 

operator&=

(
    EShaderCodeFeatures& Lhs,
    EShaderCodeFeatures Rhs
)

Public function

ERDGBuilderF...

 

operator&=

(
    ERDGBuilderFlags& Lhs,
    ERDGBuilderFlags Rhs
)

Public function

ERDGPassFlag...

 

operator&=

(
    ERDGPassFlags& Lhs,
    ERDGPassFlags Rhs
)

Public function

ERDGBufferFl...

 

operator&=

(
    ERDGBufferFlags& Lhs,
    ERDGBufferFlags Rhs
)

Public function

ERDGTextureF...

 

operator&=

(
    ERDGTextureFlags& Lhs,
    ERDGTextureFlags Rhs
)

Public function

ERDGUnordere...

 

operator&=

(
    ERDGUnorderedAccessViewFlags& Lhs,
    ERDGUnorderedAccessViewFlags Rhs
)

Public function

ERDGResource...

 

operator&=

(
    ERDGResourceExtractionFlags& Lhs,
    ERDGResourceExtractionFlags Rhs
)

Public function

ERDGInitialD...

 

operator&=

(
    ERDGInitialDataFlags& Lhs,
    ERDGInitialDataFlags Rhs
)

Public function

EShaderPermu...

 

operator&=

(
    EShaderPermutationFlags& Lhs,
    EShaderPermutationFlags Rhs
)

Public function

EVertexStrea...

 

operator&=

(
    EVertexStreamUsage& Lhs,
    EVertexStreamUsage Rhs
)

Public function

EVTProducePa...

 

operator&=

(
    EVTProducePageFlags& Lhs,
    EVTProducePageFlags Rhs
)

Public function

FVisualizeTe...

 

operator&=

(
    FVisualizeTexture::EFlags& Lhs,
    FVisualizeTexture::EFlags Rhs
)

Public function

EVertexFacto...

 

operator&=

(
    EVertexFactoryFlags& Lhs,
    EVertexFactoryFlags Rhs
)

Public function

constexpr FV...

 

operator^

(
    FVisualizeTexture::EFlags Lhs,
    FVisualizeTexture::EFlags Rhs
)

Public function

constexpr EV...

 

operator^

(
    EVertexFactoryFlags Lhs,
    EVertexFactoryFlags Rhs
)

Public function

constexpr EV...

 

operator^

(
    EVertexStreamUsage Lhs,
    EVertexStreamUsage Rhs
)

Public function

constexpr ES...

 

operator^

(
    EShaderCodeFeatures Lhs,
    EShaderCodeFeatures Rhs
)

Public function

constexpr ES...

 

operator^

(
    EShaderPermutationFlags Lhs,
    EShaderPermutationFlags Rhs
)

Public function

constexpr EV...

 

operator^

(
    EVTProducePageFlags Lhs,
    EVTProducePageFlags Rhs
)

Public function

constexpr ER...

 

operator^

(
    ERDGResourceExtractionFlags Lhs,
    ERDGResourceExtractionFlags Rhs
)

Public function

constexpr ER...

 

operator^

(
    ERDGUnorderedAccessViewFlags Lhs,
    ERDGUnorderedAccessViewFlags Rhs
)

Public function

constexpr ER...

 

operator^

(
    ERDGTextureFlags Lhs,
    ERDGTextureFlags Rhs
)

Public function

constexpr ER...

 

operator^

(
    ERDGBufferFlags Lhs,
    ERDGBufferFlags Rhs
)

Public function

constexpr ER...

 

operator^

(
    ERDGPassFlags Lhs,
    ERDGPassFlags Rhs
)

Public function

constexpr ER...

 

operator^

(
    ERDGBuilderFlags Lhs,
    ERDGBuilderFlags Rhs
)

Public function

constexpr ER...

 

operator^

(
    ERDGInitialDataFlags Lhs,
    ERDGInitialDataFlags Rhs
)

Public function

FVisualizeTe...

 

operator^=

(
    FVisualizeTexture::EFlags& Lhs,
    FVisualizeTexture::EFlags Rhs
)

Public function

EVTProducePa...

 

operator^=

(
    EVTProducePageFlags& Lhs,
    EVTProducePageFlags Rhs
)

Public function

EVertexFacto...

 

operator^=

(
    EVertexFactoryFlags& Lhs,
    EVertexFactoryFlags Rhs
)

Public function

EVertexStrea...

 

operator^=

(
    EVertexStreamUsage& Lhs,
    EVertexStreamUsage Rhs
)

Public function

EShaderCodeF...

 

operator^=

(
    EShaderCodeFeatures& Lhs,
    EShaderCodeFeatures Rhs
)

Public function

ERDGTextureF...

 

operator^=

(
    ERDGTextureFlags& Lhs,
    ERDGTextureFlags Rhs
)

Public function

ERDGResource...

 

operator^=

(
    ERDGResourceExtractionFlags& Lhs,
    ERDGResourceExtractionFlags Rhs
)

Public function

ERDGBufferFl...

 

operator^=

(
    ERDGBufferFlags& Lhs,
    ERDGBufferFlags Rhs
)

Public function

ERDGPassFlag...

 

operator^=

(
    ERDGPassFlags& Lhs,
    ERDGPassFlags Rhs
)

Public function

ERDGBuilderF...

 

operator^=

(
    ERDGBuilderFlags& Lhs,
    ERDGBuilderFlags Rhs
)

Public function

ERDGInitialD...

 

operator^=

(
    ERDGInitialDataFlags& Lhs,
    ERDGInitialDataFlags Rhs
)

Public function

EShaderPermu...

 

operator^=

(
    EShaderPermutationFlags& Lhs,
    EShaderPermutationFlags Rhs
)

Public function

ERDGUnordere...

 

operator^=

(
    ERDGUnorderedAccessViewFlags& Lhs,
    ERDGUnorderedAccessViewFlags Rhs
)

Public function

constexpr ER...

 

operator|

(
    ERDGBuilderFlags Lhs,
    ERDGBuilderFlags Rhs
)

Public function

constexpr FV...

 

operator|

(
    FVisualizeTexture::EFlags Lhs,
    FVisualizeTexture::EFlags Rhs
)

Public function

constexpr EV...

 

operator|

(
    EVTProducePageFlags Lhs,
    EVTProducePageFlags Rhs
)

Public function

constexpr EV...

 

operator|

(
    EVertexFactoryFlags Lhs,
    EVertexFactoryFlags Rhs
)

Public function

constexpr EV...

 

operator|

(
    EVertexStreamUsage Lhs,
    EVertexStreamUsage Rhs
)

Public function

constexpr ES...

 

operator|

(
    EShaderCodeFeatures Lhs,
    EShaderCodeFeatures Rhs
)

Public function

constexpr ER...

 

operator|

(
    ERDGPassFlags Lhs,
    ERDGPassFlags Rhs
)

Public function

constexpr ER...

 

operator|

(
    ERDGInitialDataFlags Lhs,
    ERDGInitialDataFlags Rhs
)

Public function

constexpr ER...

 

operator|

(
    ERDGResourceExtractionFlags Lhs,
    ERDGResourceExtractionFlags Rhs
)

Public function

constexpr ER...

 

operator|

(
    ERDGUnorderedAccessViewFlags Lhs,
    ERDGUnorderedAccessViewFlags Rhs
)

Public function

constexpr ER...

 

operator|

(
    ERDGTextureFlags Lhs,
    ERDGTextureFlags Rhs
)

Public function

constexpr ER...

 

operator|

(
    ERDGBufferFlags Lhs,
    ERDGBufferFlags Rhs
)

Public function

constexpr ES...

 

operator|

(
    EShaderPermutationFlags Lhs,
    EShaderPermutationFlags Rhs
)

Public function

EVTProducePa...

 

operator|=

(
    EVTProducePageFlags& Lhs,
    EVTProducePageFlags Rhs
)

Public function

EVertexFacto...

 

operator|=

(
    EVertexFactoryFlags& Lhs,
    EVertexFactoryFlags Rhs
)

Public function

EVertexStrea...

 

operator|=

(
    EVertexStreamUsage& Lhs,
    EVertexStreamUsage Rhs
)

Public function

EShaderCodeF...

 

operator|=

(
    EShaderCodeFeatures& Lhs,
    EShaderCodeFeatures Rhs
)

Public function

ERDGInitialD...

 

operator|=

(
    ERDGInitialDataFlags& Lhs,
    ERDGInitialDataFlags Rhs
)

Public function

ERDGTextureF...

 

operator|=

(
    ERDGTextureFlags& Lhs,
    ERDGTextureFlags Rhs
)

Public function

ERDGUnordere...

 

operator|=

(
    ERDGUnorderedAccessViewFlags& Lhs,
    ERDGUnorderedAccessViewFlags Rhs
)

Public function

ERDGBufferFl...

 

operator|=

(
    ERDGBufferFlags& Lhs,
    ERDGBufferFlags Rhs
)

Public function

ERDGPassFlag...

 

operator|=

(
    ERDGPassFlags& Lhs,
    ERDGPassFlags Rhs
)

Public function

FVisualizeTe...

 

operator|=

(
    FVisualizeTexture::EFlags& Lhs,
    FVisualizeTexture::EFlags Rhs
)

Public function

ERDGResource...

 

operator|=

(
    ERDGResourceExtractionFlags& Lhs,
    ERDGResourceExtractionFlags Rhs
)

Public function

ERDGBuilderF...

 

operator|=

(
    ERDGBuilderFlags& Lhs,
    ERDGBuilderFlags Rhs
)

Public function

EShaderPermu...

 

operator|=

(
    EShaderPermutationFlags& Lhs,
    EShaderPermutationFlags Rhs
)

Public function

constexpr ER...

 

operator~

(
    ERDGTextureFlags E
)

Public function

constexpr ER...

 

operator~

(
    ERDGBufferFlags E
)

Public function

constexpr FV...

 

operator~

(
    FVisualizeTexture::EFlags E
)

Public function

constexpr EV...

 

operator~

(
    EVTProducePageFlags E
)

Public function

constexpr EV...

 

operator~

(
    EVertexFactoryFlags E
)

Public function

constexpr EV...

 

operator~

(
    EVertexStreamUsage E
)

Public function

constexpr ER...

 

operator~

(
    ERDGPassFlags E
)

Public function

constexpr ES...

 

operator~

(
    EShaderPermutationFlags E
)

Public function

constexpr ER...

 

operator~

(
    ERDGInitialDataFlags E
)

Public function

constexpr ER...

 

operator~

(
    ERDGResourceExtractionFlags E
)

Public function

constexpr ER...

 

operator~

(
    ERDGUnorderedAccessViewFlags E
)

Public function

constexpr ES...

 

operator~

(
    EShaderCodeFeatures E
)

Public function

constexpr ER...

 

operator~

(
    ERDGBuilderFlags E
)

Public function

bool

 

operator==

(
    const FAllocatedVTDescription& Lhs,
    const FAllocatedVTDescription& Rhs
)

Public function

bool

 

operator==

(
    const FVirtualTextureLocalTile& Lh...,
    const FVirtualTextureLocalTile& Rh...
)

Public function

bool

 

operator==

(
    const FParameterAllocation& A,
    const FParameterAllocation& B
)

Public function

bool

 

operator==

(
    const TShaderRefBase< ShaderType0, ...,
    const TShaderRefBase< ShaderType1, ...
)

Public function

bool

 

operator==

(
    const FVirtualTextureProducerHandle...,
    const FVirtualTextureProducerHandle...
)

Public function

bool

 

operator==

(
    const FShaderCodeVendorExtension& ...,
    const FShaderCodeVendorExtension& ...
)

Public function

EShaderCodeR...

 

ParseShaderResourceBindingType

(
    const TCHAR* ShaderType
)

Parse the shader resource binding from the binding type used in shader code.

Public function

FString

 

ParseVirtualShaderFilename

(
    const FString& InFilename
)

Converts an absolute or relative shader filename to a filename relative to the shader directory.

Public function

bool

 

PlatformRequires128bitRT

(
    EPixelFormat PixelFormat
)

Note, this should only be used when a platform requires special shader compilation for 32 bit pixel format render targets.

Public function

bool

 

PlatformSupportsSimpleForwardShading

(
    const FStaticShaderPlatform Platfor...
)

Public function

bool

 

PlatformSupportsVelocityRendering

(
    const FStaticShaderPlatform Platfor...
)

Public function

void

 

QuantizeSceneBufferSize

(
    const FIntPoint& InBufferSize,
    FIntPoint& OutBufferSize
)

Takes the requested buffer size and quantizes it to an appropriate size for the rest of the rendering pipeline.

Public function

FRDGTextureR...

 

RegisterExternalTexture

(
    FRDGBuilder& GraphBuilder,
    FRHITexture* Texture,
    const TCHAR* NameIfUnregistere...
)

Public function

FRDGTextureM...

 

RegisterExternalTextureMSAA

(
    FRDGBuilder& GraphBuilder,
    const TRefCountPtr< IPooledRenderTa...
)

Public function

FRDGTextureM...

 

RegisterExternalTextureMSAAWithFallback

(
    FRDGBuilder& GraphBuilder,
    const TRefCountPtr< IPooledRenderTa...,
    const TRefCountPtr< IPooledRenderTa...
)

Public function

FRDGTextureR...

 

RegisterExternalTextureWithFallback

(
    FRDGBuilder& GraphBuilder,
    const TRefCountPtr< IPooledRenderTa...,
    const TRefCountPtr< IPooledRenderTa...,
    ERenderTargetTexture ExternalTextur...,
    ERenderTargetTexture FallbackTextur...
)

Register external texture with fallback if the resource is invalid.

Public function

FDelegateHan...

 

RegisterStopRenderingThreadDelegate

(
    const FStopRenderingThreadDelegate ...
)

Public function

void

 

ReleaseResourceAndFlush

(
    FRenderResource* Resource
)

Sends a message to the rendering thread to release a resource, and spins until the rendering thread has processed the message.

Public function

void

 

RenderUtilsInit()

Public function

bool

 

ReplaceVirtualFilePathForShaderAutogen

(
    FString& InOutVirtualFilePath,
    EShaderPlatform ShaderPlatform
)

Replaces virtual platform path with appropriate autogen path for a given ShaderPlatform.

Public function

bool

 

ReplaceVirtualFilePathForShaderPlatform

(
    FString& InOutVirtualFilePath,
    EShaderPlatform ShaderPlatform
)

Replaces virtual platform path with appropriate path for a given ShaderPlatform.

Public function

void

 

ResetAllShaderSourceDirectoryMappings()

Hook for shader compile worker to reset the directory mappings.

Public function

bool

 

ResizeResourceIfNeeded

(
    FRDGBuilder& GraphBuilder,
    FRWBuffer& Buffer,
    EPixelFormat Format,
    uint32 NumElements,
    const TCHAR* DebugName
)

Public function

bool

 

ResizeResourceIfNeeded

(
    FRHICommandList& RHICmdList,
    FRWBuffer& Buffer,
    EPixelFormat Format,
    uint32 NumElements,
    const TCHAR* DebugName
)

Public function

bool

 

ResizeResourceIfNeeded

(
    FRDGBuilder& GraphBuilder,
    FRWBufferStructured& Buffer,
    uint32 NumBytes,
    const TCHAR* DebugName
)

Public function

bool

 

ResizeResourceIfNeeded

(
    FRHICommandList& RHICmdList,
    ResourceType& Texture,
    uint32 NumBytes,
    const TCHAR* DebugName
)

Public function

bool

 

ResizeResourceIfNeeded

(
    FRDGBuilder& GraphBuilder,
    FRWByteAddressBuffer& Buffer,
    uint32 NumBytes,
    const TCHAR* DebugName
)

Public function

bool

 

ResizeResourceSOAIfNeeded

(
    FRDGBuilder& GraphBuilder,
    FRWBufferStructured& Buffer,
    const FResizeResourceSOAParams& Pa...,
    const TCHAR* DebugName
)

This version will resize/allocate the buffer at once and add a RDG pass to perform the copy on the RDG time-line if there was previous data).

Public function

bool

 

ResizeResourceSOAIfNeeded

(
    FRHICommandList& RHICmdList,
    ResourceType& Texture,
    const FResizeResourceSOAParams& Pa...,
    const TCHAR* DebugName
)

Public function

void

 

RestoreGlobalShaderMap

(
    const FGlobalShaderBackupData& Glo...
)

Recreates shaders in the global shader map from the serialized memory.

Public function

void

 

SerializeUniformBufferInfo

(
    FShaderSaveArchive& Ar,
    const TSortedMap< const TCHAR*...
)

Records information about all the uniform buffer layouts referenced by UniformBufferEntries.

Public function

void

 

SetLocalUniformBufferParameter

(
    FRHICommandList& RHICmdList,
    const TShaderRHIRef& Shader,
    const FShaderUniformBufferParameter...,
    const FLocalUniformBuffer& LocalUn...
)

Sets the value of a shader uniform buffer parameter to a uniform buffer containing the struct.

Public function

void

 

SetPixelShaderBool

(
    FRHICommandList& RHICmdList,
    FRHIPixelShader* PixelShader,
    const FShaderParameter& Parameter,
    bool Value
)

Please use integer values for boolean shader parameters instead.

Public function

void

 

SetRHIThreadEnabled

(
    bool bEnableDedicatedThread,
    bool bEnableRHIOnTaskThreads
)

Public function

void

 

SetSamplerParameter

(
    TRHICmdList& RHICmdList,
    TRHIShader* Shader,
    const FShaderResourceParameter& Pa...,
    FRHISamplerState* SamplerState...
)

Sets the value of a shader sampler parameter. Template'd on shader type.

Public function

void

 

SetShaderParameters

(
    TRHICmdList& RHICmdList,
    const TShaderRef< TShaderClass >& ...,
    TShaderRHI* ShadeRHI,
    const FShaderParametersMetadata...,
    const typename TShaderClass::FParam...
)

Set shader's parameters from its parameters struct.

Public function

void

 

SetShaderParameters

(
    TRHICmdList& RHICmdList,
    const TShaderRef< TShaderClass >& ...,
    TShaderRHI* ShaderRHI,
    const typename TShaderClass::FParam...
)

Public function

void

 

SetShaderUAV

(
    TRHICmdList& RHICmdList,
    const TShaderRef< TShaderClass >& ...,
    FRHIPixelShader* ShadeRHI,
    const uint8* Base,
    const FShaderParameterBindings::FRe...
)

Public function

void

 

SetShaderUAV

(
    TRHICmdList& RHICmdList,
    const TShaderRef< TShaderClass >& ...,
    FRHIComputeShader* ShadeRHI,
    const uint8* Base,
    const FShaderParameterBindings::FRe...
)

Public function

void

 

SetShaderUAV

(
    TRHICmdList& RHICmdList,
    const TShaderRef< TShaderClass >& ...,
    TShaderRHI* ShadeRHI,
    const uint8* Base,
    const FShaderParameterBindings::FRe...
)

Set compute shader UAVs.

Public function

void

 

SetShaderValue

(
    TRHICmdList& RHICmdList,
    const ShaderRHIParamRef& Shader,
    const FShaderParameter& Parameter,
    const ParameterType& Value,
    uint32 ElementIndex
)

Sets the value of a shader parameter.

Public function

void

 

SetShaderValue

(
    FRHICommandList& RHICmdList,
    const ShaderRHIParamRef& Shader,
    const FShaderParameter& Parameter,
    bool Value,
    uint32 ElementIndex
)

Please use integer values for boolean shader parameters instead.

Public function

void

 

SetShaderValue

(
    FRHIComputeCommandList& RHICmdList,
    const ShaderRHIParamRef& Shader,
    const FShaderParameter& Parameter,
    bool Value,
    uint32 ElementIndex
)

Please use integer values for boolean shader parameters instead.

Public function

void

 

SetShaderValue

(
    FRHICommandListImmediate& RHICmdLi...,
    const ShaderRHIParamRef& Shader,
    const FShaderParameter& Parameter,
    bool Value,
    uint32 ElementIndex
)

Please use integer values for boolean shader parameters instead.

Public function

void

 

SetShaderValue

(
    TRHICmdList& RHICmdList,
    const ShaderRHIParamRef& Shader,
    const FShaderParameter& Parameter,
    const FMatrix44d& Value,
    uint32 ElementIndex
)

Primary.

Public function

void

 

SetShaderValue

(
    TRHICmdList& RHICmdList,
    const ShaderRHIParamRef& Shader,
    const FShaderParameter& Parameter,
    const FVector2d& Value,
    uint32 ElementIndex
)

Public function

void

 

SetShaderValue

(
    TRHICmdList& RHICmdList,
    const ShaderRHIParamRef& Shader,
    const FShaderParameter& Parameter,
    const FVector3d& Value,
    uint32 ElementIndex
)

Public function

void

 

SetShaderValue

(
    TRHICmdList& RHICmdList,
    const ShaderRHIParamRef& Shader,
    const FShaderParameter& Parameter,
    const FVector4d& Value,
    uint32 ElementIndex
)

Public function

void

 

SetShaderValue

(
    TRHICmdList& RHICmdList,
    const ShaderRHIParamRef& Shader,
    const FShaderParameter& Parameter,
    const FSphere3d& Value,
    uint32 ElementIndex
)

Secondary.

Public function

void

 

SetShaderValue

(
    TRHICmdList& RHICmdList,
    const ShaderRHIParamRef& Shader,
    const FShaderParameter& Parameter,
    const FBox3d& Value,
    uint32 ElementIndex
)

Public function

void

 

SetShaderValue

(
    TRHICmdList& RHICmdList,
    const ShaderRHIParamRef& Shader,
    const FShaderParameter& Parameter,
    const FQuat4d& Value,
    uint32 ElementIndex
)

Public function

void

 

SetShaderValue

(
    TRHICmdList& RHICmdList,
    const ShaderRHIParamRef& Shader,
    const FShaderParameter& Parameter,
    const FPlane4d& Value,
    uint32 ElementIndex
)

Public function

void

 

SetShaderValueArray

(
    TRHICmdList& RHICmdList,
    const ShaderRHIParamRef& Shader,
    const FShaderParameter& Parameter,
    const ParameterType* Values,
    uint32 NumElements,
    uint32 BaseElementIndex
)

Sets the value of a shader parameter array.

Public function

void

 

SetShaderValueArray

(
    TRHICmdList& RHICmdList,
    const ShaderRHIParamRef& Shader,
    const FShaderParameter& Parameter,
    const bool* Values,
    uint32 NumElements,
    uint32 BaseElementIndex
)

Specialization of the above for C++ bool type.

Public function

void

 

SetShaderValueArray

(
    TRHICmdList& RHICmdList,
    const ShaderRHIParamRef& Shader,
    const FShaderParameter& Parameter,
    const FMatrix44d* Values,
    uint32 NumElements,
    uint32 BaseElementIndex
)

Public function

void

 

SetShaderValueArray

(
    TRHICmdList& RHICmdList,
    const ShaderRHIParamRef& Shader,
    const FShaderParameter& Parameter,
    const FVector2d* Values,
    uint32 NumElements,
    uint32 BaseElementIndex
)

Public function

void

 

SetShaderValueArray

(
    TRHICmdList& RHICmdList,
    const ShaderRHIParamRef& Shader,
    const FShaderParameter& Parameter,
    const FVector3d* Values,
    uint32 NumElements,
    uint32 BaseElementIndex
)

Public function

void

 

SetShaderValueArray

(
    TRHICmdList& RHICmdList,
    const ShaderRHIParamRef& Shader,
    const FShaderParameter& Parameter,
    const FVector4d* Values,
    uint32 NumElements,
    uint32 BaseElementIndex
)

Public function

void

 

SetShaderValueArray

(
    TRHICmdList& RHICmdList,
    const ShaderRHIParamRef& Shader,
    const FShaderParameter& Parameter,
    const FPlane4d* Values,
    uint32 NumElements,
    uint32 BaseElementIndex
)

Public function

void

 

SetShaderValueArray

(
    TRHICmdList& RHICmdList,
    const ShaderRHIParamRef& Shader,
    const FShaderParameter& Parameter,
    const FQuat4d* Values,
    uint32 NumElements,
    uint32 BaseElementIndex
)

Public function

void

 

SetShaderValueArray

(
    TRHICmdList& RHICmdList,
    const ShaderRHIParamRef& Shader,
    const FShaderParameter& Parameter,
    const FSphere3d* Values,
    uint32 NumElements,
    uint32 BaseElementIndex
)

Public function

void

 

SetShaderValueArray

(
    TRHICmdList& RHICmdList,
    const ShaderRHIParamRef& Shader,
    const FShaderParameter& Parameter,
    const FBox3d* Values,
    uint32 NumElements,
    uint32 BaseElementIndex
)

Public function

void

 

SetShaderValueOnContext

(
    IRHICommandContext& RHICmdListCont...,
    const ShaderRHIParamRef& Shader,
    const FShaderParameter& Parameter,
    const FBox3d& Value,
    uint32 ElementIndex
)

Public function

void

 

SetShaderValueOnContext

(
    IRHICommandContext& RHICmdListCont...,
    const ShaderRHIParamRef& Shader,
    const FShaderParameter& Parameter,
    const ParameterType& Value,
    uint32 ElementIndex
)

Public function

void

 

SetShaderValueOnContext

(
    IRHICommandContext& RHICmdListCont...,
    const ShaderRHIParamRef& Shader,
    const FShaderParameter& Parameter,
    const FVector3d& Value,
    uint32 ElementIndex
)

Public function

void

 

SetShaderValueOnContext

(
    IRHICommandContext& RHICmdListCont...,
    const ShaderRHIParamRef& Shader,
    const FShaderParameter& Parameter,
    const FVector2d& Value,
    uint32 ElementIndex
)

Public function

void

 

SetShaderValueOnContext

(
    IRHICommandContext& RHICmdListCont...,
    const ShaderRHIParamRef& Shader,
    const FShaderParameter& Parameter,
    const FSphere3d& Value,
    uint32 ElementIndex
)

Public function

void

 

SetShaderValueOnContext

(
    IRHICommandContext& RHICmdListCont...,
    const ShaderRHIParamRef& Shader,
    const FShaderParameter& Parameter,
    const FQuat4d& Value,
    uint32 ElementIndex
)

Public function

void

 

SetShaderValueOnContext

(
    IRHICommandContext& RHICmdListCont...,
    const ShaderRHIParamRef& Shader,
    const FShaderParameter& Parameter,
    const FPlane4d& Value,
    uint32 ElementIndex
)

Public function

void

 

SetShaderValueOnContext

(
    IRHICommandContext& RHICmdListCont...,
    const ShaderRHIParamRef& Shader,
    const FShaderParameter& Parameter,
    const FVector4d& Value,
    uint32 ElementIndex
)

Public function

void

 

SetShaderValueOnContext

(
    IRHICommandContext& RHICmdListCont...,
    const ShaderRHIParamRef& Shader,
    const FShaderParameter& Parameter,
    const FMatrix44d& Value,
    uint32 ElementIndex
)

Public function

void

 

SetSRVParameter

(
    TRHICmdList& RHICmdList,
    TRHIShader* Shader,
    const FShaderResourceParameter& Pa...,
    FRHIShaderResourceView* NewSha...
)

Sets the value of a shader resource view parameter Template'd on shader type (e.g. pixel shader or compute shader).

Public function

void

 

SetSRVParameter

(
    TRHICmdList& RHICmdList,
    const TRefCountPtr< TRHIShader >& ...,
    const FShaderResourceParameter& Pa...,
    FRHIShaderResourceView* NewSha...
)

Public function

void

 

SetTextureParameter

(
    TRHICmdList& RHICmdList,
    TRHIShader* Shader,
    const FShaderResourceParameter& Te...,
    const FShaderResourceParameter& Sa...,
    FRHISamplerState* SamplerState...,
    FRHITexture* TextureRHI,
    uint32 ElementIndex
)

Sets the value of a shader texture parameter. Template'd on shader type.

Public function

void

 

SetTextureParameter

(
    TRHICmdList& RHICmdList,
    TRHIShader* Shader,
    const FShaderResourceParameter& Te...,
    const FShaderResourceParameter& Sa...,
    const FTexture* Texture,
    uint32 ElementIndex
)

Sets the value of a shader texture parameter. Template'd on shader type

Public function

void

 

SetTextureParameter

(
    TRHICmdList& RHICmdList,
    TRHIShader* Shader,
    const FShaderResourceParameter& Pa...,
    FRHITexture* NewTextureRHI
)

Sets the value of a shader surface parameter (e.g. to access MSAA samples).

Public function

void

 

SetUAVParameter

(
    TRHICmdList& RHICmdList,
    FRHIComputeShader* ComputeShad...,
    const FShaderResourceParameter& Pa...,
    FRHIUnorderedAccessView* NewUn...
)

Sets the value of a unordered access view parameter

Public function

void

 

SetUAVParameter

(
    TRHICmdList& RHICmdList,
    FRHIPixelShader* PixelShader,
    const FShaderResourceParameter& Pa...,
    FRHIUnorderedAccessView* NewUn...
)

Sets the value of a unordered access view parameter

Public function

bool

 

SetUAVParameterIfCS

(
    TRHICmdList& RHICmdList,
    FRHIComputeShader* Shader,
    const FShaderResourceParameter& UA...,
    FRHIUnorderedAccessView* UAV
)

Public function

bool

 

SetUAVParameterIfCS

(
    TRHICmdList& RHICmdList,
    FRHIVertexShader* Shader,
    const FShaderResourceParameter& UA...,
    FRHIUnorderedAccessView* UAV
)

Public function

bool

 

SetUAVParameterIfCS

(
    TRHICmdList& RHICmdList,
    FRHIPixelShader* Shader,
    const FShaderResourceParameter& UA...,
    FRHIUnorderedAccessView* UAV
)

Public function

bool

 

SetUAVParameterIfCS

(
    TRHICmdList& RHICmdList,
    FRHIGeometryShader* Shader,
    const FShaderResourceParameter& UA...,
    FRHIUnorderedAccessView* UAV
)

Public function

void

 

SetUniformBufferParameter

(
    TRHICmdList& RHICmdList,
    const TShaderRHIRef& Shader,
    const TShaderUniformBufferParameter...,
    const TUniformBufferRef< TBufferStr...
)

Sets the value of a shader uniform buffer parameter to a uniform buffer containing the struct.

Public function

void

 

SetUniformBufferParameter

(
    TRHICmdList& RHICmdList,
    const TShaderRHIRef& Shader,
    const TShaderUniformBufferParameter...,
    const TUniformBuffer< TBufferStruct...
)

Sets the value of a shader uniform buffer parameter to a uniform buffer containing the struct.

Public function

void

 

SetUniformBufferParameter

(
    TRHICmdList& RHICmdList,
    const TShaderRHIRef& Shader,
    const FShaderUniformBufferParameter...,
    FRHIUniformBuffer* UniformBuff...
)

Sets the value of a shader uniform buffer parameter to a uniform buffer containing the struct.

Public function

void

 

SetUniformBufferParameterImmediate

(
    TRHICmdList& RHICmdList,
    const TShaderRHIRef& Shader,
    const TShaderUniformBufferParameter...,
    const TBufferStruct& UniformBuffer...
)

Sets the value of a shader uniform buffer parameter to a value of the struct.

Public function

void

 

SetUniformBufferParameterImmediate

(
    FRHICommandList& RHICmdList,
    const TShaderRHIRef& Shader,
    const TShaderUniformBufferParameter...,
    const TBufferStruct& UniformBuffer...
)

Sets the value of a shader uniform buffer parameter to a value of the struct.

Public function

void

 

ShaderMapAppendKeyString

(
    EShaderPlatform Platform,
    FString& KeyString
)

Appends to KeyString for all shaders.

Public function

bool

 

ShouldAllowUniqueShaderSymbols

(
    FName ShaderFormat
)

Returns true if (external) shader symbols should be specific to each shader rather than be de-duplicated.

Public function

bool

 

ShouldCompileRayTracingShadersForProject

(
    EShaderPlatform ShaderPlatform
)

Public function

bool

 

ShouldEnableExtraShaderData

(
    FName ShaderFormat
)

Returns true if the user wants more runtime shader data (names, extra info)

Public function

bool

 

ShouldExportShaderDebugInfo

(
    EShaderPlatform Platform
)

ShouldWriteShaderSymbols should be called to determine if symbols (debug data) should be written

Public function

bool

 

ShouldGenerateShaderSymbols

(
    FName ShaderFormat
)

Returns true if shader symbols should be kept for a given platform.

Public function

bool

 

ShouldKeepShaderDebugInfo

(
    EShaderPlatform Platform
)

ShouldGenerateShaderSymbols should be called to determine if symbols (debug data) should be generated

Public function

bool

 

ShouldOptimizeShaders

(
    FName ShaderFormat
)

Public function

bool

 

ShouldUseStableConstantBuffer

(
    const FShaderCompilerInput& Input
)

Public function

bool

 

ShouldWriteShaderSymbols

(
    FName ShaderFormat
)

Returns true if shader symbols should be exported to separate files for a given platform.

Public function

bool

 

ShouldWriteShaderSymbolsAsZip

(
    FName ShaderFormat
)

Returns true if shaders should be combined into a single zip file instead of individual files.

Public function

void

 

StartBatchedRelease()

Enables the batching of calls to BeginReleaseResource This is called in the game thread.

Public function

void

 

StartRenderCommandFenceBundler()

Public function

void

 

StartRenderingThread()

Starts the rendering thread.

Public function

void

 

StopRenderCommandFenceBundler()

Public function

void

 

StopRenderingThread()

Stops the rendering thread.

Public function

bool

 

SupportsGen4TAA

(
    const FStaticShaderPlatform Platfor...
)

Public function

bool

 

SupportShaderPrecisionModifier

(
    EShaderPlatform Platform
)

Returns whether EShaderPrecisionModifier is supported.

Public function

bool

 

SupportsTextureCubeArray

(
    ERHIFeatureLevel::Type FeatureLevel
)

Public function

bool

 

SupportsTSR

(
    const FStaticShaderPlatform Platfor...
)

Public function

void

 

TickRenderingTickables()

Public function

FPooledRende...

 

Translate

(
    const FRDGTextureDesc& InDesc
)

Translates from an RDG texture descriptor to a pooled render target descriptor.

Public function

FRHIBufferCr...

 

Translate

(
    const FRDGBufferDesc& InDesc
)

Translates from a RDG buffer descriptor to a RHI buffer creation info

Public function

FRHIBufferCr...

 

Translate

(
    const FRDGBufferDesc& InDesc
)

Translates from a RDG buffer descriptor to a RHI buffer creation info

Public function

FPooledRende...

 

Translate

(
    const FRDGTextureDesc& InDesc
)

Translates from an RDG texture descriptor to a pooled render target descriptor.

Public function

FRDGTextureD...

 

Translate

(
    const FPooledRenderTargetDesc& InD...,
    ERenderTargetTexture InTexture
)

Translates from a pooled render target descriptor to an RDG texture descriptor.

Public function

FRDGTextureD...

 

Translate

(
    const FPooledRenderTargetDesc& InD...,
    ERenderTargetTexture InTexture
)

Translates from a pooled render target descriptor to an RDG texture descriptor.

Public function

IPooledRende...

 

TryGetPooledRenderTarget

(
    FRDGTextureRef Texture
)

Accessing the underlying pooled render target has been deprecated. Use TryGetRHI() instead.

Public function

FRHITexture ...

 

TryGetRHI

(
    FRDGTextureRef Texture
)

Returns the RHI texture from an RDG texture if it exists, or null otherwise.

Public function

FRDGBufferRe...

 

TryRegisterExternalBuffer

(
    FRDGBuilder& GraphBuilder,
    const TRefCountPtr< FRDGPooledBuffe...,
    ERDGBufferFlags Flags
)

Variants of RegisterExternalBuffer which will return null (rather than assert) if the external buffer is null.

Public function

FRDGTextureR...

 

TryRegisterExternalTexture

(
    FRDGBuilder& GraphBuilder,
    const TRefCountPtr< IPooledRenderTa...,
    ERenderTargetTexture RenderTargetTe...,
    ERDGTextureFlags Flags
)

Variants of RegisterExternalTexture which will returns null (rather than assert) if the external texture is null.

Public function

FRDGTextureM...

 

TryRegisterExternalTextureMSAA

(
    FRDGBuilder& GraphBuilder,
    const TRefCountPtr< IPooledRenderTa...
)

Public function

bool

 

UE::PipelineCacheUtilities::LoadStableKeysFile

(
    const FStringView& Filename,
    TArray< FStableShaderKeyAndValue > ...
)

Loads stable shader keys file (using a proprietary format).

Public function

bool

 

UE::PipelineCacheUtilities::LoadStablePipelineCacheFile

(
    const FString& Filename,
    const TMultiMap< FStableShaderKeyAn...,
    TSet< FPipelineCacheFileFormatPSO >...,
    FName& OutTargetPlatform,
    int32& OutPSOsRejected,
    int32& OutPSOsMerged
)

Loads stable pipeline cache file.

Public function

bool

 

UE::PipelineCacheUtilities::SaveStableKeysFile

(
    const FStringView& Filename,
    const TSet< FStableShaderKeyAndValu...
)

Saves stable shader keys file (using a proprietary format).

Public function

bool

 

UE::PipelineCacheUtilities::SaveStablePipelineCacheFile

(
    const FString& OutputFilename,
    const TArray< FPermsPerPSO >& Stab...,
    const TArray< FStableShaderKeyAndVa...
)

Saves stable pipeline cache file.

Public function

void

 

UninitializeShaderTypes()

Uninitializes cached shader type data.

Public function

FVector2f

 

UnitVectorToHemiOctahedron

(
    const FVector3f& N
)

Public function

void

 

UnregisterStopRenderingThreadDelegate

(
    FDelegateHandle InDelegateHandle
)

Public function

void

 

UnsetShaderUAVs

(
    TRHICmdList& RHICmdList,
    const TShaderRef< TShaderClass >& ...,
    FRHIComputeShader* ShadeRHI
)

Unset compute shader UAVs.

Public function

bool

 

UseGPUScene

(
    const FStaticShaderPlatform Platfor...,
    const FStaticFeatureLevel FeatureLe...
)

Public function

bool

 

UseGPUScene

(
    const FStaticShaderPlatform Platfor...
)

Public function

bool

 

UseMobileAmbientOcclusion

(
    const FStaticShaderPlatform Platfor...
)

Public function

bool

 

UseNanite

(
    EShaderPlatform ShaderPlatform,
    bool bCheckForAtomicSupport,
    bool bCheckForProjectSetting
)

Returns true if Nanite rendering should be used for the given shader platform.

Public function

bool

 

UseNonNaniteVirtualShadowMaps

(
    EShaderPlatform ShaderPlatform,
    const FStaticFeatureLevel FeatureLe...
)

Returns true if non-nanite virtual shadow maps are enbled by CVar r.Shadow.Virtual.NonNaniteVSM and UseVirtualShadowMaps is true for the given platform and feature level.

Public function

bool

 

UseVirtualShadowMaps

(
    EShaderPlatform ShaderPlatform,
    const FStaticFeatureLevel FeatureLe...
)

Public function

bool

 

UseVirtualTextureLightmap

(
    const FStaticFeatureLevel InFeature...,
    const ITargetPlatform* TargetP...
)

Checks if virtual texturing lightmap enabled and supported

Public function

bool

 

UseVirtualTexturing

(
    const FStaticFeatureLevel InFeature...,
    const ITargetPlatform* TargetP...
)

Checks if virtual texturing enabled and supported

Public function

void

 

ValidateShaderParameterResourcesRHI

(
    const void* Contents,
    const FRHIUniformBufferLayout& Lay...
)

Validates that all resource parameters of a uniform buffer are set.

Public function

void

 

ValidateShaderParameters

(
    const TShaderRef< FShader >& Shade...,
    const FShaderParametersMetadata...,
    const void* Parameters
)

Validates that all resource parameters of a shader are set.

Public function

void

 

ValidateShaderParameters

(
    const TShaderRef< TShaderClass >& ...,
    const typename TShaderClass::FParam...
)

Public function

bool

 

VelocityEncodeDepth

(
    const FStaticShaderPlatform Platfor...
)

Public function

void

 

VerifyLayout

(
    const TRDGTextureSubresourceArray< ...,
    const FRDGTextureSubresourceLayout ...
)

Public function

void

 

VerifyShaderSourceFiles

(
    EShaderPlatform ShaderPlatform
)

Kick off SHA verification for all shader source files

Public function

bool

 

VTRequestPageStatus_HasData

(
    EVTRequestPageStatus InStatus
)

Check to see there is data available (possibly requiring waiting) given the current status

Variables

Name Description

Public variable

FTexture *

 

GBlackAlpha1VolumeTexture

A global black volume texture, with alpha=1.

Public variable

FTexture *

 

GBlackArrayTexture

A global black array texture.

Public variable

FTexture *

 

GBlackCubeArrayTexture

A global black cube array texture.

Public variable

FTexture *

 

GBlackTexture

A global black texture.

Public variable

FTexture *

 

GBlackTextureCube

A global black cube texture.

Public variable

FTexture *

 

GBlackTextureDepthCube

A global black cube depth texture.

Public variable

FTextureWithSRV...

 

GBlackTextureWithSRV

Public variable

FTexture *

 

GBlackUintTexture

A global black texture

Public variable

FTexture *

 

GBlackUintVolumeTexture

A global black volume texture

Global black volume texture resource.

Public variable

FTexture *

 

GBlackVolumeTexture

A global black volume texture.

Global black volume texture resource.

Public variable

TGlobalResource...

 

GClearVertexBuffer

Public variable

TGlobalResource...

 

GCubeIndexBuffer

Public variable

const uint16[36...

 

GCubeIndices

The indices for drawing a cube.

Public variable

ICustomResource...

 

GCustomResourcePool

Public variable

const uint32

 

GDiffuseConvolveMipLevel

4: 8x8 cubemap resolution, shader needs to use the same value as preprocessing

Public variable

FVertexBufferWi...

 

GEmptyVertexBufferWithUAV

Public variable

TGlobalResource...

 

GEmptyVertexDeclaration

Public variable

float

 

GEnableMipLevelFading

Whether to enable mip-level fading or not: +1.0f if enabled, -1.0f if disabled.

Public variable

TGlobalResource...

 

GFilterVertexDeclaration

Public variable

uint32

 

GGameThreadTime

How many cycles the gamethread used (excluding idle time).

Public variable

int32

 

GGlobalBufferNumFramesUnusedThresold

Number of frames after which unused global resource allocations will be discarded.

Public variable

FGlobalShaderMa...

 

GGlobalShaderMap

The global shader map.

Public variable

FInputLatencyTi...

 

GInputLatencyTimer

Global input latency timer. Defined in UnrealClient.cpp

Public variable

bool

 

GIsThreadedRendering

Render thread API.

Public variable

const int32

 

GlobalShaderMapId

Used to identify the global shader map in compile queues.

Public variable

TAtomic< bool >

 

GMainThreadBlockedOnRenderThread

Whether the main thread is currently blocked on the rendering thread, e.g. a call to FlushRenderingCommands.

Public variable

TGlobalResource...

 

GMediaVertexDeclaration

Public variable

FTexture *

 

GMipColorTexture

A global texture that has a different solid color in each mip-level.

Public variable

int32

 

GMipColorTextureMipLevels

Number of mip-levels in 'GMipColorTexture'

Public variable

FMipFadeSetting...

 

GMipFadeSettings

Global mip fading settings, indexed by EMipFadeSettings.

Public variable

TGlobalResource...

 

GNullColorVertexBuffer

The global null color vertex buffer, which is set with a stride of 0 on meshes without a color component.

Public variable

TGlobalResource...

 

GNullVertexBuffer

The global null vertex buffer, which is set with a stride of 0 on meshes

Public variable

bool

 

GPauseRenderingRealtimeClock

Whether to pause the global realtime clock for the rendering thread (read and write only on main thread).

Public variable

TGlobalResource...

 

GPrimitiveIdDummy

Public variable

TGlobalResource...

 

GPrimitiveIdDummyMobile

Public variable

FTimer

 

GRenderingRealtimeClock

Global realtime clock for the rendering thread.

Public variable

TGlobalResource...

 

GRenderTargetPool

The global render targets for easy shading.

The global render targets pool.

Public variable

uint32[ERenderT...

 

GRenderThreadIdle

Accumulates how many cycles the renderthread has been idle. It's defined in RenderingThread.cpp.

Public variable

uint32[ERenderT...

 

GRenderThreadNumIdle

Accumulates how times renderthread was idle. It's defined in RenderingThread.cpp.

Public variable

uint32

 

GRenderThreadTime

How many cycles the renderthread used (excluding idle time).

Public variable

uint32

 

GRHIThreadTime

How many cycles the rhithread used (excluding idle time).

Public variable

TGlobalResource...

 

GScreenRectangleIndexBuffer

Public variable

TGlobalResource...

 

GScreenRectangleVertexBuffer

Public variable

TGlobalResource...

 

GScreenSpaceVertexBuffer

Public variable

uint32

 

GSwapBufferTime

How many cycles it took to swap buffers to present the frame.

Public variable

TGlobalResource...

 

GTileVertexDeclaration

Public variable

FTexture *

 

GTransparentBlackTexture

Public variable

FTextureWithSRV...

 

GTransparentBlackTextureWithSRV

Public variable

TGlobalResource...

 

GTwoTrianglesIndexBuffer

Public variable

bool

 

GUseThreadedRendering

Whether the rendering thread should be created or not.

Public variable

TGlobalResource...

 

GVisualizeTexture

The global render targets for easy shading.

Public variable

FTexture *

 

GWhiteTexture

A global white texture.

Public variable

FTexture *

 

GWhiteTextureCube

A global white cube texture.

Public variable

FTextureWithSRV...

 

GWhiteTextureWithSRV

Public variable

FBufferWithRDG ...

 

GWhiteVertexBufferWithRDG

Public variable

FVertexBufferWi...

 

GWhiteVertexBufferWithSRV

Public variable

const int32

 

kUniqueShaderPermutationId

Public variable

const int32

 

ShaderCompileWorkerInputVersion

This is for the protocol, not the data, bump if FShaderCompilerInput or ProcessInputFromArchive changes.

Public variable

const int32

 

ShaderCompileWorkerOutputVersion

This is for the protocol, not the data, bump if FShaderCompilerOutput or WriteToOutputArchive changes.

Public variable

const int32

 

ShaderCompileWorkerPipelineJobHeader

This is for the protocol, not the data.

Public variable

const int32

 

ShaderCompileWorkerSingleJobHeader

This is for the protocol, not the data.

Public variable

 

STATCAT_Advanced

Public variable

 

STATCAT_Advanced