Unreal Engine 4.26 Documentation

Unreal Engine 4.27 Documentation

Unreal Engine 5.0 Documentation

Unreal Engine 5.1 Documentation

Unreal Engine 5.2 Documentation

Unreal Engine 5.3 Documentation

> Unreal Engine API Reference > Runtime > RHI > IRHIComputeContext > IRHIComputeContext::RHICopyToStagingBuffer

Light Theme

Dark Theme

IRHIComputeContext::RHICopyToStagingBuffer

Performs a copy of the data in 'SourceBuffer' to 'DestinationStagingBuffer.' This will occur inline on the GPU timeline.

Windows

MacOS

Linux

Override Hierarchy

IRHIComputeContext::RHICopyToStagingBuffer()

FOpenGLDynamicRHI::RHICopyToStagingBuffer()

References

Module	RHI
Header	/Engine/Source/Runtime/RHI/Public/RHIContext.h
Include	#include "RHIContext.h"

Syntax

virtual void RHICopyToStagingBuffer
(
    FRHIVertexBuffer * SourceBufferRHI,
    FRHIStagingBuffer * DestinationStagingBufferRHI,
    uint32 InOffset,
    uint32 InNumBytes
)

Remarks

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.

Parameters

Parameter	Description
SourceBuffer	The source vertex buffer that will be inlined copied.
DestinationStagingBuffer	The the host-visible destination buffer
Offset	The start of the data in 'SourceBuffer'
NumBytes	The number of bytes to copy out of 'SourceBuffer'

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

Take our survey

Dismiss