description: Encapsulates a GPU read only texture 2D with its SRV.

code: struct FTextureReadBuffer2D


className: DefaultTextureInitFlag

module: RHI

code: static constexpr ETextureCreateFlags DefaultTextureInitFlag = ETextureCreateFlags::ShaderResource | ETextureCreateFlags::UAV;


code: void Initialize2D ( const TCHAR * InDebugName, uint32 BytesPerElement, uint32 SizeX, uint32 SizeY, EPixelFormat Format, ETextureCreateFlags Flags )


code: void Initialize3D ( const TCHAR * InDebugName, uint32 BytesPerElement, uint32 SizeX, uint32 SizeY, uint32 SizeZ, EPixelFormat Format, ETextureCreateFlags Flags )


className: FTextureRWBuffer

description: Encapsulates a GPU read/write texture 2D with its UAV and SRV.

code: struct FTextureRWBuffer

Buffer

type: FTextureRHIRef

SRV

type: FShaderResource...

UAV

type: FUnorderedAcces...


className: FTransferResourceFenceData

code: struct FTransferResourceFenceData

Mask

type: FRHIGPUMask

SyncPoints

type: TStaticArray< v...


code: FTransferResourceParams ( [FRHITexture](API\Runtime\RHI\FRHITexture) * InTexture, uint32 InSrcGPUIndex, uint32 InDestGPUIndex, bool InPullData, bool InLockStepGPUs )


code: FTransferResourceParams ( [FRHIBuffer](API\Runtime\RHI\FRHIBuffer) * InBuffer, uint32 InSrcGPUIndex, uint32 InDestGPUIndex, bool InPullData, bool InLockStepGPUs )


code: FTransferResourceParams ( FRHITexture2D * InTexture, const FIntRect & InRect, uint32 InSrcGPUIndex, uint32 InDestGPUIndex, bool InPullData, bool InLockStepGPUs )


className: FTransferResourceParams

description: Parameters for RHITransferResources, used to copy memory between GPUs

code: struct FTransferResourceParams

bLockStepGPUs

type: bool

description: Whether the GPUs must handshake before and after the transfer.

bPullData

description: Whether the data is read by the dest GPU, or written by the src GPU (not allowed if the texture is a backbuffer)

Buffer

type: FBufferRHIRef

description: Or alternately, a buffer that's allocated on both GPUs.

DelayedFence

type: FTransferResour...

description: Optional pointer where fence data can be written if you want to delay waiting on the GPU fence for a resource transfer.

DestGPUIndex

description: The GPU index where the data will be written to.

Max

type: FIntVector

description: The max rect of the texture region to copy.

Min

description: The min rect of the texture region to copy.

PreTransferFence

description: Optional pointer to a fence to wait on before starting the transfer.

SrcGPUIndex

description: The GPU index where the data will be read from.

Texture

description: The texture which must be must be allocated on both GPUs.


code: void AddUniformBuffer ( [FRHIUniformBuffer](API\Runtime\RHI\FRHIUniformBuffer) * UniformBuffer )


code: void Bind ( [TArray](API\Runtime\Core\Containers\TArray)< [FRHIUniformBuffer](API\Runtime\RHI\FRHIUniformBuffer) * > & Bindings ) const


code: FUniformBufferStaticSlot GetSlot ( int32 Index ) const


code: [FRHIUniformBuffer](API\Runtime\RHI\FRHIUniformBuffer) * GetUniformBuffer ( int32 Index ) const


code: void TryAddUniformBuffer ( [FRHIUniformBuffer](API\Runtime\RHI\FRHIUniformBuffer) * UniformBuffer )


code: template<typename... TArgs> FUniformBufferStaticBindings ( TArgs... Args )


className: FUniformBufferStaticBindings

description: A list of static uniform buffer bindings.

code: class FUniformBufferStaticBindings


className: FUnnamedRhiCommand

code: struct FUnnamedRhiCommand


code: FUpdateTexture3DData ( [FRHITexture](API\Runtime\RHI\FRHITexture) * InTexture, uint32 InMipIndex, const struct [FUpdateTextureRegion3D](API\Runtime\RHI\FUpdateTextureRegion3D) & InUpdateRegion, uint32 InSourceRowPitch, uint32 InSourceDepthPitch, uint8 * InSourceData, uint32 InDataSizeBytes, uint32 InFrameNumber )


description: Struct to hold common data between begin/end updatetexture3d

code: struct FUpdateTexture3DData

Data

type: uint8 *

type: FRHITexture...

UpdateRegion

type: FUpdateTextureR...


code: FUpdateTextureRegion2D ( uint32 InDestX, uint32 InDestY, int32 InSrcX, int32 InSrcY, uint32 InWidth, uint32 InHeight )


description: Specifies an update region for a texture

code: struct FUpdateTextureRegion2D

DestX

description: Offset in texture

SrcX

description: Offset in source image data

Width

description: Size of region to copy


code: FUpdateTextureRegion3D ( FIntVector InDest, FIntVector InSource, FIntVector InSourceSize )


code: FUpdateTextureRegion3D ( uint32 InDestX, uint32 InDestY, uint32 InDestZ, int32 InSrcX, int32 InSrcY, int32 InSrcZ, uint32 InWidth, uint32 InHeight, uint32 InDepth )


code: struct FUpdateTextureRegion3D

DestX

description: Offset in texture

SrcX

description: Offset in source image data

description: Size of region to copy


code: void FromString ( const [FString](API\Runtime\Core\Containers\FString) & Src )


code: void FromString ( const FStringView & Src )


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


code: FVertexElement ( uint8 InStreamIndex, uint8 InOffset, EVertexElementType InType, uint8 InAttributeIndex, uint16 InStride, bool bInUseInstanceIndex )


className: FVertexElement

code: struct FVertexElement

bUseInstanceIndex

description: Whether to use instance index or vertex index to consume the element.

Type

type: TEnumAsByte< EV...


code: bool IsSupported ( EVertexElementType ElementType )


code: void SetSupported ( EVertexElementType ElementType, bool bIsSupported )


code: FViewportBounds ( float InTopLeftX, float InTopLeftY, float InWidth, float InHeight, float InMinDepth, float InMaxDepth )


className: FViewportBounds

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

code: struct FViewportBounds

Height

type: float


code: FVRamAllocation ( uint64 InAllocationStart, uint64 InAllocationSize )


className: FVRamAllocation

code: struct FVRamAllocation

AllocationSize

description: In bytes

AllocationStart

description: In bytes


description: Creates a new instance of the dynamic RHI implemented by the module.

code: [FDynamicRHI](API\Runtime\RHI\FDynamicRHI) * CreateRHI ( [ERHIFeatureLevel::Type](API\Runtime\RHI\ERHIFeatureLevel__Type) RequestedFeatureLevel )


description: Checks whether the RHI is supported by the current system.

code: bool IsSupported()


code: virtual bool IsSupported ( [ERHIFeatureLevel::Type](API\Runtime\RHI\ERHIFeatureLevel__Type) RequestedFeatureLevel )


className: IDynamicRHIModule

description: Defines the interface of a module implementing a dynamic RHI.

code: class IDynamicRHIModule : public [IModuleInterface](API\Runtime\Core\Modules\IModuleInterface)


className: FVertexElementTypeSupportInfo

description: Info for supporting the vertex element types

code: class FVertexElementTypeSupportInfo


code: virtual ERHIPipeline GetPipeline() const


description: This method is queued with an RHIThread, otherwise it will flush after it is queued; without an RHI thread there is no benefit to queuing this frame advance commands.

code: void RHIBeginDrawingViewport ( [FRHIViewport](API\Runtime\RHI\FRHIViewport) * Viewport, [FRHITexture](API\Runtime\RHI\FRHITexture) * RenderTargetRHI )


code: void RHIBeginFrame()


code: void RHIBeginRenderPass ( const [FRHIRenderPassInfo](API\Runtime\RHI\FRHIRenderPassInfo) & InInfo, const TCHAR * InName )


code: void RHIBeginRenderQuery ( [FRHIRenderQuery](API\Runtime\RHI\FRHIRenderQuery) * RenderQuery )


description: Signals the beginning of scene rendering. The RHI makes certain caching assumptions between calls to BeginScene/EndScene. Currently the only restriction is that you can't update texture references.

code: void RHIBeginScene()


code: void RHIBuildAccelerationStructure ( [FRHIRayTracingGeometry](API\Runtime\RHI\FRHIRayTracingGeometry) * Geometry )


code: virtual void RHIBuildAccelerationStructure ( const [FRayTracingSceneBuildParams](API\Runtime\RHI\FRayTracingSceneBuildParams) & SceneBuildParams )


code: void RHIBuildAccelerationStructures ( TConstArrayView< [FRayTracingGeometryBuildParams](API\Runtime\RHI\FRayTracingGeometryBuildParams) > Params )


code: virtual void RHIBuildAccelerationStructures ( TConstArrayView< [FRayTracingGeometryBuildParams](API\Runtime\RHI\FRayTracingGeometryBuildParams) > Params, const [FRHIBufferRange](API\Runtime\RHI\FRHIBufferRange) & ScratchBufferRange )


code: virtual void RHICalibrateTimers ( [FRHITimestampCalibrationQuery](API\Runtime\RHI\FRHITimestampCalibrationQuery) * CalibrationQuery )


code: virtual void RHIClearRayTracingBindings ( [FRHIRayTracingScene](API\Runtime\RHI\FRHIRayTracingScene) * Scene )


code: virtual void RHICopyBufferRegion ( [FRHIBuffer](API\Runtime\RHI\FRHIBuffer) * DestBuffer, uint64 DstOffset, [FRHIBuffer](API\Runtime\RHI\FRHIBuffer) * SourceBuffer, uint64 SrcOffset, uint64 NumBytes )


code: void RHICopyTexture ( [FRHITexture](API\Runtime\RHI\FRHITexture) * SourceTexture, [FRHITexture](API\Runtime\RHI\FRHITexture) * DestTexture, const [FRHICopyTextureInfo](API\Runtime\RHI\FRHICopyTextureInfo) & CopyInfo )


description: Not all RHIs need this (Mobile specific)

code: virtual void RHIDiscardRenderTargets ( bool Depth, bool Stencil, uint32 ColorBitMask )


code: void RHIDispatchComputeShader ( uint32 ThreadGroupCountX, uint32 ThreadGroupCountY, uint32 ThreadGroupCountZ )


code: void RHIDispatchIndirectComputeShader ( [FRHIBuffer](API\Runtime\RHI\FRHIBuffer) * ArgumentBuffer, uint32 ArgumentOffset )


code: virtual void RHIDispatchIndirectMeshShader ( [FRHIBuffer](API\Runtime\RHI\FRHIBuffer) * ArgumentBuffer, uint32 ArgumentOffset )


code: virtual void RHIDispatchMeshShader ( uint32 ThreadGroupCountX, uint32 ThreadGroupCountY, uint32 ThreadGroupCountZ )


code: void RHIDrawIndexedIndirect ( [FRHIBuffer](API\Runtime\RHI\FRHIBuffer) * IndexBufferRHI, [FRHIBuffer](API\Runtime\RHI\FRHIBuffer) * ArgumentsBufferRHI, int32 DrawArgumentsIndex, uint32 NumInstances )


code: void RHIDrawIndexedPrimitive ( [FRHIBuffer](API\Runtime\RHI\FRHIBuffer) * IndexBuffer, int32 BaseVertexIndex, uint32 FirstInstance, uint32 NumVertices, uint32 StartIndex, uint32 NumPrimitives, uint32 NumInstances )


code: void RHIDrawPrimitive ( uint32 BaseVertexIndex, uint32 NumPrimitives, uint32 NumInstances )


code: void RHIDrawIndexedPrimitiveIndirect ( [FRHIBuffer](API\Runtime\RHI\FRHIBuffer) * IndexBuffer, [FRHIBuffer](API\Runtime\RHI\FRHIBuffer) * ArgumentBuffer, uint32 ArgumentOffset )


code: void RHIDrawPrimitiveIndirect ( [FRHIBuffer](API\Runtime\RHI\FRHIBuffer) * ArgumentBuffer, uint32 ArgumentOffset )


code: void RHIEndDrawingViewport ( [FRHIViewport](API\Runtime\RHI\FRHIViewport) * Viewport, bool bPresent, bool bLockToVsync )


code: void RHIEndFrame()


code: void RHIEndRenderQuery ( [FRHIRenderQuery](API\Runtime\RHI\FRHIRenderQuery) * RenderQuery )


description: Signals the end of scene rendering. See RHIBeginScene.

code: void RHIEndScene()


description: Similar to RHIDrawIndexedPrimitiveIndirect, but allows many draw arguments to be provided at once. GRHIGlobals.SupportsDrawIndirect must be checked to detect support on the current machine. @ param IndexBuffer Buffer containing primitive indices @ param ArgumentsBuffer Buffer containingFRHIDrawIndexedIndirectParametersstructures @ param ArgumentOffset Offset in bytes of the first element in ArgumentsBuffer that will be used for drawing @ param CountBuffer Buffer containing uint32 count of valid draw arguments that should be consumed (may be nullptr, indicating that only MaxDrawArguments value should be used) @ param CountBuffeOffset Offset in bytes for the CountBuffer element that will be used to source the draw argument count @ param MaxDrawArguments How many draw arguments should be processed at most, i.e. NumDrawArguments = min(MaxDrawArguments, ValueFromCountBuffer)

