UDocumentation UE5.7 10.02.2026 (Source)
API documentation for Unreal Engine 5.7
Classes | Public Member Functions | Static Public Member Functions | Static Public Attributes | Friends | List of all members
TStaticBitArray< NumBits > Class Template Reference

#include <StaticBitArray.h>

Public Member Functions

UE_FORCEINLINE_HINT TStaticBitArray ()
 
UE_FORCEINLINE_HINT TStaticBitArray (UnspecifiedZeroType)
 
 TStaticBitArray (bool, uint32 InBitIndex)
 
 TStaticBitArray (const FString &Str)
 
bool HasAnyBitsSet () const
 
UE_FORCEINLINE_HINT operator bool () const
 
TStaticBitReference< WordType > operator[] (int32 Index)
 
const TConstStaticBitReference< WordType > operator[] (int32 Index) const
 
TStaticBitArray & operator|= (const TStaticBitArray &Other)
 
TStaticBitArray & operator&= (const TStaticBitArray &Other)
 
TStaticBitArray & operator^= (const TStaticBitArray &Other)
 
bool operator== (const TStaticBitArray< NumBits > &B) const
 
UE_FORCEINLINE_HINT bool operator!= (const TStaticBitArray< NumBits > &B) const
 
int32 FindFirstClearBit () const
 
int32 FindFirstSetBit () const
 
FString ToString () const
 
void Serialize (FArchive &Ar)
 
void Fill (bool Value)
 

Static Public Member Functions

static UE_FORCEINLINE_HINT int32 Num ()
 

Static Public Attributes

static constexpr uint32 NumOfBits = NumBits
 

Friends

TStaticBitArray< NumBits > operator~ (const TStaticBitArray< NumBits > &A)
 
TStaticBitArray< NumBits > operator| (const TStaticBitArray< NumBits > &A, const TStaticBitArray< NumBits > &B)
 
TStaticBitArray< NumBits > operator& (const TStaticBitArray< NumBits > &A, const TStaticBitArray< NumBits > &B)
 
TStaticBitArray< NumBits > operator^ (const TStaticBitArray< NumBits > &A, const TStaticBitArray< NumBits > &B)
 
UE_FORCEINLINE_HINT bool operator== (const TStaticBitArray< NumBits > &A, UnspecifiedBoolType Value)
 
UE_FORCEINLINE_HINT bool operator!= (const TStaticBitArray< NumBits > &A, UnspecifiedBoolType Value)
 

Detailed Description

template<uint32 NumBits>
class TStaticBitArray< NumBits >

A statically sized bit array.

Constructor & Destructor Documentation

◆ TStaticBitArray() [1/4]

template<uint32 NumBits>
UE_FORCEINLINE_HINT TStaticBitArray< NumBits >::TStaticBitArray ( )
inline

Minimal initialization constructor

◆ TStaticBitArray() [2/4]

template<uint32 NumBits>
UE_FORCEINLINE_HINT TStaticBitArray< NumBits >::TStaticBitArray ( UnspecifiedZeroType  )
inline

Constructor that allows initializing by assignment from 0

◆ TStaticBitArray() [3/4]

template<uint32 NumBits>
TStaticBitArray< NumBits >::TStaticBitArray ( bool  ,
uint32  InBitIndex 
)
inline

Constructor to initialize to a single bit

◆ TStaticBitArray() [4/4]

template<uint32 NumBits>
TStaticBitArray< NumBits >::TStaticBitArray ( const FString &  Str)
inlineexplicit

Constructor to initialize from string

Member Function Documentation

◆ Fill()

template<uint32 NumBits>
void TStaticBitArray< NumBits >::Fill ( bool  Value)
inline

Fills the entire bit array with zeros or ones.

◆ FindFirstClearBit()

template<uint32 NumBits>
int32 TStaticBitArray< NumBits >::FindFirstClearBit ( ) const
inline

Finds the first clear bit in the array and returns the bit index. If there isn't one, INDEX_NONE is returned.

