TBitArray::GetRange

Reads a range of bits within the array and writes them to the given pointer.

Choose your operating system:

Windows

macOS

Linux

References

Module

Core

Header

/Engine/Source/Runtime/Core/Public/Containers/BitArray.h

Include

#include "Containers/BitArray.h"

Syntax

template<typename InWordType>
void GetRange
(
    int32 Index,
    int32 NumBitsToGet,
    InWordType * WriteBits,
    int32 WriteOffsetBits
) const

Remarks

Reads a range of bits within the array and writes them to the given pointer.

Parameters

Parameter

Description

Index

The index of the first bit to read; must be 0 <= Index <= Num().

NumBitsToGet

The number of bits to read, must satisify 0 <= NumBitsToGet && Index + NumBitsToGet <= Num().

WriteBits

The address of sized integers to write the bits to. Bits are written into WriteBits in the current platform's mathematical bitorder (WriteBits[0] & 0x1, WriteBits[0] & 0x2, ... WriteBits[0] & 0x100, ... WriteBits[0] & 0x80000000, WriteBits[1] & 0x1 ...

WriteOffsetBits

Number of bits into WriteBits at which to start writing.