code: virtual void RHIMultiDrawIndexedPrimitiveIndirect ( [FRHIBuffer](API\Runtime\RHI\FRHIBuffer) * IndexBuffer, [FRHIBuffer](API\Runtime\RHI\FRHIBuffer) * ArgumentBuffer, uint32 ArgumentOffset, [FRHIBuffer](API\Runtime\RHI\FRHIBuffer) * CountBuffer, uint32 CountBuffeOffset, uint32 MaxDrawArguments )


description: Used for OpenGL to check and see if any occlusion queries can be read back on the RHI thread. If they aren't ready when we need them, then we end up stalling.

code: virtual void RHIPollOcclusionQueries()


code: virtual void RHIRayTraceDispatch ( [FRHIRayTracingPipelineState](API\Runtime\RHI\FRHIRayTracingPipelineState) * RayTracingPipelineState, [FRHIRayTracingShader](API\Runtime\RHI\FRHIRayTracingShader) * RayGenShader, [FRHIRayTracingScene](API\Runtime\RHI\FRHIRayTracingScene) * Scene, const FRayTracingShaderBindings & GlobalResourceBindings, uint32 Width, uint32 Height )


code: virtual void RHIRayTraceDispatchIndirect ( [FRHIRayTracingPipelineState](API\Runtime\RHI\FRHIRayTracingPipelineState) * RayTracingPipelineState, [FRHIRayTracingShader](API\Runtime\RHI\FRHIRayTracingShader) * RayGenShader, [FRHIRayTracingScene](API\Runtime\RHI\FRHIRayTracingScene) * Scene, const FRayTracingShaderBindings & GlobalResourceBindings, [FRHIBuffer](API\Runtime\RHI\FRHIBuffer) * ArgumentBuffer, uint32 ArgumentOffset )


description: Rebuilds the depth target HTILE meta data (on supported platforms).

code: virtual void RHIResummarizeHTile ( FRHITexture2D * DepthTexture )


code: void RHISetBatchedShaderParameters ( [FRHIGraphicsShader](API\Runtime\RHI\FRHIGraphicsShader) * InShader, [FRHIBatchedShaderParameters](API\Runtime\RHI\FRHIBatchedShaderParameters) & InBatchedParameters )


code: virtual void RHISetBlendFactor ( const [FLinearColor](API\Runtime\Core\Math\FLinearColor) & BlendFactor )


description: Sets Depth Bounds range with the given min/max depth.

code: void RHISetDepthBounds ( float MinDepth, float MaxDepth )


code: void RHISetGraphicsPipelineState ( [FRHIGraphicsPipelineState](API\Runtime\RHI\FRHIGraphicsPipelineState) * GraphicsState, uint32 StencilRef, bool bApplyAdditionalState )


description: Useful when used with geometry shader (emit polygons to different viewports), otherwise SetViewPort() is simpler

code: void RHISetMultipleViewports ( uint32 Count, const [FViewportBounds](API\Runtime\RHI\FViewportBounds) * Data )


code: virtual void RHISetRayTracingBindings ( [FRHIRayTracingScene](API\Runtime\RHI\FRHIRayTracingScene) * Scene, [FRHIRayTracingPipelineState](API\Runtime\RHI\FRHIRayTracingPipelineState) * Pipeline, uint32 NumBindings, const FRayTracingLocalShaderBindings * Bindings, ERayTracingBindingType BindingType )


code: virtual void RHISetRayTracingCallableShader ( [FRHIRayTracingScene](API\Runtime\RHI\FRHIRayTracingScene) * Scene, uint32 ShaderSlotInScene, [FRHIRayTracingPipelineState](API\Runtime\RHI\FRHIRayTracingPipelineState) * Pipeline, uint32 ShaderIndexInPipeline, uint32 NumUniformBuffers, [FRHIUniformBuffer](API\Runtime\RHI\FRHIUniformBuffer) *const * UniformBuffers, uint32 UserData )


code: virtual void RHISetRayTracingHitGroup ( [FRHIRayTracingScene](API\Runtime\RHI\FRHIRayTracingScene) * Scene, uint32 InstanceIndex, uint32 SegmentIndex, uint32 ShaderSlot, [FRHIRayTracingPipelineState](API\Runtime\RHI\FRHIRayTracingPipelineState) * Pipeline, uint32 HitGroupIndex, uint32 NumUniformBuffers, [FRHIUniformBuffer](API\Runtime\RHI\FRHIUniformBuffer) *const * UniformBuffers, uint32 LooseParameterDataSize, const void * LooseParameterData, uint32 UserData )


code: virtual void RHISetRayTracingMissShader ( [FRHIRayTracingScene](API\Runtime\RHI\FRHIRayTracingScene) * Scene, uint32 ShaderSlotInScene, [FRHIRayTracingPipelineState](API\Runtime\RHI\FRHIRayTracingPipelineState) * Pipeline, uint32 ShaderIndexInPipeline, uint32 NumUniformBuffers, [FRHIUniformBuffer](API\Runtime\RHI\FRHIUniformBuffer) *const * UniformBuffers, uint32 UserData )


code: void RHISetScissorRect ( bool bEnable, uint32 MinX, uint32 MinY, uint32 MaxX, uint32 MaxY )


code: void RHISetShaderParameter ( [FRHIGraphicsShader](API\Runtime\RHI\FRHIGraphicsShader) * Shader, uint32 BufferIndex, uint32 BaseIndex, uint32 NumBytes, const void * NewValue )


code: void RHISetShaderParameters ( [FRHIGraphicsShader](API\Runtime\RHI\FRHIGraphicsShader) * Shader, TConstArrayView< uint8 > InParametersData, TConstArrayView< [FRHIShaderParameter](API\Runtime\RHI\FRHIShaderParameter) > InParameters, TConstArrayView< [FRHIShaderParameterResource](API\Runtime\RHI\FRHIShaderParameterResource) > InResourceParameters, TConstArrayView< [FRHIShaderParameterResource](API\Runtime\RHI\FRHIShaderParameterResource) > InBindlessParameters )


code: void RHISetShaderResourceViewParameter ( [FRHIGraphicsShader](API\Runtime\RHI\FRHIGraphicsShader) * Shader, uint32 SamplerIndex, [FRHIShaderResourceView](API\Runtime\RHI\FRHIShaderResourceView) * SRV )


description: Sets sampler state.

code: void RHISetShaderSampler ( [FRHIGraphicsShader](API\Runtime\RHI\FRHIGraphicsShader) * Shader, uint32 SamplerIndex, [FRHISamplerState](API\Runtime\RHI\FRHISamplerState) * NewState )


description: Set the shader resource view of a surface.

code: void RHISetShaderTexture ( [FRHIGraphicsShader](API\Runtime\RHI\FRHIGraphicsShader) * Shader, uint32 TextureIndex, [FRHITexture](API\Runtime\RHI\FRHITexture) * NewTexture )


code: void RHISetShaderUnbinds ( [FRHIGraphicsShader](API\Runtime\RHI\FRHIGraphicsShader) * Shader, TConstArrayView< [FRHIShaderParameterUnbind](API\Runtime\RHI\FRHIShaderParameterUnbind) > InUnbinds )


code: void RHISetShaderUniformBuffer ( [FRHIGraphicsShader](API\Runtime\RHI\FRHIGraphicsShader) * Shader, uint32 BufferIndex, [FRHIUniformBuffer](API\Runtime\RHI\FRHIUniformBuffer) * Buffer )


code: virtual void RHISetShadingRate ( EVRSShadingRate ShadingRate, EVRSRateCombiner Combiner )


code: virtual void RHISetStencilRef ( uint32 StencilRef )


code: virtual void RHISetStereoViewport ( float LeftMinX, float RightMinX, float LeftMinY, float RightMinY, float MinZ, float LeftMaxX, float RightMaxX, float LeftMaxY, float RightMaxY, float MaxZ )


code: void RHISetStreamSource ( uint32 StreamIndex, [FRHIBuffer](API\Runtime\RHI\FRHIBuffer) * VertexBuffer, uint32 Offset )


description: Sets a pixel shader UAV parameter.

code: void RHISetUAVParameter ( [FRHIPixelShader](API\Runtime\RHI\FRHIPixelShader) * PixelShader, uint32 UAVIndex, [FRHIUnorderedAccessView](API\Runtime\RHI\FRHIUnorderedAccessView) * UAV )


code: void RHISetViewport ( float MinX, float MinY, float MinZ, float MaxX, float MaxY, float MaxZ )


className: IRHICommandContext

description: The interface RHI command context. Sometimes the RHI handles these. On platforms that can processes command lists in parallel, it is a separate object.

code: class IRHICommandContext : public [IRHIComputeContext](API\Runtime\RHI\IRHIComputeContext)

RenderPassInfo

type: FRHIRenderPassI...


code: void RHIEnableDepthBoundsTest ( bool bEnable )


code: void RHISetBlendState ( [FRHIBlendState](API\Runtime\RHI\FRHIBlendState) * NewState, const [FLinearColor](API\Runtime\Core\Math\FLinearColor) & BlendFactor )


code: void RHISetBoundShaderState ( [FRHIBoundShaderState](API\Runtime\RHI\FRHIBoundShaderState) * BoundShaderState )


code: virtual void RHISetComputePipelineState ( [FRHIComputePipelineState](API\Runtime\RHI\FRHIComputePipelineState) * ComputePipelineState )


code: void RHISetComputeShader ( [FRHIComputeShader](API\Runtime\RHI\FRHIComputeShader) * ComputeShader )


description: This will set most relevant pipeline state. Legacy APIs are expected to set corresponding disjoint state as well.

code: virtual void RHISetGraphicsPipelineState ( [FRHIGraphicsPipelineState](API\Runtime\RHI\FRHIGraphicsPipelineState) * GraphicsState, uint32 StencilRef, bool bApplyAdditionalState )


code: void RHISetDepthStencilState ( [FRHIDepthStencilState](API\Runtime\RHI\FRHIDepthStencilState) * NewState, uint32 StencilRef )


className: IRHICommandContextPSOFallback

description: Command Context for RHIs that do not support real Graphics/Compute Pipelines.

code: class IRHICommandContextPSOFallback : public [IRHICommandContext](API\Runtime\RHI\IRHICommandContext)


code: void RHISetRasterizerState ( [FRHIRasterizerState](API\Runtime\RHI\FRHIRasterizerState) * NewState )


description: Fast implementations when the RHI validation layer is disabled.


code: virtual ERHIPipeline GetPipeline() const


code: ERHIAccess GetTrackedAccess ( const [FRHIViewableResource](API\Runtime\RHI\FRHIViewableResource) * Resource ) const


code: void RHIBeginTransitions ( [TArrayView](API\Runtime\Core\Containers\TArrayView)< const [FRHITransition](API\Runtime\RHI\FRHITransition) * > Transitions )


code: virtual void RHIBeginUAVOverlap ( TConstArrayView< [FRHIUnorderedAccessView](API\Runtime\RHI\FRHIUnorderedAccessView) * > UAVs )


code: virtual void RHIBindAccelerationStructureMemory ( [FRHIRayTracingScene](API\Runtime\RHI\FRHIRayTracingScene) * Scene, [FRHIBuffer](API\Runtime\RHI\FRHIBuffer) * Buffer, uint32 BufferOffset )


code: virtual void RHIBuildAccelerationStructure ( const [FRayTracingSceneBuildParams](API\Runtime\RHI\FRayTracingSceneBuildParams) & SceneBuildParams )


code: virtual void RHIBuildAccelerationStructures ( TConstArrayView< [FRayTracingGeometryBuildParams](API\Runtime\RHI\FRayTracingGeometryBuildParams) > Params, const [FRHIBufferRange](API\Runtime\RHI\FRHIBufferRange) & ScratchBufferRange )


description: Clears a UAV to the multi-channel floating point value provided. Should only be called on UAVs with a floating point format, or on structured buffers. Structured buffers are treated as a regular R32_UINT buffer during the clear operation, and the Values.X component is copied directly into the buffer without any format conversion. (Y,Z,W) of Values is ignored. Typed floating point buffers undergo standard format conversion during the write operation. The conversion is determined by the format of the UAV.

code: void RHIClearUAVFloat ( [FRHIUnorderedAccessView](API\Runtime\RHI\FRHIUnorderedAccessView) * UnorderedAccessViewRHI, const FVector4f & Values )


description: Clears a UAV to the multi-component unsigned integer value provided. Should only be called on UAVs with an integer format, or on structured buffers. Structured buffers are treated as a regular R32_UINT buffer during the clear operation, and the Values.X component is copied directly into the buffer without any format conversion. (Y,Z,W) of Values is ignored. Typed integer buffers undergo standard format conversion during the write operation. The conversion is determined by the format of the UAV.

code: void RHIClearUAVUint ( [FRHIUnorderedAccessView](API\Runtime\RHI\FRHIUnorderedAccessView) * UnorderedAccessViewRHI, const FUintVector4 & Values )


description: Performs a copy of the data in 'SourceBuffer' to 'DestinationStagingBuffer.' This will occur inline on the GPU timeline. This is a mechanism to perform nonblocking readback of a buffer at a point in time.

