UDocumentation UE5.7 10.02.2026 (Source)
API documentation for Unreal Engine 5.7
FStructTypeBitSet::FBitSetContainer Struct Reference

#include <StructTypeBitSet.h>

+ Inheritance diagram for FStructTypeBitSet::FBitSetContainer:

Public Member Functions

 FBitSetContainer ()=default
 
 FBitSetContainer (const TBitArray<> &Source)
 
 FBitSetContainer (TBitArray<> &&Source)
 
FBitSetContaineroperator= (const TBitArray<> &Other)
 
void SetAll (const bool bValue, const int32 Count)
 
void operator-= (const TBitArray<> &Other)
 
void AddAtIndex (const int32 Index)
 
void RemoveAtIndex (const int32 Index)
 
 FConstBitSetContainer ()=default
 
 FConstBitSetContainer (const TBitArray<> &Source)
 
 FConstBitSetContainer (TBitArray<> &&Source)
 
- Public Member Functions inherited from FStructTypeBitSet::FConstBitSetContainer
 FConstBitSetContainer ()=default
 
bool HasAll (const TBitArray<> &Other) const
 
bool HasAny (const TBitArray<> &Other) const
 
bool IsEmpty () const
 
bool operator== (const FConstBitSetContainer &Other) const
 
bool Contains (const int32 Index) const
 
int32 CountStoredTypes () const
 
- Public Member Functions inherited from TBitArray<>
constexpr TBitArray ()
 
consteval TBitArray (EConstEval)
 
UE_FORCEINLINE_HINT TBitArray (bool bValue, int32 InNumBits)
 
UE_FORCEINLINE_HINT TBitArray (TBitArray &&Other)
 
UE_FORCEINLINE_HINT TBitArray (const TBitArray &Copy)
 
UE_FORCEINLINE_HINT TBitArray (const TBitArray< OtherAllocator > &Copy)
 
UE_FORCEINLINE_HINT TBitArrayoperator= (TBitArray &&Other)
 
UE_FORCEINLINE_HINT TBitArrayoperator= (const TBitArray &Copy)
 
UE_FORCEINLINE_HINT TBitArrayoperator= (const TBitArray< OtherAllocator > &Copy)
 
UE_FORCEINLINE_HINT bool operator== (const TBitArray< Allocator > &Other) const
 
UE_FORCEINLINE_HINT bool operator< (const TBitArray< Allocator > &Other) const
 
UE_FORCEINLINE_HINT bool operator!= (const TBitArray< Allocator > &Other) const
 
void CheckInvariants () const
 
void Serialize (FArchive &Ar)
 
int32 Add (const bool Value)
 
int32 Add (const bool Value, int32 NumBitsToAdd)
 
int32 AddRange (const InWordType *ReadBits, int32 NumBitsToAdd, int32 ReadOffsetBits=0)
 
int32 AddRange (const TBitArray< OtherAllocator > &ReadBits, int32 NumBitsToAdd, int32 ReadOffsetBits=0)
 
int32 AddUninitialized (int32 NumBitsToAdd)
 
void Insert (bool Value, int32 Index)
 
void Insert (bool Value, int32 Index, int32 NumBitsToAdd)
 
void InsertRange (const InWordType *ReadBits, int32 Index, int32 NumBitsToAdd, int32 ReadOffsetBits=0)
 
void InsertRange (const TBitArray< OtherAllocator > &ReadBits, int32 Index, int32 NumBitsToAdd, int32 ReadOffsetBits=0)
 
void InsertUninitialized (int32 Index, int32 NumBitsToAdd)
 
void Empty (int32 ExpectedNumBits=0)
 
void Reserve (int32 Number)
 
void Reset ()
 
UE_FORCEINLINE_HINT void Init (bool bValue, int32 InNumBits)
 
void SetNumUninitialized (int32 InNumBits)
 
FORCENOINLINE void SetNum (int32 InNumBits, ValueType bValue)
 
