RHI

Classes

Name

Description

Public class

FAsyncReallocationRequest

Asynchronous reallocation request.

Public class

FBlendStateInitializerRHI

Public struct

FBoundShaderStateInput

Public class

FBoundShaderStateKey

============================================================================= BoundShaderStateCache.h: Bound shader state cache definition.

Public class

FCachedBoundShaderStateLink

Encapsulates a bound shader state's entry in the cache.

Public class

FCachedBoundShaderStateLink_Threadsafe

Public struct

FClearValueBinding

Public struct

FComputedBSS

Public struct

FComputedGraphicsPipelineState

Public struct

FComputedUniformBuffer

Public struct

FDepthStencilStateInitializerRHI

Public class

FDumpTransitionsHelper

Public struct

FDynamicReadBuffer

Public class

FDynamicRHI

The interface which is implemented by the dynamically bound RHI.

Public class

FExclusiveDepthStencil

Public class

FGPUDefragAllocator

Simple best fit allocator, splitting and coalescing whenever/ wherever possible.

Public struct

FGPUProfiler

Encapsulates GPU profiling logic and data.

Public class

FGPUProfilerEventNode

Stats for a single perf event node.

Public struct

FGPUProfilerEventNodeFrame

An entire frame of perf event nodes, including ancillary timers.

Public class

FGPUProfilerEventNodeStats

============================================================================= GPUProfiler.h: Hierarchical GPU Profiler.

Public struct

FGPUTiming

Holds information if this platform's GPU allows timing

Public class

FGraphicsPipelineStateInitializer

Public class

FInitStaticResourceRenderThreadTask

Helper task to initialize a static resource on the render thread.

Public class

FLastRenderTimeContainer

Textures

Public struct

FLocalBoundShaderState

Public struct

FLocalBoundShaderStateWorkArea

Public struct

FLocalGraphicsPipelineState

Public struct

FLocalGraphicsPipelineStateWorkArea

Public struct

FLocalUniformBuffer

Public struct

FLocalUniformBufferWorkArea

Public struct

FRasterizerStateInitializerRHI

Public struct

FReadBuffer

Encapsulates a GPU read buffer with its SRV.

Public class

FReadSurfaceDataFlags

To customize the RHIReadSurfaceData() output

Public class

FRenderTask

Public struct

FResolveParams

Public struct

FResolveRect

Public class

FResourceTransitionUtility

Public class

FRHIAsyncComputeCommandList

Public class

FRHIAsyncComputeCommandListImmediate

Single commandlist for async compute generation.

Public class

FRHIBlendState

Public class

FRHIBoundShaderState

Public struct

FRHICommand

Public struct

FRHICommandAutomaticCacheFlushAfterComputeShader

Public struct

FRHICommandBase

Public struct

FRHICommandBeginDrawingViewport

Public struct

FRHICommandBeginFrame

Public struct

FRHICommandBeginOcclusionQueryBatch

Public struct

FRHICommandBeginRenderQuery

Public struct

FRHICommandBeginScene

Public struct

FRHICommandBeginUpdateMultiFrameResource

Public struct

FRHICommandBeginUpdateMultiFrameUAV

Public struct

FRHICommandBindClearMRTValues

Public struct

FRHICommandBuildLocalBoundShaderState

Public struct

FRHICommandBuildLocalGraphicsPipelineState

Public struct

FRHICommandBuildLocalUniformBuffer

Public struct

FRHICommandClearColorTexture

Public struct

FRHICommandClearColorTextures

Public struct

FRHICommandClearDepthStencilTexture

Public struct

FRHICommandClearTinyUAV

Public struct

FRHICommandCopyToResolveTarget

Public struct

FRHICommandDebugBreak

Public struct

FRHICommandDispatchComputeShader

Public struct

FRHICommandDispatchIndirectComputeShader

Public struct

FRHICommandDrawIndexedIndirect

Public struct

FRHICommandDrawIndexedPrimitive

Public struct

FRHICommandDrawIndexedPrimitiveIndirect

Public struct

FRHICommandDrawPrimitive

Public struct

FRHICommandDrawPrimitiveIndirect

Public struct

FRHICommandEnableDepthBoundsTest

Public struct

FRHICommandEndDrawIndexedPrimitiveUP

Public struct

FRHICommandEndDrawingViewport

Public struct

FRHICommandEndDrawPrimitiveUP

Public struct

FRHICommandEndFrame

Public struct

FRHICommandEndOcclusionQueryBatch

Public struct

FRHICommandEndRenderQuery

Public struct

FRHICommandEndScene

Public struct

FRHICommandEndUpdateMultiFrameResource

Public struct

FRHICommandEndUpdateMultiFrameUAV

Public struct

FRHICommandFlushComputeShaderCache

Public class

FRHICommandList

Public class

FRHICommandList_RecursiveHazardous

Typedef to mark the recursive use of commandlists in the RHI implementations

Public class

FRHICommandListBase

Public class

FRHICommandListExecutor

Public class

FRHICommandListFenceAllocator

Thread-safe allocator for GPU fences used in deferred command list execution Fences are stored in a ringbuffer

Public class

FRHICommandListImmediate

Public class

FRHICommandListIterator

Helper class for traversing a FRHICommandList .

Public struct

FRHICommandPopEvent

Public struct

FRHICommandPushEvent

Public struct

FRHICommandSetAsyncComputeBudget

Public struct

FRHICommandSetBlendFactor

Public struct

FRHICommandSetBlendState

Public struct

FRHICommandSetBoundShaderState

Public struct

FRHICommandSetComputePipelineState

Public struct

FRHICommandSetComputeShader

Public struct

FRHICommandSetDepthStencilState

Public struct

FRHICommandSetGraphicsPipelineState

Public struct

FRHICommandSetLocalBoundShaderState

Public struct

FRHICommandSetLocalGraphicsPipelineState

Public struct

FRHICommandSetLocalUniformBuffer

Public struct

FRHICommandSetRasterizerState

Public struct

FRHICommandSetRenderTargets

Public struct

FRHICommandSetRenderTargetsAndClear

Public struct

FRHICommandSetScissorRect

Public struct

FRHICommandSetShaderParameter

Public struct

FRHICommandSetShaderResourceViewParameter

Public struct

FRHICommandSetShaderSampler

Public struct

FRHICommandSetShaderTexture

Public struct

FRHICommandSetShaderUniformBuffer

Public struct

FRHICommandSetStencilRef

Public struct

FRHICommandSetStereoViewport

Public struct

FRHICommandSetStreamSource

Public struct

FRHICommandSetUAVParameter

Public struct

FRHICommandSetUAVParameter_IntialCount

Public struct

FRHICommandSetViewport

Public struct

FRHICommandSubmitCommandsHint

Public struct

FRHICommandTransitionTextures

Public struct

FRHICommandTransitionTexturesArray

Public struct

FRHICommandTransitionUAVs

Public struct

FRHICommandUpdateTextureReference

Public struct

FRHICommandWaitComputeFence

Public class

FRHIComputeFence

Public class

FRHIComputePipelineState

Public class

FRHIComputePipelineStateFallback

Public class

FRHIComputeShader

Public class

FRHICustomPresent

Public class

FRHIDepthRenderTargetView

Public class

FRHIDepthStencilState

Public struct

FRHIDispatchIndirectParameters

Public class

FRHIDomainShader

Public struct

FRHIDrawIndexedIndirectParameters

Public struct

FRHIDrawIndirectParameters

Public class

FRHIGeometryShader

Public class

FRHIGraphicsPipelineState

Pipeline States

Public class

FRHIGraphicsPipelineStateFallBack

This PSO is used as a fallback for RHIs that dont support PSOs. It is used to set the graphics state using the legacy state setting APIs.

Public class

FRHIHullShader

Public class

FRHIIndexBuffer

Public struct

FRHILockTracker

Public class

FRHIPixelShader

Public class

FRHIRasterizerState

Public class

FRHIRenderQuery

Misc

Public class

FRHIRenderTargetView

Public class

FRHIResource

The base type of RHI resources.

Public struct

FRHIResourceCreateInfo

Public struct

FRHIResourceInfo

Public struct

FRHIResourceTableEntry

Public class

