FBitReader

Reads bitstreams.

Choose your operating system:

Windows

macOS

Linux

Inheritance Hierarchy

References

Module

Core

Header

/Engine/Source/Runtime/Core/Public/Serialization/BitReader.h

Include

#include "Serialization/BitReader.h"

Syntax

struct FBitReader : public FBitArchive

Remarks

Reads bitstreams.

Variables

Name Description

Protected variable

TArray< uint8 >

 

Buffer

Protected variable

int64

 

Num

Protected variable

int64

 

Pos

Constructors

Name Description

Public function

FBitReader

(
    const FBitReader&
)

Public function

FBitReader

(
    FBitReader&&
)

Public function

FBitReader

(
    uint8* Src,
    int64 CountBits
)

Functions

Name Description

Public function

void

 

AppendDataFromChecked

(
    uint8* Src,
    uint32 NumBits
)

This appends data from another BitReader.

Public function

void

 

AppendDataFromChecked

(
    FBitReader& Src
)

This appends data from another BitReader.

Public function

void

 

AppendTo

(
    TArray< uint8 >& Buffer
)

Public function Virtual Const

void

 

CountMemory

(
    FArchive& Ar
)

Counts the in-memory bytes used by this object

Public function

void

 

EatByteAlign()

Public function Const

int64

 

GetBitsLeft()

Public function Const

const TArray...

 

GetBuffer()

Public function Const

int64

 

GetBytesLeft()

Public function Const

const uint8 ...

 

GetData()

Public function

uint8 *

 

GetData()

Public function

uint8 *

 

GetDataPosChecked()

Public function Const

int64

 

GetNumBits()

Public function Const

int64

 

GetNumBytes()

Public function Const

int64

 

GetPosBits()

Public function

uint8

 

ReadBit()

Public function

uint32

 

ReadInt

(
    uint32 Max
)

Public function

void

 

SetAtEnd()

Set the stream at the end

Public function

void

 

SetData

(
    uint8* Src,
    int64 CountBits
)

Public function

void

 

SetData

(
    FBitReader& Src,
    int64 CountBits
)

Public function

void

 

SetData

(
    TArray< uint8 >&& Src,
    int64 CountBits
)

Public function

void

 

SetOverflowed

(
    int64 LengthBits
)

Marks this bit reader as overflowed.

Overridden from FBitArchive

Name Description

Public function Virtual

void

 

SerializeBitsWithOffset

(
    void* Dest,
    int32 DestBit,
    int64 LengthBits
)

Overridden from FArchive

Name Description

Public function Virtual

void

 

Serialize

(
    void* Dest,
    int64 LengthBytes
)

Public function Virtual

void

 

SerializeBits

(
    void* Dest,
    int64 LengthBits
)

Public function Virtual

void

 

SerializeInt

(
    uint32& OutValue,
    uint32 ValueMax
)

OutValue < ValueMax.

Public function Virtual

void

 

SerializeIntPacked

(
    uint32& Value
)

Packs int value into bytes of 7 bits with 8th bit for 'more'

Overridden from FArchiveState

Name Description

Public function Virtual

bool

 

AtEnd()

Returns true if the current location within the backing data storage is at the end, always returns false if there is no storage.

Operators

Name Description

Public function

FBitReader &

 

operator=

(
    FBitReader&&
)

Public function

FBitReader &

 

operator=

(
    const FBitReader&
)