FComputeBufferReader | Unreal Engine 5.7 Documentation

Facilitates reading data from a compute buffer


Name	FComputeBufferReader
Type	class
Header File	/Engine/Source/Developer/Horde/Public/Compute/ComputeBuffer.h
Include Path	#include "Compute/ComputeBuffer.h"

Syntax

class FComputeBufferReader

Name	Remarks	Include Path	Unreal Specifiers
FComputeBufferReader ()		Compute/ComputeBuffer.h
FComputeBufferReader ( const FComputeBufferReader& Other )		Compute/ComputeBuffer.h
FComputeBufferReader ( FComputeBufferReader&& Other )		Compute/ComputeBuffer.h
FComputeBufferReader ( FComputeBufferDetail* Detail, int ReaderIdx )		Compute/ComputeBuffer.h

Name	Remarks	Include Path	Unreal Specifiers
~FComputeBufferReader()		Compute/ComputeBuffer.h

Name	Type	Remarks	Include Path	Unreal Specifiers
Detail	FComputeBufferDetail *		Compute/ComputeBuffer.h
ReaderIdx	int		Compute/ComputeBuffer.h

Name	Remarks	Include Path
void AdvanceReadPosition ( size_t Size )	Move the read cursor forwards by the given number of bytes.	Compute/ComputeBuffer.h
void Close()	Closes the handle to the underlying reader instance, resetting this instance back to empty.	Compute/ComputeBuffer.h
void Detach()	Detaches this reader from the buffer, causing all pending and subsequent reads to return immediately.	Compute/ComputeBuffer.h
size_t GetMaxReadSize()	Gets the amount of data that is ready to be read from a contiguous block of memory.	Compute/ComputeBuffer.h
bool IsComplete()	Test whether the buffer has finished being written to (ie. MarkComplete() has been called by the writer) and all data has been read from it.	Compute/ComputeBuffer.h
bool IsValid()	Test if the reader is valid.	Compute/ComputeBuffer.h
size_t Read ( void* Buffer, size_t MaxSize, int TimeoutMs, bool* bOutTimedOut )	Reads data into the given buffer.	Compute/ComputeBuffer.h
const unsigned char * WaitToRead ( size_t MinSize, int TimeoutMs, bool* bOutTimedOut )	Waits until the given amount of data has been read, and returns a pointer to it.	Compute/ComputeBuffer.h

Name	Remarks	Include Path	Unreal Specifiers
FComputeBufferReader & operator= ( const FComputeBufferReader& Other )		Compute/ComputeBuffer.h
FComputeBufferReader & operator= ( FComputeBufferReader&& Other )		Compute/ComputeBuffer.h