◆ FindFirstSetBit()

template<uint32 NumBits>
int32 TStaticBitArray< NumBits >::FindFirstSetBit ( ) const
inline

Finds the first set bit in the array and returns it's index. If there isn't one, INDEX_NONE is returned.

◆ HasAnyBitsSet()

template<uint32 NumBits>
bool TStaticBitArray< NumBits >::HasAnyBitsSet ( ) const
inline

◆ Num()

template<uint32 NumBits>
static UE_FORCEINLINE_HINT int32 TStaticBitArray< NumBits >::Num ( )
inlinestatic

◆ operator bool()

template<uint32 NumBits>
UE_FORCEINLINE_HINT TStaticBitArray< NumBits >::operator bool ( ) const
inlineexplicit

◆ operator!=()

template<uint32 NumBits>
UE_FORCEINLINE_HINT bool TStaticBitArray< NumBits >::operator!= ( const TStaticBitArray< NumBits > &  B) const
inline

!= simple maps to ==

◆ operator&=()

template<uint32 NumBits>
TStaticBitArray & TStaticBitArray< NumBits >::operator&= ( const TStaticBitArray< NumBits > &  Other)
inline

◆ operator==()

template<uint32 NumBits>
bool TStaticBitArray< NumBits >::operator== ( const TStaticBitArray< NumBits > &  B) const
inline

◆ operator[]() [1/2]

template<uint32 NumBits>
TStaticBitReference< WordType > TStaticBitArray< NumBits >::operator[] ( int32  Index)
inline

◆ operator[]() [2/2]

template<uint32 NumBits>
const TConstStaticBitReference< WordType > TStaticBitArray< NumBits >::operator[] ( int32  Index) const
inline

◆ operator^=()

template<uint32 NumBits>
TStaticBitArray & TStaticBitArray< NumBits >::operator^= ( const TStaticBitArray< NumBits > &  Other)
inline

◆ operator|=()

template<uint32 NumBits>
TStaticBitArray & TStaticBitArray< NumBits >::operator|= ( const TStaticBitArray< NumBits > &  Other)
inline

◆ Serialize()

template<uint32 NumBits>
void TStaticBitArray< NumBits >::Serialize ( FArchive &  Ar)
inline

◆ ToString()

template<uint32 NumBits>
FString TStaticBitArray< NumBits >::ToString ( ) const
inline

Converts the bitarray to a string representing the binary representation of the array

Friends And Related Symbol Documentation

◆ operator!=

template<uint32 NumBits>
UE_FORCEINLINE_HINT bool operator!= ( const TStaticBitArray< NumBits > &  A,
UnspecifiedBoolType  Value 
)
friend

!= simple maps to ==

◆ operator&

template<uint32 NumBits>
TStaticBitArray< NumBits > operator& ( const TStaticBitArray< NumBits > &  A,
const TStaticBitArray< NumBits > &  B 
)
friend

◆ operator==

template<uint32 NumBits>
UE_FORCEINLINE_HINT bool operator== ( const TStaticBitArray< NumBits > &  A,
UnspecifiedBoolType  Value 
)
friend

This operator only exists to disambiguate == in statements of the form (flags == 0)

◆ operator^

template<uint32 NumBits>
TStaticBitArray< NumBits > operator^ ( const TStaticBitArray< NumBits > &  A,
const TStaticBitArray< NumBits > &  B 
)
friend

◆ operator|

template<uint32 NumBits>
TStaticBitArray< NumBits > operator| ( const TStaticBitArray< NumBits > &  A,
const TStaticBitArray< NumBits > &  B 
)
friend

◆ operator~

template<uint32 NumBits>
TStaticBitArray< NumBits > operator~ ( const TStaticBitArray< NumBits > &  A)
friend

Member Data Documentation

◆ NumOfBits

template<uint32 NumBits>
constexpr uint32 TStaticBitArray< NumBits >::NumOfBits = NumBits
staticconstexpr
The documentation for this class was generated from the following file: