UDocumentation UE5.7 10.02.2026 (Source)
API documentation for Unreal Engine 5.7
TBulkDataScopedWriteLock< ElementType > Class Template Reference

#include <BulkDataScopedLock.h>

Public Member Functions

 UE_NONCOPYABLE (TBulkDataScopedWriteLock)
 
 TBulkDataScopedWriteLock (TBulkData< ElementType > &InBulkData)
 
 ~TBulkDataScopedWriteLock ()
 
int64 Num () const
 
int64 GetAllocatedSize () const
 
ElementType * GetData () const
 
TArrayView64< ElementType > GetView () const
 

Detailed Description

template<typename ElementType>
class TBulkDataScopedWriteLock< ElementType >

Locks the given bulkdata object for read/write access. Note that performing actions on the original bulkdata object while this scope is active (such as calls to realloc) may cause problems. Only use this object for bulkdata operations while it is active.

Constructor & Destructor Documentation

◆ TBulkDataScopedWriteLock()

template<typename ElementType >
TBulkDataScopedWriteLock< ElementType >::TBulkDataScopedWriteLock ( TBulkData< ElementType > &  InBulkData)
inline

◆ ~TBulkDataScopedWriteLock()

template<typename ElementType >
TBulkDataScopedWriteLock< ElementType >::~TBulkDataScopedWriteLock ( )
inline

Member Function Documentation

◆ GetAllocatedSize()

template<typename ElementType >
int64 TBulkDataScopedWriteLock< ElementType >::GetAllocatedSize ( ) const
inline

Returns the length of the bulkdata payload in bytes

◆ GetData()

template<typename ElementType >
ElementType * TBulkDataScopedWriteLock< ElementType >::GetData ( ) const
inline

Returns a raw pointer to the bulkdata payload

◆ GetView()

template<typename ElementType >
TArrayView64< ElementType > TBulkDataScopedWriteLock< ElementType >::GetView ( ) const
inline

Returns the bulkdata payload wrapped in a TArrayView64 for added safety

◆ Num()

template<typename ElementType >
int64 TBulkDataScopedWriteLock< ElementType >::Num ( ) const
inline

Returns the number of elements in the bulkdata payload

◆ UE_NONCOPYABLE()

template<typename ElementType >
TBulkDataScopedWriteLock< ElementType >::UE_NONCOPYABLE ( TBulkDataScopedWriteLock< ElementType >  )

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