FBulkDataBuffer< DataType > Class Template Reference

#include <BulkDataBuffer.h>

Public Types
using	ViewType = TArrayView64< DataType >

Public Member Functions
	FBulkDataBuffer ()=default
	FBulkDataBuffer (const FBulkDataBuffer &Other)
	FBulkDataBuffer (FBulkDataBuffer &&Other)
	FBulkDataBuffer (DataType *InBuffer, int64 InNumberOfElements)
	~FBulkDataBuffer ()
FBulkDataBuffer &	operator= (const FBulkDataBuffer &Other)
FBulkDataBuffer &	operator= (FBulkDataBuffer &&Other)
void	Empty ()
void	Reset (DataType *InBuffer, uint64 InNumberOfElements)
const ViewType &	GetView () const

Detailed Description

template<typename DataType>
class FBulkDataBuffer< DataType >

Used to manage a raw data buffer provided by BulkData while providing access to it via a TArrayView.

This object assumes that it owns the buffer that it has been given and will free the memory when the object is destroyed.

Member Typedef Documentation

ViewType

template<typename DataType >

using FBulkDataBuffer< DataType >::ViewType = TArrayView64<DataType>

Constructor & Destructor Documentation

FBulkDataBuffer() [1/4]

template<typename DataType >

FBulkDataBuffer< DataType >::FBulkDataBuffer ( )

default

Constructor.

FBulkDataBuffer() [2/4]

template<typename DataType >

FBulkDataBuffer< DataType >::FBulkDataBuffer ( const FBulkDataBuffer< DataType > &  Other )

inline

Copy constructor which will create it's own memory buffer and then copy from the source object rather than share access to the same buffer.

Parameters

Other

The source array to copy.

FBulkDataBuffer() [3/4]

template<typename DataType >

FBulkDataBuffer< DataType >::FBulkDataBuffer ( FBulkDataBuffer< DataType > &&  Other )

inline

Move constructor.

Parameters

Other

FBulkDataBuffer to move from.

FBulkDataBuffer() [4/4]

template<typename DataType >

FBulkDataBuffer< DataType >::FBulkDataBuffer ( DataType *  InBuffer, int64  InNumberOfElements  )

inline

Constructor.

Parameters

InBuffer	Pointer to memory to take ownership of, must've have been allocated via FMemory::Malloc/Realloc.
InNumberOfElements	The number of elements in the buffer.

~FBulkDataBuffer()

template<typename DataType >

FBulkDataBuffer< DataType >::~FBulkDataBuffer ( )

inline

Destructor.

Member Function Documentation

Empty()

template<typename DataType >

void FBulkDataBuffer< DataType >::Empty ( )

inline

Frees the internal buffer and sets the internal TArrayView to an empty state

GetView()

template<typename DataType >

const ViewType & FBulkDataBuffer< DataType >::GetView ( ) const

inline

Allows access to the data buffer owned by the object in the form of a TArrayView

Returns

A valid TArrayView

operator=() [1/2]

template<typename DataType >

FBulkDataBuffer & FBulkDataBuffer< DataType >::operator= ( const FBulkDataBuffer< DataType > &  Other )

inline

Assignment operator which will create it's own memory buffer and then copy from the source object rather than share access to the same buffer.

Parameters

Other

The source FBulkDataBuffer to assign from.

operator=() [2/2]

template<typename DataType >

FBulkDataBuffer & FBulkDataBuffer< DataType >::operator= ( FBulkDataBuffer< DataType > &&  Other )

inline

Move assignment operator.

Parameters

Other

FBulkDataBuffer to assign and move from.

Reset()

template<typename DataType >

void FBulkDataBuffer< DataType >::Reset ( DataType *  InBuffer, uint64  InNumberOfElements  )

inline

Frees any existing buffer and takes ownership of the buffer provided instead.

Parameters

InBuffer	Pointer to memory to take ownership of, must've have been allocated via FMemory::Malloc/Realloc.
InNumberOfElements	The number of elements in the buffer. buffers actual size if desired.

---

The documentation for this class was generated from the following file:

• Engine/Source/Runtime/CoreUObject/Public/Serialization/BulkDataBuffer.h