code: virtual void RHICopyToStagingBuffer ( [FRHIBuffer](API\Runtime\RHI\FRHIBuffer) * SourceBufferRHI, [FRHIStagingBuffer](API\Runtime\RHI\FRHIStagingBuffer) * DestinationStagingBufferRHI, uint32 InOffset, uint32 InNumBytes )


code: void RHIDispatchComputeShader ( uint32 ThreadGroupCountX, uint32 ThreadGroupCountY, uint32 ThreadGroupCountZ )


code: void RHIDispatchIndirectComputeShader ( [FRHIBuffer](API\Runtime\RHI\FRHIBuffer) * ArgumentBuffer, uint32 ArgumentOffset )


code: void RHIEndTransitions ( [TArrayView](API\Runtime\Core\Containers\TArrayView)< const [FRHITransition](API\Runtime\RHI\FRHITransition) * > Transitions )


code: virtual void RHIEndUAVOverlap ( TConstArrayView< [FRHIUnorderedAccessView](API\Runtime\RHI\FRHIUnorderedAccessView) * > UAVs )


code: virtual [FRHIGPUMask](API\Runtime\RHI\FRHIGPUMask) RHIGetGPUMask() const


code: virtual void * RHIGetNativeCommandBuffer()


description: Some RHI implementations (OpenGL) cache render state internally Signal to RHI that cached state is no longer valid

code: virtual void RHIInvalidateCachedState()


code: void RHIPushEvent ( const TCHAR * Name, [FColor](API\Runtime\Core\Math\FColor) Color )


code: virtual void RHISetAsyncComputeBudget ( EAsyncComputeBudget Budget )


code: void RHISetBatchedShaderParameters ( [FRHIComputeShader](API\Runtime\RHI\FRHIComputeShader) * InShader, [FRHIBatchedShaderParameters](API\Runtime\RHI\FRHIBatchedShaderParameters) & InBatchedParameters )


code: void RHISetComputePipelineState ( [FRHIComputePipelineState](API\Runtime\RHI\FRHIComputePipelineState) * ComputePipelineState )


code: virtual void RHISetGPUMask ( [FRHIGPUMask](API\Runtime\RHI\FRHIGPUMask) GPUMask )


code: void RHISetShaderParameter ( [FRHIComputeShader](API\Runtime\RHI\FRHIComputeShader) * ComputeShader, uint32 BufferIndex, uint32 BaseIndex, uint32 NumBytes, const void * NewValue )


code: void RHISetShaderParameters ( [FRHIComputeShader](API\Runtime\RHI\FRHIComputeShader) * ComputeShader, TConstArrayView< uint8 > InParametersData, TConstArrayView< [FRHIShaderParameter](API\Runtime\RHI\FRHIShaderParameter) > InParameters, TConstArrayView< [FRHIShaderParameterResource](API\Runtime\RHI\FRHIShaderParameterResource) > InResourceParameters, TConstArrayView< [FRHIShaderParameterResource](API\Runtime\RHI\FRHIShaderParameterResource) > InBindlessParameters )


code: void RHISetShaderResourceViewParameter ( [FRHIComputeShader](API\Runtime\RHI\FRHIComputeShader) * ComputeShader, uint32 SamplerIndex, [FRHIShaderResourceView](API\Runtime\RHI\FRHIShaderResourceView) * SRV )


description: Sets sampler state.

code: void RHISetShaderSampler ( [FRHIComputeShader](API\Runtime\RHI\FRHIComputeShader) * ComputeShader, uint32 SamplerIndex, [FRHISamplerState](API\Runtime\RHI\FRHISamplerState) * NewState )


code: void RHISetShaderUnbinds ( [FRHIComputeShader](API\Runtime\RHI\FRHIComputeShader) * ComputeShader, TConstArrayView< [FRHIShaderParameterUnbind](API\Runtime\RHI\FRHIShaderParameterUnbind) > InUnbinds )


code: virtual void RHISetStaticUniformBuffers ( const [FUniformBufferStaticBindings](API\Runtime\RHI\FUniformBufferStaticBindings) & InUniformBuffers )


description: Sets a compute shader UAV parameter.

code: void RHISetUAVParameter ( [FRHIComputeShader](API\Runtime\RHI\FRHIComputeShader) * ComputeShader, uint32 UAVIndex, [FRHIUnorderedAccessView](API\Runtime\RHI\FRHIUnorderedAccessView) * UAV )


description: Sets a compute shader counted UAV parameter and initial count

code: void RHISetUAVParameter ( [FRHIComputeShader](API\Runtime\RHI\FRHIComputeShader) * ComputeShader, uint32 UAVIndex, [FRHIUnorderedAccessView](API\Runtime\RHI\FRHIUnorderedAccessView) * UAV, uint32 InitialCount )


description: Set the shader resource view of a surface. This is used for binding TextureMS parameter types that need a multi sampled view.

code: void RHISetShaderTexture ( [FRHIComputeShader](API\Runtime\RHI\FRHIComputeShader) * ComputeShader, uint32 TextureIndex, [FRHITexture](API\Runtime\RHI\FRHITexture) * NewTexture )


description: Submit the current command buffer to the GPU if possible.

code: void RHISubmitCommandsHint()


description: Write the fence in the GPU timeline. The fence can then be tested on the CPU to know if the previous GPU commands are completed.

code: virtual void RHIWriteGPUFence ( [FRHIGPUFence](API\Runtime\RHI\FRHIGPUFence) * FenceRHI )


code: void RHISetShaderUniformBuffer ( [FRHIComputeShader](API\Runtime\RHI\FRHIComputeShader) * ComputeShader, uint32 BufferIndex, [FRHIUniformBuffer](API\Runtime\RHI\FRHIUniformBuffer) * Buffer )


code: void StatsSetCategory ( [FRHIDrawStats](API\Runtime\RHI\FRHIDrawStats) * InStats, uint32 InCategoryID )


code: void StatsSetCategory ( [FRHIDrawStats](API\Runtime\RHI\FRHIDrawStats) * InStats, uint32 InCategoryID, uint32 InGPUIndex )


className: IRHIComputeContext

description: Context that is capable of doing Compute work. Can be async or compute on the gfx pipe.

code: class IRHIComputeContext

Stats

type: FRHIPerCategory...


code: IRHIPlatformCommandList & operator&61; &40; IRHIPlatformCommandList const & &41;


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


code: void SetTrackedAccess ( const [FRHITrackedAccessInfo](API\Runtime\RHI\FRHITrackedAccessInfo) & Info )


description: This type is only usable by derived types (platform RHI implementations)

code: IRHIPlatformCommandList()


description: Prevent copying.

code: IRHIPlatformCommandList &40; IRHIPlatformCommandList const & &41;


description: Allow moving.

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


className: IRHIPlatformCommandList

description: Opaque type representing a finalized platform GPU command list, which can be submitted to the GPU via RHISubmitCommandLists(). This type is intended only for use by RHI command list management. Platform RHIs provide the implementation.

code: class IRHIPlatformCommandList


code: [FRHITransientBuffer](API\Runtime\RHI\FRHITransientBuffer) * CreateBuffer ( const [FRHIBufferCreateInfo](API\Runtime\RHI\FRHIBufferCreateInfo) & InCreateInfo, const TCHAR * InDebugName, uint32 InPassIndex )


description: Allocates a new transient resource with memory backed by the transient allocator.

code: [FRHITransientTexture](API\Runtime\RHI\FRHITransientTexture) * CreateTexture ( const FRHITextureCreateInfo & InCreateInfo, const TCHAR * InDebugName, uint32 InPassIndex )


description: Deallocates the underlying memory for use by a future resource creation call.

code: void DeallocateMemory ( [FRHITransientTexture](API\Runtime\RHI\FRHITransientTexture) * InTexture, uint32 InPassIndex )


description: Flushes any pending allocations prior to rendering. Optionally emits stats if OutStats is valid.

code: void Flush ( [FRHICommandListImmediate](API\Runtime\RHI\FRHICommandListImmediate) & RHICmdList, [FRHITransientAllocationStats](API\Runtime\RHI\FRHITransientAllocationStats) * OutStats )


description: Releases this instance of the transient allocator. Invalidates any outstanding transient resources.

code: virtual void Release ( [FRHICommandListImmediate](API\Runtime\RHI\FRHICommandListImmediate) & RHICmdList )


className: IRHITransientResourceAllocator

code: class IRHITransientResourceAllocator


description: Boost the priority of the given PSO request ID

code: namespace PipelineStateCache { void PipelineStateCache::BoostPrecachePriority ( const [FPSOPrecacheRequestID](API\Runtime\RHI\FPSOPrecacheRequestID) & PSOPrecacheRequestID ) }


code: void DeallocateMemory ( [FRHITransientBuffer](API\Runtime\RHI\FRHITransientBuffer) * InBuffer, uint32 InPassIndex )


description: Retrieve the current PSO precache result state (slightly slower than IsPrecaching)

code: namespace PipelineStateCache { EPSOPrecacheResult PipelineStateCache::CheckPipelineStateInCache ( const [FGraphicsPipelineStateInitializer](API\Runtime\RHI\FGraphicsPipelineStateInitialize-) & PipelineStateInitializer ) }


code: namespace PipelineStateCache { EPSOPrecacheResult PipelineStateCache::CheckPipelineStateInCache ( [FRHIComputeShader](API\Runtime\RHI\FRHIComputeShader) * ComputeShader ) }


code: namespace PipelineStateCache { FGraphicsPipelineState * PipelineStateCache::FindGraphicsPipelineState ( const [FGraphicsPipelineStateInitializer](API\Runtime\RHI\FGraphicsPipelineStateInitialize-) & Initializer ) }


description: Called at the end of each frame during the RHI . Evicts all items left in the backfill cached based on time

code: namespace PipelineStateCache { void PipelineStateCache::FlushResources() }


code: namespace PipelineStateCache { FComputePipelineState * PipelineStateCache::GetAndOrCreateComputePipelineState ( [FRHIComputeCommandList](API\Runtime\RHI\FRHIComputeCommandList) & RHICmdList, [FRHIComputeShader](API\Runtime\RHI\FRHIComputeShader) * ComputeShader, bool bFromFileCache ) }


code: namespace PipelineStateCache { FGraphicsPipelineState * PipelineStateCache::GetAndOrCreateGraphicsPipelineState ( [FRHICommandList](API\Runtime\RHI\FRHICommandList) & RHICmdList, const [FGraphicsPipelineStateInitializer](API\Runtime\RHI\FGraphicsPipelineStateInitialize-) & OriginalInitializer, EApplyRendertargetOption ApplyFlags, EPSOPrecacheResult PSOPrecacheResult ) }


description: Retrieves RTPSO object from cache or adds a task to create it, which will be waited on by RHI thread. May return NULL in non-blocking mode if pipeline is not already in cache.

code: namespace PipelineStateCache { FRayTracingPipelineState * PipelineStateCache::GetAndOrCreateRayTracingPipelineState ( [FRHICommandList](API\Runtime\RHI\FRHICommandList) & RHICmdList, const [FRayTracingPipelineStateInitializer](API\Runtime\RHI\FRayTracingPipelineStateInitiali-) & Initializer, ERayTracingPipelineCacheFlags Flags ) }


description: Returns the number of PSO precompiles currently in progress

code: namespace PipelineStateCache { int32 PipelineStateCache::GetNumActivePipelinePrecompileTasks() }


code: namespace PipelineStateCache { [FRHIVertexDeclaration](API\Runtime\RHI\FRHIVertexDeclaration) * PipelineStateCache::GetOrCreateVertexDeclaration ( const FVertexDeclarationElementList & Elements ) }


description: Retrieves RTPSO object from cache or returns NULL if it's not found.

code: namespace PipelineStateCache { FRayTracingPipelineState * PipelineStateCache::GetRayTracingPipelineState ( const [FRayTracingPipelineStateSignature](API\Runtime\RHI\FRayTracingPipelineStateSignatur-) & Signature ) }


description: Any async precaching operations still busy

code: namespace PipelineStateCache { bool PipelineStateCache::IsPrecaching() }


description: Is the given PSO still precaching?

code: namespace PipelineStateCache { bool PipelineStateCache::IsPrecaching ( const [FPSOPrecacheRequestID](API\Runtime\RHI\FPSOPrecacheRequestID) & PSOPrecacheRequestID ) }


description: Is the given PSO initializer still precaching?

code: namespace PipelineStateCache { bool PipelineStateCache::IsPrecaching ( const [FGraphicsPipelineStateInitializer](API\Runtime\RHI\FGraphicsPipelineStateInitialize-) & PipelineStateInitializer ) }


code: namespace PipelineStateCache { bool PipelineStateCache::IsPrecaching ( [FRHIComputeShader](API\Runtime\RHI\FRHIComputeShader) * ComputeShader ) }


description: Is precaching currently enabled - can help to skip certain time critical code when precaching is disabled

code: namespace PipelineStateCache { bool PipelineStateCache::IsPSOPrecachingEnabled() }


description: Return number of active or pending PSO precache requests

code: namespace PipelineStateCache { uint32 PipelineStateCache::NumActivePrecacheRequests() }


description: Precache the compute shader and return a request ID if precached async

