FComputeBufferWriter | Unreal Engine 5.7 Documentation

Facilitates writing data to a compute buffer


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

Syntax

class FComputeBufferWriter

Name	Remarks	Include Path	Unreal Specifiers
FComputeBufferWriter ()		Compute/ComputeBuffer.h
FComputeBufferWriter ( const FComputeBufferWriter& Other )		Compute/ComputeBuffer.h
FComputeBufferWriter ( FComputeBufferWriter&& Other )		Compute/ComputeBuffer.h
FComputeBufferWriter ( FComputeBufferDetail* Detail )		Compute/ComputeBuffer.h

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

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

Name	Remarks	Include Path
void AdvanceWritePosition ( size_t Size )	Move the write cursor forward by the given number of bytes.	Compute/ComputeBuffer.h
void Close()	Closes the handle to the underlying writer instance, resetting this instance back to empty.	Compute/ComputeBuffer.h
size_t GetChunkMaxLength()	Get the max length of a chunk.	Compute/ComputeBuffer.h
size_t GetMaxWriteSize()	Gets the length of the current write buffer.	Compute/ComputeBuffer.h
bool IsValid()	Test if the writer is valid.	Compute/ComputeBuffer.h
void MarkComplete()	Signal that we've finished writing to this buffer.	Compute/ComputeBuffer.h
unsigned char * WaitToWrite ( size_t MinSize, int TimeoutMs )	Waits until a write buffer of the requested size is available, and returns a pointer to it.	Compute/ComputeBuffer.h
size_t Write ( const void* Buffer, size_t MaxSize, int TimeoutMs )	Writes data into the compute buffer.	Compute/ComputeBuffer.h

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