#include <RendererPrivateUtils.h>

Inheritance diagram for UE::RendererPrivateUtils::Implementation::TBufferScatterUploader< InValueType, InBufferTraits, InNumValuesPerScatter >:

Classes
struct	FUploadData

Public Types
using	BufferTraits = InBufferTraits

using	ValueType = InValueType

Public Member Functions
	TBufferScatterUploader (int32 NumScatters=0)

virtual	~TBufferScatterUploader ()=default

void	Reserve (int32 NumScatters)

void	Add (const ValueType &Value, int32 ScatterOffset)

void	Add (const TConstArrayView< ValueType > &InValues, int32 ScatterOffset)

void	AddMultiple (const TConstArrayView< ValueType > &InValues, int32 FirstScatterOffset)

TArrayView< ValueType >	AddMultiple_GetRef (int32 FirstScatterOffset, int32 NumValues)

int32	GetNumScatters () const

FRDGBuffer *	ResizeAndUploadTo (FRDGBuilder &GraphBuilder, TPersistentBuffer< ValueType, BufferTraits > &DestDataBuffer, int32 DestDataMinimumSize, FScatterInfo &OutScatterInfo)

FRDGBuffer *	ResizeAndUploadTo (FRDGBuilder &GraphBuilder, TPersistentBuffer< ValueType, BufferTraits > &DestDataBuffer, int32 DestDataMinimumSize)

Public Member Functions inherited from FBufferScatterUploader
RENDERER_API void	UploadTo (FRDGBuilder &GraphBuilder, FRDGBuffer DestBuffer, FRDGBuffer ScatterOffsets, FRDGBuffer *Values, uint32 NumScatters, uint32 NumBytesPerElement, int32 NumValuesPerScatter)

RENDERER_API void	UploadTo (FRDGBuilder &GraphBuilder, FRDGBuffer DestBuffer, FRDGBuffer ScatterOffsets, FRDGBuffer *Values, TFunction< uint64()> &&GetNumScatters, uint32 NumBytesPerElement, int32 NumValuesPerScatter)

Static Public Attributes
static constexpr int32	BytesPerElement = sizeof(ValueType)

static constexpr int32	NumValuesPerScatter = InNumValuesPerScatter

Protected Attributes
FUploadData *	UploadDataProxy = nullptr

FUploadData	UploadData

Member Typedef Documentation

◆ BufferTraits

template<typename InValueType , typename InBufferTraits , int32 InNumValuesPerScatter = 1>

using UE::RendererPrivateUtils::Implementation::TBufferScatterUploader< InValueType, InBufferTraits, InNumValuesPerScatter >::BufferTraits = InBufferTraits

◆ ValueType

template<typename InValueType , typename InBufferTraits , int32 InNumValuesPerScatter = 1>

using UE::RendererPrivateUtils::Implementation::TBufferScatterUploader< InValueType, InBufferTraits, InNumValuesPerScatter >::ValueType = InValueType

Constructor & Destructor Documentation

◆ TBufferScatterUploader()

template<typename InValueType , typename InBufferTraits , int32 InNumValuesPerScatter = 1>

UE::RendererPrivateUtils::Implementation::TBufferScatterUploader< InValueType, InBufferTraits, InNumValuesPerScatter >::TBufferScatterUploader ( int32 NumScatters = 0 )

inline

Optionally reserve space for NumScatters items.

◆ ~TBufferScatterUploader()

template<typename InValueType , typename InBufferTraits , int32 InNumValuesPerScatter = 1>

virtual UE::RendererPrivateUtils::Implementation::TBufferScatterUploader< InValueType, InBufferTraits, InNumValuesPerScatter >::~TBufferScatterUploader ( )

virtualdefault

Member Function Documentation

◆ Add() [1/2]

template<typename InValueType , typename InBufferTraits , int32 InNumValuesPerScatter = 1>

