Navigation
API > API/Runtime > API/Runtime/Core
A statically sized bit array.
| Name | TStaticBitArray |
| Type | class |
| Header File | /Engine/Source/Runtime/Core/Public/Containers/StaticBitArray.h |
| Include Path | #include "Containers/StaticBitArray.h" |
Syntax
template<uint32 NumBits>
class TStaticBitArray
Constructors
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
TStaticBitArray
(
const FString& Str |
Constructor to initialize from string | Containers/StaticBitArray.h | |
| Minimal initialization constructor | Containers/StaticBitArray.h | ||
TStaticBitArray
(
UnspecifiedZeroType |
Constructor that allows initializing by assignment from 0 | Containers/StaticBitArray.h | |
TStaticBitArray
(
bool, |
Constructor to initialize to a single bit | Containers/StaticBitArray.h |
Structs
| Name | Remarks |
|---|---|
| FBoolType | Helper class for bool conversion. |
Typedefs
| Name | Type | Remarks | Include Path |
|---|---|---|---|
| UnspecifiedBoolType | int32 *FBoolType::* | Containers/StaticBitArray.h | |
| UnspecifiedZeroType | float *FBoolType::* | Containers/StaticBitArray.h | |
| WordType | uint64 | Containers/StaticBitArray.h |
Constants
| Name | Type | Remarks | Include Path |
|---|---|---|---|
| NumBitsPerWord | uint32 | Containers/StaticBitArray.h | |
| NumBitsPerWordLog2 | uint32 | Containers/StaticBitArray.h | |
| NumOfBits | uint32 | Containers/StaticBitArray.h | |
| NumWords | uint32 | Containers/StaticBitArray.h |
Variables
Protected
| Name | Type | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|---|
| Words | WordType | Containers/StaticBitArray.h |
Functions
Public
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
void Fill
(
bool Value |
Fills the entire bit array with zeros or ones. | Containers/StaticBitArray.h | |
int32 FindFirstClearBit () |
Finds the first clear bit in the array and returns the bit index. | Containers/StaticBitArray.h | |
int32 FindFirstSetBit () |
Finds the first set bit in the array and returns it's index. | Containers/StaticBitArray.h | |
bool HasAnyBitsSet() |
Containers/StaticBitArray.h | ||
void Serialize
(
FArchive& Ar |
Containers/StaticBitArray.h | ||
FString ToString() |
Converts the bitarray to a string representing the binary representation of the array | Containers/StaticBitArray.h |
Static
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
static int32 Num() |
Accessors. | Containers/StaticBitArray.h |
Operators
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
operator bool() |
Explicit conversion to bool. | Containers/StaticBitArray.h | |
bool operator!=
(
const TStaticBitArray< NumBits >& B |
!= simple maps to == | Containers/StaticBitArray.h | |
TStaticBitArray & operator&=
(
const TStaticBitArray& Other |
Containers/StaticBitArray.h | ||
const TConstStaticBitReference< WordType > operator[]
(
int32 Index |
Containers/StaticBitArray.h | ||
TStaticBitReference< WordType > operator[]
(
int32 Index |
Containers/StaticBitArray.h | ||
TStaticBitArray & operator^=
(
const TStaticBitArray& Other |
Containers/StaticBitArray.h | ||
TStaticBitArray & operator|=
(
const TStaticBitArray& Other |
Modifiers. | Containers/StaticBitArray.h | |
bool operator==
(
const TStaticBitArray< NumBits >& B |
Containers/StaticBitArray.h |