className: FRHIGlobals

code: struct FRHIGlobals

BindlessSupport

type: ERHIBindlessSup...

description: Whether dynamic (bindless) resources are supported

BufferMemorySize

description: Amount of memory allocated by buffers

DefaultMSAASampleOffsets

description: Tables of all MSAA sample offset for all MSAA supported. Use GetMSAASampleOffsets() to read it.

DemotedLocalMemorySize

description: Amount of local video memory demoted to system memory. In bytes.

DeviceIsIntegrated

description: Whether or not the current GPU is integrated into to CPU

DrawUPIndexCheckCount

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

DrawUPVertexCheckCount

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

description: Allow opt-out default RHI resource deletion latency for streaming textures

GPUTraceFileName

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

HardwareHiddenSurfaceRemoval

description: True if the GPU supports hidden surface removal in hardware.

HDRDisplayOutputFormat

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

IsDebugLayerEnabled

description: True if the RHI has initialized a device with the debug layer enabled.

IsHDREnabled

description: Whether or not HDR is currently enabled

IsRHIInitialized

description: True if the render hardware has been initialized.

LazyShaderCodeLoading

description: If true, then avoiding loading shader code and instead force the "native" path, which sends a library and a hash instead.

MaxBufferDimensions

type: TRHIGlobal< int...

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

MaxComputeDispatchDimension

description: The maximum size allowed for a computeshader dispatch.

MaxComputeSharedMemory

description: The maximum size allowed for Shared Compute Memory.

MaxConstantBufferByteSize

description: The maximum size allowed for a contant buffer.

MaxCubeTextureDimensions

description: The maximum size allowed for cube textures.

MaxDispatchThreadGroupsPerDimension

description: The maximum number of groups that can be dispatched in each dimensions.

description: If an RHI cannot do an unlimited number of occlusion queries without stalling and waiting for the GPU, this can be used to tune hte occlusion culler to try not to do that.

MaxShadowDepthBufferSizeX

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

MaxShadowDepthBufferSizeY

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

MaxTextureArrayLayers

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

MaxTextureMipCount

description: The maximum number of mip-maps that a texture can contain.

MaxVolumeTextureDimensions

description: The maximum size allowed for 3D textures in all three dimensions.

MaxWorkGroupInvocations

description: The maximum work group invocations allowed for compute shader.

MinimumWaveSize

description: Specifies the minimum and maximum number of lanes in the SIMD wave that this GPU can support.

NeedsExtraDeletionLatency

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

NeedsUnatlasedCSMDepthsWorkaround

description: True if the RHI has artifacts with atlased CSM depths.

NonStreamingTextureMemorySizeInKB

description: Amount of memory allocated by non streaming textures. In kilobytes.

PersistentThreadGroupCount

description: Optimal number of persistent thread groups to fill the GPU.

PoolSizeVRAMPercentage

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

PresentCounter

description: Counter incremented once on each frame present.

RequiresRenderTargetForPixelShaderUAVs

description: True if the RHI requires a valid RT bound during UAV scatter operation inside the pixel shader

RHIThreadNeedsKicking

description: If an RHI is so slow, that it is the limiting factor for the entire frame, we can kick early to try to give it as much as possible.

ShaderPlatformForFeatureLevel

type: EShaderPlatform...

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

StreamingTextureMemorySizeInKB

description: Amount of memory allocated by streaming textures. In kilobytes.

SupportsArrayIndexFromAnyShader

description: True if the RHI supports setting the render target array index from any shader stage

SupportsAsyncGetRenderQueryResult

description: Whether RHIGetRenderQueryResult can be safely called off the render thread.

SupportsAsyncPipelinePrecompile

description: True if the RHI supports pipeline precompiling from any thread.

SupportsAsyncTextureCreation

description: True if the RHI supports asynchronous creation of texture resources

SupportsAsyncTextureStreamOut

description: Support using async thread for texture stream out operations

description: True if the RHI supports 64 bit uint atomics.

description: Whether or not the RHI can render to the backbuffer with a custom depth/stencil surface bound.

SupportsBaseVertexIndex

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

SupportsConservativeRasterization

description: Whether current RHI supports overestimated conservative rasterization.

SupportsDepthBoundsTest

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

SupportsDepthUAV

description: True if the RHI supports depth target unordered access views.

SupportsDirectGPUMemoryLock

description: True if the pointer returned by Lock is a persistent direct pointer to gpu memory

SupportsDrawIndirect

description: True if the RHI supports Draw Indirect

description: True if the RHI supports 64 bit uint atomics using DX12 SM6.6 - TEMP / DEPRECATED - DO NOT USE

SupportsDynamicResolution

description: Whether or not the RHI can handle dynamic resolution or not.

SupportsEfficientAsyncCompute

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

SupportsExactOcclusionQueries

description: Some RHIs can only do visible or not occlusion queries.

SupportsExplicitFMask

description: True if the RHI supports explicit access to MSAA target FMask meta data.

SupportsExplicitHTile

description: True if the RHI supports explicit access to depth target HTile meta data.

SupportsFirstInstance

description: Whether or not the RHI can handle a non-zero FirstInstance to DrawIndexedPrimitive and friends - extra SetStreamSource calls will be needed if this is false

SupportsFrameCyclesBubblesRemoval

description: True if RHIGetGPUFrameCycles removes CPu generated bubbles.

SupportsGPUTimestampBubblesRemoval

description: True if RQT_AbsoluteTime is supported by RHICreateRenderQuery

SupportsGPUUsage

description: True if RHIGetGPUUsage() is supported.

SupportsHDROutput

description: Whether the present adapter/display offers HDR output capabilities.

SupportsImageExternal

description: True if the RHI supports image external

SupportsLazyShaderCodeLoading

description: If true, then it is possible to turn on LazyShaderCodeLoading.

SupportsMapWriteNoOverwrite

description: True if the RHI supports RLM_WriteOnly_NoOverwrite

description: True if the RHI supports Mesh and Amplification shaders with tier0 capability

description: True if the RHI supports Mesh and Amplification shaders with tier1 capability

SupportsMobileMultiView

description: True if the RHI supports mobile multi-view

SupportsMSAADepthSampleAccess

description: Whether or not the RHI can perform MSAA sample load.

SupportsMultiDrawIndirect

description: True if the RHI supports Multi Draw Indirect, a variant of Draw Indirect with variable number of sub-commands generated by GPU

SupportsMultithreadedResources

description: Does the RHI support parallel resource commands (i.e. create / lock / unlock) on non-immediate command list APIs, recorded off the render thread.

SupportsMultithreadedShaderCreation

description: True if the multi-threaded shader creation is supported by (or desirable for) the RHI.

SupportsMultithreading

description: Whether the RHI can send commands to the device context from multiple threads.

description: Whether or not the RHI supports 16bit VALU and resource loads (HLSL shader model 6.2).

SupportsParallelOcclusionQueries

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

description: Temporary.

SupportsParallelRHIExecute

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

SupportsPipelineFileCache

description: True if the pipeline file cache can be used with this RHI

SupportsPipelineStateSortKey

description: True if the RHI supports optimal low level pipeline state sort keys.

SupportsPixelLocalStorage

description: True if mobile pixel local storage is supported

SupportsPixelShaderUAVs

description: True if the RHI supports Pixel Shader UAV

SupportsPrimitiveShaders

description: True if the RHI supports primitive shaders.

SupportsPSOPrecaching

description: True if the RHI support PSO precaching

SupportsQuadBufferStereo

description: True if this platform has quad buffer stereo support.

SupportsQuadTopology

description: True if the RHI supports quad topology (PT_QuadList).

SupportsRawViewsForAnyBuffer

description: Whether a raw (ByteAddress) buffer view can be created for any buffer, regardless of its EBufferUsageFlags::ByteAddressBuffer flag.

SupportsRectTopology

description: True if the RHI supports rectangular topology (PT_RectList).

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

type: TRHIGlobal< boo...

description: True if PF_FloatRGBA render targets are supported

description: True if PF_G8 render targets are supported

SupportsReservedResources

description: True if the RHI supports reserved (AKA tiled, virtual or sparse) resources and operations related to them

SupportsResummarizeHTile

description: True if the RHI supports resummarizing depth target HTile meta data.

SupportsRHIOnTaskThread

description: As above, but we run the commands on arbitrary task threads

SupportsRHIThread

description: Whether or not the RHI supports an RHI thread.

SupportsRWTextureBuffers

description: Whether RW texture buffers are supported

SupportsSeparateDepthStencilCopyAccess

description: Whether depth or stencil can individually be set to CopySrc/Dest access.

SupportsSeparateRenderTargetBlendState

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

SupportsShaderDepthStencilFetch

description: True if mobile depth & stencil fetch is supported

SupportsShaderFramebufferFetch

description: True if mobile framebuffer fetch is supported

SupportsShaderMRTFramebufferFetch

description: True if mobile framebuffer fetch is supported from MRT's

SupportsShaderTimestamp

description: True if the RHI supports reading system timer in shaders via GetShaderTimestamp().

SupportsStencilRefFromPixelShader

description: True if the RHI supports setting the stencil ref at pixel granularity from the pixel shader

description: Whether to initialize 3D textures using a bulk data (or through a mip update if false).

SupportsTextureStreaming

description: True if the RHI supports texture streaming

SupportsTextureViews

description: True if the RHI supports texture views (data aliasing)

SupportsUAVFormatAliasing

description: True if the RHI supports unordered access view format aliasing

SupportsUpdateFromBufferTexture

description: True if the RHI supports UpdateFromBufferTexture method

SupportsVolumeTextureRendering

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

SupportsWaveOperations

description: Whether or not the RHI supports shader wave operations (shader model 6.0).

SupportsWideMRT

description: True if the RHI supports 256bit MRT

TexturePoolSize

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

TriggerGPUHitchProfile

description: Whether we are profiling GPU hitches.

TriggerGPUProfile

description: Whether the next frame should profile the GPU.

UniformBufferMemorySize

description: Amount of memory allocated by uniform buffers

description: True if bulk data should be used with 3d textures

UsingNullRHI

description: True if we are running with the NULL RHI

VertexElementTypeSupport

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


description: Copy the current state of the resource to the readback data.

module: RHI

code: virtual void EnqueueCopy ( [FRHICommandList](API\Runtime\RHI\FRHICommandList) & RHICmdList, [FRHIBuffer](API\Runtime\RHI\FRHIBuffer) * SourceBuffer, uint32 NumBytes )


description:
Returns the CPU accessible pointer that backs this staging buffer.
A CPU accessible pointer to the backing buffer.

code: virtual void * Lock ( uint32 NumBytes )


description: Signals that the host is finished reading from the backing buffer.

code: virtual void Unlock()


code: FRHIGPUBufferReadback ( [FName](API\Runtime\Core\UObject\FName) RequestName )


className: FRHIGPUBufferReadback

description: Buffer readback implementation.

code: class FRHIGPUBufferReadback : public [FRHIGPUMemoryReadback](API\Runtime\RHI\FRHIGPUMemoryReadback)


code: const [FName](API\Runtime\Core\UObject\FName) & GetFName() const


description:
Poll the fence to see if the GPU has signaled it.
True if and only if the GPU fence has been inserted and the GPU has signaled the fence.

code: bool Poll() const


description: Poll on a subset of the GPUs that this fence supports.

code: virtual bool Poll ( [FRHIGPUMask](API\Runtime\RHI\FRHIGPUMask) GPUMask ) const


code: FRHIGPUFence ( [FName](API\Runtime\Core\UObject\FName) InName )


className: FRHIGPUFence

description: Generic GPU fence class. Granularity differs depending on backing RHI - ie it may only represent command buffer granularity. RHI specific fences derive from this to implement real GPU->CPU fencing. The default implementation always returns false for Poll until the next frame from the frame the fence was inserted because not all APIs have a GPU/CPU sync object, we need to fake it.

code: class FRHIGPUFence : public [FRHIResource](API\Runtime\RHI\FRHIResource)

FenceName

type: FName

NumPendingWriteCommands

type: FThreadSafeCoun...


code: static const [FRHIGPUMask](API\Runtime\RHI\FRHIGPUMask) All()


code: bool Contains ( uint32 GPUIndex ) const


code: bool ContainsAll ( const [FRHIGPUMask](API\Runtime\RHI\FRHIGPUMask) & Rhs ) const


code: static const [FRHIGPUMask](API\Runtime\RHI\FRHIGPUMask) FilterGPUsBefore ( uint32 GPUIndex )


className: FRHIGPUMask::FIterator::operator bool

code: operator bool&40;&41; const


code: bool operator&33;&61; &40; const FIterator & Rhs &41; const


code: FIterator operator&43;&43; &40; int &41;


code: FIterator &40; const uint32 InGPUMask &41;


code: FIterator &40; const FRHIGPUMask & InGPUMask &41;


code: static [FRHIGPUMask](API\Runtime\RHI\FRHIGPUMask) FromIndex ( uint32 GPUIndex )


code: static const [FRHIGPUMask](API\Runtime\RHI\FRHIGPUMask) GPU0()


code: bool Intersects ( const [FRHIGPUMask](API\Runtime\RHI\FRHIGPUMask) & Rhs ) const


code: [FRHIGPUMask](API\Runtime\RHI\FRHIGPUMask) operator& ( const [FRHIGPUMask](API\Runtime\RHI\FRHIGPUMask) & Rhs ) const


code: bool operator== ( const [FRHIGPUMask](API\Runtime\RHI\FRHIGPUMask) & Rhs ) const


