UDocumentation UE5.7 10.02.2026 (Source)
API documentation for Unreal Engine 5.7
FBitArrayMemory Class Reference

#include <BitArray.h>

Static Public Member Functions

static CORE_API void MemmoveBitsWordOrder (uint32 *DestBits, int32 DestOffset, const uint32 *SourceBits, int32 SourceOffset, uint32 NumBits)
 
static void MemmoveBitsWordOrder (int32 *DestBits, int32 DestOffset, const int32 *SourceBits, int32 SourceOffset, uint32 NumBits)
 
static void ModularizeWordOffset (uint32 *&Data, int32 &Offset)
 
static void ModularizeWordOffset (uint32 const *&Data, int32 &Offset)
 

Friends

class FBitArrayMemoryTest
 

Member Function Documentation

◆ MemmoveBitsWordOrder() [1/2]

static void FBitArrayMemory::MemmoveBitsWordOrder ( int32 DestBits,
int32  DestOffset,
const int32 SourceBits,
int32  SourceOffset,
uint32  NumBits 
)
inlinestatic

◆ MemmoveBitsWordOrder() [2/2]

void FBitArrayMemory::MemmoveBitsWordOrder ( uint32 DestBits,
int32  DestOffset,
const uint32 SourceBits,
int32  SourceOffset,
uint32  NumBits 
)
static

Copy NumBits bits from the source pointer and offset into the dest pointer and offset. This function is not suitable for general use because it uses a bit order that is specific to the uint32 internal storage of BitArray

Bits within each word are read or written in the current platform's mathematical bitorder (Data[0] & 0x1, Data[0] & 0x2, ... Data[0] & 0x100, ... Data[0] & 0x80000000, Data[1] & 0x1 ... Correctly handles overlap between destination range and source range; the array of destination bits will be a copy of the source bits as they were before the copy started.

Parameters
DestBitsThe base location to which the bits are written.
DestOffsetThe (word-order) bit within DestBits at which to start writing. Can be any value; offsets outside of [0,NumBitsPerDWORD) will be equivalent to modifying the DestBits pointer.
SourceBitsThe base location from which the bits are read.
SourceOffsetThe (word-order) bit within SourceBits at which to start reading. Can be any value; offsets outside of [0,NumBitsPerDWORD) will be equivalent to modifying the SourceBits pointer.
NumBitsNumber of bits to copy. Must be >= 0.

◆ ModularizeWordOffset() [1/2]

static void FBitArrayMemory::ModularizeWordOffset ( uint32 *&  Data,
int32 Offset 
)
inlinestatic

Given Data and Offset that specify a specific bit in a specific word, modify Data and Offset so that they specify the same bit but that 0 <= Offset < NumBitsPerDWORD.

◆ ModularizeWordOffset() [2/2]

void FBitArrayMemory::ModularizeWordOffset ( uint32 const *&  Data,
int32 Offset 
)
static

Given Data and Offset that specify a specific bit in a specific word, modify Data and Offset so that they specify the same bit but that 0 <= Offset < NumBitsPerDWORD.

Friends And Related Symbol Documentation

◆ FBitArrayMemoryTest

friend class FBitArrayMemoryTest
friend

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