FRHISamplerState

State blocks

Public class

FRHISetRenderTargetsInfo

Public class

FRHIShader

Shaders

Public class

FRHIShaderLibrary

Shader Library

Public class

FRHIShaderResourceView

Public class

FRHIStructuredBuffer

Public class

FRHITexture

Public class

FRHITexture2D

Public class

FRHITexture2DArray

Public class

FRHITexture3D

Public class

FRHITextureCube

Public class

FRHITextureReference

Public class

FRHITextureReferenceNullImpl

Public class

FRHIUniformBuffer

Public struct

FRHIUniformBufferLayout

BuffersThe layout of a uniform buffer in memory.

Public class

FRHIUnorderedAccessView

Views

Public class

FRHIVertexBuffer

Public class

FRHIVertexDeclaration

Shader bindings

Public class

FRHIVertexShader

Public class

FRHIViewport

Public struct

FRWBuffer

Encapsulates a GPU read/write buffer with its UAV and SRV.

Public struct

FRWBufferByteAddress

Encapsulates a GPU read/write ByteAddress buffer with its UAV and SRV.

Public struct

FRWBufferStructured

Encapsulates a GPU read/write structured buffer with its UAV and SRV.

Public struct

FSamplerStateInitializerRHI

Public struct

FScopedCommandListWaitForTasks

Public class

FScopedGPUDefragLock

FScopedGPUDefragLock can't cover any scope that will add dcb commands or we might deadlock with a master reserve failure.

Public class

FScopedRHIThreadStaller

Public struct

FScreenResolutionRHI

Screen Resolution

Public struct

FStreamOutElement

RHI representation of a single stream out element.

Public struct

FTextureMemoryStats

Public struct

FUpdateTextureRegion2D

Specifies an update region for a texture

Public struct

FUpdateTextureRegion3D

Specifies an update region for a texture

Public struct

FVertexElement

Public class

FVertexElementTypeSupportInfo

Info for supporting the vertex element types

Public struct

FViewportBounds

Viewport bounds structure to set multiple view ports for the geometry shader (needs to be 1:1 to the D3D11 structure)

Public struct

FVRamAllocation

Public class

FWindowedGPUTimer

Simple moving window averaged GPU timer; create an instance, call Begin() and End() around the block to time, then call GetElapsedAverage to get the averaged timings; BufferSize determines the number of queries in the window, FramesBehind determines how long we wait to grab query results, so we don't have to block on them, so the effective window size is BufferSize - FramesBehind The timer keeps track of failed queries; GetElapsedAverage returns a float [0;1] that indicates fail rate: 0 means no queries have failed, 1 means all queries within the window have failed.

Public class

IDynamicRHIModule

Defines the interface of a module implementing a dynamic RHI.

Public class

IRHICommandContext

The interface RHI command context.

Public class

IRHICommandContextContainer

Public class

IRHIComputeContext

Statically bound RHI resource reference type definitions for the dynamically bound RHI.Context that is capable of doing Compute work.

Public class

IRHIDeprecatedContext

These state is now set by the Pipeline State Object and is now deprecated.

Public struct

TRHIShaderToEnum

Template magic to convert an FRHI*Shader to its enum.

Public class

TStaticBlendState

A static RHI blend state resource.

Public class

TStaticBlendStateWriteMask

A static RHI blend state resource which only allows controlling MRT write masks, for use when only opaque blending is needed.

Public class

TStaticDepthStencilState

A static RHI stencil state resource.

Public class

TStaticRasterizerState

A static RHI rasterizer state resource.

Public class

TStaticSamplerState

A static RHI sampler state resource.

Public class

TStaticStateRHI

The base class of the static RHI state classes.

Constants

Name

Description

MAX_TEXTURE_MIP_COUNT

Maximum number of miplevels in a texture.

MaxSimultaneousRenderTargets

The number of render-targets that may be simultaneously written to.

MaxSimultaneousRenderTargets_NumBits

The number of render-targets that may be simultaneously written to.

MaxSimultaneousUAVs

The number of UAVs that may be simultaneously bound to a shader.

MaxVertexElementCount

The maximum number of vertex elements which can be used by a vertex declaration.

MaxVertexElementCount_NumBits

The maximum number of vertex elements which can be used by a vertex declaration.

ShaderArrayElementAlignBytes

The alignment in bytes between elements of array shader parameters.

Typedefs

Name

Description

FBlendStateRHIParamRef

FBlendStateRHIRef

FBoundShaderStateRHIParamRef

FBoundShaderStateRHIRef

FComputeFenceRHIParamRef

FComputeFenceRHIRef

FComputeShaderRHIParamRef

FComputeShaderRHIRef

FCustomPresentRHIParamRef

FCustomPresentRHIRef

FDepthStencilStateRHIParamRef

FDepthStencilStateRHIRef

FDomainShaderRHIParamRef

FDomainShaderRHIRef

FGeometryShaderRHIParamRef

FGeometryShaderRHIRef

FGraphicsPipelineStateRHIParamRef

FGraphicsPipelineStateRHIRef

FHullShaderRHIParamRef

FHullShaderRHIRef

FIndexBufferRHIParamRef

FIndexBufferRHIRef

FPixelShaderRHIParamRef

FPixelShaderRHIRef

FRasterizerStateRHIParamRef

FRasterizerStateRHIRef

FRenderQueryRHIParamRef

FRenderQueryRHIRef

FRHIShaderLibraryParamRef

FRHIShaderLibraryRef

FSamplerStateRHIParamRef

FSamplerStateRHIRef

FScreenResolutionArray

FShaderResourceViewRHIParamRef

FShaderResourceViewRHIRef

FStreamOutElementList

FStructuredBufferRHIParamRef

FStructuredBufferRHIRef

FTexture2DArrayRHIParamRef

FTexture2DArrayRHIRef

FTexture2DRHIParamRef

FTexture2DRHIRef

FTexture3DRHIParamRef

FTexture3DRHIRef

FTextureCubeRHIParamRef

FTextureCubeRHIRef

FTextureReferenceRHIParamRef

FTextureReferenceRHIRef

FTextureRHIParamRef

FTextureRHIRef

FUniformBufferRHIParamRef

FUniformBufferRHIRef

FUnorderedAccessViewRHIParamRef

FUnorderedAccessViewRHIRef

FVertexBufferRHIParamRef

FVertexBufferRHIRef

FVertexDeclarationElementList

FVertexDeclarationRHIParamRef

FVertexDeclarationRHIRef

FVertexShaderRHIParamRef

FVertexShaderRHIRef

FViewportRHIParamRef

FViewportRHIRef

Enums

Name

Description

Public enum

EApplyRendertargetOption

Utility flags for modifying render target behavior on a PSO.

Public enum

EAsyncComputeBudget

Hint to the driver on how to load balance async compute work.

Public enum

EAsyncComputePriority

Public enum

EBlendFactor

Public enum

EBlendOperation

Public enum

EBufferUsageFlags

Resource usage flags - for vertex and index buffers.

Public enum

EClearBinding

Public enum

EClearDepthStencil

Public enum

ECmdList

Public enum

EColorWriteMask

Public enum

ECompareFunction

Public enum

ECubeFace

Public enum

EImmediateFlushType::Type

Public enum

EPrimitiveTopologyType

Public enum

EPrimitiveType

Public enum

ERangeCompressionMode

Limited to 8 types in FReadSurfaceDataFlags

Public enum

ERasterizerCullMode

Public enum

ERasterizerFillMode

Public enum

ERenderQueryType

Public enum

ERenderTargetLoadAction

Action to take when a rendertarget is set.

Public enum

ERenderTargetStoreAction

Action to take when a rendertarget is unset or at the end of a pass.

Public enum

EResourceAliasability

Public enum

EResourceLockMode

Public enum

EResourceTransitionAccess

Public enum

EResourceTransitionPipeline

Public enum

ERHIFeatureLevel::Type

The RHI's feature level indicates what level of support can be relied upon.

Public enum

ERHIResourceType

An enumeration of the different RHI reference types.

Public enum

ERHIZBuffer

Public enum

ESamplerAddressMode

Public enum

ESamplerCompareFunction

Public enum

ESamplerFilter

Public enum