code: namespace PipelineStateCache { [FPSOPrecacheRequestResult](API\Runtime\RHI\FPSOPrecacheRequestResult) PipelineStateCache::PrecacheComputePipelineState ( [FRHIComputeShader](API\Runtime\RHI\FRHIComputeShader) * ComputeShader, bool bForcePrecache ) }


description: Precache the graphic PSO and return an optional graph event if precached async

code: namespace PipelineStateCache { [FPSOPrecacheRequestResult](API\Runtime\RHI\FPSOPrecacheRequestResult) PipelineStateCache::PrecacheGraphicsPipelineState ( const [FGraphicsPipelineStateInitializer](API\Runtime\RHI\FGraphicsPipelineStateInitialize-) & PipelineStateInitializer ) }


description: Called when PSO precompile has completed

code: namespace PipelineStateCache { void PipelineStateCache::PreCompileComplete() }


code: namespace PipelineStateCache { void PipelineStateCache::ReportFrameHitchToCSV() }


code: namespace PipelineStateCache { uint64 PipelineStateCache::RetrieveGraphicsPipelineStateSortKey ( const FGraphicsPipelineState * GraphicsPipelineState ) }


description: Shuts down core services.

code: namespace PipelineStateCache { void PipelineStateCache::Shutdown() }


className: IRHITestModule

code: class IRHITestModule : public [IModuleInterface](API\Runtime\Core\Modules\IModuleInterface)


className: TGetTypeLayoutHelper<                          ERayTracingGeometryInitializerType >::Do

code: static const FTypeLayoutDesc & Do &40; const ERayTracingGeometryInitializerType & &41;


code: template<> struct TGetTypeLayoutHelper< ERayTracingGeometryInitializerType >


className: TGetTypeLayoutHelper<                          ERHIFeatureLevel::Type >::Do

code: static const FTypeLayoutDesc & Do &40; const ERHIFeatureLevel::Type & &41;


className: TGetTypeLayoutHelper<                          ERayTracingGeometryType >::Do

code: static const FTypeLayoutDesc & Do &40; const ERayTracingGeometryType & &41;


code: template<> struct TGetTypeLayoutHelper< ERayTracingGeometryType >


code: namespace TGetTypeLayoutHelper< ERHIFeatureLevel { template<> struct TGetTypeLayoutHelper< ERHIFeatureLevel::Type > }


className: TGetTypeLayoutHelper<                          EUniformBufferBaseType >::Do

code: static const FTypeLayoutDesc & Do &40; const EUniformBufferBaseType & &41;


code: template<> struct TGetTypeLayoutHelper< EUniformBufferBaseType >


className: TGetTypeLayoutHelper<                          EUniformBufferBindingFlags >::Do

code: static const FTypeLayoutDesc & Do &40; const EUniformBufferBindingFlags & &41;


code: template<> struct TGetTypeLayoutHelper< EUniformBufferBindingFlags >


className: TGetTypeLayoutHelper<                          EVertexElementType >::Do

code: static const FTypeLayoutDesc & Do &40; const EVertexElementType & &41;


code: template<> struct TGetTypeLayoutHelper< EVertexElementType >


code: template<> struct THasTypeLayout< ERayTracingGeometryInitializerType >


code: template<> struct THasTypeLayout< ERayTracingGeometryType >


code: namespace THasTypeLayout< ERHIFeatureLevel { template<> struct THasTypeLayout< ERHIFeatureLevel::Type > }


code: template<> struct THasTypeLayout< EUniformBufferBaseType >


code: template<> struct THasTypeLayout< EUniformBufferBindingFlags >


className: THasTypeLayout<                          EVertexElementType >

code: template<> struct THasTypeLayout< EVertexElementType >


description: Remove

code: [FSetElementId](API\Runtime\Core\Containers\FSetElementId) Add ( const KeyType & Key, const ValueType & Value )


description: Remove

code: bool Contains ( const KeyType & Key ) const


description: RemoveByPredicate

code: template<typename Predicate> bool ContainsByPredicate ( Predicate Pred ) const


description: Remove

code: void Empty ( int32 InMaxNumElements )


description: RemoveByPredicate

code: template<typename Predicate> [TArray](API\Runtime\Core\Containers\TArray)< ValueType > FilterByPredicate ( Predicate Pred ) const


description: Remove

code: const ValueType * Find ( const KeyType & Key ) const


description: Remove

code: const ValueType * FindAndTouch ( const KeyType & Key )


description: RemoveByPredicate

code: template<typename Predicate> const ValueType * FindByPredicate ( Predicate Pred ) const


description: Find

code: void GetKeys ( [TArray](API\Runtime\Core\Containers\TArray)< KeyType > & OutKeys ) const


description:
Return the least recent element from the cache.
Copy of the least recent value.

code: const ValueType GetLeastRecent() const


code: void MarkAsRecent ( const [FSetElementId](API\Runtime\Core\Containers\FSetElementId) & LRUNode )


description: Mark the given entry as recently used.

code: void MarkAsRecent ( FCacheEntry & Entry )


description: Num

code: int32 Max() const


description: Max

code: int32 Num() const


description: RemoveByPredicate

code: void Remove ( const KeyType & Key )


description: Remove the specified entry from the cache.

code: void Remove ( FCacheEntry * Entry )


code: bool Remove ( const KeyType & Key, ValueType & RemovedValue )


description:
Remove and return the least recent element from the cache.
Copy of removed value.

code: ValueType RemoveLeastRecent()


description: Remove

code: template<typename Predicate> int32 RemoveByPredicate ( Predicate Pred )


description:
Remove and return the most recent element from the cache.
Copy of removed value.

code: ValueType RemoveMostRecent()


code: ValueType & operator&45;>&40;&41; const


code: ValueType & operator&42;&40;&41; const


code: TBaseIterator &40; const TPsoLruCache & Cache &41;


className: TBaseIterator

description: Iteration begins at the most recent entry.

code: template<bool Const> class TBaseIterator


code: TConstIterator &40; const TPsoLruCache & Cache &41;


className: TConstIterator

description: Cache iterator (const).

code: class TConstIterator : public [TPsoLruCache< KeyType, ValueType >::TBaseIterator< true >](API\Runtime\RHI\TPsoLruCache\TBaseIterator)


description: Removes the current element from the cache and increments the iterator.

code: void RemoveCurrentAndIncrement&40;&41;


code: TIterator &40; TPsoLruCache & InCache &41;


description: Default constructor (empty cache that cannot hold any values).

code: TPsoLruCache()


className: TIterator

description: Cache iterator.

code: class TIterator : public [TPsoLruCache< KeyType, ValueType >::TBaseIterator< false >](API\Runtime\RHI\TPsoLruCache\TBaseIterator)


description: Create and initialize a new instance.

code: TPsoLruCache ( int32 InMaxNumElements )


className: TPsoLruCache

description: Implements a Least Recently Used (LRU) cache.

code: template<typename KeyType, typename ValueType> class TPsoLruCache


description: Destructor.

code: ~TPsoLruCache()


description: Helper class used internally by RHIs to make use ofFRHICommandList_RecursiveHazardoussafer. Access to the underlying context is exposed viaRunOnContext()to ensure correct ordering of commands.

code: template<typename ContextType> class TRHICommandList_RecursiveHazardous : public [FRHICommandList_RecursiveHazardous](API\Runtime\RHI\FRHICommandList_RecursiveHazardo-)


code: TRHICommandList_RecursiveHazardous ( ContextType * Context )


code: template<typename LAMBDA> void RunOnContext ( LAMBDA && Lambda )


code: TRHIComputeCommandList_RecursiveHazardous ( ContextType * Context )


description: Helper class used internally by RHIs to make use ofFRHIComputeCommandList_RecursiveHazardoussafer. Access to the underlying context is exposed viaRunOnContext()to ensure correct ordering of commands.

code: template<typename ContextType> class TRHIComputeCommandList_RecursiveHazardous : public [FRHIComputeCommandList_RecursiveHazardous](API\Runtime\RHI\FRHIComputeCommandList_Recursive-)


className: TRHIGlobal::operator TValueType

code: operator TValueType() const


code: void SetPreviewOverride ( const TValueType & InValue )


code: [TRHIGlobal](API\Runtime\RHI\TRHIGlobal) & operator= ( const TValueType & InValue )


code: TRHIGlobal ( const TValueType & InValue )


className: TRHIGlobal

description: Wrapper for GRHI## global variables, allows values to be overridden for mobile preview modes.

code: template<typename TValueType> class TRHIGlobal


code: TRHILambdaCommand ( LAMBDA && InLambda, const TCHAR * InName )


code: virtual void ExecuteAndDestruct ( [FRHICommandListBase](API\Runtime\RHI\FRHICommandListBase) & CmdList, [FRHICommandListDebugContext](API\Runtime\RHI\FRHICommandListDebugContext) & )


className: TRHILambdaCommand

code: template<typename RHICmdListType, typename LAMBDA> struct TRHILambdaCommand : public [FRHICommandBase](API\Runtime\RHI\FRHICommandBase)

Lambda

type: LAMBDA


code: [ElementType](API\Runtime\Core\Containers\TStaticArray\ElementType) & operator[] ( ERHIPipeline Pipeline )


code: const [ElementType](API\Runtime\Core\Containers\TStaticArray\ElementType) & operator[] ( ERHIPipeline Pipeline ) const


className: TRHIPipelineArray

description: Array of pass handles by RHI pipeline, with overloads to help with enum conversion.

code: template<typename ElementType> class TRHIPipelineArray : public [TStaticArray< ElementType, GetRHIPipelineCount()>](API\Runtime\Core\Containers\TStaticArray)


code: bool IsInRange ( uint32 Value ) const


code: TRHIRange ( uint32 InFirst, uint32 InNum )


className: TRHIRange

description: Views

code: template<typename TType> struct TRHIRange

First

type: TType


className: TRHIResourceUpdateBatcher

code: template<uint32 MaxNumUpdates> struct TRHIResourceUpdateBatcher : public [FRHIResourceUpdateBatcher](API\Runtime\RHI\FRHIResourceUpdateBatcher)

UpdateInfoStorage

type: FRHIResourceUpd...


className: TRHIShaderToEnum

code: template<typename TRHIShader> struct TRHIShaderToEnum


className: ShaderFrequency

code: enum &123; ShaderFrequency = SF_Amplification &125;


code: template<> struct TRHIShaderToEnum< FAmplificationShaderRHIRef >


code: enum &123; ShaderFrequency = SF_Compute &125;


code: template<> struct TRHIShaderToEnum< FComputeShaderRHIRef >


code: template<> struct TRHIShaderToEnum< FGeometryShaderRHIRef >


code: enum &123; ShaderFrequency = SF_Geometry &125;


code: enum &123; ShaderFrequency = SF_Mesh &125;


className: TRHIShaderToEnum< FMeshShaderRHIRef >

code: template<> struct TRHIShaderToEnum< FMeshShaderRHIRef >


code: enum &123; ShaderFrequency = SF_Pixel &125;


className: TRHIShaderToEnum< FPixelShaderRHIRef >

code: template<> struct TRHIShaderToEnum< FPixelShaderRHIRef >


className: TRHIShaderToEnum< FRHIComputeShader >

code: template<> struct TRHIShaderToEnum< FRHIComputeShader >


className: TRHIShaderToEnum< FRHIMeshShader >

code: template<> struct TRHIShaderToEnum< FRHIMeshShader >


code: enum &123; ShaderFrequency = SF_Vertex &125;


className: TRHIShaderToEnum< FRHIVertexShader >

code: template<> struct TRHIShaderToEnum< FRHIVertexShader >


className: TStaticGetTypeLayoutHelper<                          ERayTracingGeometryInitializerType >::CallAppendHash

code: static uint32 CallAppendHash &40; const FTypeLayoutDesc & TypeDesc, const FPlatformTypeLayoutParameters & LayoutParams, FSHA1 & Hasher &41;


className: TRHIShaderToEnum< FVertexShaderRHIRef >

code: template<> struct TRHIShaderToEnum< FVertexShaderRHIRef >


className: TStaticGetTypeLayoutHelper<                          ERayTracingGeometryInitializerType >::CallDestroy

code: static void CallDestroy &40; void &42; Object, const FTypeLayoutDesc &, const FPointerTableBase &42; PtrTable, bool bIsFrozen &41;


className: TStaticGetTypeLayoutHelper<                          ERayTracingGeometryInitializerType >::CallGetTargetAlignment

code: static uint32 CallGetTargetAlignment &40; const FTypeLayoutDesc & TypeDesc, const FPlatformTypeLayoutParameters & LayoutParams &41;


className: TStaticGetTypeLayoutHelper<                          ERayTracingGeometryInitializerType >::CallToString

code: static void CallToString &40; const void &42; Object, const FTypeLayoutDesc & TypeDesc, const FPlatformTypeLayoutParameters & LayoutParams, FMemoryToStringContext & OutContext &41;


className: TStaticGetTypeLayoutHelper<                          ERayTracingGeometryInitializerType >::CallUnfrozenCopy

code: static uint32 CallUnfrozenCopy &40; const FMemoryUnfreezeContent & Context, const void &42; Object, const FTypeLayoutDesc & TypeDesc, void &42; OutDst &41;


className: TStaticGetTypeLayoutHelper<                          ERayTracingGeometryInitializerType >::CallWriteMemoryImage