FORCENOINLINE void SetRange (int32 Index, int32 NumBitsToSet, bool Value)
 
void SetRangeFromRange (int32 Index, int32 NumBitsToSet, const InWordType *ReadBits, int32 ReadOffsetBits=0)
 
UE_FORCEINLINE_HINT void SetRangeFromRange (int32 Index, int32 NumBitsToSet, const TBitArray< OtherAllocator > &ReadBits, int32 ReadOffsetBits=0)
 
UE_FORCEINLINE_HINT void GetRange (int32 Index, int32 NumBitsToGet, InWordType *WriteBits, int32 WriteOffsetBits=0) const
 
void RemoveAt (int32 BaseIndex, int32 NumBitsToRemove=1)
 
void RemoveAtSwap (int32 BaseIndex, int32 NumBitsToRemove=1)
 
uint32 GetAllocatedSize (void) const
 
void CountBytes (FArchive &Ar) const
 
int32 Find (bool bValue) const
 
UE_FORCEINLINE_HINT int32 FindFrom (bool bValue, IndexType StartIndex) const
 
UE_FORCEINLINE_HINT int32 FindFrom (bool bValue, IndexType StartIndex, IndexType EndIndexExclusive) const
 
int32 FindLast (bool bValue) const
 
int32 FindLastFrom (bool bValue, IndexType EndIndexInclusive) const
 
UE_FORCEINLINE_HINT bool Contains (bool bValue) const
 
int32 FindAndSetFirstZeroBit (int32 StartIndex=0)
 
int32 FindAndSetLastZeroBit ()
 
TBitArrayCombineWithBinaryOp (const TBitArray< OtherAllocator > &InOther, EBitwiseOperatorFlags InFlags, BinaryOpType &&InBinaryOp)
 
TBitArrayCombineWithBitwiseAND (const TBitArray< OtherAllocator > &InOther, EBitwiseOperatorFlags InFlags)
 
TBitArrayCombineWithBitwiseOR (const TBitArray< OtherAllocator > &InOther, EBitwiseOperatorFlags InFlags)
 
TBitArrayCombineWithBitwiseXOR (const TBitArray< OtherAllocator > &InOther, EBitwiseOperatorFlags InFlags)
 
void BitwiseNOT ()
 
int32 CountSetBits (int32 FromIndex=0, int32 ToIndex=INDEX_NONE) const
 
bool CompareSetBits (const TBitArray< OtherAllocator > &Other, const bool bMissingBitValue) const
 
int32 PadToNum (int32 DesiredNum, bool bPadValue)
 
UE_FORCEINLINE_HINT bool IsValidIndex (int32 InIndex) const
 
bool IsEmpty () const
 
UE_FORCEINLINE_HINT int32 Num () const
 
UE_FORCEINLINE_HINT int32 Max () const
 
UE_FORCEINLINE_HINT FBitReference operator[] (int32 Index)
 
UE_FORCEINLINE_HINT const FConstBitReference operator[] (int32 Index) const
 
UE_FORCEINLINE_HINT FBitReference AccessCorrespondingBit (const FRelativeBitReference &RelativeReference)
 
UE_FORCEINLINE_HINT const FConstBitReference AccessCorrespondingBit (const FRelativeBitReference &RelativeReference) const
 
UE_FORCEINLINE_HINT const uint32GetData () const
 
UE_FORCEINLINE_HINT uint32GetData ()
 
UE_FORCEINLINE_HINT FIterator begin ()
 
UE_FORCEINLINE_HINT FConstIterator begin () const
 
UE_FORCEINLINE_HINT FIterator end ()
 
UE_FORCEINLINE_HINT FConstIterator end () const
 
UE_FORCEINLINE_HINT FReverseIterator rbegin ()
 
UE_FORCEINLINE_HINT FConstReverseIterator rbegin () const
 
UE_FORCEINLINE_HINT FReverseIterator rend ()
 
UE_FORCEINLINE_HINT FConstReverseIterator rend () const
 