EShaderFrequency

============================================================================= RHIDefinitions.h: Render Hardware Interface definitions (that don't require linking).

Public enum

EShaderPlatform

: update LegacyShaderPlatform when the below changes

Public enum

ESimpleRenderTargetMode

Common render target use cases

Public enum

EStencilMask

Public enum

EStencilOp

Public enum

ETextureCreateFlags

Flags used for texture creation

Public enum

ETextureReallocationStatus

Async texture reallocation status, returned by RHIGetReallocateTexture2DStatus().

Public enum

EUniformBufferBaseType

The base type of a value in a uniform buffer.

Public enum

EUniformBufferUsage

Public enum

EVertexElementType

Functions

Name Description

Public function

FMatrix

 

AdjustProjectionMatrixForRHI

(
    const FMatrix & InProjectionMatrix
)

Adjusts a projection matrix to output in the correct clip space for the current RHI.

Public function

void

 

appDefragmentTexturePool()

Defragment the texture pool.

Public function

void

 

appDumpTextureMemoryStats

(
    const TCHAR *
)

Log the current texture memory stats.

Public function

bool

 

appIsPoolTexture

(
    FTextureRHIParamRef TextureRHI
)

Checks if the texture data is allocated within the texture pool or not.

Public function

uint32

 

ComputeAnisotropyRT

(
    int32 InitializerMaxAnisotropy
)

Public function

void

 

DecodeRenderTargetMode

(
    ESimpleRenderTargetMode Mode,
    ERenderTargetLoadAction & ColorLoad...,
    ERenderTargetStoreAction & ColorSto...,
    ERenderTargetLoadAction & DepthLoad...,
    ERenderTargetStoreAction & DepthSto...,
    FExclusiveDepthStencil DepthStencil...
)

Convert the ESimpleRenderTargetMode into usable values

Public function

[RHI_API](API\Runtime\RHI\RHI_API) void

 

DisableDepthBoundsTest

(
    FRHICommandList & RHICmdList
)

Public function

void

 

DrawIndexedPrimitiveUP

(
    FRHICommandList & RHICmdList,
    uint32 PrimitiveType,
    uint32 MinVertexIndex,
    uint32 NumVertices,
    uint32 NumPrimitives,
    const void* IndexData,
    uint32 IndexDataStride,
    const void* VertexData,
    uint32 VertexDataStride
)

Draw a primitive using the vertices passed in as described the passed in indices.

Public function

void

 

DrawPrimitiveUP

(
    FRHICommandList & RHICmdList,
    uint32 PrimitiveType,
    uint32 NumPrimitives,
    const void* VertexData,
    uint32 VertexDataStride
)

Draw a primitive using the vertices passed in.

Public function

[RHI_API](API\Runtime\RHI\RHI_API) void

 

EmptyCachedBoundShaderStates()

Public function

[RHI_API](API\Runtime\RHI\RHI_API) void

 

EnableDepthBoundsTest

(
    FRHICommandList & RHICmdList,
    float WorldSpaceDepthNear,
    float WorldSpaceDepthFar,
    const FMatrix & ProjectionMatrix
)

Public function

[RHI_API](API\Runtime\RHI\RHI_API)FGrap...

 

GetAndOrCreateGraphicsPipelineState

(
    FRHICommandList & RHICmdList,
    const FGraphicsPipelineStateInitial ...,
    EApplyRendertargetOption ApplyFlags
)

Public function

[RHI_API](API\Runtime\RHI\RHI_API)FCach ...

 

GetCachedBoundShaderState

(
    FVertexDeclarationRHIParamRef Verte...,
    FVertexShaderRHIParamRef VertexShad...,
    FPixelShaderRHIParamRef PixelShader,
    FHullShaderRHIParamRef HullShader,
    FDomainShaderRHIParamRef DomainShad...,
    FGeometryShaderRHIParamRef Geometry...
)

Searches for a cached bound shader state.

Public function

[RHI_API](API\Runtime\RHI\RHI_API)FBoun ...

 

GetCachedBoundShaderState_Threadsafe

(
    FVertexDeclarationRHIParamRef Verte...,
    FVertexShaderRHIParamRef VertexShad...,
    FPixelShaderRHIParamRef PixelShader,
    FHullShaderRHIParamRef HullShader,
    FDomainShaderRHIParamRef DomainShad...,
    FGeometryShaderRHIParamRef Geometry...
)

Searches for a cached bound shader state.

Public function

uint32

 

GetExpectedFeatureLevelMaxTextureSamplers

(
    ERHIFeatureLevel::Type FeatureLevel
)

Return what the expected number of samplers will be supported by a feature level Note that since the Feature Level is pretty orthogonal to the RHI/HW, this is not going to be perfect If should only be used for a guess at the limit, the real limit will not be known until runtime

Public function

[RHI_API](API\Runtime\RHI\RHI_API) bool

 

GetFeatureLevelFromName

(
    FName Name,
    ERHIFeatureLevel::Type & OutFeature...
)

Current shader platform.

Public function

int32

 

GetFeatureLevelMaxNumberOfBones

(
    ERHIFeatureLevel::Type FeatureLevel
)

Public function

[RHI_API](API\Runtime\RHI\RHI_API) void

 

GetFeatureLevelName

(
    ERHIFeatureLevel::Type InFeatureLev...,
    FName & OutName
)

Creates an FName for the given feature level.

Public function

[RHI_API](API\Runtime\RHI\RHI_API) void

 

GetFeatureLevelName

(
    ERHIFeatureLevel::Type InFeatureLev...,
    FString & OutName
)

Creates a string for the given feature level.

Public function

EShaderPlatf ...

 

GetFeatureLevelShaderPlatform

(
    ERHIFeatureLevel::Type InFeatureLev...
)

Get the shader platform associated with the supplied feature level on this machine

Public function

uint32

 

GetMax2DTextureDimension()

Public function

uint32

 

GetMaxCubeTextureDimension()

Public function

ERHIFeatureL ...

 

GetMaxSupportedFeatureLevel

(
    EShaderPlatform InShaderPlatform
)

Public function

uint32

 

GetMaxTextureArrayLayers()

Public function

uint32

 

GetMaxTextureSamplers()

Public function

const TCHAR ...

 

GetShaderFrequencyString

(
    EShaderFrequency Frequency,
    bool bIncludePrefix
)

Public function

FRasterizerS ...

 

GetStaticRasterizerState

(
    ERasterizerFillMode FillMode,
    ERasterizerCullMode CullMode
)

Given a fill and cull mode, returns a static rasterizer state.

Public function

uint32

 

GetVertexCountForPrimitiveCount

(
    uint32 NumPrimitives,
    uint32 PrimitiveType
)

Computes the vertex count for a given number of primitives of the specified type.

Public function

bool

 

IsAndroidOpenGLESPlatform

(
    const EShaderPlatform Platform
)

Public function

bool

 

IsConsolePlatform

(
    const EShaderPlatform Platform
)

Public function

bool

 

IsD3DPlatform

(
    const EShaderPlatform Platform,
    bool bIncludeXboxOne
)

Public function Static

bool

 

IsDepthOrStencilFormat

(
    EPixelFormat Format
)

Public function

bool

 

IsES2Platform

(
    const EShaderPlatform Platform
)

Whether the shader platform corresponds to the ES2 feature level.

Public function

bool

 

IsFeatureLevelSupported

(
    EShaderPlatform InShaderPlatform,
    ERHIFeatureLevel::Type InFeatureLev...
)

Returns true if the feature level is supported by the shader platform.

Public function

bool

 

IsMetalPlatform

(
    const EShaderPlatform Platform
)

Public function

bool

 

IsMobilePlatform

(
    const EShaderPlatform Platform
)

Whether the shader platform corresponds to the ES2/ES3.1 feature level.

Public function

bool

 

IsOpenGLPlatform

(
    const EShaderPlatform Platform
)

Public function

bool

 

IsPCPlatform

(
    const EShaderPlatform Platform
)

Public function

[RHI_API](API\Runtime\RHI\RHI_API) bool

 

IsRHIDeviceAMD()

To trigger GPU specific optimizations and fallbacks

Public function

[RHI_API](API\Runtime\RHI\RHI_API) bool

 

IsRHIDeviceIntel()

To trigger GPU specific optimizations and fallbacks

Public function

[RHI_API](API\Runtime\RHI\RHI_API) bool

 

IsRHIDeviceNVIDIA()

To trigger GPU specific optimizations and fallbacks

Public function

bool

 

IsUniformBufferResourceType

(
    EUniformBufferBaseType BaseType
)

Public function

const bool

 

IsValidFenceID

(
    const uint64 FenceID
)

Public function

bool

 

IsVulkanMobilePlatform

(
    const EShaderPlatform Platform
)

Public function

bool

 

IsVulkanPlatform

(
    const EShaderPlatform Platform
)

Public function

[RHI_API](API\Runtime\RHI\RHI_API)FName

 

LegacyShaderPlatformToShaderFormat

(
    EShaderPlatform Platform
)

Public function

constexpr bo...

 

operator!

Public function

constexpr EA ...

 

operator&

Public function

EApplyRender ...

 

operator&=

Public function

constexpr EA ...

 

operator^

Public function

EApplyRender ...

 

operator^=

Public function

constexpr EA ...

 

operator|

Public function

EApplyRender ...

 

operator|=

Public function

constexpr EA ...

 

operator~

Public function

bool

 

operator==

(
    const FRHIUniformBufferLayout & A,
    const FRHIUniformBufferLayout & B
)

Compare two uniform buffer layouts.

Public function

FDynamicRHI ...

 

PlatformCreateDynamicRHI()

Each platform that utilizes dynamic RHIs should implement this function Called to create the instance of the dynamic RHI.

Public function

void

 

RHIAcquireThreadOwnership()

Public function

void

 

RHIAdvanceFrameForGetViewportBackBuffer()

Public function

FTexture2DRH ...

 

RHIAsyncCreateTexture2D

(
    uint32 SizeX,
    uint32 SizeY,
    uint8 Format,
    uint32 NumMips,
    uint32 Flags,
    void** InitialMipData,
    uint32 NumInitialMips
)

Public function

FTexture2DRH ...

 

RHIAsyncReallocateTexture2D

(
    FTexture2DRHIParamRef Texture2D,
    int32 NewMipCount,
    int32 NewSizeX,
    int32 NewSizeY,
    FThreadSafeCounter * RequestSta...
)

Public function

void

 

RHIBindDebugLabelName

(
    FUnorderedAccessViewRHIParamRef Uno...,
    const TCHAR * Name
)

Public function

void

 

RHIBindDebugLabelName

(
    FTextureRHIParamRef Texture,
    const TCHAR * Name
)

Public function

uint64

 

RHICalcTexture2DPlatformSize

(
    uint32 SizeX,
    uint32 SizeY,
    uint8 Format,
    uint32 NumMips,
    uint32 NumSamples,
    uint32 Flags,
    uint32 & OutAlign
)

Public function

uint64

 

RHICalcTexture3DPlatformSize

(
    uint32 SizeX,
    uint32 SizeY,
    uint32 SizeZ,
    uint8 Format,
    uint32 NumMips,
    uint32 Flags,
    uint32 & OutAlign
)

Public function

uint64

 

RHICalcTextureCubePlatformSize

(
    uint32 Size,
    uint8 Format,
    uint32 NumMips,
    uint32 Flags,
    uint32 & OutAlign
)

Public function

ETextureReal ...

 

RHICancelAsyncReallocateTexture2D

(
    FTexture2DRHIParamRef Texture2D,
    bool bBlockUntilCompleted
)

Public function

uint32

 

RHIComputeMemorySize

(
    FTextureRHIParamRef TextureRHI
)

Public function

void

 

RHICopySharedMips

(
    FTexture2DRHIParamRef DestTexture2D,
    FTexture2DRHIParamRef SrcTexture2D
)

Public function

FIndexBuffer ...

 

RHICreateAndLockIndexBuffer

(
    uint32 Stride,
    uint32 Size,
    uint32 InUsage,
    FRHIResourceCreateInfo & CreateInfo,
    void*& OutDataBuffer
)

Public function

FVertexBuffe ...

 

RHICreateAndLockVertexBuffer

(
    uint32 Size,
    uint32 InUsage,
    FRHIResourceCreateInfo & CreateInfo,
    void*& OutDataBuffer
)

Public function

FBlendStateR ...

 

RHICreateBlendState

(
    const FBlendStateInitializerRHI & I...
)

Public function

FBoundShader ...

 

RHICreateBoundShaderState

(
    FVertexDeclarationRHIParamRef Verte...,
    FVertexShaderRHIParamRef VertexShad...,
    FHullShaderRHIParamRef HullShader,
    FDomainShaderRHIParamRef DomainShad...,
    FPixelShaderRHIParamRef PixelShader,
    FGeometryShaderRHIParamRef Geometry...
)

Public function

FComputeFenc ...

 

RHICreateComputeFence

(
    const FName & Name
)

Public function

TRefCountPtr ...

 

RHICreateComputePipelineState

(
    FRHIComputeShader * ComputeShad...
)

Public function

FComputeShad ...

 

RHICreateComputeShader

(
    const TArray < uint8 >& Code
)

Public function

FComputeShad ...

 

RHICreateComputeShader

(
    FRHIShaderLibraryParamRef Library,
    FSHAHash Hash
)

Public function

FDepthStenci ...

 

RHICreateDepthStencilState

(
    const FDepthStencilStateInitializer ...
)

Public function

FDomainShade ...

 

RHICreateDomainShader

(
    const TArray < uint8 >& Code
)

Public function

FDomainShade ...

 

RHICreateDomainShader

(
    FRHIShaderLibraryParamRef Library,
    FSHAHash Hash
)

Public function

FGeometrySha ...

 

RHICreateGeometryShader

(
    const TArray < uint8 >& Code
)

Public function

FGeometrySha ...

 

RHICreateGeometryShader

(
    FRHIShaderLibraryParamRef Library,
    FSHAHash Hash
)

Public function

FGeometrySha ...

 

RHICreateGeometryShaderWithStreamOutput

(
    const TArray < uint8 >& Code,
    const FStreamOutElementList & Eleme...,
    uint32 NumStrides,
    const uint32 * Strides,
    int32 RasterizedStream
)

Public function

FGeometrySha ...

 

RHICreateGeometryShaderWithStreamOutput

(
    const FStreamOutElementList & Eleme...,
    uint32 NumStrides,
    const uint32 * Strides,
    int32 RasterizedStream,
    FRHIShaderLibraryParamRef Library,
    FSHAHash Hash
)

Public function

FGraphicsPip ...

 

RHICreateGraphicsPipelineState

(
    const FGraphicsPipelineStateInitial ...
)

Public function

FHullShaderR ...

 

RHICreateHullShader

(
    const TArray < uint8 >& Code
)

Public function

FHullShaderR ...

 

RHICreateHullShader

(
    FRHIShaderLibraryParamRef Library,
    FSHAHash Hash
)

Public function

FIndexBuffer ...

 

RHICreateIndexBuffer

(
    uint32 Stride,
    uint32 Size,
    uint32 InUsage,
    FRHIResourceCreateInfo & CreateInfo
)

Public function

FPixelShader ...

 

RHICreatePixelShader

(
    const TArray < uint8 >& Code
)

Public function

FPixelShader ...

 

RHICreatePixelShader

(
    FRHIShaderLibraryParamRef Library,
    FSHAHash Hash
)

Public function

FRasterizerS ...

 

RHICreateRasterizerState

(
    const FRasterizerStateInitializerRH ...
)

Public function

FRenderQuery ...

 

RHICreateRenderQuery

(
    ERenderQueryType QueryType
)

Public function

FStructuredB ...

 

RHICreateRTWriteMaskBuffer

(
    FTexture2DRHIRef RenderTarget
)

Public function

FSamplerStat ...

 

RHICreateSamplerState

(
    const FSamplerStateInitializerRHI &...
)

Public function

FRHIShaderLi ...

 

RHICreateShaderLibrary

(
    EShaderPlatform Platform,
    FString FilePath
)

Public function

FShaderResou ...

 

RHICreateShaderResourceView

(
    FTextureCubeRHIParamRef TextureCube...,
    uint8 MipLevel
)

Public function

FShaderResou ...

 

RHICreateShaderResourceView

(
    FIndexBufferRHIParamRef Buffer
)

Public function

FShaderResou ...

 

RHICreateShaderResourceView

(
    FTexture2DRHIParamRef Texture2DRHI,
    uint8 MipLevel
)

Public function

FShaderResou ...

 

RHICreateShaderResourceView

(
    FTexture3DRHIParamRef Texture3DRHI,
    uint8 MipLevel
)

Public function

FShaderResou ...

 

RHICreateShaderResourceView

(
    FTexture2DArrayRHIParamRef Texture2...,
    uint8 MipLevel
)

Public function

FShaderResou ...

 

RHICreateShaderResourceView

(
    FStructuredBufferRHIParamRef Struct...
)

Public function

FShaderResou ...

 

RHICreateShaderResourceView

(
    FVertexBufferRHIParamRef VertexBuff...,
    uint32 Stride,
    uint8 Format
)

Public function

FShaderResou ...

 

RHICreateShaderResourceView

(
    FTexture2DRHIParamRef Texture2DRHI,
    uint8 MipLevel,
    uint8 NumMipLevels,
    uint8 Format
)

Public function

FStructuredB ...

 

RHICreateStructuredBuffer

(
    uint32 Stride,
    uint32 Size,
    uint32 InUsage,
    FRHIResourceCreateInfo & CreateInfo
)

Public function

void

 

RHICreateTargetableShaderResource2D

(
    uint32 SizeX,
    uint32 SizeY,
    uint8 Format,
    uint32 NumMips,
    uint32 Flags,
    uint32 TargetableTextureFlags,
    bool bForceSeparateTargetAndShaderR...,
    FRHIResourceCreateInfo & CreateInfo,
    FTexture2DRHIRef & OutTargetableTex...,
    FTexture2DRHIRef & OutShaderResourc...,
    uint32 NumSamples
)

Creates 1 or 2 textures with the same dimensions/format.

Public function

void

 

RHICreateTargetableShaderResource2DArray

(
    uint32 SizeX,
    uint32 SizeY,
    uint32 SizeZ,
    uint8 Format,
    uint32 NumMips,
    uint32 Flags,
    uint32 TargetableTextureFlags,
    FRHIResourceCreateInfo & CreateInfo,
    FTexture2DArrayRHIRef & OutTargetab...,
    FTexture2DArrayRHIRef & OutShaderRe...,
    uint32 NumSamples
)

Public function

void

 

RHICreateTargetableShaderResource3D

(
    uint32 SizeX,
    uint32 SizeY,
    uint32 SizeZ,
    uint8 Format,
    uint32 NumMips,
    uint32 Flags,
    uint32 TargetableTextureFlags,
    bool bForceSeparateTargetAndShaderR...,
    FRHIResourceCreateInfo & CreateInfo,
    FTexture3DRHIRef & OutTargetableTex...,
    FTexture3DRHIRef & OutShaderResourc...
)

Creates 1 or 2 textures with the same dimensions/format.

Public function

void

 

RHICreateTargetableShaderResourceCube

(
    uint32 LinearSize,
    uint8 Format,
    uint32 NumMips,
    uint32 Flags,
    uint32 TargetableTextureFlags,
    bool bForceSeparateTargetAndShaderR...,
    FRHIResourceCreateInfo & CreateInfo,
    FTextureCubeRHIRef & OutTargetableT...,
    FTextureCubeRHIRef & OutShaderResou...
)

Creates 1 or 2 textures with the same dimensions/format.

Public function

void

 

RHICreateTargetableShaderResourceCubeArray

(
    uint32 LinearSize,
    uint32 ArraySize,
    uint8 Format,
    uint32 NumMips,
    uint32 Flags,
    uint32 TargetableTextureFlags,
    bool bForceSeparateTargetAndShaderR...,
    FRHIResourceCreateInfo & CreateInfo,
    FTextureCubeRHIRef & OutTargetableT...,
    FTextureCubeRHIRef & OutShaderResou...
)

Creates 1 or 2 textures with the same dimensions/format.

Public function

FTexture2DRH ...

 

RHICreateTexture2D

(
    uint32 SizeX,
    uint32 SizeY,
    uint8 Format,
    uint32 NumMips,
    uint32 NumSamples,
    uint32 Flags,
    FRHIResourceCreateInfo & CreateInfo
)

Public function

FTexture2DAr ...

 

RHICreateTexture2DArray

(
    uint32 SizeX,
    uint32 SizeY,
    uint32 SizeZ,
    uint8 Format,
    uint32 NumMips,
    uint32 Flags,
    FRHIResourceCreateInfo & CreateInfo
)

Public function

FTexture3DRH ...

 

RHICreateTexture3D

(
    uint32 SizeX,
    uint32 SizeY,
    uint32 SizeZ,
    uint8 Format,
    uint32 NumMips,
    uint32 Flags,
    FRHIResourceCreateInfo & CreateInfo
)

Public function

FTextureCube ...

 

RHICreateTextureCube

(
    uint32 Size,
    uint8 Format,
    uint32 NumMips,
    uint32 Flags,
    FRHIResourceCreateInfo & CreateInfo
)

Public function

FTextureCube ...

 

RHICreateTextureCubeArray

(
    uint32 Size,
    uint32 ArraySize,
    uint8 Format,
    uint32 NumMips,
    uint32 Flags,
    FRHIResourceCreateInfo & CreateInfo
)

Public function

FTextureRefe ...

 

RHICreateTextureReference

(
    FLastRenderTimeContainer * Last...
)

Public function

FUniformBuff ...

 

RHICreateUniformBuffer

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

Public function

FUnorderedAc ...

 

RHICreateUnorderedAccessView

(
    FTextureRHIParamRef Texture,
    uint32 MipLevel
)

Public function

FUnorderedAc ...

 

RHICreateUnorderedAccessView

(
    FStructuredBufferRHIParamRef Struct...,
    bool bUseUAVCounter,
    bool bAppendBuffer
)

Public function

FUnorderedAc ...

 

RHICreateUnorderedAccessView

(
    FVertexBufferRHIParamRef VertexBuff...,
    uint8 Format
)

Public function

FVertexBuffe ...

 

RHICreateVertexBuffer

(
    uint32 Size,
    uint32 InUsage,
    FRHIResourceCreateInfo & CreateInfo
)

Public function

FVertexDecla ...

 

RHICreateVertexDeclaration

(
    const FVertexDeclarationElementList ...
)

Public function

FVertexShade ...

 

RHICreateVertexShader

(
    const TArray < uint8 >& Code
)

Public function

FVertexShade ...

 

RHICreateVertexShader

(
    FRHIShaderLibraryParamRef Library,
    FSHAHash Hash
)

Public function

FViewportRHI ...

 

RHICreateViewport

(
    void* WindowHandle,
    uint32 SizeX,
    uint32 SizeY,
    bool bIsFullscreen,
    EPixelFormat PreferredPixelFormat
)

Public function

void

 

RHIExecuteCommandList

(
    FRHICommandList * CmdList
)

Public function

[RHI_API](API\Runtime\RHI\RHI_API) void

 

RHIExit()

Shuts down the RHI.

Public function

ETextureReal ...

 

RHIFinalizeAsyncReallocateTexture2D

(
    FTexture2DRHIParamRef Texture2D,
    bool bBlockUntilCompleted
)

Public function

void

 

RHIFlushResources()

Public function

bool

 

RHIGetAvailableResolutions

(
    FScreenResolutionArray & Resolution...,
    bool bIgnoreRefreshRate
)

Public function

IRHICommandC ...

 

RHIGetCommandContextContainer

(
    int32 Index,
    int32 Num
)

Public function

IRHIComputeC ...

 

RHIGetDefaultAsyncComputeContext()

Public function

IRHICommandC ...

 

RHIGetDefaultContext()

Public function

uint32

 

RHIGetGPUFrameCycles()

Public function

void *

 

RHIGetNativeDevice()

Public function

bool

 

RHIGetRenderQueryResult

(
    FRenderQueryRHIParamRef RenderQuery,
    uint64 & OutResult,
    bool bWait
)

Public function

void

 

RHIGetResourceInfo

(
    FTextureRHIParamRef Ref,
    FRHIResourceInfo & OutInfo
)

Public function

[RHI_API](API\Runtime\RHI\RHI_API)uint3 ...

 

RHIGetShaderLanguageVersion

(
    const EShaderPlatform Platform
)

Helper to return the shader language version for the given shader platform.

Public function

void

 

RHIGetSupportedResolution

(
    uint32 & Width,
    uint32 & Height
)

Public function

void

 

RHIGetTextureMemoryStats

(
    FTextureMemoryStats & OutStats
)

Public function

FTexture2DRH ...

 

RHIGetViewportBackBuffer

(
    FViewportRHIParamRef Viewport
)

Public function

bool

 

RHIHasTiledGPU

(
    const EShaderPlatform Platform
)

Public function

[RHI_API](API\Runtime\RHI\RHI_API) void

 

RHIInit

(
    bool bHasEditorToken
)

RHI memory stats.

Public function

void *

 

RHILockIndexBuffer

(
    FIndexBufferRHIParamRef IndexBuffer,
    uint32 Offset,
    uint32 Size,
    EResourceLockMode LockMode
)

Public function

void *

 

RHILockStructuredBuffer

(
    FStructuredBufferRHIParamRef Struct...,
    uint32 Offset,
    uint32 SizeRHI,
    EResourceLockMode LockMode
)

Public function

void *

 

RHILockTexture2D

(
    FTexture2DRHIParamRef Texture,
    uint32 MipIndex,
    EResourceLockMode LockMode,
    uint32 & DestStride,
    bool bLockWithinMiptail,
    bool bFlushRHIThread
)

Public function

void *

 

RHILockTexture2DArray

(
    FTexture2DArrayRHIParamRef Texture,
    uint32 TextureIndex,
    uint32 MipIndex,
    EResourceLockMode LockMode,
    uint32 & DestStride,
    bool bLockWithinMiptail
)

Public function

void *

 

RHILockTextureCubeFace

(
    FTextureCubeRHIParamRef Texture,
    uint32 FaceIndex,
    uint32 ArrayIndex,
    uint32 MipIndex,
    EResourceLockMode LockMode,
    uint32 & DestStride,
    bool bLockWithinMiptail
)

Public function

void *

 

RHILockVertexBuffer

(
    FVertexBufferRHIParamRef VertexBuff...,
    uint32 Offset,
    uint32 SizeRHI,
    EResourceLockMode LockMode
)

Public function

bool

 

RHINeedsToSwitchVerticalAxis

(
    EShaderPlatform Platform
)

Public function

[RHI_API](API\Runtime\RHI\RHI_API) void

 

RHIPostInit()

Performs additional RHI initialization before the render thread starts.

Public function

[RHI_API](API\Runtime\RHI\RHI_API) void

 

RHIPrivateBeginFrame()

Called once per frame only from within an RHI.

Public function

void

 

RHIRecreateRecursiveBoundShaderStates()

Public function

void

 

RHIReleaseThreadOwnership()

Public function

void

 

RHIResizeViewport

(
    FViewportRHIParamRef Viewport,
    uint32 SizeX,
    uint32 SizeY,
    bool bIsFullscreen,
    EPixelFormat PreferredPixelFormat
)

Public function

void

 

RHIResumeRendering()

Public function

bool

 

RHISupportsComputeShaders

(
    const EShaderPlatform Platform
)

Public function

bool

 

RHISupportsGeometryShaders

(
    const EShaderPlatform Platform
)

Public function

bool

 

RHISupportsMSAA

(
    EShaderPlatform Platform
)

Public function

[RHI_API](API\Runtime\RHI\RHI_API) bool

 

RHISupportsPixelShaderUAVs

(
    const EShaderPlatform Platform
)

Helper to check that the shader platform supports writing to UAVs from pixel shaders.

Public function

bool

 

RHISupportsSeparateMSAAAndResolveTextures

(
    const EShaderPlatform Platform
)

Public function

bool

 

RHISupportsShaderCompression

(
    const EShaderPlatform Platform
)

Public function

[RHI_API](API\Runtime\RHI\RHI_API) bool

 

RHISupportsTessellation

(
    const EShaderPlatform Platform
)

Helper to check that the shader platform supports tessellation.

Public function

bool

 

RHISupportsVertexShaderLayer

(
    const EShaderPlatform Platform
)

Public function

void

 

RHISuspendRendering()

Public function

void

 

RHITick

(
    float DeltaTime
)

Public function

void

 

RHIUnlockIndexBuffer

(
    FIndexBufferRHIParamRef IndexBuffer
)

Public function

void

 

RHIUnlockStructuredBuffer

(
    FStructuredBufferRHIParamRef Struct...
)

Public function

void

 

RHIUnlockTexture2D

(
    FTexture2DRHIParamRef Texture,
    uint32 MipIndex,
    bool bLockWithinMiptail,
    bool bFlushRHIThread
)

Public function

void

 

RHIUnlockTexture2DArray

(
    FTexture2DArrayRHIParamRef Texture,
    uint32 TextureIndex,
    uint32 MipIndex,
    bool bLockWithinMiptail
)

Public function

void

 

RHIUnlockTextureCubeFace

(
    FTextureCubeRHIParamRef Texture,
    uint32 FaceIndex,
    uint32 ArrayIndex,
    uint32 MipIndex,
    bool bLockWithinMiptail
)

Public function

void

 

RHIUnlockVertexBuffer

(
    FVertexBufferRHIParamRef VertexBuff...
)

Public function

void

 

RHIUpdateTexture2D

(
    FTexture2DRHIParamRef Texture,
    uint32 MipIndex,
    const FUpdateTextureRegion2D & Upda...,
    uint32 SourcePitch,
    const uint8 * SourceData
)

Public function

void

 

RHIUpdateTexture3D

(
    FTexture3DRHIParamRef Texture,
    uint32 MipIndex,
    const FUpdateTextureRegion3D & Upda...,
    uint32 SourceRowPitch,
    uint32 SourceDepthPitch,
    const uint8 * SourceData
)

Public function

void

 

RHIUpdateTextureReference

(
    FTextureReferenceRHIParamRef Textur...,
    FTextureRHIParamRef NewTexture
)

Public function

[RHI_API](API\Runtime\RHI\RHI_API) cons...

 

RHIVendorIdToString()

Helper to convert GRHIVendorId into a printable string, or "Unknown" if unknown.

Public function

void

 

RHIVirtualTextureSetFirstMipInMemory

(
    FTexture2DRHIParamRef Texture,
    uint32 FirstMip
)

Public function

void

 

RHIVirtualTextureSetFirstMipVisible

(
    FTexture2DRHIParamRef Texture,
    uint32 FirstMip
)

Public function

[RHI_API](API\Runtime\RHI\RHI_API) void

 

SetComputePipelineState

(
    FRHICommandList & RHICmdList,
    FRHIComputeShader * ComputeShad...
)

Public function

[RHI_API](API\Runtime\RHI\RHI_API) void

 

SetGraphicsPipelineState

(
    FRHICommandList & RHICmdList,
    const FGraphicsPipelineStateInitial ...,
    EApplyRendertargetOption ApplyFlags
)

Public function

void

 

SetRenderTarget

(
    FRHICommandList & RHICmdList,
    FTextureRHIParamRef NewRenderTarget,
    FTextureRHIParamRef NewDepthStencil...,
    bool bWritableBarrier
)

Helper for the common case of using a single color and depth render target.

Public function

void

 

SetRenderTarget

(
    FRHICommandList & RHICmdList,
    FTextureRHIParamRef NewRenderTarget,
    int32 MipIndex,
    FTextureRHIParamRef NewDepthStencil...,
    bool bWritableBarrier
)

Helper for the common case of using a single color and depth render target, with a mip index for the color target.

Public function

void

 

SetRenderTarget

(
    FRHICommandList & RHICmdList,
    FTextureRHIParamRef NewRenderTarget,
    FTextureRHIParamRef NewDepthStencil...,
    ESimpleRenderTargetMode Mode,
    FExclusiveDepthStencil DepthStencil...,
    bool bWritableBarrier
)

Helper for the common case of using a single color and depth render target.

Public function

void

 

SetRenderTarget

(
    FRHICommandList & RHICmdList,
    FTextureRHIParamRef NewRenderTarget,
    int32 MipIndex,
    int32 ArraySliceIndex,
    FTextureRHIParamRef NewDepthStencil...,
    bool bWritableBarrier
)

Helper for the common case of using a single color and depth render target, with a mip index for the color target.

Public function

void

 

SetRenderTargets

(
    FRHICommandList & RHICmdList,
    uint32 NewNumSimultaneousRenderTarg...,
    const FTextureRHIParamRef * New...,
    FTextureRHIParamRef NewDepthStencil...,
    uint32 NewNumUAVs,
    const FUnorderedAccessViewRHIParamR ...,
    bool bWritableBarrier
)

Helper that converts FTextureRHIParamRef's into FRHIRenderTargetView 's.

Public function

void

 

SetRenderTargets

(
    FRHICommandList & RHICmdList,
    uint32 NewNumSimultaneousRenderTarg...,
    const FTextureRHIParamRef * New...,
    FTextureRHIParamRef NewDepthStencil...,
    ESimpleRenderTargetMode Mode,
    FExclusiveDepthStencil DepthStencil...,
    bool bWritableBarrier
)

Helper that converts FTextureRHIParamRef's into FRHIRenderTargetView 's.

Public function

[RHI_API](API\Runtime\RHI\RHI_API)EShad ...

 

ShaderFormatToLegacyShaderPlatform

(
    FName ShaderFormat
)

Public function

void

 

TransitionSetRenderTargetsHelper

(
    FRHICommandList & RHICmdList,
    FTextureRHIParamRef NewRenderTarget,
    FTextureRHIParamRef NewDepthStencil...,
    FExclusiveDepthStencil DepthStencil...
)

Public function

void

 

TransitionSetRenderTargetsHelper

(
    FRHICommandList & RHICmdList,
    uint32 NumRenderTargets,
    const FTextureRHIParamRef * New...,
    const FTextureRHIParamRef NewDepthS...,
    FExclusiveDepthStencil DepthStencil...
)

Variables

Name Description

Public variable

[RHI_API](API\Runtime\RHI\RHI_API)FAutoCon ...

 

CPrio_SceneRenderingTask

Public variable

[RHI_API](API\Runtime\RHI\RHI_API)TAutoCon ...

 

CVarRHICmdFlushRenderThreadTasks

Public variable

[RHI_API](API\Runtime\RHI\RHI_API)TAutoCon ...

 

CVarRHICmdWidth

Public variable

[RHI_API](API\Runtime\RHI\RHI_API)

 

FRHICommandList

Public variable

[RHI_API](API\Runtime\RHI\RHI_API) volatil...

 

GCurrentRendertargetMemorySize

Amount of memory allocated by rendertargets. In kilobytes.

Public variable

[RHI_API](API\Runtime\RHI\RHI_API) volatil...

 

GCurrentTextureMemorySize

Amount of memory allocated by textures. In kilobytes.

Public variable

[RHI_API](API\Runtime\RHI\RHI_API)int32

 

GDrawUPIndexCheckCount

The size to check against for Draw*UP call index counts.

Public variable

[RHI_API](API\Runtime\RHI\RHI_API)int32

 

GDrawUPVertexCheckCount

The size to check against for Draw*UP call vertex counts.

Public variable

[RHI_API](API\Runtime\RHI\RHI_API)FDynamic ...

 

GDynamicRHI

Globals.

Public variable

[RHI_API](API\Runtime\RHI\RHI_API) bool

 

GEnableAsyncCompute

Thread used for RHI

Public variable

[RHI_API](API\Runtime\RHI\RHI_API)FString

 

GGPUTraceFileName

Non-empty if we are performing a gpu trace. Also says where to place trace file.

Public variable

[RHI_API](API\Runtime\RHI\RHI_API) bool

 

GHardwareHiddenSurfaceRemoval

True if the GPU supports hidden surface removal in hardware.

Public variable

[RHI_API](API\Runtime\RHI\RHI_API) bool

 

GIsRHIInitialized

RHI globals.True if the render hardware has been initialized.

RHI globals.

Public variable

[RHI_API](API\Runtime\RHI\RHI_API)int32

 

GMaxCubeTextureDimensions

The maximum size allowed for cube textures.

Public variable

[RHI_API](API\Runtime\RHI\RHI_API)ERHIFeat ...

 

GMaxRHIFeatureLevel

The maximum feature level and shader platform available on this system GRHIFeatureLevel and GRHIShaderPlatform have been deprecated.

Public variable

[RHI_API](API\Runtime\RHI\RHI_API)EShaderP ...

 

GMaxRHIShaderPlatform

The current shader platform.

Public variable

[RHI_API](API\Runtime\RHI\RHI_API)int32

 

GMaxShadowDepthBufferSizeX

The maximum size to allow for the shadow depth buffer in the X dimension.

Public variable

[RHI_API](API\Runtime\RHI\RHI_API)int32

 

GMaxShadowDepthBufferSizeY

The maximum size to allow for the shadow depth buffer in the Y dimension.

Public variable

[RHI_API](API\Runtime\RHI\RHI_API)int32

 

GMaxTextureArrayLayers

The Maximum number of layers in a 1D or 2D texture array.

Public variable

[RHI_API](API\Runtime\RHI\RHI_API)int32

 

GMaxTextureDimensions

The maximum size allowed for 2D textures in both dimensions.

Public variable

[RHI_API](API\Runtime\RHI\RHI_API)int32

 

GMaxTextureMipCount

RHI capabilities.The maximum number of mip-maps that a texture can contain.

Public variable

[RHI_API](API\Runtime\RHI\RHI_API)int32

 

GMaxTextureSamplers

Public variable

[RHI_API](API\Runtime\RHI\RHI_API) float

 

GMinClipZ

The minimum Z value in clip space for the RHI.

Public variable

[RHI_API](API\Runtime\RHI\RHI_API)int32

 

GNumDrawCallsRHI

Some simple runtime stats, reset on every call to RHIBeginFrame.

Public variable

[RHI_API](API\Runtime\RHI\RHI_API)int32

 

GNumPrimitivesDrawnRHI

Public variable

[RHI_API](API\Runtime\RHI\RHI_API)int32

 

GPoolSizeVRAMPercentage

In percent. If non-zero, the texture pool size is a percentage of GTotalGraphicsMemory.

Public variable

[RHI_API](API\Runtime\RHI\RHI_API) float

 

GProjectionSignY

The sign to apply to the Y axis of projection matrices.

Public variable

[RHI_API](API\Runtime\RHI\RHI_API)FString

 

GRHIAdapterDriverDate

Public variable

[RHI_API](API\Runtime\RHI\RHI_API)FString

 

GRHIAdapterInternalDriverVersion

Public variable

[RHI_API](API\Runtime\RHI\RHI_API)FString

 

GRHIAdapterName

Only set if RHI has the information (after init of the RHI and only if RHI has that information, never changes after that) e.g. "NVIDIA GeForce GTX 670"

Public variable

[RHI_API](API\Runtime\RHI\RHI_API)FString

 

GRHIAdapterUserDriverVersion

Public variable

[RHI_API](API\Runtime\RHI\RHI_API)FRHIComm ...

 

GRHICommandList

Public variable

[RHI_API](API\Runtime\RHI\RHI_API)uint32

 

GRHIDeviceId

Public variable

[RHI_API](API\Runtime\RHI\RHI_API) bool

 

GRHIDeviceIsAMDPreGCNArchitecture

True if the GPU is AMD's Pre-GCN architecture

Public variable

[RHI_API](API\Runtime\RHI\RHI_API)uint32

 

GRHIDeviceRevision

Public variable

[RHI_API](API\Runtime\RHI\RHI_API)FRHIComm ...

 

GRHIFenceAllocator

Used by AsyncCompute.

Public variable

[RHI_API](API\Runtime\RHI\RHI_API)EPixelFo ...

 

GRHIHDRDisplayOutputFormat

Format used for the backbuffer when outputting to a HDR display.

Public variable

[RHI_API](API\Runtime\RHI\RHI_API)FRHILock ...

 

GRHILockTracker

Public variable

[RHI_API](API\Runtime\RHI\RHI_API) bool

 

GRHINeedsExtraDeletionLatency

Does this RHI need to wait for deletion of resources due to ref counting.

Public variable

[RHI_API](API\Runtime\RHI\RHI_API) bool

 

GRHINeedsUnatlasedCSMDepthsWorkaround

True if the RHI has artifacts with atlased CSM depths.

Public variable

[RHI_API](API\Runtime\RHI\RHI_API) bool

 

GRHIRequiresEarlyBackBufferRenderTarget

Whether or not the engine should set the BackBuffer as a render target early in the frame.

Public variable

[RHI_API](API\Runtime\RHI\RHI_API) bool

 

GRHISupportsAsyncTextureCreation

True if the RHI supports asynchronous creation of texture resources

Public variable

[RHI_API](API\Runtime\RHI\RHI_API) bool

 

GRHISupportsBaseVertexIndex

Whether or not the RHI can handle a non-zero BaseVertexIndex - extra SetStreamSource calls will be needed if this is false

Public variable

[RHI_API](API\Runtime\RHI\RHI_API) bool

 

GRHISupportsFirstInstance

Whether or not the RHI can handle a non-zero FirstInstance - extra SetStreamSource calls will be needed if this is false

Public variable

[RHI_API](API\Runtime\RHI\RHI_API) bool

 

GRHISupportsHDROutput

Whether the present adapter/display offers HDR output capabilities.

Public variable

[RHI_API](API\Runtime\RHI\RHI_API) bool

 

GRHISupportsInstancing

True if the RHI supports hardware instancing

Public variable

[RHI_API](API\Runtime\RHI\RHI_API) bool

 

GRHISupportsMSAADepthSampleAccess

Whether or not the RHI can perform MSAA sample load.

Public variable

[RHI_API](API\Runtime\RHI\RHI_API) bool

 

GRHISupportsParallelRHIExecute

Whether or not the RHI supports parallel RHIThread executes / translates Requirements: RHICreateBoundShaderState & RHICreateGraphicsPipelineState is threadsafe and GetCachedBoundShaderState must not be used.

Public variable

[RHI_API](API\Runtime\RHI\RHI_API) bool

 

GRHISupportsResolveCubemapFaces

True if the RHI supports copying cubemap faces using CopyToResolveTarget

Public variable

[RHI_API](API\Runtime\RHI\RHI_API) bool

 

GRHISupportsRHIThread

Whether or not the RHI supports an RHI thread.

Public variable

[RHI_API](API\Runtime\RHI\RHI_API) bool

 

GRHISupportsTextureStreaming

True if the RHI supports texture streaming

Public variable

[RHI_API](API\Runtime\RHI\RHI_API)uint32

 

GRHIVendorId

0 means not defined yet, use functions like IsRHIDeviceAMD() to access

Public variable

[RHI_API](API\Runtime\RHI\RHI_API)EShaderP ...

 

GShaderPlatformForFeatureLevel

Table for finding out which shader platform corresponds to a given feature level for this RHI.

Public variable

[RHI_API](API\Runtime\RHI\RHI_API) bool

 

GSupportsDepthBoundsTest

True if the RHI and current hardware supports supports depth bounds testing

Public variable

[RHI_API](API\Runtime\RHI\RHI_API) bool

 

GSupportsDepthFetchDuringDepthTest

True if the RHI supports binding depth as a texture when testing against depth

Public variable

[RHI_API](API\Runtime\RHI\RHI_API) bool

 

GSupportsDepthRenderTargetWithoutColorRenderTarget

True if the RHI can render to a depth-only render target with no additional color render target.

Public variable

[RHI_API](API\Runtime\RHI\RHI_API) bool

 

GSupportsEfficientAsyncCompute

True if the RHI and current hardware supports efficient AsyncCompute (by default we assume false and later we can enable this for more hardware)

Public variable

[RHI_API](API\Runtime\RHI\RHI_API) bool

 

GSupportsHDR32bppEncodeModeIntrinsic

True if the RHI supports 'GetHDR32bppEncodeModeES2' shader intrinsic.

Public variable

[RHI_API](API\Runtime\RHI\RHI_API) bool

 

GSupportsMobileMultiView

True if the RHI supports mobile multi-view

Public variable

[RHI_API](API\Runtime\RHI\RHI_API) bool

 

GSupportsMultipleRenderTargets

True if the RHI supports MRT

Public variable

[RHI_API](API\Runtime\RHI\RHI_API) bool

 

GSupportsParallelOcclusionQueries

True if the RHI supports getting the result of occlusion queries when on a thread other than the renderthread

Public variable

[RHI_API](API\Runtime\RHI\RHI_API) bool

 

GSupportsQuadBufferStereo

True if this platform has quad buffer stereo support.

Public variable

[RHI_API](API\Runtime\RHI\RHI_API) bool

 

GSupportsQuads

Can we handle quad primitives?

Public variable

[RHI_API](API\Runtime\RHI\RHI_API) bool

 

GSupportsRenderDepthTargetableShaderResources

True if the RHI supports textures that may be bound as both a render target and a shader resource.

Public variable

[RHI_API](API\Runtime\RHI\RHI_API) bool

 

GSupportsRenderTargetFormat_PF_FloatRGBA

True if PF_FloatRGBA render targets are supported

Public variable

[RHI_API](API\Runtime\RHI\RHI_API) bool

 

GSupportsRenderTargetFormat_PF_G8

True if PF_G8 render targets are supported

Public variable

[RHI_API](API\Runtime\RHI\RHI_API) bool

 

GSupportsRenderTargetWriteMask

True if the RHI and current hardware support a render target write mask

Public variable

[RHI_API](API\Runtime\RHI\RHI_API) bool

 

GSupportsResourceView

True if the RHI supports SRVs

Public variable

[RHI_API](API\Runtime\RHI\RHI_API) bool

 

GSupportsSeparateRenderTargetBlendState

True if the RHI supports separate blend states per render target.

Public variable

[RHI_API](API\Runtime\RHI\RHI_API) bool

 

GSupportsShaderDepthStencilFetch

True if mobile depth & stencil fetch is supported

Public variable

[RHI_API](API\Runtime\RHI\RHI_API) bool

 

GSupportsShaderFramebufferFetch

True if mobile framebuffer fetch is supported

Public variable

[RHI_API](API\Runtime\RHI\RHI_API) bool

 

GSupportsTexture3D

True if the RHI supports 3D textures

Public variable

[RHI_API](API\Runtime\RHI\RHI_API) bool

 

GSupportsTimestampRenderQueries

True if RQT_AbsoluteTime is supported by RHICreateRenderQuery

Public variable

[RHI_API](API\Runtime\RHI\RHI_API) bool

 

GSupportsVolumeTextureRendering

True if and only if the GPU support rendering to volume textures (2D Array, 3D).

Public variable

[RHI_API](API\Runtime\RHI\RHI_API) bool

 

GSupportsWideMRT

True if the RHI supports 256bit MRT

Public variable

[RHI_API](API\Runtime\RHI\RHI_API)int64

 

GTexturePoolSize

Current texture streaming pool size, in bytes. 0 means unlimited.

Public variable

[RHI_API](API\Runtime\RHI\RHI_API) bool

 

GTriggerGPUHitchProfile

Whether we are profiling GPU hitches.

Public variable

[RHI_API](API\Runtime\RHI\RHI_API) bool

 

GTriggerGPUProfile

Whether the next frame should profile the GPU.

Public variable

[RHI_API](API\Runtime\RHI\RHI_API) bool

 

GUsingNullRHI

True if we are running with the NULL RHI

Public variable

[RHI_API](API\Runtime\RHI\RHI_API) class F ...

 

GVertexElementTypeSupport

True for each VET that is supported. One-to-one mapping with EVertexElementType

Public variable

 

RHI_API

RHI Logging.

Public variable

 

STATCAT_Advanced

Public variable

[RHI_API](API\Runtime\RHI\RHI_API) FCritic...

 

StaticStateRHICriticalSection

============================================================================= RHIStaticStates.h: RHI static state template definition.