code: static void CallWriteMemoryImage &40; FMemoryImageWriter & Writer, const void &42; Object, const FTypeLayoutDesc & TypeDesc, const FTypeLayoutDesc & DerivedTypeDesc &41;


className: TStaticGetTypeLayoutHelper<                          ERayTracingGeometryInitializerType >::Do

code: static const FTypeLayoutDesc & Do&40;&41;


className: TStaticGetTypeLayoutHelper<                          ERayTracingGeometryType >::CallAppendHash


className: TStaticGetTypeLayoutHelper<                          ERayTracingGeometryType >::CallDestroy


className: TStaticGetTypeLayoutHelper<                          ERayTracingGeometryType >::CallGetTargetAlignment


className: TStaticGetTypeLayoutHelper<                          ERayTracingGeometryType >::CallToString


className: TStaticGetTypeLayoutHelper<                          ERayTracingGeometryType >::CallUnfrozenCopy


className: TStaticGetTypeLayoutHelper<                          ERayTracingGeometryType >::CallWriteMemoryImage


className: TStaticGetTypeLayoutHelper<                          ERayTracingGeometryType >::Do


code: template<> struct TStaticGetTypeLayoutHelper< ERayTracingGeometryType >


className: TStaticGetTypeLayoutHelper<                          ERHIFeatureLevel::Type >::CallAppendHash


className: TStaticGetTypeLayoutHelper<                          ERHIFeatureLevel::Type >::CallDestroy


className: TStaticGetTypeLayoutHelper<                          ERHIFeatureLevel::Type >::CallGetTargetAlignment


code: template<> struct TStaticGetTypeLayoutHelper< ERayTracingGeometryInitializerType >


className: TStaticGetTypeLayoutHelper<                          ERHIFeatureLevel::Type >::CallToString


className: TStaticGetTypeLayoutHelper<                          ERHIFeatureLevel::Type >::CallUnfrozenCopy


className: TStaticGetTypeLayoutHelper<                          ERHIFeatureLevel::Type >::CallWriteMemoryImage


className: TStaticGetTypeLayoutHelper<                          ERHIFeatureLevel::Type >::Do


code: namespace TStaticGetTypeLayoutHelper< ERHIFeatureLevel { template<> struct TStaticGetTypeLayoutHelper< ERHIFeatureLevel::Type > }


className: TStaticGetTypeLayoutHelper<                          EUniformBufferBaseType >::CallAppendHash


className: TStaticGetTypeLayoutHelper<                          EUniformBufferBaseType >::CallDestroy


className: TStaticGetTypeLayoutHelper<                          EUniformBufferBaseType >::CallGetTargetAlignment


className: TStaticGetTypeLayoutHelper<                          EUniformBufferBaseType >::CallToString


className: TStaticGetTypeLayoutHelper<                          EUniformBufferBaseType >::CallUnfrozenCopy


className: TStaticGetTypeLayoutHelper<                          EUniformBufferBaseType >::CallWriteMemoryImage


className: TStaticGetTypeLayoutHelper<                          EUniformBufferBaseType >::Do


className: TStaticGetTypeLayoutHelper<                          EUniformBufferBindingFlags >::CallDestroy


className: TStaticGetTypeLayoutHelper<                          EUniformBufferBindingFlags >::CallAppendHash


className: TStaticGetTypeLayoutHelper<                          EUniformBufferBindingFlags >::CallGetTargetAlignment


className: TStaticGetTypeLayoutHelper<                          EUniformBufferBindingFlags >::CallToString


className: TStaticGetTypeLayoutHelper<                          EUniformBufferBindingFlags >::CallUnfrozenCopy


className: TStaticGetTypeLayoutHelper<                          EUniformBufferBindingFlags >::CallWriteMemoryImage


className: TStaticGetTypeLayoutHelper<                          EUniformBufferBindingFlags >::Do


code: template<> struct TStaticGetTypeLayoutHelper< EUniformBufferBindingFlags >


className: TStaticGetTypeLayoutHelper<                          EVertexElementType >::CallAppendHash


className: TStaticGetTypeLayoutHelper<                          EVertexElementType >::CallDestroy


code: template<> struct TStaticGetTypeLayoutHelper< EUniformBufferBaseType >


className: TStaticGetTypeLayoutHelper<                          EVertexElementType >::CallGetTargetAlignment


className: TStaticGetTypeLayoutHelper<                          EVertexElementType >::CallUnfrozenCopy


className: TStaticGetTypeLayoutHelper<                          EVertexElementType >::CallToString


className: TStaticGetTypeLayoutHelper<                          EVertexElementType >::CallWriteMemoryImage


className: TStaticGetTypeLayoutHelper<                          EVertexElementType >::Do


code: template<> struct TStaticGetTypeLayoutHelper< EVertexElementType >


module: RHICore

code: FResolveTextureInfo ( [FRHITexture](API\Runtime\RHI\FRHITexture) * InSourceTexture, [FRHITexture](API\Runtime\RHI\FRHITexture) * InDestTexture, uint8 InMipLevel, int32 InArraySlice, [FResolveRect](API\Runtime\RHI\FResolveRect) InResolveRect )


className: FResolveTextureInfo

code: struct FResolveTextureInfo

ResolveRect

type: FResolveRect


code: [FRHIDescriptorHandle](API\Runtime\RHI\FRHIDescriptorHandle) Allocate ( ERHIDescriptorHeapType InType )


code: bool Allocate ( uint32 NumDescriptors, uint32 & OutSlot )


code: void Free ( [FRHIDescriptorHandle](API\Runtime\RHI\FRHIDescriptorHandle) InHandle )


code: void Free ( uint32 Slot, uint32 NumDescriptors )


code: void Init ( uint32 InNumDescriptors, TConstArrayView< [TStatId](API\Runtime\Core\Stats\TStatId) > InStats )


code: FRHIDescriptorAllocator ( uint32 InNumDescriptors, TConstArrayView< [TStatId](API\Runtime\Core\Stats\TStatId) > InStats )


className: FRHIDescriptorAllocator

code: class FRHIDescriptorAllocator


code: ERHIDescriptorHeapType GetType() const


code: bool HandlesAllocation ( ERHIDescriptorHeapType InType ) const


code: FRHIHeapDescriptorAllocator ( ERHIDescriptorHeapType InType, uint32 InDescriptorCount, TConstArrayView< [TStatId](API\Runtime\Core\Stats\TStatId) > InStats )


className: FRHIHeapDescriptorAllocator

code: class FRHIHeapDescriptorAllocator : protected [FRHIDescriptorAllocator](API\Runtime\RHICore\FRHIDescriptorAllocator)


code: [FRHIPoolAllocationData](API\Runtime\RHICore\FRHIPoolAllocationData) * AddToFreeBlocks ( [FRHIPoolAllocationData](API\Runtime\RHICore\FRHIPoolAllocationData) * InFreeBlock )


code: void Deallocate ( [FRHIPoolAllocationData](API\Runtime\RHICore\FRHIPoolAllocationData) & AllocationData )


className: EFreeListOrder

code: enum EFreeListOrder { SortBySize, SortByOffset, }


code: static uint32 GetAlignedOffset ( uint32 InOffset, uint32 InPoolAlignment, uint32 InAllocationAlignment )


description: Free block management helper function.

code: int32 FindFreeBlock ( uint32 InSizeInBytes, uint32 InAllocationAlignment ) const


description: Static public helper functions.

code: static uint32 GetAlignedSize ( uint32 InSizeInBytes, uint32 InPoolAlignment, uint32 InAllocationAlignment )


code: uint32 GetAllocatedBlocks() const


description: Get/Release allocation data blocks.


description: Getters.

code: int16 GetPoolIndex() const


description: Setup/Shutdown.

code: virtual void Init()


code: bool IsResourceTypeSupported ( ERHIPoolResourceTypes InType ) const


code: void ReleaseAllocationData ( [FRHIPoolAllocationData](API\Runtime\RHICore\FRHIPoolAllocationData) * InData )


code: void RemoveFromFreeBlocks ( [FRHIPoolAllocationData](API\Runtime\RHICore\FRHIPoolAllocationData) * InFreeBlock )


description: AllocationData functions: allocate, free, move, ...

code: bool TryAllocate ( uint32 InSizeInBytes, uint32 InAllocationAlignment, ERHIPoolResourceTypes InAllocationResourceType, [FRHIPoolAllocationData](API\Runtime\RHICore\FRHIPoolAllocationData) & AllocationData )


description: Bookkeeping and clearing.

code: void TryClear ( [FRHIPoolAllocator](API\Runtime\RHICore\FRHIPoolAllocator) * InAllocator, uint32 InMaxCopySize, uint32 & CopySize, const [TArray](API\Runtime\Core\Containers\TArray)< [FRHIMemoryPool](API\Runtime\RHICore\FRHIMemoryPool) * > & InTargetPools )


description: Validate the linked list data - slow.

code: void Validate()


description: Constructor.

code: FRHIMemoryPool ( int16 InPoolIndex, uint64 InPoolSize, uint32 InPoolAlignment, ERHIPoolResourceTypes InSupportedResourceTypes, [EFreeListOrder](API\Runtime\RHICore\FRHIMemoryPool\EFreeListOrder) InFreeListOrder )


className: FRHIMemoryPool

description: Pool which stores for each allocation the previous and next allocation. Each block is either free or allocated.

code: class FRHIMemoryPool

AllocationDataPool

type: TArray<FRHIPoo...

description: Allocation data pool used to reduce allocation overhead.

FreeBlocks

description: Actual Free blocks.

FreeListOrder

type: constEFreeList...

FreeSize

description: Stats.

HeadBlock

type: FRHIPoolAllocat...

description: Special start block to mark the beginning and the end of the linked list.

PoolAlignment

type: const uint32

PoolIndex

description: Const creation members.

PoolSize

type: const uint64

SupportedResourceTypes

type: const ERHIPoolR...


code: void Free ( [FRHIDescriptorHandle](API\Runtime\RHI\FRHIDescriptorHandle) InHandle )


code: FRHIOffsetHeapDescriptorAllocator ( ERHIDescriptorHeapType InType, uint32 InDescriptorCount, uint32 InHeapOffset, TConstArrayView< [TStatId](API\Runtime\Core\Stats\TStatId) > InStats )


code: FRHIOffsetHeapDescriptorAllocator()


description: Alias operations (NOTE: currently not accessed when pool lock is taken, needs to be fixed)

code: void AddAlias ( [FRHIPoolAllocationData](API\Runtime\RHICore\FRHIPoolAllocationData) * InOther )


className: FRHIOffsetHeapDescriptorAllocator

code: class FRHIOffsetHeapDescriptorAllocator : protected [FRHIHeapDescriptorAllocator](API\Runtime\RHICore\FRHIHeapDescriptorAllocator)


className: EAllocationType

code: enum EAllocationType { Unknown, Free, Allocated, Head, }


code: [FRHIPoolAllocationData](API\Runtime\RHICore\FRHIPoolAllocationData) * GetFirstAlias() const


description: Linked list getters.

code: [FRHIPoolAllocationData](API\Runtime\RHICore\FRHIPoolAllocationData) * GetNext() const


code: [FRHIPoolResource](API\Runtime\RHICore\FRHIPoolResource) * GetOwner() const


code: [FRHIPoolAllocationData](API\Runtime\RHICore\FRHIPoolAllocationData) * GetPrev() const


description: Allocation data getters.

code: uint32 GetSize() const


code: void InitAsAllocated ( uint32 InSize, uint32 InPoolAlignment, uint32 InAllocationAlignment, [FRHIPoolAllocationData](API\Runtime\RHICore\FRHIPoolAllocationData) * InFree )


description: Initialize options.

code: void InitAsHead ( int16 InPoolIndex )


code: void InitAsFree ( int16 InPoolIndex, uint32 InSize, uint32 InAlignment, uint32 InOffset )


description: Type getters.

code: bool IsHead() const


description: Unlock can be public - no lock required.

code: bool IsLocked() const


description: Free block operation (TODO: make internal)

code: void MarkFree ( uint32 InPoolAlignment, uint32 InAllocationAlignment )


code: void MoveFrom ( [FRHIPoolAllocationData](API\Runtime\RHICore\FRHIPoolAllocationData) & InAllocated, bool InLocked )


description: Reset to unknown state.

code: void Reset()


description: Owner getter/setter - opaque data.

code: void SetOwner ( [FRHIPoolResource](API\Runtime\RHICore\FRHIPoolResource) * InOwner )


className: FRHIPoolAllocationData

description: Pool allocator internal data.

code: struct FRHIPoolAllocationData


description: Helper function to create a new platform specific pool.

code: [FRHIMemoryPool](API\Runtime\RHICore\FRHIMemoryPool) * CreateNewPool ( int16 InPoolIndex, uint32 InMinimumAllocationSize, ERHIPoolResourceTypes InAllocationResourceType )


code: void DeallocateInternal ( [FRHIPoolAllocationData](API\Runtime\RHICore\FRHIPoolAllocationData) & AllocationData )


description: Defrag & cleanup operation.

code: void Defrag ( uint32 InMaxCopySize, uint32 & CurrentCopySize )


