FBitArrayMemory::MemmoveBitsWordOrder

Copy NumBits bits from the source pointer and offset into the dest pointer and offset.

Windows
MacOS
Linux

References

Module

Core

Header

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

Include

#include "Containers/BitArray.h"

Syntax

static void MemmoveBitsWordOrder
(
    int32 * DestBits,
    int32 DestOffset,
    const int32 * SourceBits,
    int32 SourceOffset,
    uint32 NumBits
)

Remarks

Copy NumBits bits from the source pointer and offset into the dest pointer and offset. This function is not suitable for general use because it uses a bit order that is specific to the uint32 internal storage of BitArray

Bits within each word are read or written in the current platform's mathematical bitorder (Data[0] & 0x1, Data[0] & 0x2, ... Data[0] & 0x100, ... Data[0] & 0x80000000, Data[1] & 0x1 ... Correctly handles overlap between destination range and source range; the array of destination bits will be a copy of the source bits as they were before the copy started.

Parameters

Parameter

Description

DestBits

The base location to which the bits are written.

DestOffset

The (word-order) bit within DestBits at which to start writing. Can be any value; offsets outside of [0,NumBitsPerDWORD) will be equivalent to modifying the DestBits pointer.

SourceBits

The base location from which the bits are read.

SourceOffset

The (word-order) bit within SourceBits at which to start reading. Can be any value; offsets outside of [0,NumBitsPerDWORD) will be equivalent to modifying the SourceBits pointer.

NumBits

Number of bits to copy. Must be >= 0.

Help shape the future of Unreal Engine documentation! Tell us how we're doing so we can serve you better.
Take our survey
Dismiss