FRHIGPUMemoryReadback

[FRHIGPUMemoryReadback](API\Runtime\RHI\FRHIGPUMemoryReadback): Represents a memory readback request scheduled with CopyToStagingBuffer Wraps a staging buffer with a [FRHIGPUFence](API\Runtime\RHI\FRHIGPUFence) for synchronization.

Windows
MacOS
Linux

Inheritance Hierarchy

References

Module

RHI

Header

/Engine/Source/Runtime/RHI/Public/RHIGPUReadback.h

Include

#include "RHIGPUReadback.h"

Syntax

class FRHIGPUMemoryReadback

Remarks

FRHIGPUMemoryReadback: Represents a memory readback request scheduled with CopyToStagingBuffer Wraps a staging buffer with a FRHIGPUFence for synchronization.

Variables

Name Description

Protected variable

FGPUFenceRHIRef

 

Fence

Protected variable

FRHIGPUMask

 

LastCopyGPUMask

Constructors

Name Description

Public function

FRHIGPUMemoryReadback

(
    FName RequestName
)

Destructors

Name Description

Public function Virtual

~FRHIGPUMemoryReadback()

Functions

Name Description

Public function Virtual

void

 

EnqueueCopy

(
    FRHICommandList& RHICmdList,
    FRHIVertexBuffer* SourceBuffer,
    uint32 NumBytes
)

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

Public function Virtual

void

 

EnqueueCopy

(
    FRHICommandList& RHICmdList,
    FRHITexture* SourceTexture,
    FResolveRect Rect
)

Public function Const

const FRHIGP...

 

GetLastCopyGPUMask()

Public function

bool

 

IsReady()

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

Public function

bool

 

IsReady

(
    FRHIGPUMask GPUMask
)

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

Public function

void *

 

Lock

(
    uint32 NumBytes
)

Returns the CPU accessible pointer that backs this staging buffer.

Public function

void

 

Unlock()

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

Help shape the future of Unreal Engine documentation! Tell us how we're doing so we can serve you better.
Take our survey
Dismiss