code: bool HandleDefragRequest ( [FRHIPoolAllocationData](API\Runtime\RHICore\FRHIPoolAllocationData) * InSourceBlock, [FRHIPoolAllocationData](API\Runtime\RHICore\FRHIPoolAllocationData) & InTmpTargetBlock )


description: Setup/Shutdown.

code: void Initialize()


description: Supported allocator operations.

code: bool TryAllocateInternal ( uint32 InSizeInBytes, uint32 InAllocationAlignment, ERHIPoolResourceTypes InAllocationResourceType, [FRHIPoolAllocationData](API\Runtime\RHICore\FRHIPoolAllocationData) & AllocationData )


description: Stats.

code: void UpdateMemoryStats ( uint32 & IOMemoryAllocated, uint32 & IOMemoryUsed, uint32 & IOMemoryFree, uint32 & IOMemoryEndFree, uint32 & IOAlignmentWaste, uint32 & IOAllocatedPageCount, uint32 & IOFullPageCount )


description: Constructor.

code: FRHIPoolAllocator ( uint64 InDefaultPoolSize, uint32 InPoolAlignment, uint32 InMaxAllocationSize, [FRHIMemoryPool::EFreeListOrder](API\Runtime\RHICore\FRHIMemoryPool\EFreeListOrder) InFreeListOrder, bool InDefragEnabled )


className: FRHIPoolAllocator

description: Manages an array ofFRHIMemoryPooland supports defragmentation between multiple pools

code: class FRHIPoolAllocator

bDefragEnabled

type: const bool

CS

type: FCriticalSectio...

description: Critical section to lock access to the pools.

DefaultPoolSize

description: Const creation members - used to create new pools.

FreeListOrder

type: constFRHIMemor...

LastDefragPoolIndex

description: Last defrag pool index - defrag is time slices to reduce CPU overhead.

PoolAllocationOrder

type: TArray< uint32 ...

description: Allocation order of the pools when performing new allocations Can' sort the pools directly because pool index is stored in the allocation info

Pools

type: TArray<FRHIMem...

description: Actual pools managing each a linked list of allocations.

TotalAllocatedBlocks

description: Stats.


className: FRHIPoolResource

description: Owner of the pool allocation data which needs to handle memory move operations.

code: class FRHIPoolResource


code: void DeallocateMemory ( [FRHITransientTexture](API\Runtime\RHI\FRHITransientTexture) * Texture, uint32 PassIndex )


code: [FRHITransientBuffer](API\Runtime\RHI\FRHITransientBuffer) * CreateBuffer ( const [FRHIBufferCreateInfo](API\Runtime\RHI\FRHIBufferCreateInfo) & CreateInfo, const TCHAR * DebugName, uint32 PassIndex, uint64 CurrentAllocatorCycle, uint64 BufferSize, uint32 BufferAlignment, [FCreateBufferFunction](API\Runtime\RHICore\FRHITransientHeap\FCreateBufferFunction) CreateBufferFunction )


code: [FRHITransientTexture](API\Runtime\RHI\FRHITransientTexture) * CreateTexture ( const FRHITextureCreateInfo & CreateInfo, const TCHAR * DebugName, uint32 PassIndex, uint64 CurrentAllocatorCycle, uint64 TextureSize, uint32 TextureAlignment, [FCreateTextureFunction](API\Runtime\RHICore\FRHITransientHeap\FCreateTextureFunction) CreateTextureFunction )


code: void DeallocateMemory ( [FRHITransientBuffer](API\Runtime\RHI\FRHITransientBuffer) * Buffer, uint32 PassIndex )


className: FCreateBufferFunction

code: typedef [TFunction](API\Runtime\Core\GenericPlatform\TFunction)< [FRHITransientBuffer](API\Runtime\RHI\FRHITransientBuffer) *(const [FResourceInitializer](API\Runtime\RHICore\FRHITransientHeap\FResourceInitializer) &)> FCreateBufferFunction


className: FInitializer

code: struct FInitializer

Alignment

description: Alignment of the heap in bytes.

BufferCacheSize

description: Size of the buffer cache before elements are evicted.

Flags

type: ERHITransientHe...

description: Flags used to filter resource allocations within the heap.

Size

description: Size of the heap in bytes.

TextureCacheSize

description: Size of the texture cache before elements are evicted.


code: void Flush ( uint64 CurrentAllocatorCycle, [FRHITransientMemoryStats](API\Runtime\RHICore\FRHITransientMemoryStats) & OutMemoryStats, [FRHITransientAllocationStats](API\Runtime\RHI\FRHITransientAllocationStats) * OutAllocationStats )


code: FResourceInitializer &40; const FRHITransientHeapAllocation & InAllocation, uint64 InHash &41;


className: FResourceInitializer

code: struct FResourceInitializer

Allocation

type: constFRHITrans...

description: The allocation (offset / size) on the provided heap.

Hash

description: The unique hash computed from the create info and allocation offset.

Heap

type: FRHITransientHe...

description: The heap on which to create the resource.


code: uint64 GetGPUVirtualAddress() const


code: const [FInitializer](API\Runtime\RHICore\FRHITransientHeap\FInitializer) & GetInitializer() const


code: bool IsAllocationSupported ( uint64 Size, ERHITransientHeapFlags Flags ) const


code: void SetGpuVirtualAddress ( uint64 InBaseGPUVirtualAddress )


code: FRHITransientHeap ( const [FInitializer](API\Runtime\RHICore\FRHITransientHeap\FInitializer) & InInitializer )


className: FRHITransientHeap

description: The base class for a platform heap implementation. Transient resources are placed on the heap at specific byte offsets. Each heap additionally contains a cache of RHI transient resources, each with its own RHI resource and cache of RHI views. The lifetime of the resource cache is tied to the heap.

code: class FRHITransientHeap


code: [FRHITransientHeapAllocation](API\Runtime\RHI\FRHITransientHeapAllocation) Allocate ( uint64 Size, uint32 Alignment )


code: void Deallocate ( [FRHITransientHeapAllocation](API\Runtime\RHI\FRHITransientHeapAllocation) Allocation )


className: FRangeHandle

code: typedef uint16 FRangeHandle


code: uint32 GetAllocationCount() const


code: uint64 GetGpuVirtualAddress() const


className: InvalidRangeHandle

code: static const FRangeHandle InvalidRangeHandle = FRangeHandle(~0);


code: FRHITransientHeapAllocator ( uint64 Capacity, uint32 Alignment )


code: void SetGpuVirtualAddress ( uint64 InGpuVirtualAddress )


className: FRHITransientHeapAllocator

description: First-fit allocator used for placing resources on a heap.

code: class FRHITransientHeapAllocator


code: [FRHITransientHeap](API\Runtime\RHICore\FRHITransientHeap) * Acquire ( uint64 FirstAllocationSize, ERHITransientHeapFlags FirstAllocationHeapFlags )


description: Creates a default initializer using common RHI CVars.


className: kDefaultResourceCacheSize

code: static kDefaultResourceCacheSize = 256;


code: struct FInitializer

bSupportsAllHeapFlags

type: bool

description: Whether all heaps should be created with the AllowAll heap flag.

GarbageCollectLatency

description: The latency between the completed fence value and the used fence value to invoke garbage collection of the heap.

HeapAlignment

description: The minimum alignment for resources in the heap.

MaximumHeapSize

description: The maximum size of a pool. Allocations above this size will fail.

MinimumHeapSize

description: The minimum size to use when creating a heap. This is the default but can grow based on allocations.


code: void Forfeit ( TConstArrayView< [FRHITransientHeap](API\Runtime\RHICore\FRHITransientHeap) * > Heaps )


code: uint64 GetGarbageCollectCycle() const


code: uint64 GetHeapSize ( uint64 RequestedHeapSize ) const


code: const [FInitializer](API\Runtime\RHICore\FRHITransientHeapCache\FInitializer) & GetInitializer() const


code: FRHITransientHeapCache ( const [FInitializer](API\Runtime\RHICore\FRHITransientHeapCache\FInitializer) & InInitializer )


className: FRHITransientHeapCache

description: The RHI transient heap system is a base class for the platform implementation. It has a persistent lifetime and contains a cache of transient heaps. The transient allocator acquires heaps from the system and forfeits them at the end of its lifetime. Garbage collection of heaps is done using an internal counter that increments with each GarbageCollect call. This should be done periodically. Heaps older than a platform-specified fence latency are destroyed. Additionally, statistics are gathered automatically and reported to the 'rhitransientmemory' stats group.

code: class FRHITransientHeapCache : public [IRHITransientMemoryCache](API\Runtime\RHICore\IRHITransientMemoryCache)


code: virtual ~FRHITransientHeapCache()


code: void Accumulate ( const [FRHITransientMemoryStats](API\Runtime\RHICore\FRHITransientMemoryStats) & Other )


code: void AllocateBuffer ( uint64 Size )


code: void AllocateTexture ( uint64 Size )


code: void DeallocateBuffer ( uint64 Size )


code: void DeallocateTexture ( uint64 Size )


code: void Submit ( uint64 TotalMemoryCapacity )


code: void Allocate ( [FAllocationContext](API\Runtime\RHICore\FRHITransientPagePool\FAllocationContext) & AllocationContext )


className: FRHITransientMemoryStats

description: Tracks all transient memory statistics for the current allocation cycle and reports results to various profilers.

code: struct FRHITransientMemoryStats

AliasedSize

description: Current aliased size as items are being allocated / deallocated.

AliasedSizeCurrent

description: Total allocated memory usage with aliasing.

Buffers

type: FRHITransientRe...


code: void Deallocate ( uint32 SpanIndex )


code: FAllocationContext &40; FRHITransientResource & InResource, uint32 InPageSize &41;


className: FAllocationContext

code: struct FAllocationContext

Allocations

type: TArray<FRHITra...

AllocationsBefore

type: constTArray<F...


code: void Flush ( [FRHICommandListImmediate](API\Runtime\RHI\FRHICommandListImmediate) & RHICmdList )


description: Platform API.

code: void Flush &40; FRHICommandListImmediate & RHICmdList, TArray< FPageMapRequest > && InPageMapRequests, TArray< FRHITransientPageSpan > && InPageSpans &41;


code: FPageMapRequest &40; uint64 InDestinationAddress, uint64 InSourcePagePoolAddress, uint32 InSourcePageCount, uint32 InPageSpanOffset, uint32 InPageSpanCount &41;


className: FPageMapRequest

code: struct FPageMapRequest


code: uint64 GetGpuVirtualAddress() const


code: void SetGpuVirtualAddress ( uint64 InGpuVirtualAddress )


code: FRHITransientPagePool ( const [FInitializer](API\Runtime\RHICore\FRHITransientPagePool\FInitializer) & InInitializer )


className: FRHITransientPagePool

code: class FRHITransientPagePool

Initializer

type: constFInitiali...


description: Called by the transient allocator to acquire a page pool from the cache.


code: static kDefaultResourceCacheSize = 256;


code: struct FInitializer

BufferCacheSize

description: Size of the buffer cache before elements are evicted.

PageSize

description: Size of each page.

PoolSize

description: Size in bytes of the pool. Must be a multiple of PageSize.

PoolSizeFirst

description: Size in bytes of the first pool. Only takes effect if larger than PoolSize.

TextureCacheSize

description: Size of the texture cache before elements are evicted.


description: Called by the transient allocator to forfeit all acquired heaps back to the cache.

code: void Forfeit ( TConstArrayView< [FRHITransientPagePool](API\Runtime\RHICore\FRHITransientPagePool) * > PagePools )


description: Called by the transient allocator to return the fast page pool if it exists.


code: FRHITransientPagePoolCache ( const [FInitializer](API\Runtime\RHICore\FRHITransientPagePoolCache\FInitializer) & InInitializer )


code: virtual ~FRHITransientPagePoolCache()


className: FRHITransientPagePoolCache

code: class FRHITransientPagePoolCache : public [IRHITransientMemoryCache](API\Runtime\RHICore\IRHITransientMemoryCache)


code: bool Allocate ( uint32 PageCount, uint32 & NumPagesAllocated, uint32 & SpanIndex )


code: void Deallocate ( uint32 SpanIndex )


code: FRHITransientPagePoolCache ( const [FRHITransientPagePoolCache](API\Runtime\RHICore\FRHITransientPagePoolCache) & )


className: FreeSpanListTailIndex

code: static const uint32 FreeSpanListTailIndex = 1;


code: uint32 GetAllocationPageCount ( uint32 SpanIndex ) const


code: uint32 GetAllocationCount() const


className: FreeSpanListHeadIndex

code: static const uint32 FreeSpanListHeadIndex = 0;


code: template<typename SpanArrayType> void GetSpanArray ( uint32 SpanIndex, SpanArrayType & OutPageSpans ) const


className: InvalidIndex

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


className: FRHITransientPageSpanAllocator

description: Allocates page spans for a resource.

code: class FRHITransientPageSpanAllocator


code: FRHITransientPageSpanAllocator ( uint32 InPageCount, uint32 InPageSize )


description: Allocates a buffer on a heap at a specific offset, returning a cached RHI transient buffer pointer, or null if the allocation failed. BufferSize and BufferAlignment are platform specific and must be derived from the buffer create info and passed in, along with a platform-specific buffer creation function if no cached resource if found.

