FOpenGLDynamicRHI::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

OpenGLDrv

Header

/Engine/Source/Runtime/OpenGLDrv/Public/OpenGLDrv.h

Include

#include "OpenGLDrv.h"

Source

/Engine/Source/Runtime/OpenGLDrv/Private/OpenGLVertexBuffer.cpp

Syntax

virtual void * LockStagingBuffer_RenderThread
(
    class FRHICommandListImmediate & RHICmdList,
    FRHIStagingBuffer * StagingBuffer,
    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.

Offset

The offset in the buffer to return.

SizeRHI

The length of the region in the buffer to lock.

Select Skin
Light
Dark

Welcome to the new Unreal Engine 4 Documentation site!

We're working on lots of new features including a feedback system so you can tell us how we are doing. It's not quite ready for use in the wild yet, so head over to the Documentation Feedback forum to tell us about this page or call out any issues you are encountering in the meantime.

We'll be sure to let you know when the new system is up and running.

Post Feedback