1. Epic GamesDeveloper
  3. FBitReader

FBitReader

Reads bitstreams.

API > API/Runtime > API/Runtime/Core

Reads bitstreams.

   
Name FBitReader
Type struct
Header File /Engine/Source/Runtime/Core/Public/Serialization/BitReader.h
Include Path #include "Serialization/BitReader.h"

Syntax

struct FBitReader : public FBitArchive

Inheritance Hierarchy

Derived Classes

Constructors

Name Remarks Include Path Unreal Specifiers

FBitReader ( const uint8* Src,
int64 CountBits
)

   Serialization/BitReader.h  
  Serialization/BitReader.h  

FBitReader ( const FBitReader&
)

   Serialization/BitReader.h  

Destructors

Name Remarks Include Path Unreal Specifiers

~FBitReader()

   Serialization/BitReader.h  

Functions

Public

Name Remarks Include Path Unreal Specifiers
This appends data from another BitReader. Serialization/BitReader.h  

void AppendDataFromChecked ( uint8* Src,
uint32 NumBits
)

   Serialization/BitReader.h  

void AppendTo ( TArray< uint8 >& Buffer
)

   Serialization/BitReader.h  

virtual void CountMemory ( FArchive& Ar
) const

 Counts the in-memory bytes used by this object Serialization/BitReader.h  

void EatByteAlign()

   Serialization/BitReader.h  

int64 GetBitsLeft()

   Serialization/BitReader.h  

const TArray< uint8 > & GetBuffer()

   Serialization/BitReader.h  

int64 GetBytesLeft()

   Serialization/BitReader.h  

uint8 * GetData ()

   Serialization/BitReader.h  

const uint8 * GetData ()

   Serialization/BitReader.h  

uint8 * GetDataPosChecked()

   Serialization/BitReader.h  

int64 GetNumBits()

   Serialization/BitReader.h  

int64 GetNumBytes()

   Serialization/BitReader.h  

int64 GetPosBits()

   Serialization/BitReader.h  

uint8 ReadBit()

   Serialization/BitReader.h  

uint32 ReadInt ( uint32 Max
)

   Serialization/BitReader.h  

void ResetData ( FBitReader& Src,
int64 CountBits,
int64 CountBitsWithSlack
)

 Equivalent to SetData (reset position, copy from Src into internal buffer), but uses Reset not Empty to avoid a realloc if possible. Serialization/BitReader.h  

void SetAtEnd()

 Set the stream at the end Serialization/BitReader.h  

void SetData ( uint8* Src,
int64 CountBits
)

   Serialization/BitReader.h  

void SetData ( FBitReader& Src,
int64 CountBits
)

   Serialization/BitReader.h  

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

   Serialization/BitReader.h  

void SetOverflowed ( int64 LengthBits
)

 Marks this bit reader as overflowed. Serialization/BitReader.h  

void Skip ( int32 BitCount
)

   Serialization/BitReader.h  

Overridden from FBitArchive

Name Remarks Include Path Unreal Specifiers

virtual void SerializeBitsWithOffset ( void* Dest,
int32 DestBit,
int64 LengthBits
)

   Serialization/BitReader.h  

Overridden from FArchive

Name Remarks Include Path Unreal Specifiers

virtual void Serialize ( void* Dest,
int64 LengthBytes
)

   Serialization/BitReader.h  

virtual void SerializeBits ( void* Dest,
int64 LengthBits
)

 Disable false positive buffer overrun warning during pgoprofile linking step. Serialization/BitReader.h  

virtual void SerializeInt ( uint32& OutValue,
uint32 ValueMax
)

 OutValue < ValueMax. Serialization/BitReader.h  

virtual void SerializeIntPacked ( uint32& Value
)

 Packs int value into bytes of 7 bits with 8th bit for 'more' Serialization/BitReader.h  

Overridden from FArchiveState

Name Remarks Include Path Unreal Specifiers

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. Serialization/BitReader.h  

Protected

Name Remarks Include Path Unreal Specifiers

void SetNetVersionsFromArchive ( FArchive& Source
)

 Copies version information used for network compatibility from Source to this archive Serialization/BitReader.h  

Operators

Name Remarks Include Path Unreal Specifiers
  Serialization/BitReader.h  
  Serialization/BitReader.h  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page