code: [FRHITransientBuffer](API\Runtime\RHI\FRHITransientBuffer) * CreateBufferInternal ( const [FRHIBufferCreateInfo](API\Runtime\RHI\FRHIBufferCreateInfo) & CreateInfo, const TCHAR * DebugName, uint32 PassIndex, uint32 BufferSize, uint32 BufferAlignment, [FRHITransientHeap::FCreateBufferFunction](API\Runtime\RHICore\FRHITransientHeap\FCreateBufferFunction) CreateBufferFunction )


description: Deallocates a texture from its parent heap. Provide the current platform fence value used to update the heap.

code: virtual void DeallocateMemory ( [FRHITransientTexture](API\Runtime\RHI\FRHITransientTexture) * Texture, uint32 PassIndex )


description: Allocates a texture on a heap at a specific offset, returning a cached RHI transient texture pointer, or null if the allocation failed. TextureSize and TextureAlignment are platform specific and must be derived from the texture create info and passed in, along with a platform-specific texture creation function if no cached resource if found.

code: [FRHITransientTexture](API\Runtime\RHI\FRHITransientTexture) * CreateTextureInternal ( const FRHITextureCreateInfo & CreateInfo, const TCHAR * DebugName, uint32 PassIndex, uint64 TextureSize, uint32 TextureAlignment, [FRHITransientHeap::FCreateTextureFunction](API\Runtime\RHICore\FRHITransientHeap\FCreateTextureFunction) CreateTextureFunction )


description: Deallocates a buffer from its parent heap. Provide the current platform fence value used to update the heap.

code: virtual void DeallocateMemory ( [FRHITransientBuffer](API\Runtime\RHI\FRHITransientBuffer) * Buffer, uint32 PassIndex )


description: Called to flush any active allocations prior to rendering.

code: virtual void Flush ( [FRHICommandListImmediate](API\Runtime\RHI\FRHICommandListImmediate) & RHICmdList, [FRHITransientAllocationStats](API\Runtime\RHI\FRHITransientAllocationStats) * OutAllocationStats )


description: Returns the array of heaps used by this allocator, including the required commit size for each.

code: TConstArrayView< [FRHITransientHeap](API\Runtime\RHICore\FRHITransientHeap) * > GetHeaps() const


code: FRHITransientResourceHeapAllocator ( [FRHITransientHeapCache](API\Runtime\RHICore\FRHITransientHeapCache) & InHeapCache )


className: FRHITransientResourceHeapAllocator

description: A base class for implementingIRHITransientResourceAllocatorfor a virtual aliasing placed resource heap allocation strategy.

code: class FRHITransientResourceHeapAllocator : public [IRHITransientResourceAllocator](API\Runtime\RHI\IRHITransientResourceAllocator)


code: void Track ( [FRHITransientResource](API\Runtime\RHI\FRHITransientResource) * InResource, uint32 PageOffsetMin, uint32 PageOffsetMax )


className: FRHITransientResourceOverlapTracker

description: Tracks resource allocations on the heap and adds overlap events to transient resources.


code: virtual [FRHITransientBuffer](API\Runtime\RHI\FRHITransientBuffer) * CreateBuffer ( const [FRHIBufferCreateInfo](API\Runtime\RHI\FRHIBufferCreateInfo) & CreateInfo, const TCHAR * DebugName, uint32 PassIndex )


description: Allocates a new transient resource with memory backed by the transient allocator.

code: virtual [FRHITransientTexture](API\Runtime\RHI\FRHITransientTexture) * CreateTexture ( const FRHITextureCreateInfo & InCreateInfo, const TCHAR * InDebugName, uint32 InPassIndex )


description: Deallocates the underlying memory for use by a future resource creation call.

code: virtual void DeallocateMemory ( [FRHITransientTexture](API\Runtime\RHI\FRHITransientTexture) * InTexture, uint32 InPassIndex )


description: Flushes any pending allocations prior to rendering. Optionally emits stats if OutStats is valid.

code: virtual void Flush ( [FRHICommandListImmediate](API\Runtime\RHI\FRHICommandListImmediate) & RHICmdList, [FRHITransientAllocationStats](API\Runtime\RHI\FRHITransientAllocationStats) * OutStats )


className: KB

code: static constexpr uint64 KB = 1024;


className: MB

code: static constexpr uint64 MB = 1024 * KB;


className: ResourceCacheGarbageCollectionLatency

code: static constexpr uint32 ResourceCacheGarbageCollectionLatency = 2;


code: FRHITransientResourcePageAllocator ( [FRHITransientPagePoolCache](API\Runtime\RHICore\FRHITransientPagePoolCache) & InPagePoolCache )


className: FRHITransientResourcePageAllocator

code: class FRHITransientResourcePageAllocator : public [IRHITransientResourceAllocator](API\Runtime\RHI\IRHITransientResourceAllocator)

PagePoolCache

type: FRHITransientPa...


code: void Add ( const [FRHITransientResourceStats](API\Runtime\RHICore\FRHITransientResourceStats) & Other )


className: FRHITransientResourceStats

description: Tracks allocation statistics for buffer or texture resources.

code: struct FRHITransientResourceStats

AllocatedSize

description: The number of bytes allocated from the transient allocator this cycle.

AllocationCount

description: The number of allocations made from the transient allocator this cycle.

CreateCount

description: The number of resource creations made from the transient allocator this cycle.

DeallocationCount

description: The number of deallocations made from the transient allocator this cycle.


code: virtual ~IRHITransientMemoryCache()


className: IRHITransientMemoryCache

description: Abstract base class for memory caching, providing a common garbage collection method.

code: class IRHITransientMemoryCache


description: Adds a bound shader state to the history.

code: void Add ( [FRHIBoundShaderState](API\Runtime\RHI\FRHIBoundShaderState) * BoundShaderState )


description: Releases the RHI resources used by this resource. Called when leaving the state where both the resource and the RHI have been initialized. This is only called by the rendering thread.

code: virtual void ReleaseRHI()


className: TBoundShaderStateHistory

description: A list of the most recently used bound shader states. This is used to keep bound shader states that have been used recently from being freed, as they're likely to be used again soon.

code: template<uint32 Size, bool TThreadSafe> class TBoundShaderStateHistory : public [FRenderResource](API\Runtime\RenderCore\FRenderResource)


className: String

code: static String = TEXT("Sampler State");


className: TResourceTypeStr

code: template<typename TResourceType> struct TResourceTypeStr


className: TResourceTypeStr< FRHISamplerState                                   >

code: template<> struct TResourceTypeStr< FRHISamplerState >


code: static String = TEXT("Shader Resource View");


code: template<> struct TResourceTypeStr< FRHIShaderResourceView >


className: TResourceTypeStr< FRHITexture                                                                           >

code: template<> struct TResourceTypeStr< FRHITexture >


code: static String = TEXT("Texture");


code: static String = TEXT("Unordered Access View");


code: template<> struct TResourceTypeStr< FRHIUnorderedAccessView >


code: template<typename CreateFunctionType> TransientResourceType * Acquire ( uint64 Hash, CreateFunctionType CreateFunction )


code: void Forfeit ( uint64 CurrentFrameIndex )


code: TConstArrayView< TransientResourceType * > GetAllocated() const


code: template<typename ReleaseFunctionType> void Forfeit ( uint64 CurrentFrameIndex, ReleaseFunctionType ReleaseFunction )


className: kDefaultCapacity

code: static const uint32 kDefaultCapacity = kInfinity;


className: kDefaultGarbageCollectLatency

code: static const uint32 kDefaultGarbageCollectLatency = 32;


className: kInfinity

code: static const uint32 kInfinity = ~0u;


code: TRHITransientResourceCache ( uint32 InCapacity, uint32 InGarbageCollectLatency )


className: TRHITransientResourceCache

description: An RHI transient resource cache designed to optimize fetches for resources placed into a heap with an offset. The cache has a fixed capacity whereby no garbage collection will occur. Once that capacity is exceeded, garbage collection is invoked on resources older than a specified generation (where generation is incremented with each cycle of forfeiting acquired resources).

code: template<typename TransientResourceType> class TRHITransientResourceCache


code: namespace UE { namespace RHICore { template<typename TRHIContext, typename TRHIShader> void UE::RHICore::ApplyStaticUniformBuffers ( TRHIContext * CommandContext, TRHIShader * Shader, const [TArray](API\Runtime\Core\Containers\TArray)< FUniformBufferStaticSlot > & Slots, const [TArray](API\Runtime\Core\Containers\TArray)< uint32 > & LayoutHashes, const [TArray](API\Runtime\Core\Containers\TArray)< [FRHIUniformBuffer](API\Runtime\RHI\FRHIUniformBuffer) * > & UniformBuffers ) } }


code: namespace UE { namespace RHICore { template<typename TResourceType, typename TCallback> void UE::RHICore::EnumerateUniformBufferResources ( [FRHIUniformBuffer](API\Runtime\RHI\FRHIUniformBuffer) *__restrict Buffer, int32 BufferIndex, const uint32 *__restrict ResourceMap, TCallback && Callback ) } }


code: namespace UE { namespace RHICore { void UE::RHICore::InitStaticUniformBufferSlots ( [TArray](API\Runtime\Core\Containers\TArray)< FUniformBufferStaticSlot > & StaticSlots, const [FShaderResourceTable](API\Runtime\RenderCore\FShaderResourceTable) & ShaderResourceTable ) } }


code: namespace UE { namespace RHICore { template<typename TBinder, typename TUniformBufferArrayType, typename TBitMaskType> void UE::RHICore::SetResourcesFromTables ( TBinder && Binder, [FRHIShader](API\Runtime\RHI\FRHIShader) const & Shader, [FShaderResourceTable](API\Runtime\RenderCore\FShaderResourceTable) const & SRT, TBitMaskType & DirtyUniformBuffers, TUniformBufferArrayType const & BoundUniformBuffers ) } }


description: Encrypt the supplied byte data using the given private key

module: RSA

code: static int32 DecryptPrivate ( const [TArrayView](API\Runtime\Core\Containers\TArrayView)< const uint8 > InSource, [TArray](API\Runtime\Core\Containers\TArray)< uint8 > & OutDestination, const FRSAKeyHandle InKey )


description: Destroy the supplied key

code: static void DestroyKey ( const FRSAKeyHandle InKey )


description: Decrypt the supplied byte data using the given public key

code: static int32 DecryptPublic ( const [TArrayView](API\Runtime\Core\Containers\TArrayView)< const uint8 > InSource, [TArray](API\Runtime\Core\Containers\TArray)< uint8 > & OutDestination, const FRSAKeyHandle InKey )


code: static int32 EncryptPrivate ( const [TArrayView](API\Runtime\Core\Containers\TArrayView)< const uint8 > InSource, [TArray](API\Runtime\Core\Containers\TArray)< uint8 > & OutDestination, const FRSAKeyHandle InKey )


description: Encrypt the supplied byte data using the given public key

code: static int32 EncryptPublic ( const [TArrayView](API\Runtime\Core\Containers\TArrayView)< const uint8 > InSource, [TArray](API\Runtime\Core\Containers\TArray)< uint8 > & OutDestination, const FRSAKeyHandle InKey )


description: Returns the size in bytes of the supplied key

code: static int32 GetKeySize ( const FRSAKeyHandle InKey )


description: Returns the maximum number of bytes that can be encrypted in a single payload

code: static int32 GetMaxDataSize ( const FRSAKeyHandle InKey )


description: Add exclusion. These files and / or directories pretend not to exist so that they cannot be accessed at all (except in the sandbox)

module: SandboxFile

code: void AddExclusion ( const TCHAR * Wildcard, bool bIsDirectory )


code: [FString](API\Runtime\Core\Containers\FString) ConvertFromSandboxPath ( const TCHAR * Filename ) const


description:
Converts passed in filename to use an absolute path (for writing)
filename using absolute path

code: virtual [FString](API\Runtime\Core\Containers\FString) ConvertToAbsolutePathForExternalAppForWrite ( const TCHAR * Filename )


description: Create a new RSA public/private key from the supplied exponents and modulus binary data. Each of these arrays should contain a single little endian large integer value

code: static FRSAKeyHandle CreateKey ( const [TArray](API\Runtime\Core\Containers\TArray)< uint8 > & InPublicExponent, const [TArray](API\Runtime\Core\Containers\TArray)< uint8 > & InPrivateExponent, const [TArray](API\Runtime\Core\Containers\TArray)< uint8 > & InModulus )


description:
Converts passed in filename to use an absolute path (for reading).
filename using absolute path

code: virtual [FString](API\Runtime\Core\Containers\FString) ConvertToAbsolutePathForExternalAppForRead ( const TCHAR * Filename )


description:
Converts passed in filename to use a sandbox path.
filename using sandbox path

code: [FString](API\Runtime\Core\Containers\FString) ConvertToSandboxPath ( const TCHAR * Filename ) const


description:
Copy a file. This will fail if the destination file already exists.
true if the file was copied sucessfully.

code: virtual bool CopyFile ( const TCHAR * To, const TCHAR * From, EPlatformFileRead ReadFlags, EPlatformFileWrite WriteFlags )


code: static [TUniquePtr](API\Runtime\Core\Templates\TUniquePtr)< [FSandboxPlatformFile](API\Runtime\SandboxFile\FSandboxPlatformFile) > Create ( bool bInEntireEngineWillUseThisSandbox )