void UE::RendererPrivateUtils::Implementation::TBufferScatterUploader< InValueType, InBufferTraits, InNumValuesPerScatter >::Add	(	const TConstArrayView< ValueType > &	InValues,
		int32	ScatterOffset
	)

inline

Add a number of values to scatter to a common destination start offset, NOTE: the destination start offset is ScatterOffset * InNumValuesPerScatter (not ScatterOffset)

◆ Add() [2/2]

template<typename InValueType , typename InBufferTraits , int32 InNumValuesPerScatter = 1>

void UE::RendererPrivateUtils::Implementation::TBufferScatterUploader< InValueType, InBufferTraits, InNumValuesPerScatter >::Add	(	const ValueType &	Value,
		int32	ScatterOffset
	)

inline

Add single value to scatter to the destination offset.

◆ AddMultiple()

template<typename InValueType , typename InBufferTraits , int32 InNumValuesPerScatter = 1>

void UE::RendererPrivateUtils::Implementation::TBufferScatterUploader< InValueType, InBufferTraits, InNumValuesPerScatter >::AddMultiple	(	const TConstArrayView< ValueType > &	InValues,
		int32	FirstScatterOffset
	)

inline

Add a number of values to scatter to consecutive destination offsets with a common start offset, NOTE: this allocates a new scatter offset for each NumValuesPerScatter elements.

◆ AddMultiple_GetRef()

template<typename InValueType , typename InBufferTraits , int32 InNumValuesPerScatter = 1>

TArrayView< ValueType > UE::RendererPrivateUtils::Implementation::TBufferScatterUploader< InValueType, InBufferTraits, InNumValuesPerScatter >::AddMultiple_GetRef	(	int32	FirstScatterOffset,
		int32	NumValues
	)

inline

Add a number of values to scatter to consecutive destination offsets with a common start offset, NOTE: this allocates a new scatter offset for each NumValuesPerScatter elements.

◆ GetNumScatters()

template<typename InValueType , typename InBufferTraits , int32 InNumValuesPerScatter = 1>

int32 UE::RendererPrivateUtils::Implementation::TBufferScatterUploader< InValueType, InBufferTraits, InNumValuesPerScatter >::GetNumScatters ( ) const

inline

◆ Reserve()

template<typename InValueType , typename InBufferTraits , int32 InNumValuesPerScatter = 1>

void UE::RendererPrivateUtils::Implementation::TBufferScatterUploader< InValueType, InBufferTraits, InNumValuesPerScatter >::Reserve ( int32 NumScatters )

inline

Pre-size the value and scatter arrays, allocates space for InNumValuesPerScatter * NumScatters values & NumScatters scatter offsets.

◆ ResizeAndUploadTo() [1/2]

template<typename InValueType , typename InBufferTraits , int32 InNumValuesPerScatter = 1>

FRDGBuffer * UE::RendererPrivateUtils::Implementation::TBufferScatterUploader< InValueType, InBufferTraits, InNumValuesPerScatter >::ResizeAndUploadTo	(	FRDGBuilder &	GraphBuilder,
		TPersistentBuffer< ValueType, BufferTraits > &	DestDataBuffer,
		int32	DestDataMinimumSize
	)

inline

◆ ResizeAndUploadTo() [2/2]

template<typename InValueType , typename InBufferTraits , int32 InNumValuesPerScatter = 1>

FRDGBuffer * UE::RendererPrivateUtils::Implementation::TBufferScatterUploader< InValueType, InBufferTraits, InNumValuesPerScatter >::ResizeAndUploadTo	(	FRDGBuilder &	GraphBuilder,
		TPersistentBuffer< ValueType, BufferTraits > &	DestDataBuffer,
		int32	DestDataMinimumSize,
		FScatterInfo &	OutScatterInfo
	)

inline

Resize the destination persistent buffer (if needed) and upload & scatter the collected data to it. This locks the uploader to prevent accidental resize (and thus realloc) of the buffer by adding more elements.