void WriteMemoryImage (FMemoryImageWriter &Writer) const
 

Protected Member Functions

void SetBitNoCheck (const int32 Index, const bool Value)
 
- Protected Member Functions inherited from FStructTypeBitSet::FConstBitSetContainer
 FConstBitSetContainer (const TBitArray<> &Source)
 
 FConstBitSetContainer (TBitArray<> &&Source)
 

Additional Inherited Members

- Public Types inherited from FStructTypeBitSet::FConstBitSetContainer
using Super = TBitArray<>
 
- Public Types inherited from TBitArray<>
typedef Allocator::template ForElementType< uint32AllocatorType
 
- Static Public Member Functions inherited from TBitArray<>
static TBitArray BitwiseAND (const TBitArray< AllocatorA > &A, const TBitArray< AllocatorB > &B, EBitwiseOperatorFlags InFlags)
 
static TBitArray BitwiseOR (const TBitArray< AllocatorA > &A, const TBitArray< AllocatorB > &B, EBitwiseOperatorFlags InFlags)
 
static TBitArray BitwiseXOR (const TBitArray< AllocatorA > &A, const TBitArray< AllocatorB > &B, EBitwiseOperatorFlags InFlags)
 

Detailed Description

A mutable extension of FConstBitSetContainer, adding methods for modifying bits

Constructor & Destructor Documentation

◆ FBitSetContainer() [1/3]

FStructTypeBitSet::FBitSetContainer::FBitSetContainer ( )
default

◆ FBitSetContainer() [2/3]

FStructTypeBitSet::FBitSetContainer::FBitSetContainer ( const TBitArray<> &  Source)
inlineexplicit

◆ FBitSetContainer() [3/3]

FStructTypeBitSet::FBitSetContainer::FBitSetContainer ( TBitArray<> &&  Source)
inlineexplicit

Member Function Documentation

◆ AddAtIndex()

void FStructTypeBitSet::FBitSetContainer::AddAtIndex ( const int32  Index)
inline

Adds a bit at the specified index

Parameters
Index- The index of the bit to add

◆ FConstBitSetContainer() [1/3]

FStructTypeBitSet::FConstBitSetContainer::FConstBitSetContainer ( )
default

◆ FConstBitSetContainer() [2/3]

FStructTypeBitSet::FConstBitSetContainer::FConstBitSetContainer ( const TBitArray<> &  Source)
inlineexplicit

Copy-constructor for creating a bitset from another bit array

Parameters
Source- The source bit array

◆ FConstBitSetContainer() [3/3]

FStructTypeBitSet::FConstBitSetContainer::FConstBitSetContainer ( TBitArray<> &&  Source)
inlineexplicit

Move-constructor for creating a bitset from another bit array

Parameters
Source- The source bit array to move from

◆ operator-=()

void FStructTypeBitSet::FBitSetContainer::operator-= ( const TBitArray<> &  Other)
inline

Removes bits set in the Other bit array from this bitset

Parameters
Other- The bit array to remove

◆ operator=()

FBitSetContainer & FStructTypeBitSet::FBitSetContainer::operator= ( const TBitArray<> &  Other)
inline

◆ RemoveAtIndex()

void FStructTypeBitSet::FBitSetContainer::RemoveAtIndex ( const int32  Index)
inline

Removes a bit at the specified index

Parameters
Index- The index of the bit to remove

◆ SetAll()

void FStructTypeBitSet::FBitSetContainer::SetAll ( const bool  bValue,
const int32  Count 
)
inline

Initializes the bitset to a specified size and value

Parameters
bValue- The value to set all bits to
Count- The number of bits to initialize

◆ SetBitNoCheck()

void FStructTypeBitSet::FBitSetContainer::SetBitNoCheck ( const int32  Index,
const bool  Value 
)
inlineprotected

Directly sets a bit without boundary checks for improved performance.

Parameters
Index- The index of the bit to set.
Value- The value to set the bit to.

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