description: Create a directory and return true if the directory was created or already existed.

code: virtual bool CreateDirectory ( const TCHAR * Directory )


description: Create a directory, including any parent directories and return true if the directory was created or already existed.

code: virtual bool CreateDirectoryTree ( const TCHAR * Directory )


description: Delete a directory and return true if the directory was deleted or otherwise does not exist.

code: virtual bool DeleteDirectory ( const TCHAR * Directory )


description:
Deletes a directory This is partially copied from file manager but sinceIPlatformFileis lower level it's better to have local version which doesn't use the wrappedIPlatformFile.
true if the operaton was successful.

code: bool DeleteDirectory &40; const TCHAR &42; Path, bool Tree &41;


description:
Delete all files and subdirectories in a directory, then delete the directory itself
true if the directory was deleted or did not exist.

code: virtual bool DeleteDirectoryRecursively ( const TCHAR * Directory )


description: Delete a file and return true if the file exists. Will not delete read only files.

code: virtual bool DeleteFile ( const TCHAR * Filename )


description: Returns absolute path to game directory (without the game directory itself)

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


description: Returns absolute root directory

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


description: Return the last access time of a file. ReturnsFDateTime::MinValue()on failure

code: virtual [FDateTime](API\Runtime\Core\Misc\FDateTime) GetAccessTimeStamp ( const TCHAR * Filename )


description: Return true if the directory exists.

code: virtual bool DirectoryExists ( const TCHAR * Directory )


description: Return true if the file exists.

code: virtual bool FileExists ( const TCHAR * Filename )


description: Return the size of the file, or -1 if it doesn't exist.

code: virtual int64 FileSize ( const TCHAR * Filename )


description: Returns absolute game directory

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


description: For case insensitive filesystems, returns the full path of the file with the same case as in the filesystem

code: virtual [FString](API\Runtime\Core\Containers\FString) GetFilenameOnDisk ( const TCHAR * Filename )


description: Returns the name of the sandbox directory for the game's content

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


description: Gets the platform file wrapped by this file.

code: virtual [IPlatformFile](API\Runtime\Core\GenericPlatform\IPlatformFile) * GetLowerLevel()


description: Gets this platform file type name.

code: virtual const TCHAR * GetName() const


description: Returns sandbox directory

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


description: Return the stat data for the given file or directory. Check theFFileStatData::bIsValidmember before using the returned data

code: virtual [FFileStatData](API\Runtime\Core\GenericPlatform\FFileStatData) GetStatData ( const TCHAR * FilenameOrDirectory )


description: Return the modification time of a file. ReturnsFDateTime::MinValue()on failure

code: virtual [FDateTime](API\Runtime\Core\Misc\FDateTime) GetTimeStamp ( const TCHAR * Filename )


description:
Initializes platform file.
true if the initialization was successful, false otherise.

code: virtual bool Initialize ( [IPlatformFile](API\Runtime\Core\GenericPlatform\IPlatformFile) * Inner, const TCHAR * CmdLine )


description:
Returns whether the sandbox is enabled or not
bool true if enabled, false if not

code: virtual bool IsSandboxEnabled() const


description: Return true if the file is read only.

code: virtual bool IsReadOnly ( const TCHAR * Filename )


description:
Call the Visit function of the visitor once for each file or directory in a single directory. This function does not explore subdirectories.
false if the directory did not exist or if the visitor returned false.

code: virtual bool IterateDirectory ( const TCHAR * Directory, [IPlatformFile::FDirectoryVisitor](API\Runtime\Core\GenericPlatform\IPlatformFile\FDirectoryVisitor) & Visitor )


description:
Call the Visit function of the visitor once for each file or directory in a directory tree. This function explores subdirectories.
false if the directory did not exist or if the visitor returned false.

code: virtual bool IterateDirectoryRecursively ( const TCHAR * Directory, [IPlatformFile::FDirectoryVisitor](API\Runtime\Core\GenericPlatform\IPlatformFile\FDirectoryVisitor) & Visitor )


code: virtual bool IterateDirectoryStat ( const TCHAR * Directory, [IPlatformFile::FDirectoryStatVisitor](API\Runtime\Core\GenericPlatform\IPlatformFile\FDirectoryStatVisitor) & Visitor )


description: Attempt to move a file. Return true if successful. Will not overwrite existing files.

code: virtual bool MoveFile ( const TCHAR * To, const TCHAR * From )


code: virtual bool IterateDirectoryStatRecursively ( const TCHAR * Directory, [IPlatformFile::FDirectoryStatVisitor](API\Runtime\Core\GenericPlatform\IPlatformFile\FDirectoryStatVisitor) & Visitor )


description:
Open a file for async reading. This call does not hit the disk or block.
Close the file by delete'ing the handle. A non-null return value does not mean the file exists, since that may not be determined yet.

code: virtual [IAsyncReadFileHandle](API\Runtime\Core\Async\IAsyncReadFileHandle) * OpenAsyncRead ( const TCHAR * Filename )


description:
Open a file for async reading. This call does hit the disk; it is synchronous open.
Close the file by delete'ing the handle. A non-null return value does mean the file exists. Null can be returned for many reasons even if the file exists. Perhaps this platform does not support mapped files, or this file is compressed in a pak file. Generally you attempt to open mapped, and if that fails, then use other file operations instead.

code: virtual [IMappedFileHandle](API\Runtime\Core\Async\IMappedFileHandle) * OpenMapped ( const TCHAR * Filename )


description:
Attempt to open a file for reading.
If successful will return a non-nullptr pointer. Close the file by delete'ing the handle.

code: virtual [IFileHandle](API\Runtime\Core\GenericPlatform\IFileHandle) * OpenRead ( const TCHAR * Filename, bool bAllowWrite )


description: Attempt to open a file for writing. If successful will return a non-nullptr pointer. Close the file by delete'ing the handle.

code: virtual [IFileHandle](API\Runtime\Core\GenericPlatform\IFileHandle) * OpenWrite ( const TCHAR * Filename, bool bAppend, bool bAllowRead )


code: void RemoveExclusion ( const TCHAR * Wildcard, bool bIsDirectory )


description: Controls if the pak precacher should process precache requests. Requests below this threshold will not get precached. Without this throttle, quite a lot of memory can be consumed if the disk races ahead of the CPU.

code: virtual void SetAsyncMinimumPriority ( EAsyncIOPriorityAndFlags MinPriority )


description: Sets the platform file wrapped by this file.

code: virtual void SetLowerLevel ( [IPlatformFile](API\Runtime\Core\GenericPlatform\IPlatformFile) * NewLowerLevel )


description: Attempt to change the read only status of a file. Return true if successful.

code: virtual bool SetReadOnly ( const TCHAR * Filename, bool bNewReadOnlyValue )


description: Set whether the sandbox is enabled or not

code: virtual void SetSandboxEnabled ( bool bInEnabled )


description: Whether access is restricted the the sandbox or not.

code: void SetSandboxOnly ( bool bInSandboxOnly )


description: Sets the modification time of a file

code: virtual void SetTimeStamp ( const TCHAR * Filename, [FDateTime](API\Runtime\Core\Misc\FDateTime) DateTime )


description: Checks if this platform file should be used even though it was not asked to be. i.e. pak files exist on disk so we should use a pak file

code: virtual bool ShouldBeUsed ( [IPlatformFile](API\Runtime\Core\GenericPlatform\IPlatformFile) * Inner, const TCHAR * CmdLine ) const


code: virtual ~FSandboxPlatformFile()


className: FSandboxPlatformFile

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

code: class FSandboxPlatformFile : public [IPlatformFile](API\Runtime\Core\GenericPlatform\IPlatformFile)


description:
Gets the identifier of the current field.
The field's name.

module: Serialization

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


description:
The returned string contains debug information that is relevant to the reader's serialization format. For example, it could be a line and column number for text based formats, or a byte offset for binary serialization formats.
The debug string.

code: virtual [FString](API\Runtime\Core\Containers\FString) GetDebugString() const


description:
Gets the last error message.
Error message.

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


description:
Reads the next token from the stream.
true if a token was read, false otherwise.

code: virtual bool GetNextToken ( EStructDeserializerBackendTokens & OutToken )


description:
implementations will support only a Int8 or Byte array at the moment
true on success, false if need to fall back to per element array serialization.

code: virtual bool ReadPODArray ( [FArrayProperty](API\Runtime\CoreUObject\UObject\FArrayProperty) * ArrayProperty, void * Data )


description:
Reads the specified property from the stream.
true on success, false otherwise.

code: virtual bool ReadProperty ( [FProperty](API\Runtime\CoreUObject\UObject\FProperty) * Property, [FProperty](API\Runtime\CoreUObject\UObject\FProperty) * Outer, void * Data, int32 ArrayIndex )


description: Skips the array that is currently being read from the stream.

code: virtual void SkipArray()


description: Skips the object that is currently being read from the stream.

code: virtual void SkipStructure()


description: For backward compatibility and performance, the implementation default to the the platform endianness rather than the CBOR standard one (big endian).

code: FCborStructDeserializerBackend ( [FArchive](API\Runtime\Core\Serialization\FArchive) & Archive, ECborEndianness CborDataEndianness, bool bInIsLWCCompatibilityMode )


className: FCborStructDeserializerBackend

description: Implements a reader forUStructdeserialization using Cbor.

code: class FCborStructDeserializerBackend : public [IStructDeserializerBackend](API\Runtime\Serialization\IStructDeserializerBackend)


description: EndArray

code: virtual void BeginArray ( const [FStructSerializerState](API\Runtime\Serialization\FStructSerializerState) & State )


description: EndStructure

code: virtual void BeginStructure ( const [FStructSerializerState](API\Runtime\Serialization\FStructSerializerState) & State )


description: EndStructure

code: virtual void EndArray ( const [FStructSerializerState](API\Runtime\Serialization\FStructSerializerState) & State )


description: EndArray

code: virtual void EndStructure ( const [FStructSerializerState](API\Runtime\Serialization\FStructSerializerState) & State )


description: WriteProperty

code: virtual void WriteComment ( const [FString](API\Runtime\Core\Containers\FString) & Comment )


description: WriteComment

code: virtual bool WritePODArray ( const [FStructSerializerState](API\Runtime\Serialization\FStructSerializerState) & State )


description: WriteComment

code: virtual void WriteProperty ( const [FStructSerializerState](API\Runtime\Serialization\FStructSerializerState) & State, int32 ArrayIndex )


description: Deprecated, use the two-parameter constructor with EStructSerializerBackendFlags::Legacy if you need backwards compatibility with code compiled prior to 4.22.

code: FCborStructSerializerBackend ( [FArchive](API\Runtime\Core\Serialization\FArchive) & InArchive )


description: Creates and initializes a new instance with the given flags.

code: FCborStructSerializerBackend ( [FArchive](API\Runtime\Core\Serialization\FArchive) & InArchive, const EStructSerializerBackendFlags InFlags )


code: virtual ~FCborStructSerializerBackend()


className: FCborStructSerializerBackend

description: Implements a writer forUStructserialization using Cbor.

code: class FCborStructSerializerBackend : public [IStructSerializerBackend](API\Runtime\Serialization\IStructSerializerBackend)


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


code: virtual [FString](API\Runtime\Core\Containers\FString) GetDebugString() const


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


code: EJsonNotation GetLastNotation()


code: virtual bool GetNextToken ( EStructDeserializerBackendTokens & OutToken )


code: [TSharedRef](API\Runtime\Core\Templates\TSharedRef)< [TJsonReader](API\Runtime\Json\Serialization\TJsonReader)< WIDECHAR > > & GetReader()


code: virtual bool ReadProperty ( [FProperty](API\Runtime\CoreUObject\UObject\FProperty) * Property, [FProperty](API\Runtime\CoreUObject\UObject\FProperty) * Outer, void * Data, int32 ArrayIndex )


code: virtual void SkipArray()


code: virtual void SkipStructure()


description: Creates and initializes a new instance.

code: FJsonStructDeserializerBackend ( [FArchive](API\Runtime\Core\Serialization\FArchive) & Archive )


className: FJsonStructDeserializerBackend

description: Note: The underlying Json de-serializer is currently hard-coded to use UCS2CHAR. This is because the current JsonReader API does not allow writers to be substituted since it's all based on templates. At some point we will refactor the low-level Json API to provide more flexibility for serialization.

code: class FJsonStructDeserializerBackend : public [IStructDeserializerBackend](API\Runtime\Serialization\IStructDeserializerBackend)


description: EndArray

code: virtual void BeginArray ( const [FStructSerializerState](API\Runtime\Serialization\FStructSerializerState) & State )


description: EndStructure

code: virtual void BeginStructure ( const [FStructSerializerState](API\Runtime\Serialization\FStructSerializerState) & State )


description: EndStructure

code: virtual void EndArray ( const [FStructSerializerState](API\Runtime\Serialization\FStructSerializerState) & State )


description: EndArray

code: virtual void EndStructure ( const [FStructSerializerState](API\Runtime\Serialization\FStructSerializerState) & State )


description: Allow access to the internal JsonWriter to subclasses.

code: [TSharedRef](API\Runtime\Core\Templates\TSharedRef)< TJsonWriter< UCS2CHAR > > & GetWriter()