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 > FDynamicRHI > FDynamicRHI::LockStagingBuffer_RenderThread

Light Theme

Dark Theme

FDynamicRHI::LockStagingBuffer_RenderThread

Lock a staging buffer to read contents on the CPU that were written by the GPU, without having to stall.

Windows

MacOS

Linux

Override Hierarchy

FDynamicRHI::LockStagingBuffer_RenderThread()

FOpenGLDynamicRHI::LockStagingBuffer_RenderThread()

References

Module	RHI
Header	/Engine/Source/Runtime/RHI/Public/DynamicRHI.h
Include	#include "DynamicRHI.h"
Source	/Engine/Source/Runtime/RHI/Private/RHICommandList.cpp

Syntax

virtual void * LockStagingBuffer_RenderThread
(
    class FRHICommandListImmediate & RHICmdList,
    FRHIStagingBuffer * StagingBuffer,
    FRHIGPUFence * Fence,
    uint32 Offset,
    uint32 SizeRHI
)

Remarks

Lock a staging buffer to read contents on the CPU that were written by the GPU, without having to stall. This function requires that you have issued an CopyToStagingBuffer invocation and verified that the FRHIGPUFence has been signaled before calling.

Returns

A pointer to the data starting at 'Offset' and of length 'SizeRHI' from 'StagingBuffer', or nullptr when there is an error.

Parameters

Parameter	Description
RHICmdList	The command-list to execute on or synchronize with.
StagingBuffer	The buffer to lock.
Fence	An optional fence synchronized with the last buffer update.
Offset	The offset in the buffer to return.
SizeRHI	The length of the region in the buffer to lock.

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

Take our survey

Dismiss