1. Epic GamesDeveloper
  3. FNetBitStreamReader

FNetBitStreamReader

API > API/Runtime > API/Runtime/IrisCore

   
Name FNetBitStreamReader
Type class
Header File /Engine/Source/Runtime/Net/Iris/Public/Iris/Serialization/NetBitStreamReader.h
Include Path #include "Iris/Serialization/NetBitStreamReader.h"

Syntax

class FNetBitStreamReader

Constructors

Name Remarks Include Path Unreal Specifiers

FNetBitStreamReader()

   Iris/Serialization/NetBitStreamReader.h  

Destructors

Name Remarks Include Path Unreal Specifiers

~FNetBitStreamReader()

   Iris/Serialization/NetBitStreamReader.h  

Variables

Protected

Name Type Remarks Include Path Unreal Specifiers
bHasSubstream uint32   Iris/Serialization/NetBitStreamReader.h  
bIsInvalid uint32   Iris/Serialization/NetBitStreamReader.h  
bIsSubstream uint32   Iris/Serialization/NetBitStreamReader.h  
Buffer const uint32 *   Iris/Serialization/NetBitStreamReader.h  
BufferBitCapacity uint32 The BufferBitCapacity is an absolute bit position indicating the bit after the last valid bit position to read. Iris/Serialization/NetBitStreamReader.h  
BufferBitPosition uint32   Iris/Serialization/NetBitStreamReader.h  
BufferBitStartOffset uint32 For substreams this indicate the absolute bit position in the buffer where it will start reading. Iris/Serialization/NetBitStreamReader.h  
OverflowBitCount uint32   Iris/Serialization/NetBitStreamReader.h  
PendingWord uint32   Iris/Serialization/NetBitStreamReader.h  

Functions

Public

Name Remarks Include Path Unreal Specifiers

void CommitSubstream ( FNetBitStreamReader& Substream
)

 Commits a substream to this stream. Iris/Serialization/NetBitStreamReader.h  

FNetBitStreamReader CreateSubstream ( uint32 MaxBitCount
)

 Creates a substream at the current bit position. Iris/Serialization/NetBitStreamReader.h  

void DiscardSubstream ( FNetBitStreamReader& Substream
)

 Discards a substream of this stream. This stream's bit position will remain intact. Iris/Serialization/NetBitStreamReader.h  

void DoOverflow()

 Force an overflow. Iris/Serialization/NetBitStreamReader.h  

uint32 GetAbsolutePosBits()

 Returns the absolute bit position Iris/Serialization/NetBitStreamReader.h  

uint32 GetBitsLeft()

 Returns the number of bits that can be read before overflowing. Iris/Serialization/NetBitStreamReader.h  

uint32 GetPosBits()

 Returns the current bit position Iris/Serialization/NetBitStreamReader.h  

uint32 GetPosBytes()

 Returns the the current byte position. Iris/Serialization/NetBitStreamReader.h  

void InitBits ( const void* Buffer,
uint32 BitCount
)

 InitBits must be called before reading from the stream. Iris/Serialization/NetBitStreamReader.h  

bool IsOverflown()

 Returns whether the stream is overflown or not. Iris/Serialization/NetBitStreamReader.h  

uint32 ReadBits ( uint32 BitCount
)

 Reads BitCount bits that are stored in the least significant bits in the return value. Iris/Serialization/NetBitStreamReader.h  

void ReadBitStream ( uint32* Dst,
uint32 BitCount
)

 Reads BitCount bits and stores them in Dst, starting from bit offset 0. Iris/Serialization/NetBitStreamReader.h  

bool ReadBool()

 Reads a bool from the stream and returns the value, A failed read will always return false and stream will be marked as overflown Iris/Serialization/NetBitStreamReader.h  

void Seek ( uint32 BitPosition
)

 Seek to a specific position from the start of the stream or substream. Iris/Serialization/NetBitStreamReader.h  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page