code: void operator&= ( const [FRHIGPUMask](API\Runtime\RHI\FRHIGPUMask) & Rhs )


code: bool operator!= ( const [FRHIGPUMask](API\Runtime\RHI\FRHIGPUMask) & Rhs ) const


code: FRHIGPUMask &40; uint32 InGPUMask &41;


className: FRHIGPUMask

description: A mask where each bit is a GPU index. Can not be empty so that non SLI platforms can optimize it to be always 1.

code: struct FRHIGPUMask


code: virtual void EnqueueCopy ( [FRHICommandList](API\Runtime\RHI\FRHICommandList) & RHICmdList, [FRHIBuffer](API\Runtime\RHI\FRHIBuffer) * SourceBuffer, uint32 NumBytes )


code: void EnqueueCopy ( [FRHICommandList](API\Runtime\RHI\FRHICommandList) & RHICmdList, [FRHITexture](API\Runtime\RHI\FRHITexture) * SourceTexture, [FResolveRect](API\Runtime\RHI\FResolveRect) Rect )


code: virtual void EnqueueCopy ( [FRHICommandList](API\Runtime\RHI\FRHICommandList) & RHICmdList, [FRHITexture](API\Runtime\RHI\FRHITexture) * SourceTexture, const FIntVector & SourcePosition, uint32 SourceSlice, const FIntVector & Size )


code: const [FRHIGPUMask](API\Runtime\RHI\FRHIGPUMask) & GetLastCopyGPUMask() const


description: Indicates if the data is in place and ready to be read.

code: bool IsReady()


description: Indicates if the data is in place and ready to be read on a subset of GPUs.

code: bool IsReady ( [FRHIGPUMask](API\Runtime\RHI\FRHIGPUMask) GPUMask )


code: void * Lock ( uint32 NumBytes )


code: void Unlock()


code: FRHIGPUMemoryReadback ( [FName](API\Runtime\Core\UObject\FName) RequestName )


className: FRHIGPUMemoryReadback

description: FRHIGPUMemoryReadback: Represents a memory readback request scheduled with CopyToStagingBuffer Wraps a staging buffer with aFRHIGPUFencefor synchronization.

code: class FRHIGPUMemoryReadback

Fence

type: FGPUFenceRHIRef

LastCopyGPUMask

type: FRHIGPUMask

LastLockGPUIndex

description: We need to separately track which GPU buffer was last locked.


description: Returns the CPU accessible pointer that backs this staging buffer.

code: virtual void * Lock ( uint32 NumBytes )


code: void * Lock ( int32 & OutRowPitchInPixels, int32 * OutBufferHeight )


description: Deprecated* Use FRHIGPUTextureReadback::Lock( int32& OutRowPitchInPixels) instead.

code: void LockTexture ( [FRHICommandListImmediate](API\Runtime\RHI\FRHICommandListImmediate) & RHICmdList, void *& OutBufferPtr, int32 & OutRowPitchInPixels )


code: virtual void Unlock()


code: FRHIGPUTextureReadback ( [FName](API\Runtime\Core\UObject\FName) RequestName )


className: FRHIGPUTextureReadback

description: Texture readback implementation.

code: class FRHIGPUTextureReadback : public [FRHIGPUMemoryReadback](API\Runtime\RHI\FRHIGPUMemoryReadback)

DestinationStagingTextures

type: FTextureRHIRef[...


description: Remaining fraction of GPU resource that is idle.

code: float GetUnused()


className: FRHIGPUUsageFractions

description: Structs that describe how intensively a GPU is being used.

code: struct FRHIGPUUsageFractions

ClockScaling

type: float

description: Fraction on how much much the GPU clocks has been scaled down by driver for energy savings.

CurrentProcess

description: Fraction of GPU resource dedicated for our own process at current clock scaling.

ExternalProcesses

description: Fraction of GPU resource dedicated for other processes at current clock scaling.


className: FRHIGraphicsPipelineState

description: Pipeline States

code: class FRHIGraphicsPipelineState : public [FRHIResource](API\Runtime\RHI\FRHIResource)


code: FRHIGraphicsPipelineStateFallBack ( const [FGraphicsPipelineStateInitializer](API\Runtime\RHI\FGraphicsPipelineStateInitialize-) & Init )


className: FRHIGraphicsPipelineStateFallBack

description: 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.

code: class FRHIGraphicsPipelineStateFallBack : public [FRHIGraphicsPipelineState](API\Runtime\RHI\FRHIGraphicsPipelineState)

Initializer

type: FGraphicsPipeli...


code: FRHIGraphicsShader ( ERHIResourceType InResourceType, EShaderFrequency InFrequency )


className: FRHIGraphicsShader

code: class FRHIGraphicsShader : public [FRHIShader](API\Runtime\RHI\FRHIShader)


code: template<class TIndexOrVertexBufferPointer> void AddUnlockFence ( TIndexOrVertexBufferPointer * Buffer, [FRHICommandListImmediate](API\Runtime\RHI\FRHICommandListImmediate) & RHICmdList, const [FLockParams](API\Runtime\RHI\FRHILockTracker\FLockParams) & LockParms )


className: FLockParams

code: struct FLockParams

bCreateLock

type: bool

Buffer

type: void *

LockMode

type: EResourceLockMo...


code: FLockParams &40; void &42; InRHIBuffer, void &42; InBuffer, uint32 InOffset, uint32 InBufferSize, EResourceLockMode InLockMode, bool bInbDirectLock, bool bInCreateLock &41;


code: FUnlockFenceParams &40; void &42; InRHIBuffer, FGraphEventRef InUnlockEvent &41;


className: FUnlockFenceParams

code: struct FUnlockFenceParams

UnlockEvent

type: FGraphEventRef


code: void Lock ( void * RHIBuffer, void * Buffer, uint32 Offset, uint32 SizeRHI, EResourceLockMode LockMode, bool bInDirectBufferWrite, bool bInCreateLock )


code: [FLockParams](API\Runtime\RHI\FRHILockTracker\FLockParams) Unlock ( void * RHIBuffer, uint32 Offset )


code: void WaitForUnlock ( void * RHIBuffer )


className: FRHILockTracker

code: struct FRHILockTracker

OutstandingLocks

type: TArray<FLockPa...

OutstandingUnlocks

type: TArray<FUnlock...


className: FRHIMeshShader

code: class FRHIMeshShader : public [FRHIGraphicsShader](API\Runtime\RHI\FRHIGraphicsShader)


className: FRHIPerCategoryDrawStats

code: struct FRHIPerCategoryDrawStats


code: [FRHIPerCategoryDrawStats](API\Runtime\RHI\FRHIPerCategoryDrawStats) & operator+= ( [FRHIPerCategoryDrawStats](API\Runtime\RHI\FRHIPerCategoryDrawStats) const & RHS )


code: FRHIPipelineBinaryLibrary ( EShaderPlatform InPlatform, [FString](API\Runtime\Core\Containers\FString) const & FilePath )


className: FRHIPipelineBinaryLibrary

code: class FRHIPipelineBinaryLibrary : public [FRHIResource](API\Runtime\RHI\FRHIResource)

Platform

type: EShaderPlatform


className: FRHIPixelShader

code: class FRHIPixelShader : public [FRHIGraphicsShader](API\Runtime\RHI\FRHIGraphicsShader)


code: [FRHIRenderQuery](API\Runtime\RHI\FRHIRenderQuery) * GetQuery() const


code: [FRHIPooledRenderQuery](API\Runtime\RHI\FRHIPooledRenderQuery) & operator= ( const [FRHIPooledRenderQuery](API\Runtime\RHI\FRHIPooledRenderQuery) & )


code: [FRHIPooledRenderQuery](API\Runtime\RHI\FRHIPooledRenderQuery) & operator= ( [FRHIPooledRenderQuery](API\Runtime\RHI\FRHIPooledRenderQuery) && )


code: FRHIPooledRenderQuery ( const [FRHIPooledRenderQuery](API\Runtime\RHI\FRHIPooledRenderQuery) & )


code: FRHIPooledRenderQuery ( [FRHIPooledRenderQuery](API\Runtime\RHI\FRHIPooledRenderQuery) && )


code: FRHIPooledRenderQuery ( [FRHIRenderQueryPool](API\Runtime\RHI\FRHIRenderQueryPool) * InQueryPool, [TRefCountPtr](API\Runtime\Core\Templates\TRefCountPtr)< [FRHIRenderQuery](API\Runtime\RHI\FRHIRenderQuery) > && InQuery )


className: FRHIPooledRenderQuery

code: class FRHIPooledRenderQuery


description: Helper for accessing R10G10B10A2 colors.

code: struct FRHIR10G10B10A2

A

type: uint32:  2


code: virtual bool GetInitializer ( struct [FRasterizerStateInitializerRHI](API\Runtime\RHI\FRasterizerStateInitializerRHI) & Init )


className: FRHIRasterizerState

code: class FRHIRasterizerState : public [FRHIResource](API\Runtime\RHI\FRHIResource)


className: FRHIRayCallableShader

code: class FRHIRayCallableShader : public [FRHIRayTracingShader](API\Runtime\RHI\FRHIRayTracingShader)


className: FRHIRayGenShader

code: class FRHIRayGenShader : public [FRHIRayTracingShader](API\Runtime\RHI\FRHIRayTracingShader)


className: FRHIRayHitGroupShader

code: class FRHIRayHitGroupShader : public [FRHIRayTracingShader](API\Runtime\RHI\FRHIRayTracingShader)


className: FRHIRayMissShader

code: class FRHIRayMissShader : public [FRHIRayTracingShader](API\Runtime\RHI\FRHIRayTracingShader)


code: FRHIRayTracingAccelerationStructure()


className: FRHIRayTracingAccelerationStructure

code: class FRHIRayTracingAccelerationStructure : public [FRHIResource](API\Runtime\RHI\FRHIResource)

SizeInfo

type: FRayTracingAcce...


code: FRayTracingAccelerationStructureAddress GetAccelerationStructureAddress ( uint64 GPUIndex ) const


code: const [FRayTracingGeometryInitializer](API\Runtime\RHI\FRayTracingGeometryInitializer) & GetInitializer() const


code: void SetInitializer ( const [FRayTracingGeometryInitializer](API\Runtime\RHI\FRayTracingGeometryInitializer) & Initializer )


code: FRHIRayTracingGeometry ( const [FRayTracingGeometryInitializer](API\Runtime\RHI\FRayTracingGeometryInitializer) & InInitializer )


className: FRHIRayTracingGeometry

description: Bottom level ray tracing acceleration structure (contains triangles).

code: class FRHIRayTracingGeometry : public [FRHIRayTracingAccelerationStructure](API\Runtime\RHI\FRHIRayTracingAccelerationStruct-)

InitializedType

type: ERayTracingGeom...

Initializer

type: FRayTracingGeom...


className: FRHIRayTracingGeometryUpdateInfo

code: struct FRHIRayTracingGeometryUpdateInfo

DestGeometry

type: FRHIRayTracingG...


className: FRHIRayTracingPipelineState

code: class FRHIRayTracingPipelineState : public [FRHIResource](API\Runtime\RHI\FRHIResource)


code: const [FRayTracingSceneInitializer2](API\Runtime\RHI\FRayTracingSceneInitializer2) & GetInitializer() const


code: uint32 GetLayerBufferOffset ( uint32 LayerIndex ) const


code: FRHIRayTracingShader ( EShaderFrequency InFrequency )


description: Returns a buffer view for RHI-specific system parameters associated with this scene. This may be needed to access ray tracing geometry data in shaders that use ray queries. Returns NULL if current RHI does not require this buffer.

code: virtual [FRHIShaderResourceView](API\Runtime\RHI\FRHIShaderResourceView) * GetOrCreateMetadataBufferSRV ( [FRHICommandListImmediate](API\Runtime\RHI\FRHICommandListImmediate) & RHICmdList )


className: FRHIRayTracingScene

description: Top level ray tracing acceleration structure (contains instances of meshes).

code: class FRHIRayTracingScene : public [FRHIRayTracingAccelerationStructure](API\Runtime\RHI\FRHIRayTracingAccelerationStruct-)


code: void ConvertToRenderTargetsInfo ( [FRHISetRenderTargetsInfo](API\Runtime\RHI\FRHISetRenderTargetsInfo) & OutRTInfo ) const


className: FColorEntry

code: struct FColorEntry

Action

type: ERenderTargetAc...

RenderTarget

type: FRHITexture...


className: FDepthStencilEntry

code: struct FDepthStencilEntry

Action

type: EDepthStencilTa...

ExclusiveDepthStencil

type: FExclusiveDepth...


code: int32 GetNumColorRenderTargets() const


code: [FRHIRenderPassInfo](API\Runtime\RHI\FRHIRenderPassInfo) & operator= ( const [FRHIRenderPassInfo](API\Runtime\RHI\FRHIRenderPassInfo) & )


className: FRHIRayTracingShader

code: class FRHIRayTracingShader : public [FRHIShader](API\Runtime\RHI\FRHIShader)


description: Color and depth with resolve.

code: FRHIRenderPassInfo ( [FRHITexture](API\Runtime\RHI\FRHITexture) * ColorRT, ERenderTargetActions ColorAction, [FRHITexture](API\Runtime\RHI\FRHITexture) * ResolveColorRT, [FRHITexture](API\Runtime\RHI\FRHITexture) * DepthRT, EDepthStencilTargetActions DepthActions, [FRHITexture](API\Runtime\RHI\FRHITexture) * ResolveDepthRT, [FExclusiveDepthStencil](API\Runtime\RHI\FExclusiveDepthStencil) InEDS )


description: Color MRTs and depth.

code: FRHIRenderPassInfo ( int32 NumColorRTs, [FRHITexture](API\Runtime\RHI\FRHITexture) * ColorRTs, ERenderTargetActions ColorAction, [FRHITexture](API\Runtime\RHI\FRHITexture) * ResolveRTs, [FRHITexture](API\Runtime\RHI\FRHITexture) * DepthRT, EDepthStencilTargetActions DepthActions, [FRHITexture](API\Runtime\RHI\FRHITexture) * ResolveDepthRT, [FExclusiveDepthStencil](API\Runtime\RHI\FExclusiveDepthStencil) InEDS )


description: Color and depth with resolve and optional sample density.

code: FRHIRenderPassInfo ( [FRHITexture](API\Runtime\RHI\FRHITexture) * ColorRT, ERenderTargetActions ColorAction, [FRHITexture](API\Runtime\RHI\FRHITexture) * ResolveColorRT, [FRHITexture](API\Runtime\RHI\FRHITexture) * DepthRT, EDepthStencilTargetActions DepthActions, [FRHITexture](API\Runtime\RHI\FRHITexture) * ResolveDepthRT, [FRHITexture](API\Runtime\RHI\FRHITexture) * InShadingRateTexture, EVRSRateCombiner InShadingRateTextureCombiner, [FExclusiveDepthStencil](API\Runtime\RHI\FExclusiveDepthStencil) InEDS )


code: FRHIRenderPassInfo ( const [FRHIRenderPassInfo](API\Runtime\RHI\FRHIRenderPassInfo) & )


description: Color MRTs, no depth.

code: FRHIRenderPassInfo ( int32 NumColorRTs, [FRHITexture](API\Runtime\RHI\FRHITexture) * ColorRTs, ERenderTargetActions ColorAction )


description: Color MRTs, no depth.

code: FRHIRenderPassInfo ( int32 NumColorRTs, [FRHITexture](API\Runtime\RHI\FRHITexture) * ColorRTs, ERenderTargetActions ColorAction, [FRHITexture](API\Runtime\RHI\FRHITexture) * ResolveTargets )


description: Depth, no color.

code: FRHIRenderPassInfo ( [FRHITexture](API\Runtime\RHI\FRHITexture) * DepthRT, EDepthStencilTargetActions DepthActions, [FRHITexture](API\Runtime\RHI\FRHITexture) * ResolveDepthRT, [FExclusiveDepthStencil](API\Runtime\RHI\FExclusiveDepthStencil) InEDS )


description: Color, no depth, optional resolve, optional mip, optional array slice.

code: FRHIRenderPassInfo ( [FRHITexture](API\Runtime\RHI\FRHITexture) * ColorRT, ERenderTargetActions ColorAction, [FRHITexture](API\Runtime\RHI\FRHITexture) * ResolveRT, uint8 InMipIndex, int32 InArraySlice )


description: Depth, no color, occlusion queries.

code: FRHIRenderPassInfo ( [FRHITexture](API\Runtime\RHI\FRHITexture) * DepthRT, uint32 InNumOcclusionQueries, EDepthStencilTargetActions DepthActions, [FRHITexture](API\Runtime\RHI\FRHITexture) * ResolveDepthRT, [FExclusiveDepthStencil](API\Runtime\RHI\FExclusiveDepthStencil) InEDS )


description: Color and depth.

code: FRHIRenderPassInfo ( [FRHITexture](API\Runtime\RHI\FRHITexture) * ColorRT, ERenderTargetActions ColorAction, [FRHITexture](API\Runtime\RHI\FRHITexture) * DepthRT, EDepthStencilTargetActions DepthActions, [FExclusiveDepthStencil](API\Runtime\RHI\FExclusiveDepthStencil) InEDS )


description: Color MRTs and depth.

code: FRHIRenderPassInfo ( int32 NumColorRTs, [FRHITexture](API\Runtime\RHI\FRHITexture) * ColorRTs, ERenderTargetActions ColorAction, [FRHITexture](API\Runtime\RHI\FRHITexture) * DepthRT, EDepthStencilTargetActions DepthActions, [FExclusiveDepthStencil](API\Runtime\RHI\FExclusiveDepthStencil) InEDS )


className: FRHIRenderPassInfo

code: struct FRHIRenderPassInfo

ColorRenderTargets

type: TStaticArray<F...

DepthStencilRenderTarget

type: FDepthStencilEn...

MultiViewCount

description: If this renderpass should be multiview, and if so how many views are required

NumOcclusionQueries

description: Some RHIs require a hint that occlusion queries will be used in this render pass.

ResolveRect

type: FResolveRect

description: Controls the area for a multisample resolve or raster UAV (i.e. no fixed-function targets) operation.

ShadingRateTexture

type: FTextureRHIRef

description: Some RHIs can use a texture to control the sampling and/or shading resolution of different areas.

ShadingRateTextureCombiner

type: EVRSRateCombine...

SubpassHint

type: ESubpassHint

description: Hint for some RHI's that renderpass will have specific sub-passes.


className: FRHIRenderQuery

code: class FRHIRenderQuery : public [FRHIResource](API\Runtime\RHI\FRHIResource)


className: FRHIRenderQueryPool

code: class FRHIRenderQueryPool : public [FRHIResource](API\Runtime\RHI\FRHIResource)


code: [FRHIRenderTargetView](API\Runtime\RHI\FRHIRenderTargetView) & operator= ( [FRHIRenderTargetView](API\Runtime\RHI\FRHIRenderTargetView) && )


code: [FRHIRenderTargetView](API\Runtime\RHI\FRHIRenderTargetView) & operator= ( const [FRHIRenderTargetView](API\Runtime\RHI\FRHIRenderTargetView) & )


code: bool operator== ( const [FRHIRenderTargetView](API\Runtime\RHI\FRHIRenderTargetView) & Other ) const


code: FRHIRenderTargetView ( [FRHIRenderTargetView](API\Runtime\RHI\FRHIRenderTargetView) && )


code: FRHIRenderTargetView ( const [FRHIRenderTargetView](API\Runtime\RHI\FRHIRenderTargetView) & )


description: Common case

code: FRHIRenderTargetView ( [FRHITexture](API\Runtime\RHI\FRHITexture) * InTexture, ERenderTargetLoadAction InLoadAction )


description: Common case

code: FRHIRenderTargetView ( [FRHITexture](API\Runtime\RHI\FRHITexture) * InTexture, ERenderTargetLoadAction InLoadAction, uint32 InMipIndex, uint32 InArraySliceIndex )


code: FRHIRenderTargetView ( [FRHITexture](API\Runtime\RHI\FRHITexture) * InTexture, uint32 InMipIndex, uint32 InArraySliceIndex, ERenderTargetLoadAction InLoadAction, ERenderTargetStoreAction InStoreAction )


className: FRHIRenderTargetView

code: class FRHIRenderTargetView

ArraySliceIndex

description: Array slice or texture cube face.

LoadAction

type: ERenderTargetLo...

StoreAction

type: ERenderTargetSt...


className: CurrentlyDeleting

code: static [FRHIResource](API\Runtime\RHI\FRHIResource) * CurrentlyDeleting = nullptr;


description: Deprecated* FlushPendingDeletes is deprecated, please useFRHICommandListExecutor::GetImmediateCommandList().ImmediateFlush(EImmediateFlushType::FlushRHIThreadFlushResources)

code: static int32 FlushPendingDeletes ( [FRHICommandListImmediate](API\Runtime\RHI\FRHICommandListImmediate) & RHICmdList )


code: void SetOwnerName ( const [FName](API\Runtime\Core\UObject\FName) & InOwnerName )


code: FRHIResource ( ERHIResourceType InResourceType )


className: FRHIResource

description: The base type of RHI resources.

code: class FRHIResource


code: FRHIResourceCreateInfo ( const TCHAR * InDebugName )


code: FRHIResourceCreateInfo ( uint32 InExtData )


description: For CreateTexture calls

code: FRHIResourceCreateInfo ( const TCHAR * InDebugName, [FResourceBulkDataInterface](API\Runtime\Core\Containers\FResourceBulkDataInterface) * InBulkData )


description: For CreateBuffer calls

code: FRHIResourceCreateInfo ( const TCHAR * InDebugName, [FResourceArrayInterface](API\Runtime\Core\Containers\FResourceArrayInterface) * InResourceArray )


code: FRHIResourceCreateInfo ( const TCHAR * InDebugName, const [FClearValueBinding](API\Runtime\RHI\FClearValueBinding) & InClearValueBinding )


className: FRHIResourceCreateInfo

code: struct FRHIResourceCreateInfo

BulkData

type: FResourceBulkDa...

description: For CreateTexture calls

bWithoutNativeResource

type: bool

description: Whether to create an RHI object with no underlying resource

ClassName

type: FName

ClearValueBinding

type: FClearValueBind...

description: For binding clear colors to render targets.

DebugName

type: const TCHAR ...

ExtData

description: Optional data that would have come from an offline cooker or whatever - general purpose

GPUMask

type: FRHIGPUMask

description: Set of GPUs on which to create the resource

ResourceArray

type: FResourceArrayI...

description: For CreateBuffer calls


className: FRHIResourceInfo

code: struct FRHIResourceInfo

Type

type: ERHIResourceTyp...

VRamAllocation

type: FVRamAllocation


code: FRHIResourceStats ( const [FName](API\Runtime\Core\UObject\FName) & InName, const [FName](API\Runtime\Core\UObject\FName) & InOwnerName, const [FString](API\Runtime\Core\Containers\FString) & InType, const [FString](API\Runtime\Core\Containers\FString) & InFlags, const uint64 & InSizeInBytes, bool bInResident, bool bInMarkedForDelete, bool bInTransient, bool bInStreaming, bool bInRT, bool bInDS, bool bInUAV, bool bInRTAS, bool bInHasFlags )


className: FRHIResourceStats

code: struct FRHIResourceStats

Flags

type: FString


code: static uint32 Create ( uint16 UniformBufferIndex, uint16 ResourceIndex, uint16 BindIndex )


className: EResourceTableDefinitions

code: enum EResourceTableDefinitions { RTD_NumBits_UniformBufferIndex = 8, RTD_NumBits_ResourceIndex = 16, RTD_NumBits_BindIndex = 8, RTD_Mask_UniformBufferIndex = (1 << RTD_NumBits_UniformBufferIndex) - 1, RTD_Mask_ResourceIndex = (1 << RTD_NumBits_ResourceIndex) - 1, RTD_Mask_BindIndex = (1 << RTD_NumBits_BindIndex) - 1, RTD_Shift_BindIndex = 0, RTD_Shift_ResourceIndex = RTD_Shift_BindIndex + RTD_NumBits_BindIndex, RTD_Shift_UniformBufferIndex = RTD_Shift_ResourceIndex + RTD_NumBits_ResourceIndex, }


code: static uint16 GetBindIndex ( uint32 Data )


code: static constexpr uint32 GetEndOfStreamToken()


code: static uint16 GetResourceIndex ( uint32 Data )


code: static uint16 GetUniformBufferIndex ( uint32 Data )


className: FRHIResourceTableEntry

code: struct FRHIResourceTableEntry


code: void QueueUpdateRequest ( [FRHIBuffer](API\Runtime\RHI\FRHIBuffer) * DestBuffer, [FRHIBuffer](API\Runtime\RHI\FRHIBuffer) * SrcBuffer )


code: void QueueUpdateRequest ( [FRHIRayTracingGeometry](API\Runtime\RHI\FRHIRayTracingGeometry) * DestGeometry, [FRHIRayTracingGeometry](API\Runtime\RHI\FRHIRayTracingGeometry) * SrcGeometry )


code: FRHIResourceUpdateBatcher ( [TArrayView](API\Runtime\Core\Containers\TArrayView)< [FRHIResourceUpdateInfo](API\Runtime\RHI\FRHIResourceUpdateInfo) > InUpdateInfos )


className: FRHIResourceUpdateBatcher

code: struct FRHIResourceUpdateBatcher

UpdateInfos

type: TArrayView<FRH...


className: EUpdateType

code: enum EUpdateType { UT_Buffer, UT_RayTracingGeometry, UT_Num, }


className: FRHIResourceUpdateInfo

code: struct FRHIResourceUpdateInfo

type: union FRHIResou...

Buffer

type: FRHIBufferUpdat...

RayTracingGeometry

type: FRHIRayTracingG...

Type

type: EUpdateType


description: Helper for accessing R16G16 colors.

code: struct FRHIRG16


description: Helper for accessing R16G16B16A16 colors.

code: struct FRHIRGBA16


code: virtual [FRHIDescriptorHandle](API\Runtime\RHI\FRHIDescriptorHandle) GetBindlessHandle() const


className: FRHISamplerState

description: State blocks

code: class FRHISamplerState : public [FRHIResource](API\Runtime\RHI\FRHIResource)


code: FRHIScopedGPUMask ( [FRHIScopedGPUMask](API\Runtime\RHI\FRHIScopedGPUMask) const & )


code: FRHIScopedGPUMask ( [FRHIScopedGPUMask](API\Runtime\RHI\FRHIScopedGPUMask) && )


code: FRHIScopedGPUMask ( [FRHIComputeCommandList](API\Runtime\RHI\FRHIComputeCommandList) & InRHICmdList, [FRHIGPUMask](API\Runtime\RHI\FRHIGPUMask) InGPUMask )


className: FRHIScopedGPUMask

code: struct FRHIScopedGPUMask

RHICmdList

type: FRHIComputeComm...


code: void SetClearDepthStencil ( bool bInClearDepth, bool bInClearStencil )


code: FRHISetRenderTargetsInfo ( int32 InNumColorRenderTargets, const [FRHIRenderTargetView](API\Runtime\RHI\FRHIRenderTargetView) * InColorRenderTargets, const [FRHIDepthRenderTargetView](API\Runtime\RHI\FRHIDepthRenderTargetView) & InDepthStencilRenderTarget )


className: FRHISetRenderTargetsInfo

code: class FRHISetRenderTargetsInfo

ColorRenderTarget

type: FRHIRenderTarge...

description: Color Render Targets Info.

ColorResolveRenderTarget

description: Color Render Targets Info.

DepthStencilRenderTarget

type: FRHIDepthRender...

description: Depth/Stencil Render Target Info.

ShadingRateTexture

type: FRHITexture...

ShadingRateTextureCombiner

type: EVRSRateCombine...


code: EShaderFrequency GetFrequency() const


code: [FString](API\Runtime\Core\Containers\FString) GetUniformBufferName ( uint32 Index ) const


code: void SetHash ( [FSHAHash](API\Runtime\Core\Misc\FSHAHash) InHash )


code: FRHIShader ( ERHIResourceType InResourceType, EShaderFrequency InFrequency )


className: FRHIShader

code: class FRHIShader : public [FRHIResource](API\Runtime\RHI\FRHIResource)

Debug

description: For debugging only e.g. MaterialName:ShaderFile.usf or ShaderFile.usf/EntryFunc

DebugStrideValidationData

type: TArray<FShader...

UniformBufferNames

type: TArray<FName>


code: virtual [TRefCountPtr](API\Runtime\Core\Templates\TRefCountPtr)< [FRHIShader](API\Runtime\RHI\FRHIShader) > CreateShader ( int32 ShaderIndex )


code: int32 FindShaderIndex ( const [FSHAHash](API\Runtime\Core\Misc\FSHAHash) & Hash )


code: int32 FindShaderMapIndex ( const [FSHAHash](API\Runtime\Core\Misc\FSHAHash) & Hash )


code: const [FString](API\Runtime\Core\Containers\FString) & GetName() const


code: int32 GetNumShadersForShaderMap ( int32 ShaderMapIndex ) const


code: [FSHAHash](API\Runtime\Core\Misc\FSHAHash) GetShaderHash ( int32 ShaderMapIndex, int32 ShaderIndex )


code: int32 GetShaderIndex ( int32 ShaderMapIndex, int32 i ) const


code: virtual bool PreloadShader ( int32 ShaderIndex, FGraphEventArray & OutCompletionEvents )


code: virtual bool PreloadShaderMap ( int32 ShaderMapIndex, FGraphEventArray & OutCompletionEvents )


code: virtual bool PreloadShaderMap ( int32 ShaderMapIndex, [FCoreDelegates::FAttachShaderReadRequestFunc](API\Runtime\Core\Misc\FCoreDelegates\FAttachShaderReadRequestFunc) AttachShaderReadRequestFunc )


code: virtual void ReleasePreloadedShader ( int32 ShaderIndex )


code: FRHIShaderLibrary ( EShaderPlatform InPlatform, [FString](API\Runtime\Core\Containers\FString) const & InName )


className: FRHIShaderLibrary

description: Shader Library

code: class FRHIShaderLibrary : public [FRHIResource](API\Runtime\RHI\FRHIResource)

Platform

type: EShaderPlatform


className: EType

code: enum EType { Texture, ResourceView, UnorderedAccessView, Sampler, UniformBuffer, }


code: FRHIShaderParameter ( uint16 InBufferIndex, uint16 InBaseIndex, uint16 InByteOffset, uint16 InByteSize )


className: FRHIShaderParameter

description: Compact representation of a bound shader parameter (read: value). Its offsets are for referencing their data in an associated blob.

code: struct FRHIShaderParameter


code: FRHIShaderParameterResource ( [FRHITexture](API\Runtime\RHI\FRHITexture) * InTexture, uint16 InIndex )


code: FRHIShaderParameterResource ( [FRHIShaderResourceView](API\Runtime\RHI\FRHIShaderResourceView) * InView, uint16 InIndex )


code: FRHIShaderParameterResource ( [FRHIUnorderedAccessView](API\Runtime\RHI\FRHIUnorderedAccessView) * InUAV, uint16 InIndex )


code: FRHIShaderParameterResource ( [FRHISamplerState](API\Runtime\RHI\FRHISamplerState) * InSamplerState, uint16 InIndex )


code: FRHIShaderParameterResource ( [FRHIUniformBuffer](API\Runtime\RHI\FRHIUniformBuffer) * InUniformBuffer, uint16 InIndex )


code: FRHIShaderParameterResource ( [EType](API\Runtime\RHI\FRHIShaderParameterResource\EType) InType, [FRHIResource](API\Runtime\RHI\FRHIResource) * InResource, uint16 InIndex )


code: enum EType { ResourceView, UnorderedAccessView, }


className: FRHIShaderParameterResource

description: Compact representation of a bound resource parameter (Texture, SRV, UAV, SamplerState, or UniformBuffer)

code: struct FRHIShaderParameterResource

Resource

type: FRHIResource&#...

Type

type: EType


code: FRHIShaderParameterUnbind ( [EType](API\Runtime\RHI\FRHIShaderParameterUnbind\EType) InType, uint16 InIndex )


className: FRHIShaderParameterUnbind

description: Compact representation of a resource parameter unbind, limited to SRVs and UAVs

code: struct FRHIShaderParameterUnbind


code: FRHIShaderResourceView ( [FRHIViewableResource](API\Runtime\RHI\FRHIViewableResource) * InResource, [FRHIViewDesc](API\Runtime\RHI\FRHIViewDesc) const & InViewDesc )


className: FRHIShaderResourceView

code: class FRHIShaderResourceView : public [FRHIView](API\Runtime\RHI\FRHIView)


description: For debugging, may not be implemented on all RHIs.

code: virtual uint64 GetGPUSizeBytes() const


code: void * Lock ( uint32 Offset, uint32 NumBytes )


className: FRHIStagingBuffer

description: Generic staging buffer class used byFRHIGPUMemoryReadbackRHI specific staging buffers derive from this

code: class FRHIStagingBuffer : public [FRHIResource](API\Runtime\RHI\FRHIResource)

bIsLocked

type: bool


className: kStencilPlaneSlice

code: static const uint32 kStencilPlaneSlice = 1;


className: kAllSubresources

code: static const uint32 kAllSubresources = TNumericLimits<uint32>::Max();


className: kDepthPlaneSlice

code: static const uint32 kDepthPlaneSlice = 0;


code: bool operator== ( [FRHISubresourceRange](API\Runtime\RHI\FRHISubresourceRange) const & RHS ) const


code: bool operator!= ( [FRHISubresourceRange](API\Runtime\RHI\FRHISubresourceRange) const & RHS ) const


code: FRHISubresourceRange ( uint32 InMipIndex, uint32 InArraySlice, uint32 InPlaneSlice )


className: FRHISubresourceRange

code: struct FRHISubresourceRange


description: Deprecated*GetClearBinding()is deprecated, please useGetDesc().ClearValue instead

code: const [FClearValueBinding](API\Runtime\RHI\FClearValueBinding) GetClearBinding() const


description: the clear color value if set


code: virtual [FRHIDescriptorHandle](API\Runtime\RHI\FRHIDescriptorHandle) GetDefaultBindlessHandle() const


description: the depth clear value if set

code: float GetDepthClearValue() const


description: the depth & stencil clear value if set

code: void GetDepthStencilClearValue ( float & OutDepth, uint32 & OutStencil ) const


description:
Get the texture description used to create the texture Still virtual becauseFRHITextureReferencecan override this function - remove virtual whenFRHITextureReferenceis deprecated
TextureDesc used to create the texture

code: virtual const [FRHITextureDesc](API\Runtime\RHI\FRHITextureDesc) & GetDesc() const


description: Deprecated*GetFlags()is deprecated, please useGetDesc().Flags instead

code: ETextureCreateFlags GetFlags() const


description: Deprecated*GetFormat()is deprecated, please useGetDesc().Format instead

code: EPixelFormat GetFormat() const


description: Returns the dimensions (i.e. the actual number of texels in each dimension) of the specified mip. ArraySize is ignored. The Z component will always be 1 for 2D/cube resources and will contain depth for volume textures. This differs fromGetSizeXYZ()which returns ArraySize in Z for 2D arrays.

code: FIntVector GetMipDimensions ( uint8 MipIndex ) const


description:
Returns access to the platform-specific native resource pointer. This is designed to be used to provide plugins with access to the underlying resource and should be used very carefully or not at all.
The pointer to the native resource or NULL if it not initialized or not supported for this resource type for some reason

code: virtual void * GetNativeResource() const


description:
Returns access to the platform-specific native shader resource view pointer. This is designed to be used to provide plugins with access to the underlying resource and should be used very carefully or not at all.
The pointer to the native resource or NULL if it not initialized or not supported for this resource type for some reason

code: virtual void * GetNativeShaderResourceView() const


description: Deprecated*GetNumMips()is deprecated, please useGetDesc().NumMips instead

code: uint32 GetNumMips() const


description: Deprecated*GetNumSamples()is deprecated, please useGetDesc().NumSamples instead

code: uint32 GetNumSamples() const


description: Deprecated*GetSize()is deprecated, please useGetDesc().Extent.X instead

code: uint32 GetSize() const


description: Helper getter functions - non virtual Returns the x, y & z dimensions if the texture The Z component will always be 1 for 2D/cube resources and will contain depth for volume textures & array size for array textures

code: FIntVector GetSizeXYZ() const


description: Deprecated*GetSizeX()is deprecated, please useGetDesc().Extent.X instead

code: uint32 GetSizeX() const


description: Deprecated*GetSizeXY()is deprecated, please useGetDesc().Extent.X orGetDesc().Extent.Y instead

code: FIntPoint GetSizeXY() const


description: Deprecated*GetSizeY()is deprecated, please useGetDesc().Extent.Y instead

code: uint32 GetSizeY() const


description: Deprecated*GetSizeZ()is deprecated, please useGetDesc().ArraySize instead for TextureArrays andGetDesc().Depth for 3D textures

code: uint32 GetSizeZ() const


description: the stencil clear value if set

code: uint32 GetStencilClearValue() const


description: Deprecated functions

code: FRHITexture2D * GetTexture2D()


description: Deprecated* FRHITexture2DArray is deprecated, please useFRHITexturedirectly


description: Deprecated* FRHITexture3D is deprecated, please useFRHITexturedirectly

code: FRHITexture3D * GetTexture3D()


description:
Returns access to the platform-specific RHI texture baseclass. This is designed to provide the RHI with fast access to its base classes in the face of multiple inheritance.
The pointer to the platform-specific RHI texture baseclass or NULL if it not initialized or not supported for this RHI

code: virtual void * GetTextureBaseRHI()


description: Deprecated* FRHITextureCube is deprecated, please useFRHITexturedirectly

code: FRHITextureCube * GetTextureCube()


description: Virtual functions implemented per RHI

code: virtual [FRHITextureReference](API\Runtime\RHI\FRHITextureReference) * GetTextureReference()


code: virtual void GetWriteMaskProperties ( void *& OutData, uint32 & OutSize )


description: Whether the texture has a clear color defined

code: bool HasClearValue() const


description: Whether the texture is multi sampled.

code: bool IsMultisampled() const


description: RenderTime & Name functions - non virtualsets the last time this texture was cached in a resource table.

code: void SetLastRenderTime ( float InLastRenderTime )


description: Initialization constructor. Should only be called by platform RHI implementations.

code: FRHITexture ( const [FRHITextureCreateDesc](API\Runtime\RHI\FRHITextureCreateDesc) & InDesc )


code: void SetName ( const [FName](API\Runtime\Core\UObject\FName) & InName )


description: Constructor for texture references

code: FRHITexture &40; ERHIResourceType InResourceType &41;


className: FRHITexture

code: class FRHITexture : public [FRHIViewableResource](API\Runtime\RHI\FRHIViewableResource)


code: [FRHITextureCreateDesc](API\Runtime\RHI\FRHITextureCreateDesc) & AddFlags ( ETextureCreateFlags InFlags )


code: static [FRHITextureCreateDesc](API\Runtime\RHI\FRHITextureCreateDesc) Create ( const TCHAR * InDebugName, ETextureDimension InDimension )


code: static [FRHITextureCreateDesc](API\Runtime\RHI\FRHITextureCreateDesc) Create2D ( const TCHAR * InDebugName )


code: static [FRHITextureCreateDesc](API\Runtime\RHI\FRHITextureCreateDesc) Create2D ( const TCHAR * DebugName, FIntPoint Size, EPixelFormat Format )


code: static [FRHITextureCreateDesc](API\Runtime\RHI\FRHITextureCreateDesc) Create2D ( const TCHAR * DebugName, int32 SizeX, int32 SizeY, EPixelFormat Format )


code: static [FRHITextureCreateDesc](API\Runtime\RHI\FRHITextureCreateDesc) Create2DArray ( const TCHAR * InDebugName )


code: static [FRHITextureCreateDesc](API\Runtime\RHI\FRHITextureCreateDesc) Create2DArray ( const TCHAR * DebugName, FIntPoint Size, uint16 ArraySize, EPixelFormat Format )


code: static [FRHITextureCreateDesc](API\Runtime\RHI\FRHITextureCreateDesc) Create2DArray ( const TCHAR * DebugName, int32 SizeX, int32 SizeY, int32 ArraySize, EPixelFormat Format )


code: static [FRHITextureCreateDesc](API\Runtime\RHI\FRHITextureCreateDesc) Create3D ( const TCHAR * InDebugName )


code: static [FRHITextureCreateDesc](API\Runtime\RHI\FRHITextureCreateDesc) Create3D ( const TCHAR * DebugName, FIntVector Size, EPixelFormat Format )


code: static [FRHITextureCreateDesc](API\Runtime\RHI\FRHITextureCreateDesc) Create3D ( const TCHAR * DebugName, int32 SizeX, int32 SizeY, int32 SizeZ, EPixelFormat Format )


code: static [FRHITextureCreateDesc](API\Runtime\RHI\FRHITextureCreateDesc) CreateCube ( const TCHAR * DebugName, uint32 Size, EPixelFormat Format )


code: static [FRHITextureCreateDesc](API\Runtime\RHI\FRHITextureCreateDesc) CreateCubeArray ( const TCHAR * InDebugName )


code: static [FRHITextureCreateDesc](API\Runtime\RHI\FRHITextureCreateDesc) CreateCubeArray ( const TCHAR * DebugName, uint32 Size, uint16 ArraySize, EPixelFormat Format )


code: static [FRHITextureCreateDesc](API\Runtime\RHI\FRHITextureCreateDesc) CreateCube ( const TCHAR * InDebugName )


code: [FRHITextureCreateDesc](API\Runtime\RHI\FRHITextureCreateDesc) & SetArraySize ( uint16 InArraySize )


code: [FRHITextureCreateDesc](API\Runtime\RHI\FRHITextureCreateDesc) & SetBulkData ( [FResourceBulkDataInterface](API\Runtime\Core\Containers\FResourceBulkDataInterface) * InBulkData )


code: [FRHITextureCreateDesc](API\Runtime\RHI\FRHITextureCreateDesc) & SetClassName ( const [FName](API\Runtime\Core\UObject\FName) & InClassName )


code: [FRHITextureCreateDesc](API\Runtime\RHI\FRHITextureCreateDesc) & SetClearValue ( [FClearValueBinding](API\Runtime\RHI\FClearValueBinding) InClearValue )


code: [FRHITextureCreateDesc](API\Runtime\RHI\FRHITextureCreateDesc) & SetDebugName ( const TCHAR * InDebugName )


code: [FRHITextureCreateDesc](API\Runtime\RHI\FRHITextureCreateDesc) & SetDepth ( uint16 InDepth )


code: [FRHITextureCreateDesc](API\Runtime\RHI\FRHITextureCreateDesc) & SetDimension ( ETextureDimension InDimension )


code: [FRHITextureCreateDesc](API\Runtime\RHI\FRHITextureCreateDesc) & SetExtData ( uint32 InExtData )


code: [FRHITextureCreateDesc](API\Runtime\RHI\FRHITextureCreateDesc) & SetExtent ( const FIntPoint & InExtent )


code: [FRHITextureCreateDesc](API\Runtime\RHI\FRHITextureCreateDesc) & SetExtent ( uint32 InExtent )


code: [FRHITextureCreateDesc](API\Runtime\RHI\FRHITextureCreateDesc) & SetExtent ( int32 InExtentX, int32 InExtentY )


code: [FRHITextureCreateDesc](API\Runtime\RHI\FRHITextureCreateDesc) & SetFastVRAMPercentage ( float In )


code: [FRHITextureCreateDesc](API\Runtime\RHI\FRHITextureCreateDesc) & SetFlags ( ETextureCreateFlags InFlags )


code: [FRHITextureCreateDesc](API\Runtime\RHI\FRHITextureCreateDesc) & SetFormat ( EPixelFormat InFormat )


code: [FRHITextureCreateDesc](API\Runtime\RHI\FRHITextureCreateDesc) & SetGPUMask ( [FRHIGPUMask](API\Runtime\RHI\FRHIGPUMask) InGPUMask )


code: [FRHITextureCreateDesc](API\Runtime\RHI\FRHITextureCreateDesc) & SetInitialState ( ERHIAccess InInitialState )


code: [FRHITextureCreateDesc](API\Runtime\RHI\FRHITextureCreateDesc) & SetNumMips ( uint8 InNumMips )


code: [FRHITextureCreateDesc](API\Runtime\RHI\FRHITextureCreateDesc) & SetNumSamples ( uint8 InNumSamples )


code: [FRHITextureCreateDesc](API\Runtime\RHI\FRHITextureCreateDesc) & SetOwnerName ( const [FName](API\Runtime\Core\UObject\FName) & InOwnerName )


code: [FRHITextureCreateDesc](API\Runtime\RHI\FRHITextureCreateDesc) & SetUAVFormat ( EPixelFormat InUAVFormat )


description: Constructor with minimal argument set. Name and dimension are always required.

code: FRHITextureCreateDesc ( const TCHAR * InDebugName, ETextureDimension InDimension )


description: Constructor for when you already have anFRHITextureDesc.

code: FRHITextureCreateDesc ( [FRHITextureDesc](API\Runtime\RHI\FRHITextureDesc) const & InDesc, ERHIAccess InInitialState, TCHAR const * InDebugName, [FResourceBulkDataInterface](API\Runtime\Core\Containers\FResourceBulkDataInterface) * InBulkData )


className: FRHITextureCreateDesc

code: struct FRHITextureCreateDesc : public [FRHITextureDesc](API\Runtime\RHI\FRHITextureDesc)

BulkData

type: FResourceBulkDa...

description: Optional initial data to fill the resource with.

ClassName

type: FName

DebugName

type: const TCHAR ...

description: A friendly name for the resource.

InitialState

type: ERHIAccess

description: The RHI access state that the resource will be created in.


code: uint64 CalcMemorySizeEstimate ( uint32 FirstMipIndex ) const


description: To get a true measure of a texture resource for the current running platform RHI, use RHICalcTexturePlatformSize().

code: uint64 CalcMemorySizeEstimate ( uint32 FirstMipIndex, uint32 LastMipIndex ) const


description: Check the validity.

code: static bool CheckValidity ( const [FRHITextureDesc](API\Runtime\RHI\FRHITextureDesc) & Desc, const TCHAR * Name )


description: Returns whether this descriptor conforms to requirements.

code: bool IsValid() const


code: [FRHITextureDesc](API\Runtime\RHI\FRHITextureDesc) & operator= ( const [FRHITextureDesc](API\Runtime\RHI\FRHITextureDesc) & Other )


code: bool operator== ( const [FRHITextureDesc](API\Runtime\RHI\FRHITextureDesc) & Other ) const


code: bool operator!= ( const [FRHITextureDesc](API\Runtime\RHI\FRHITextureDesc) & Other ) const


code: FRHITextureDesc ( const [FRHITextureDesc](API\Runtime\RHI\FRHITextureDesc) & Other )


code: FRHITextureDesc ( ETextureDimension InDimension )


code: FRHITextureDesc ( ETextureDimension InDimension, ETextureCreateFlags InFlags, EPixelFormat InFormat, [FClearValueBinding](API\Runtime\RHI\FClearValueBinding) InClearValue, FIntPoint InExtent, uint16 InDepth, uint16 InArraySize, uint8 InNumMips, uint8 InNumSamples, uint32 InExtData )


className: FRHITextureDesc

description: Descriptor used to create a texture resource

code: struct FRHITextureDesc

ArraySize

description: The number of array elements in the texture. (Keep at 1 if dimension is 3D).

ClearValue

type: FClearValueBind...

description: Clear value to use when fast-clearing the texture.

Depth

description: Depth of the texture if the dimension is 3D.

Dimension

type: ETextureDimensi...

description: Texture dimension to use when creating the RHI texture.

ExtData

description: Platform-specific additional data. Used for offline processed textures on some platforms.

Extent

type: FIntPoint

description: Extent of the texture in x and y.

FastVRAMPercentage

description: Resource memory percentage which should be allocated onto fast VRAM (hint-only).

Flags

type: ETextureCreateF...

description: Texture flags passed on to RHI texture.

Format

type: EPixelFormat

description: Pixel format used to create RHI texture.

GPUMask

type: FRHIGPUMask

description: A mask representing which GPUs to create the resource on, in a multi-GPU system.

NumMips

description: Number of mips in the texture mip-map chain.

NumSamples

description: Number of samples in the texture. >1 for MSAA.

UAVFormat

description: Texture format used when creating the UAV.


className: DefaultTexture

code: static [TRefCountPtr](API\Runtime\Core\Templates\TRefCountPtr)< [FRHITexture](API\Runtime\RHI\FRHITexture) > DefaultTexture;


code: [FRHIShaderResourceView](API\Runtime\RHI\FRHIShaderResourceView) * GetBindlessView() const


code: virtual [FRHIDescriptorHandle](API\Runtime\RHI\FRHIDescriptorHandle) GetDefaultBindlessHandle() const


code: static [FRHITexture](API\Runtime\RHI\FRHITexture) * GetDefaultTexture()


description:
Get the texture description used to create the texture Still virtual becauseFRHITextureReferencecan override this function - remove virtual whenFRHITextureReferenceis deprecated
TextureDesc used to create the texture

code: virtual const [FRHITextureDesc](API\Runtime\RHI\FRHITextureDesc) & GetDesc() const


description:
Returns access to the platform-specific native resource pointer. This is designed to be used to provide plugins with access to the underlying resource and should be used very carefully or not at all.
The pointer to the native resource or NULL if it not initialized or not supported for this resource type for some reason

code: virtual void * GetNativeResource() const


description:
Returns access to the platform-specific native shader resource view pointer. This is designed to be used to provide plugins with access to the underlying resource and should be used very carefully or not at all.
The pointer to the native resource or NULL if it not initialized or not supported for this resource type for some reason

code: virtual void * GetNativeShaderResourceView() const


code: [FRHITexture](API\Runtime\RHI\FRHITexture) * GetReferencedTexture() const


description:
Returns access to the platform-specific RHI texture baseclass. This is designed to provide the RHI with fast access to its base classes in the face of multiple inheritance.
The pointer to the platform-specific RHI texture baseclass or NULL if it not initialized or not supported for this RHI

code: virtual void * GetTextureBaseRHI()


description: Virtual functions implemented per RHI

code: virtual [FRHITextureReference](API\Runtime\RHI\FRHITextureReference) * GetTextureReference()


code: virtual void GetWriteMaskProperties ( void *& OutData, uint32 & OutSize )


description: Deprecated*FRHITextureReferencenow requires a texture reference on construction

code: FRHITextureReference()


className: FRHITextureReference

code: class FRHITextureReference : public [FRHITexture](API\Runtime\RHI\FRHITexture)


description: Check the validity.

code: static bool CheckValidity ( const [FRHITextureDesc](API\Runtime\RHI\FRHITextureDesc) & TextureDesc, const [FRHITextureSRVCreateInfo](API\Runtime\RHI\FRHITextureSRVCreateInfo) & TextureSRVDesc, const TCHAR * TextureName )


code: bool operator== ( const [FRHITextureSRVCreateInfo](API\Runtime\RHI\FRHITextureSRVCreateInfo) & Other ) const


code: bool operator!= ( const [FRHITextureSRVCreateInfo](API\Runtime\RHI\FRHITextureSRVCreateInfo) & Other ) const


code: static bool Validate ( const [FRHITextureDesc](API\Runtime\RHI\FRHITextureDesc) & TextureDesc, const [FRHITextureSRVCreateInfo](API\Runtime\RHI\FRHITextureSRVCreateInfo) & TextureSRVDesc, const TCHAR * TextureName, bool bFatal )


code: FRHITextureReference ( [FRHITexture](API\Runtime\RHI\FRHITexture) * InReferencedTexture, [FRHIShaderResourceView](API\Runtime\RHI\FRHIShaderResourceView) * InBindlessView )


code: FRHITextureSRVCreateInfo ( uint8 InMipLevel, uint8 InNumMipLevels, EPixelFormat InFormat )


code: FRHITextureSRVCreateInfo ( uint8 InMipLevel, uint8 InNumMipLevels, uint16 InFirstArraySlice, uint16 InNumArraySlices, EPixelFormat InFormat )


className: FRHITextureSRVCreateInfo

description: Deprecated* Use FRHITextureSRVCreateDesc rather thanFRHITextureSRVCreateInfo.

code: struct FRHITextureSRVCreateInfo

DimensionOverride

type: TOptional< ETex...

description: Specify a dimension to use which overrides the default

FirstArraySlice

description: Specify first array slice index.Bydefault 0.

Format

description: View the texture with a different format.

MetaData

type: ERHITextureMeta...

description: Specify the metadata plane to use when creating a view.

MipLevel

description: Specify the mip level to use. Useful when rendering to one mip while sampling from another

NumArraySlices

description: Specify number of array slices.

NumMipLevels

description: Create a view to a single, or multiple mip levels

SRGBOverride

type: ERHITextureSRVO...

description: Potentially override the texture's sRGB flag


code: bool operator== ( const [FRHITextureUAVCreateInfo](API\Runtime\RHI\FRHITextureUAVCreateInfo) & Other ) const


code: bool operator!= ( const [FRHITextureUAVCreateInfo](API\Runtime\RHI\FRHITextureUAVCreateInfo) & Other ) const


code: FRHITextureUAVCreateInfo ( ERHITextureMetaDataAccess InMetaData )


code: FRHITextureUAVCreateInfo ( uint8 InMipLevel, EPixelFormat InFormat, uint16 InFirstArraySlice, uint16 InNumArraySlices )


className: FRHITextureUAVCreateInfo

code: struct FRHITextureUAVCreateInfo


description: Deprecated* GetOrCreateSRV now requires a command list.

code: [FRHIShaderResourceView](API\Runtime\RHI\FRHIShaderResourceView) * GetOrCreateSRV ( [FRHITexture](API\Runtime\RHI\FRHITexture) * Texture, const [FRHITextureSRVCreateInfo](API\Runtime\RHI\FRHITextureSRVCreateInfo) & CreateInfo )


description: Finds a SRV matching the descriptor in the cache or creates a new one and updates the cache.

code: [FRHIShaderResourceView](API\Runtime\RHI\FRHIShaderResourceView) * GetOrCreateSRV ( [FRHICommandListBase](API\Runtime\RHI\FRHICommandListBase) & RHICmdList, [FRHITexture](API\Runtime\RHI\FRHITexture) * Texture, const [FRHITextureSRVCreateInfo](API\Runtime\RHI\FRHITextureSRVCreateInfo) & CreateInfo )


description: Deprecated* GetOrCreateUAV now requires a command list.

code: [FRHIUnorderedAccessView](API\Runtime\RHI\FRHIUnorderedAccessView) * GetOrCreateUAV ( [FRHITexture](API\Runtime\RHI\FRHITexture) * Texture, const [FRHITextureUAVCreateInfo](API\Runtime\RHI\FRHITextureUAVCreateInfo) & CreateInfo )


description: Finds a UAV matching the descriptor in the cache or creates a new one and updates the cache.

code: [FRHIUnorderedAccessView](API\Runtime\RHI\FRHIUnorderedAccessView) * GetOrCreateUAV ( [FRHICommandListBase](API\Runtime\RHI\FRHICommandListBase) & RHICmdList, [FRHITexture](API\Runtime\RHI\FRHITexture) * Texture, const [FRHITextureUAVCreateInfo](API\Runtime\RHI\FRHITextureUAVCreateInfo) & CreateInfo )


description: Sets the debug name of the RHI view resources.

code: void SetDebugName ( const TCHAR * DebugName )


className: FRHITextureViewCache

code: class FRHITextureViewCache


className: FRHITimestampCalibrationQuery

description: Misc

code: class FRHITimestampCalibrationQuery : public [FRHIResource](API\Runtime\RHI\FRHIResource)


code: FRHITrackedAccessInfo ( [FRHIViewableResource](API\Runtime\RHI\FRHIViewableResource) * InResource, ERHIAccess InAccess )


className: FRHITrackedAccessInfo

code: struct FRHITrackedAccessInfo

Resource

type: FRHIViewableRes...


code: static [FRHITransientAliasingInfo](API\Runtime\RHI\FRHITransientAliasingInfo) Acquire ( class [FRHITexture](API\Runtime\RHI\FRHITexture) * Texture, [TArrayView](API\Runtime\Core\Containers\TArrayView)< const [FRHITransientAliasingOverlap](API\Runtime\RHI\FRHITransientAliasingOverlap) > InOverlaps )


code: static [FRHITransientAliasingInfo](API\Runtime\RHI\FRHITransientAliasingInfo) Acquire ( class [FRHIBuffer](API\Runtime\RHI\FRHIBuffer) * Buffer, [TArrayView](API\Runtime\Core\Containers\TArrayView)< const [FRHITransientAliasingOverlap](API\Runtime\RHI\FRHITransientAliasingOverlap) > InOverlaps )


code: static [FRHITransientAliasingInfo](API\Runtime\RHI\FRHITransientAliasingInfo) Discard ( class [FRHIBuffer](API\Runtime\RHI\FRHIBuffer) * Buffer )


code: static [FRHITransientAliasingInfo](API\Runtime\RHI\FRHITransientAliasingInfo) Discard ( class [FRHITexture](API\Runtime\RHI\FRHITexture) * Texture )


className: EAction

code: enum EAction { Acquire, Discard, }


code: bool operator== ( const [FRHITransientAliasingInfo](API\Runtime\RHI\FRHITransientAliasingInfo) & RHS ) const


code: bool operator!= ( const [FRHITransientAliasingInfo](API\Runtime\RHI\FRHITransientAliasingInfo) & RHS ) const


className: FRHITransientAliasingInfo

code: struct FRHITransientAliasingInfo

type: union FRHITrans...

Action

type: enumFRHITransi...

Buffer

type: FRHIBuffer*...

Overlaps

type: TArrayView< con...

description: List of prior resource overlaps to use when acquiring. Must be empty for discard operations.

type: FRHIResource&#...

Texture

type: FRHITexture...


code: bool operator== ( const [FRHITransientAliasingOverlap](API\Runtime\RHI\FRHITransientAliasingOverlap) & Other ) const


code: bool operator!= ( const [FRHITransientAliasingOverlap](API\Runtime\RHI\FRHITransientAliasingOverlap) & RHS ) const


code: FRHITransientAliasingOverlap ( [FRHITexture](API\Runtime\RHI\FRHITexture) * InTexture )


code: FRHITransientAliasingOverlap ( [FRHIResource](API\Runtime\RHI\FRHIResource) * InResource, [EType](API\Runtime\RHI\FRHITransientAliasingOverlap\EType) InType )


code: FRHITransientAliasingOverlap ( [FRHIBuffer](API\Runtime\RHI\FRHIBuffer) * InBuffer )


className: FRHITransientAliasingOverlap

code: struct FRHITransientAliasingOverlap


className: EMemoryRangeFlags

code: enum EMemoryRangeFlags { None = 0, FastVRAM = 1 << 0, }


className: FAllocationArray

code: typedef [TArray](API\Runtime\Core\Containers\TArray)< [FAllocation](API\Runtime\RHI\FRHITransientAllocationStats\FAllocation), TInlineAllocator< 2 >> FAllocationArray


description: Internal Allocator API.

code: virtual void Acquire ( const TCHAR * InName, uint32 InAcquirePassIndex, uint64 InInitCycle )


className: FMemoryRange

code: struct FMemoryRange

Capacity

description: Number of bytes available for use in the memory range.

CommitSize

description: Number of bytes allocated for use in the memory range.

Flags

type: EMemoryRangeFla...

description: Flags specified for this memory range.


className: FRHITransientAllocationStats

code: class FRHITransientAllocationStats

MemoryRanges

type: TArray<FMemory...

Resources

type: TMap< constFRH...


description: Returns the create info used when creating this buffer.

code: const [FRHIBufferCreateInfo](API\Runtime\RHI\FRHIBufferCreateInfo) & GetCreateInfo() const


code: [FRHIShaderResourceView](API\Runtime\RHI\FRHIShaderResourceView) * GetOrCreateSRV ( [FRHICommandListBase](API\Runtime\RHI\FRHICommandListBase) & RHICmdList, const [FRHIBufferSRVCreateInfo](API\Runtime\RHI\FRHIBufferSRVCreateInfo) & InCreateInfo )


code: [FRHIUnorderedAccessView](API\Runtime\RHI\FRHIUnorderedAccessView) * GetOrCreateUAV ( [FRHICommandListBase](API\Runtime\RHI\FRHICommandListBase) & RHICmdList, const [FRHIBufferUAVCreateInfo](API\Runtime\RHI\FRHIBufferUAVCreateInfo) & InCreateInfo )


description: Returns the underlying RHI buffer.

code: [FRHIBuffer](API\Runtime\RHI\FRHIBuffer) * GetRHI() const


code: FRHITransientBuffer ( [FRHIBuffer](API\Runtime\RHI\FRHIBuffer) * InBuffer, uint64 InGpuVirtualAddress, uint64 InHash, uint64 InSize, ERHITransientAllocationType InAllocationType, const [FRHIBufferCreateInfo](API\Runtime\RHI\FRHIBufferCreateInfo) & InCreateInfo )


className: FRHITransientBuffer

code: class FRHITransientBuffer : public [FRHITransientResource](API\Runtime\RHI\FRHITransientResource)

CreateInfo

type: constFRHIBuffe...

description: The create info describing the texture.

ViewCache

type: FRHIBufferViewC...

description: The persistent view cache containing all views created for this buffer.


className: FRHITransientHeapAllocation

description: Represents an allocation from the transient heap.

code: struct FRHITransientHeapAllocation

AlignmentPad

description: Number of bytes of padding were added to the offset.

Heap

type: FRHITransientHe...

description: Transient heap which made the allocation.

Offset

description: Offset in the transient heap; front of the heap starts at 0.

Size

description: Size of the allocation made from the allocator (aligned).


className: FRHITransientPageAllocation

description: Represents a full set of page allocations from multiple page pools.

code: struct FRHITransientPageAllocation

PoolAllocations

type: TArray<FRHITra...

description: The list of allocations by pool.

Spans

description: The full list of spans indexed by each allocation.


className: FRHITransientPagePoolAllocation

description: Represents an allocation from a transient page pool.

code: struct FRHITransientPagePoolAllocation

Hash

description: A unique hash identifying this allocation to the allocator implementation.

Pool

type: FRHITransientPa...

description: The transient page pool which made the allocation.

SpanIndex

description: The index identifying the allocation to the page pool.

SpanOffsetMin

description: Offsets into the array of spans for the allocator implementation.


className: FRHITransientPageSpan

code: struct FRHITransientPageSpan

Count

description: Number of pages in the span.

Offset

description: Offset of the span in the page pool in pages.


description: Internal Allocator API.

code: virtual void Acquire ( const TCHAR * InName, uint32 InAcquirePassIndex, uint64 InAllocatorCycle )


code: void AddAliasingOverlap ( [FRHITransientResource](API\Runtime\RHI\FRHITransientResource) * InResource )


description: Returns the number of times Acquire has been called.

code: uint32 GetAcquireCount() const


description: Returns the last allocator cycle this resource was acquired.

code: uint64 GetAcquireCycle() const


description: Returns the pass index which may end acquiring this resource.

code: [TInterval](API\Runtime\Core\Math\TInterval)< uint32 > GetAcquirePasses() const


description: Returns the list of aliasing overlaps used when transitioning the resource.

code: TConstArrayView< [FRHITransientAliasingOverlap](API\Runtime\RHI\FRHITransientAliasingOverlap) > GetAliasingOverlaps() const


code: void Discard ( uint32 InDiscardPassIndex )


description: Returns the pass index which discarded this resource.

code: [TInterval](API\Runtime\Core\Math\TInterval)< uint32 > GetDiscardPasses() const


description: Returns the gpu virtual address of the transient resource.

code: uint64 GetGpuVirtualAddress() const


description: Returns the hash used to uniquely identify this resource if cached.

code: uint64 GetHash() const


code: const [FRHITransientHeapAllocation](API\Runtime\RHI\FRHITransientHeapAllocation) & GetHeapAllocation() const


description: Returns the name assigned to the transient resource at allocation time.

code: const TCHAR * GetName() const


code: const [FRHITransientPageAllocation](API\Runtime\RHI\FRHITransientPageAllocation) & GetPageAllocation() const


description: Returns the underlying RHI resource.

code: [FRHIResource](API\Runtime\RHI\FRHIResource) * GetRHI() const


description: Returns the required size in bytes of the resource.

code: uint64 GetSize() const


description: Returns whether this resource is still in an acquired state.

code: bool IsAcquired() const


className: kInvalidPassIndex

code: static const uint32 kInvalidPassIndex = TNumericLimits<uint32>::Max();


code: FRHITransientResource ( [FRHIResource](API\Runtime\RHI\FRHIResource) * InResource, uint64 InGpuVirtualAddress, uint64 InHash, uint64 InSize, ERHITransientAllocationType InAllocationType, ERHITransientResourceType InResourceType )


className: FRHITransientResource

code: class FRHITransientResource


description: Internal Allocator API.

code: virtual void Acquire ( const TCHAR * InName, uint32 InAcquirePassIndex, uint64 InInitCycle )


description: Returns the create info struct used when creating this texture.

code: const FRHITextureCreateInfo & GetCreateInfo() const


description: Finds a SRV matching the descriptor in the cache or creates a new one and updates the cache.

code: [FRHIShaderResourceView](API\Runtime\RHI\FRHIShaderResourceView) * GetOrCreateSRV ( [FRHICommandListBase](API\Runtime\RHI\FRHICommandListBase) & RHICmdList, const [FRHITextureSRVCreateInfo](API\Runtime\RHI\FRHITextureSRVCreateInfo) & InCreateInfo )


description: Finds a UAV matching the descriptor in the cache or creates a new one and updates the cache.

code: [FRHIUnorderedAccessView](API\Runtime\RHI\FRHIUnorderedAccessView) * GetOrCreateUAV ( [FRHICommandListBase](API\Runtime\RHI\FRHICommandListBase) & RHICmdList, const [FRHITextureUAVCreateInfo](API\Runtime\RHI\FRHITextureUAVCreateInfo) & InCreateInfo )


description: Returns the underlying RHI texture.

code: [FRHITexture](API\Runtime\RHI\FRHITexture) * GetRHI() const


code: FRHITransientTexture ( [FRHITexture](API\Runtime\RHI\FRHITexture) * InTexture, uint64 InGpuVirtualAddress, uint64 InHash, uint64 InSize, ERHITransientAllocationType InAllocationType, const FRHITextureCreateInfo & InCreateInfo )


className: FRHITransientTexture

code: class FRHITransientTexture : public [FRHITransientResource](API\Runtime\RHI\FRHITransientResource)

CreateInfo

type: const FRHITextu...

description: The create info describing the texture.

ViewCache

type: FRHITextureView...

description: The persistent view cache containing all views created for this texture.


code: template<typename T> T * GetPrivateData()


code: template<typename T> const T * GetPrivateData() const


className: FRHITransition

description: No destructors are accessible with public or protected access.

code: struct FRHITransition


code: FRHITransitionCreateInfo ( ERHIPipeline InSrcPipelines, ERHIPipeline InDstPipelines, ERHITransitionCreateFlags InFlags, [TArrayView](API\Runtime\Core\Containers\TArrayView)< const [FRHITransitionInfo](API\Runtime\RHI\FRHITransitionInfo) > InTransitionInfos, [TArrayView](API\Runtime\Core\Containers\TArrayView)< const [FRHITransientAliasingInfo](API\Runtime\RHI\FRHITransientAliasingInfo) > InAliasingInfos )


className: FRHITransitionCreateInfo

code: struct FRHITransitionCreateInfo

DstPipelines

type: ERHIPipeline

Flags

type: ERHITransitionC...


className: EType

code: enum EType { Unknown, Texture, Buffer, UAV, BVH, }


code: bool operator== ( [FRHITransitionInfo](API\Runtime\RHI\FRHITransitionInfo) const & RHS ) const


code: bool operator!= ( [FRHITransitionInfo](API\Runtime\RHI\FRHITransitionInfo) const & RHS ) const


code: FRHITransitionInfo ( class [FRHITexture](API\Runtime\RHI\FRHITexture) * InTexture, ERHIAccess InNewState )


code: FRHITransitionInfo ( class [FRHIUnorderedAccessView](API\Runtime\RHI\FRHIUnorderedAccessView) * InUAV, ERHIAccess InNewState )


code: FRHITransitionInfo ( class [FRHIBuffer](API\Runtime\RHI\FRHIBuffer) * InRHIBuffer, ERHIAccess InNewState )


code: FRHITransitionInfo ( class [FRHIUnorderedAccessView](API\Runtime\RHI\FRHIUnorderedAccessView) * InUAV, ERHIAccess InPreviousState, ERHIAccess InNewState, EResourceTransitionFlags InFlags )


code: FRHITransitionInfo ( class [FRHIBuffer](API\Runtime\RHI\FRHIBuffer) * InRHIBuffer, ERHIAccess InPreviousState, ERHIAccess InNewState, EResourceTransitionFlags InFlags )


code: FRHITransitionInfo ( class [FRHIRayTracingAccelerationStructure](API\Runtime\RHI\FRHIRayTracingAccelerationStruct-) * InBVH, ERHIAccess InPreviousState, ERHIAccess InNewState, EResourceTransitionFlags InFlags )


code: FRHITransitionInfo ( class [FRHITexture](API\Runtime\RHI\FRHITexture) * InTexture, ERHIAccess InPreviousState, ERHIAccess InNewState, EResourceTransitionFlags InFlags, uint32 InMipIndex, uint32 InArraySlice, uint32 InPlaneSlice )


className: FRHITransitionInfo

code: struct FRHITransitionInfo : public [FRHISubresourceRange](API\Runtime\RHI\FRHISubresourceRange)

type: union FRHITrans...

AccessAfter

type: ERHIAccess

BVH

type: FRHIRayTracingA...

type: EResourceTransi...

Type

type: enumFRHITransi...

UAV

type: FRHIUnorderedAc...

ViewableResource

type: FRHIViewableRes...


code: const [FRHIUniformBufferLayout](API\Runtime\RHI\FRHIUniformBufferLayout) & GetLayout() const


code: const [FRHIUniformBufferLayout](API\Runtime\RHI\FRHIUniformBufferLayout) * GetLayoutPtr() const


code: const [TArray](API\Runtime\Core\Containers\TArray)< [TRefCountPtr](API\Runtime\Core\Templates\TRefCountPtr)< [FRHIResource](API\Runtime\RHI\FRHIResource) > > & GetResourceTable() const


description: The number of bytes in the uniform buffer.

code: uint32 GetSize() const


description: Initialization constructor.

code: FRHIUniformBuffer ( const [FRHIUniformBufferLayout](API\Runtime\RHI\FRHIUniformBufferLayout) * InLayout )


className: FRHIUniformBuffer

code: class FRHIUniformBuffer : public [FRHIResource](API\Runtime\RHI\FRHIResource)

ResourceTable

type: TArray<TRefCou...


code: const [FString](API\Runtime\Core\Containers\FString) & GetDebugName() const


code: FRHIUniformBufferLayout ( const [FRHIUniformBufferLayoutInitializer](API\Runtime\RHI\FRHIUniformBufferLayoutInitializ-) & Initializer )


className: FRHIUniformBufferLayout

description: The layout of a uniform buffer in memory.

code: struct FRHIUniformBufferLayout : public [FRHIResource](API\Runtime\RHI\FRHIResource)

bHasNonGraphOutputs

type: const bool

description: Whether this layout may contain non-render-graph outputs (e.g. RHI UAVs).

BindingFlags

type: const EUniformB...

description: The binding flags describing how this resource can be bound to the RHI.

bNoEmulatedUniformBuffer

description: Used for platforms which use emulated ub's, forces a real uniform buffer instead

ConstantBufferSize

type: const uint32

description: The size of the constant buffer in bytes.

GraphBuffers

type: constTArray<F...

description: The list of all RDG buffer references inlined into the shader parameter structure.

GraphResources

description: The list of all RDG resource references inlined into the shader parameter structure.

GraphTextures

description: The list of all RDG texture references inlined into the shader parameter structure.

GraphUniformBuffers

description: The list of all RDG uniform buffer references inlined into the shader parameter structure.

Name

type: constFString

RenderTargetsOffset

type: const uint16

description: The render target binding slots offset, if it exists.

Resources

description: The list of all resource inlined into the shader parameter structure.

StaticSlot

type: const FUniformB...

description: The static slot (if applicable).

UniformBuffers

description: The list of all non-RDG uniform buffer references inlined into the shader parameter structure.


code: void CopyFrom ( const [FRHIUniformBufferLayoutInitializer](API\Runtime\RHI\FRHIUniformBufferLayoutInitializ-) & Source )


className: CounterBase

code: static constexpr int CounterBase = __COUNTER__;


code: const [FMemoryImageString](API\Runtime\Core\Serialization\FMemoryImageString) & GetDebugName() const


code: RHI_API const [FTypeLayoutDesc](API\Runtime\Core\Serialization\FTypeLayoutDesc) & GetTypeLayout() const


className: InterfaceType

code: static constexpr [ETypeLayoutInterface::Type](API\Runtime\Core\Serialization\ETypeLayoutInterface__Type) InterfaceType = ETypeLayoutInterface:: NonVirtual;


code: static void Initialize &40; FTypeLayoutDesc & TypeDesc &41;


description: Initialize(FTypeLayoutDesc& TypeDesc)

code: template<> struct InternalLinkType< COUNTER-CounterBase >


className: InternalLinkType

description: InternalLinkType<COUNTER-CounterBase >

code: template<int Counter> struct InternalLinkType


code: static RHI_API [FTypeLayoutDesc](API\Runtime\Core\Serialization\FTypeLayoutDesc) & StaticGetTypeLayout()


code: FRHIUniformBufferLayoutInitializer ( const TCHAR * InName )


code: FRHIUniformBufferLayoutInitializer ( const TCHAR * InName, uint32 InConstantBufferSize )


className: FRHIUniformBufferLayoutInitializer

description: Initializer for the layout of a uniform buffer in memory.

bHasNonGraphOutputs

type: bool

BindingFlags

type: EUniformBufferB...

GraphBuffers

type: TMemoryImageArr...

StaticSlot

type: FUniformBufferS...

description: The static slot (if applicable).


className: FRHIUniformBufferResource

code: struct FRHIUniformBufferResource

MemberOffset

description: Byte offset to each resource in the uniform buffer memory.

MemberType

description: Type of the member that allow ().


code: template<> struct InternalLinkType< __COUNTER__-CounterBase >


className: FRHIUniformBufferResourceInitializer

description: Data structure to store information about resource parameter in a shader parameter structure.

description: Type of the member that allow ().


code: FRHIUnorderedAccessView ( [FRHIViewableResource](API\Runtime\RHI\FRHIViewableResource) * InResource, [FRHIViewDesc](API\Runtime\RHI\FRHIViewDesc) const & InViewDesc )


className: FRHIUnorderedAccessView

code: class FRHIUnorderedAccessView : public [FRHIView](API\Runtime\RHI\FRHIView)


code: virtual bool GetInitializer ( FVertexDeclarationElementList & Init )


code: virtual uint32 GetPrecachePSOHash() const


className: FRHIVertexDeclaration

code: class FRHIVertexDeclaration : public [FRHIResource](API\Runtime\RHI\FRHIResource)


className: FRHIVertexShader

code: class FRHIVertexShader : public [FRHIGraphicsShader](API\Runtime\RHI\FRHIGraphicsShader)


code: virtual [FRHIDescriptorHandle](API\Runtime\RHI\FRHIDescriptorHandle) GetBindlessHandle() const


code: [FRHIBuffer](API\Runtime\RHI\FRHIBuffer) * GetBuffer() const


code: [FRHIViewDesc](API\Runtime\RHI\FRHIViewDesc) const & GetDesc() const


code: [FRHIViewableResource](API\Runtime\RHI\FRHIViewableResource) * GetResource() const


code: [FRHITexture](API\Runtime\RHI\FRHITexture) * GetTexture() const


code: FRHIView ( ERHIResourceType InResourceType, [FRHIViewableResource](API\Runtime\RHI\FRHIViewableResource) * InResource, [FRHIViewDesc](API\Runtime\RHI\FRHIViewDesc) const & InViewDesc )


className: FRHIView

code: class FRHIView : public [FRHIResource](API\Runtime\RHI\FRHIResource)

ViewDesc

type: FRHIViewDescco...


description: TODO (RemoveUnknowns) remove once FRHIBufferCreateDesc contains initial access.

code: void SetTrackedAccess_Unsafe ( ERHIAccess Access )


code: void TakeOwnership ( [FRHIViewableResource](API\Runtime\RHI\FRHIViewableResource) & Other )


code: FRHIViewableResource ( ERHIResourceType InResourceType, ERHIAccess InAccess )


className: FRHIViewableResource

code: class FRHIViewableResource : public [FRHIResource](API\Runtime\RHI\FRHIResource)

Name

type: FName


className: EBufferType

code: enum EBufferType { Unknown = 0, Typed = 1, Structured = 2, AccelerationStructure = 3, Raw = 4, }


className: EDimension

code: enum EDimension { Unknown = 0, Texture2D = 1, Texture2DArray = 2, TextureCube = 3, TextureCubeArray = 4, Texture3D = 5, NumBits = 3, }


className: EViewType

code: enum EViewType { BufferSRV, BufferUAV, TextureSRV, TextureUAV, }


className: FViewInfo

description: Used by platform RHIs to create views of buffers. The data in this structure is computed inGetViewInfo(), and is specific to a particular buffer resource. It is not intended to be stored in a view instance.

code: struct FViewInfo


code: FViewInfo GetViewInfo &40; FRHIBuffer &42; TargetBuffer &41; const


className: FBuffer

description: Properties shared by buffer views. Some fields are SRV or UAV specific.

code: struct FBuffer : public [FRHIViewDesc::FCommon](API\Runtime\RHI\FRHIViewDesc\FCommon)

type: uint8:  6

bAppendBuffer

type: uint8:  1

BufferType

type: EBufferType


code: FInitializer & SetFormat &40; EPixelFormat InFormat &41;


code: FInitializer & SetNumElements &40; uint32 InNumElements &41;


code: FInitializer & SetOffsetInBytes &40; uint32 InOffsetBytes &41;


code: FInitializer & SetStride &40; uint32 InStride &41;


code: FInitializer & SetType &40; EBufferType Type &41;


description: Provided for back-compat with existing code. Consider usingSetType()instead for more direct control over the view. For example, it is possible to create a typed view of a BUF_ByteAddress buffer, but not using this function which always choses raw access.

code: FInitializer & SetTypeFromBuffer &40; FRHIBuffer &42; TargetBuffer &41;


className: FInitializer

description: These static asserts are to ensure the descriptor is minimal in size and can be copied around by-value. If they fail, consider re-packing the struct.

code: struct FInitializer : private [FRHIViewDesc](API\Runtime\RHI\FRHIViewDesc)

FRHICommandListBase

type: friend


description: Buffer SRV specific info.

code: struct FViewInfo : public FRHIViewDesc::FBuffer::FViewInfo


className: FBufferSRV

code: struct FBufferSRV : public [FRHIViewDesc::FBuffer](API\Runtime\RHI\FRHIViewDesc\FBuffer)


code: FInitializer & SetAtomicCounter &40; bool InAtomicCounter &41;


code: FInitializer & SetAppendBuffer &40; bool InAppendBuffer &41;


description: Buffer UAV specific info.


className: FBufferUAV

code: struct FBufferUAV : public [FRHIViewDesc::FBuffer](API\Runtime\RHI\FRHIViewDesc\FBuffer)


className: FCommon

description: Properties that apply to all views.

code: struct FCommon

Format

type: EPixelFormat

ViewType

type: EViewType


description: Used by platform RHIs to create views of textures. The data in this structure is computed inGetViewInfo(), and is specific to a particular texture resource. It is not intended to be stored in a view instance.


className: FTexture

description: Properties shared by texture views. Some fields are SRV or UAV specific.

code: struct FTexture : public [FRHIViewDesc::FCommon](API\Runtime\RHI\FRHIViewDesc\FCommon)

Dimension

type: EDimension:  ui...

Plane

type: ERHITexturePlan...


code: FViewInfo GetViewInfo &40; FRHITexture &42; TargetTexture &41; const


description: If the view dimension is smaller than the resource dimension, the array range will be further limited. E.g. creating a Texture2D dimension view of a TextureCubeArray resource

code: FInitializer & SetArrayRange &40; uint16 InFirstElement, uint16 InNumElements &41;


description: Some combinations are not valid, e.g. 3D textures can only have 3D views.

code: FInitializer & SetDimension &40; ETextureDimension InDimension &41;


description: Provided for back-compat with existing code. Consider usingSetDimension()instead for more direct control over the view. For example, it is possible to create a 2D view of a 2DArray texture, but not using this function which always choses 2DArray dimension.

code: FInitializer & SetDimensionFromTexture &40; FRHITexture &42; TargetTexture &41;


code: FInitializer & SetDisableSRGB &40; bool InDisableSRGB &41;


code: FInitializer & SetFormat &40; EPixelFormat InFormat &41;


code: FInitializer & SetMipRange &40; uint8 InFirstMip, uint8 InNumMips &41;


code: FInitializer & SetPlane &40; ERHITexturePlane InPlane &41;


description: Texture SRV specific info.

code: struct FViewInfo : public FRHIViewDesc::FTexture::FViewInfo


className: FTextureSRV

code: struct FTextureSRV : public [FRHIViewDesc::FTexture](API\Runtime\RHI\FRHIViewDesc\FTexture)


code: FInitializer & SetMipLevel &40; uint8 InMipLevel &41;


code: struct FInitializer : private [FRHIViewDesc](API\Runtime\RHI\FRHIViewDesc)


description: Texture UAV specific info.


className: FTextureUAV

code: struct FTextureUAV : public [FRHIViewDesc::FTexture](API\Runtime\RHI\FRHIViewDesc\FTexture)


code: bool operator== ( [FRHIViewDesc](API\Runtime\RHI\FRHIViewDesc) const & RHS ) const


code: bool operator!= ( [FRHIViewDesc](API\Runtime\RHI\FRHIViewDesc) const & RHS ) const


code: FRHIViewDesc ( [EViewType](API\Runtime\RHI\FRHIViewDesc\EViewType) ViewType )


className: FRHIViewDesc

description: The unified RHI view descriptor. These are stored in the baseFRHIViewtype, and packed to minimize memory usage. Platform RHI implementations use the GetViewInfo() functions to convert anFRHIViewDescinto the required info to make a view / descriptor for the GPU.

code: struct FRHIViewDesc

type: union FRHIViewD...

Common

type: FCommon

SRV

type: FTextureSRV

type: FBufferSRV

UAV

type: FTextureUAV

type: FBufferUAV


description: Returns currently set custom present handler.

code: virtual [FRHICustomPresent](API\Runtime\RHI\FRHICustomPresent) * GetCustomPresent() const


description:
Returns access to the platform-specific native resource pointer to a backbuffer rendertarget. This is designed to be used to provide plugins with access to the underlying resource and should be used very carefully or not at all.
The pointer to the native resource or NULL if it not initialized or not supported for this resource type for some reason

code: virtual void * GetNativeBackBufferRT() const


description:
Returns access to the platform-specific native resource pointer to a backbuffer texture. This is designed to be used to provide plugins with access to the underlying resource and should be used very carefully or not at all.
The pointer to the native resource or NULL if it not initialized or not supported for this resource type for some reason

code: virtual void * GetNativeBackBufferTexture() const


description:
Returns access to the platform-specific native resource pointer. This is designed to be used to provide plugins with access to the underlying resource and should be used very carefully or not at all.
The pointer to the native resource or NULL if it not initialized or not supported for this resource type for some reason

code: virtual void * GetNativeSwapChain() const


description:
Returns access to the platform-specific native window. This is designed to be used to provide plugins with access to the underlying resource and should be used very carefully or not at all.
The pointer to the native resource or NULL if it not initialized or not supported for this resource type for some reason. AddParam could represent any additional platform-specific data (could be null).

code: virtual void * GetNativeWindow ( void ** AddParam ) const


description: Sets custom Present handler on the viewport

code: virtual void SetCustomPresent ( class [FRHICustomPresent](API\Runtime\RHI\FRHICustomPresent) * )


description: Ticks the viewport on the Game thread

code: virtual void Tick ( float DeltaTime )


className: FRHIViewport

code: class FRHIViewport : public [FRHIResource](API\Runtime\RHI\FRHIResource)


description: Deprecated* Initialize now requires a command list.

code: void Initialize ( const TCHAR * InDebugName, uint32 BytesPerElement, uint32 NumElements, EPixelFormat Format, EBufferUsageFlags AdditionalUsage, [FResourceArrayInterface](API\Runtime\Core\Containers\FResourceArrayInterface) * InResourceArray )


code: void Initialize ( [FRHICommandListBase](API\Runtime\RHI\FRHICommandListBase) & RHICmdList, const TCHAR * InDebugName, uint32 BytesPerElement, uint32 NumElements, EPixelFormat Format, EBufferUsageFlags AdditionalUsage, [FResourceArrayInterface](API\Runtime\Core\Containers\FResourceArrayInterface) * InResourceArray )


code: void Initialize ( const TCHAR * InDebugName, uint32 BytesPerElement, uint32 NumElements, EPixelFormat Format, ERHIAccess InResourceState, EBufferUsageFlags AdditionalUsage, [FResourceArrayInterface](API\Runtime\Core\Containers\FResourceArrayInterface) * InResourceArray )


code: void Initialize ( [FRHICommandListBase](API\Runtime\RHI\FRHICommandListBase) & RHICmdList, const TCHAR * InDebugName, uint32 BytesPerElement, uint32 NumElements, EPixelFormat Format, ERHIAccess InResourceState, EBufferUsageFlags AdditionalUsage, [FResourceArrayInterface](API\Runtime\Core\Containers\FResourceArrayInterface) * InResourceArray )


code: [FRWBuffer](API\Runtime\RHI\FRWBuffer) & operator= ( const [FRWBuffer](API\Runtime\RHI\FRWBuffer) & Other )


code: [FRWBuffer](API\Runtime\RHI\FRWBuffer) & operator= ( [FRWBuffer](API\Runtime\RHI\FRWBuffer) && Other )


code: FRWBuffer ( [FRWBuffer](API\Runtime\RHI\FRWBuffer) && Other )


code: FRWBuffer ( const [FRWBuffer](API\Runtime\RHI\FRWBuffer) & Other )


className: FRWBuffer

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

code: struct FRWBuffer

Buffer

type: FBufferRHIRef

SRV

type: FShaderResource...

type: FUnorderedAcces...


code: void Initialize ( [FRHICommandListBase](API\Runtime\RHI\FRHICommandListBase) & RHICmdList, const TCHAR * InDebugName, uint32 BytesPerElement, uint32 NumElements, EBufferUsageFlags AdditionalUsage, bool bUseUavCounter, bool bAppendBuffer, ERHIAccess InitialState )


code: void Initialize ( const TCHAR * InDebugName, uint32 BytesPerElement, uint32 NumElements, EBufferUsageFlags AdditionalUsage, bool bUseUavCounter, bool bAppendBuffer, ERHIAccess InitialState )


className: FRWBufferStructured

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

code: struct FRWBufferStructured


code: void Initialize ( const TCHAR * DebugName, uint32 InNumBytes, EBufferUsageFlags AdditionalUsage )


code: void Initialize ( [FRHICommandListBase](API\Runtime\RHI\FRHICommandListBase) & RHICmdList, const TCHAR * DebugName, uint32 InNumBytes, EBufferUsageFlags AdditionalUsage )


className: FRWByteAddressBuffer

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

code: struct FRWByteAddressBuffer : public [FByteAddressBuffer](API\Runtime\RHI\FByteAddressBuffer)


code: FSamplerStateInitializerRHI ( ESamplerFilter InFilter, ESamplerAddressMode InAddressU, ESamplerAddressMode InAddressV, ESamplerAddressMode InAddressW, float InMipBias, int32 InMaxAnisotropy, float InMinMipLevel, float InMaxMipLevel, uint32 InBorderColor, ESamplerCompareFunction InSamplerComparisonFunction )


className: FSamplerStateInitializerRHI

code: struct FSamplerStateInitializerRHI

AddressU

type: TEnumAsByte< ES...

MaxMipLevel

type: float

description: Largest mip map level that will be used, where 0 is the highest resolution mip level.

MinMipLevel

description: Smallest mip map level that will be used, where 0 is the highest resolution mip level.


code: FScopedGPUDefragLock ( [FGPUDefragAllocator](API\Runtime\RHI\FGPUDefragAllocator) & InDefragAllocator )


className: FScopedGPUDefragLock

description: FScopedGPUDefragLockcan't cover any scope that will add dcb commands or we might deadlock.

code: class FScopedGPUDefragLock


code: FScopedRHIThreadStaller ( class [FRHICommandListImmediate](API\Runtime\RHI\FRHICommandListImmediate) & InImmed, bool bDoStall )


className: FScopedRHIThreadStaller

code: class FScopedRHIThreadStaller


className: bRecursionGuard

code: static bool bRecursionGuard = false;


code: FScopedUniformBufferStaticBindings ( [FRHIComputeCommandList](API\Runtime\RHI\FRHIComputeCommandList) & InRHICmdList, [FUniformBufferStaticBindings](API\Runtime\RHI\FUniformBufferStaticBindings) UniformBuffers )


code: template<typename... TArgs> FScopedUniformBufferStaticBindings ( [FRHIComputeCommandList](API\Runtime\RHI\FRHIComputeCommandList) & InRHICmdList, TArgs... Args )


code: ~FScopedUniformBufferStaticBindings()


className: FScopedUniformBufferStaticBindings

RHICmdList

type: FRHIComputeComm...


className: FScreenResolutionRHI

description: Screen Resolution

code: struct FScreenResolutionRHI


className: FShaderCodeValidationStride

code: struct FShaderCodeValidationStride


code: FShaderResourceViewInitializer ( [FRHIBuffer](API\Runtime\RHI\FRHIBuffer) * InBuffer )


code: FShaderResourceViewInitializer ( [FRHIBuffer](API\Runtime\RHI\FRHIBuffer) * InBuffer, EPixelFormat InFormat )


code: FShaderResourceViewInitializer ( [FRHIBuffer](API\Runtime\RHI\FRHIBuffer) * InBuffer, uint32 InStartOffsetBytes, uint32 InNumElements )


code: FShaderResourceViewInitializer ( [FRHIBuffer](API\Runtime\RHI\FRHIBuffer) * InBuffer, EPixelFormat InFormat, uint32 InStartOffsetBytes, uint32 InNumElements )


className: FShaderResourceViewInitializer

description: Deprecated* Use the CreateShaderResourceView function that takes an FRHIBufferSRVCreateDesc.

code: struct FShaderResourceViewInitializer : public [FRHIViewDesc::FBufferSRV::FInitializer](API\Runtime\RHI\FRHIViewDesc\FBufferSRV\FInitializer)

Buffer

type: FRHIBuffer*...


code: static [FStaticShaderPlatformNames](API\Runtime\RHI\FStaticShaderPlatformNames) const & Get()


code: const [FName](API\Runtime\Core\UObject\FName) & GetPlatformName ( EShaderPlatform Platform ) const


code: const [FName](API\Runtime\Core\UObject\FName) & GetShaderFormat ( EShaderPlatform Platform ) const


code: const [FName](API\Runtime\Core\UObject\FName) & GetShaderPlatform ( EShaderPlatform Platform ) const


className: NumPlatforms

code: static const uint32 NumPlatforms = 16;


code: static bool IsStaticPlatform ( EShaderPlatform Platform )


className: FStaticShaderPlatformNames

description: No constructors are accessible with public or protected access.

code: class FStaticShaderPlatformNames


className: FTextureMemoryStats

code: struct FTextureMemoryStats

DedicatedSystemMemory

description: -1 if unknown, in bytes

DedicatedVideoMemory

description: -1 if unknown, in bytes

LargestContiguousAllocation

description: Size of the largest memory fragment, in bytes.

NonStreamingMemorySize

description: Size of memory allocated to non-streaming textures, in bytes.

SharedSystemMemory

description: -1 if unknown, in bytes

StreamingMemorySize

description: Size of memory allocated to streaming textures, in bytes.

TexturePoolSize

description: 0 if streaming pool size limitation is disabled, in bytes

TotalGraphicsMemory

description: Total amount of "graphics memory" that we think we can use for all our graphics resources, in bytes. -1 if unknown.


className: DefaultTextureInitFlag

code: static const ETextureCreateFlags DefaultTextureInitFlag = ETextureCreateFlags::ShaderResource;


code: void Initialize ( const TCHAR * InDebugName, const uint32 BytesPerElement, const uint32 SizeX, const uint32 SizeY, const EPixelFormat Format, ETextureCreateFlags Flags, [FResourceBulkDataInterface](API\Runtime\Core\Containers\FResourceBulkDataInterface) * InBulkData )