UDocumentation UE5.7 10.02.2026 (Source)
API documentation for Unreal Engine 5.7
UE::MovieScene::TDynamicSparseBitSet< HashType, BucketStorage > Struct Template Reference

#include <SparseBitSet.h>

Classes

struct  FIterator
 

Public Member Functions

uint32 GetMaxNumBits () const
 
ESparseBitSetBitResult SetBit (uint32 Bit)
 
bool IsEmpty () const
 
bool IsBitSet (uint32 Bit) const
 
uint32 CountSetBits () const
 
TDynamicSparseBitSet< HashType, BucketStorage > & operator|= (const TDynamicSparseBitSet< HashType, BucketStorage > &Other)
 

Public Attributes

TArray< FEntry > Entries
 

Friends

FIterator begin (const TDynamicSparseBitSet< HashType, BucketStorage > &In)
 
FIterator end (const TDynamicSparseBitSet< HashType, BucketStorage > &In)
 

Detailed Description

template<typename HashType, typename BucketStorage>
struct UE::MovieScene::TDynamicSparseBitSet< HashType, BucketStorage >

NOTE: This class is currently considered internal only, and should only be used by engine code. A dynamically sized sparse bitset comprising multiple TFixedSparseBitSets.

In theory this class supports the full integer range, it is optimized for small numbers of set bits within a large range, ideally when they occupy the same adjacent space.

Member Function Documentation

◆ CountSetBits()

template<typename HashType , typename BucketStorage >
uint32 UE::MovieScene::TDynamicSparseBitSet< HashType, BucketStorage >::CountSetBits ( ) const
inline

Count the total number of set bits in this container

◆ GetMaxNumBits()

template<typename HashType , typename BucketStorage >
uint32 UE::MovieScene::TDynamicSparseBitSet< HashType, BucketStorage >::GetMaxNumBits ( ) const
inline

Get the maximum number of bits that this bitset supports

◆ IsBitSet()

template<typename HashType , typename BucketStorage >
bool UE::MovieScene::TDynamicSparseBitSet< HashType, BucketStorage >::IsBitSet ( uint32  Bit) const
inline

Check whether the specified bit index is set

◆ IsEmpty()

template<typename HashType , typename BucketStorage >
bool UE::MovieScene::TDynamicSparseBitSet< HashType, BucketStorage >::IsEmpty ( ) const
inline

Check whether this container has any bits set

◆ operator|=()

template<typename HashType , typename BucketStorage >
TDynamicSparseBitSet< HashType, BucketStorage > & UE::MovieScene::TDynamicSparseBitSet< HashType, BucketStorage >::operator|= ( const TDynamicSparseBitSet< HashType, BucketStorage > &  Other)
inline

◆ SetBit()

Set the bit at the specified index. Any bits between Num and BitIndex will be considered 0.

Returns
true if the bit was previously considered 0 and is now set, false if it was already set.

Friends And Related Symbol Documentation

◆ begin

template<typename HashType , typename BucketStorage >
FIterator begin ( const TDynamicSparseBitSet< HashType, BucketStorage > &  In)
friend

◆ end

template<typename HashType , typename BucketStorage >
FIterator end ( const TDynamicSparseBitSet< HashType, BucketStorage > &  In)
friend

Member Data Documentation

◆ Entries

template<typename HashType , typename BucketStorage >
TArray<FEntry> UE::MovieScene::TDynamicSparseBitSet< HashType, BucketStorage >::Entries

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