Urho3D
Public Member Functions | Protected Attributes | List of all members
Urho3D::Deserializer Class Referenceabstract

Abstract stream for reading. @nocount. More...

#include </home/runner/work/urho3d-doxygen.github.io/urho3d-doxygen.github.io/urho3d_repo/Source/Urho3D/IO/Deserializer.h>

Inheritance diagram for Urho3D::Deserializer:
Urho3D::AbstractFile Urho3D::HttpRequest Urho3D::File Urho3D::MemoryBuffer Urho3D::NamedPipe Urho3D::VectorBuffer

Public Member Functions

 Deserializer ()
 Construct with zero size.
 
 Deserializer (i64 size)
 Construct with defined size.
 
virtual ~Deserializer ()
 Destruct.
 
virtual i32 Read (void *dest, i32 size)=0
 Read bytes from the stream. Return number of bytes actually read. More...
 
virtual i64 Seek (i64 position)=0
 Set position from the beginning of the stream. Return actual new position. More...
 
virtual const StringGetName () const
 Return name of the stream. More...
 
virtual hash32 GetChecksum ()
 Return a checksum if applicable. More...
 
virtual bool IsEof () const
 Return whether the end of stream has been reached. More...
 
i64 SeekRelative (i64 delta)
 Set position relative to current position. Return actual new position.
 
i64 GetPosition () const
 Return current position.
 
i64 Tell () const
 Return current position.
 
i64 GetSize () const
 Return size.
 
i64 ReadI64 ()
 Read a 64-bit integer.
 
i32 ReadI32 ()
 Read a 32-bit integer.
 
i16 ReadI16 ()
 Read a 16-bit integer.
 
i8 ReadI8 ()
 Read an 8-bit integer.
 
u64 ReadU64 ()
 Read a 64-bit unsigned integer.
 
u32 ReadU32 ()
 Read a 32-bit unsigned integer.
 
u16 ReadU16 ()
 Read a 16-bit unsigned integer.
 
u8 ReadU8 ()
 Read an 8-bit unsigned integer.
 
byte ReadByte ()
 Read an 8-bit unsigned integer.
 
bool ReadBool ()
 Read a bool.
 
float ReadFloat ()
 Read a float.
 
double ReadDouble ()
 Read a double.
 
IntRect ReadIntRect ()
 Read an IntRect.
 
IntVector2 ReadIntVector2 ()
 Read an IntVector2.
 
IntVector3 ReadIntVector3 ()
 Read an IntVector3.
 
Rect ReadRect ()
 Read a Rect.
 
Vector2 ReadVector2 ()
 Read a Vector2.
 
Vector3 ReadVector3 ()
 Read a Vector3.
 
Vector3 ReadPackedVector3 (float maxAbsCoord)
 Read a Vector3 packed into 3 x 16 bits with the specified maximum absolute range.
 
Vector4 ReadVector4 ()
 Read a Vector4.
 
Quaternion ReadQuaternion ()
 Read a quaternion.
 
Quaternion ReadPackedQuaternion ()
 Read a quaternion with each component packed in 16 bits.
 
Matrix3 ReadMatrix3 ()
 Read a Matrix3.
 
Matrix3x4 ReadMatrix3x4 ()
 Read a Matrix3x4.
 
Matrix4 ReadMatrix4 ()
 Read a Matrix4.
 
Color ReadColor ()
 Read a color.
 
BoundingBox ReadBoundingBox ()
 Read a bounding box.
 
String ReadString ()
 Read a null-terminated string.
 
String ReadFileID ()
 Read a four-letter file ID.
 
StringHash ReadStringHash ()
 Read a 32-bit StringHash.
 
Vector< byte > ReadBuffer ()
 Read a buffer with size encoded as VLE.
 
ResourceRef ReadResourceRef ()
 Read a resource reference.
 
ResourceRefList ReadResourceRefList ()
 Read a resource reference list.
 
Variant ReadVariant ()
 Read a variant.
 
Variant ReadVariant (VariantType type)
 Read a variant whose type is already known.
 
VariantVector ReadVariantVector ()
 Read a variant vector.
 
StringVector ReadStringVector ()
 Read a string vector.
 
VariantMap ReadVariantMap ()
 Read a variant map.
 
unsigned ReadVLE ()
 Read a variable-length encoded unsigned integer, which can use 29 bits maximum.
 
id32 ReadNetID ()
 Read a 24-bit network object ID.
 
String ReadLine ()
 Read a text line.
 

Protected Attributes

i64 position_
 Stream position.
 
i64 size_
 Stream size.
 

Detailed Description

Abstract stream for reading. @nocount.

Member Function Documentation

◆ GetChecksum()

hash32 Urho3D::Deserializer::GetChecksum ( )
virtual

Return a checksum if applicable.

Reimplemented in Urho3D::File.

◆ GetName()

const String & Urho3D::Deserializer::GetName ( ) const
virtual

Return name of the stream.

Reimplemented in Urho3D::AbstractFile.

◆ IsEof()

virtual bool Urho3D::Deserializer::IsEof ( ) const
inlinevirtual

Return whether the end of stream has been reached.

Reimplemented in Urho3D::NamedPipe, and Urho3D::HttpRequest.

◆ Read()

virtual i32 Urho3D::Deserializer::Read ( void *  dest,
i32  size 
)
pure virtual

Read bytes from the stream. Return number of bytes actually read.

Implemented in Urho3D::File, Urho3D::MemoryBuffer, Urho3D::NamedPipe, Urho3D::VectorBuffer, and Urho3D::HttpRequest.

◆ Seek()

virtual i64 Urho3D::Deserializer::Seek ( i64  position)
pure virtual

Set position from the beginning of the stream. Return actual new position.

Implemented in Urho3D::File, Urho3D::MemoryBuffer, Urho3D::NamedPipe, Urho3D::VectorBuffer, and Urho3D::HttpRequest.


The documentation for this class was generated from the following files: