Urho3D::MemoryBuffer Class Reference

Memory area that can be read and written to as a stream. More...

#include <Urho3D/IO/MemoryBuffer.h>

Inheritance diagram for Urho3D::MemoryBuffer:
Collaboration diagram for Urho3D::MemoryBuffer:

Public Member Functions

 MemoryBuffer (void *data, unsigned size)
 Construct with a pointer and size.
 MemoryBuffer (const void *data, unsigned size)
 Construct as read-only with a pointer and size.
 MemoryBuffer (PODVector< unsigned char > &data)
 Construct from a vector, which must not go out of scope before MemoryBuffer.
 MemoryBuffer (const PODVector< unsigned char > &data)
 Construct from a read-only vector, which must not go out of scope before MemoryBuffer.
virtual unsigned Read (void *dest, unsigned size)
 Read bytes from the memory area. Return number of bytes actually read.
virtual unsigned Seek (unsigned position)
 Set position from the beginning of the memory area. Return actual new position.
virtual unsigned Write (const void *data, unsigned size)
 Write bytes to the memory area.
unsigned char * GetData ()
 Return memory area.
bool IsReadOnly ()
 Return whether buffer is read-only.
- Public Member Functions inherited from Urho3D::AbstractFile
 AbstractFile ()
 AbstractFile (unsigned int size)
virtual ~AbstractFile ()
- Public Member Functions inherited from Urho3D::Deserializer
 Deserializer ()
 Construct with zero size.
 Deserializer (unsigned size)
 Construct with defined size.
virtual ~Deserializer ()
virtual const StringGetName () const
 Return name of the stream.
virtual unsigned GetChecksum ()
 Return a checksum if applicable.
virtual bool IsEof () const
 Return whether the end of stream has been reached.
unsigned SeekRelative (int delta)
 Set position relative to current position. Return actual new position.
unsigned GetPosition () const
 Return current position.
unsigned Tell () const
 Return current position.
unsigned GetSize () const
 Return size.
long long ReadInt64 ()
 Read a 64-bit integer.
int ReadInt ()
 Read a 32-bit integer.
short ReadShort ()
 Read a 16-bit integer.
signed char ReadByte ()
 Read an 8-bit integer.
unsigned long long ReadUInt64 ()
 Read a 64-bit unsigned integer.
unsigned ReadUInt ()
 Read a 32-bit unsigned integer.
unsigned short ReadUShort ()
 Read a 16-bit unsigned integer.
unsigned char ReadUByte ()
 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.
PODVector< unsigned char > 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.
unsigned ReadNetID ()
 Read a 24-bit network object ID.
String ReadLine ()
 Read a text line.
- Public Member Functions inherited from Urho3D::Serializer
virtual ~Serializer ()
bool WriteInt64 (long long value)
 Write a 64-bit integer.
bool WriteInt (int value)
 Write a 32-bit integer.
bool WriteShort (short value)
 Write a 16-bit integer.
bool WriteByte (signed char value)
 Write an 8-bit integer.
bool WriteUInt64 (unsigned long long value)
 Write a 64-bit unsigned integer.
bool WriteUInt (unsigned value)
 Write a 32-bit unsigned integer.
bool WriteUShort (unsigned short value)
 Write a 16-bit unsigned integer.
bool WriteUByte (unsigned char value)
 Write an 8-bit unsigned integer.
bool WriteBool (bool value)
 Write a bool.
bool WriteFloat (float value)
 Write a float.
bool WriteDouble (double value)
 Write a double.
bool WriteIntRect (const IntRect &value)
 Write an IntRect.
bool WriteIntVector2 (const IntVector2 &value)
 Write an IntVector2.
bool WriteIntVector3 (const IntVector3 &value)
 Write an IntVector3.
bool WriteRect (const Rect &value)
 Write a Rect.
bool WriteVector2 (const Vector2 &value)
 Write a Vector2.
bool WriteVector3 (const Vector3 &value)
 Write a Vector3.
bool WritePackedVector3 (const Vector3 &value, float maxAbsCoord)
 Write a Vector3 packed into 3 x 16 bits with the specified maximum absolute range.
bool WriteVector4 (const Vector4 &value)
 Write a Vector4.
bool WriteQuaternion (const Quaternion &value)
 Write a quaternion.
bool WritePackedQuaternion (const Quaternion &value)
 Write a quaternion with each component packed in 16 bits.
bool WriteMatrix3 (const Matrix3 &value)
 Write a Matrix3.
bool WriteMatrix3x4 (const Matrix3x4 &value)
 Write a Matrix3x4.
bool WriteMatrix4 (const Matrix4 &value)
 Write a Matrix4.
bool WriteColor (const Color &value)
 Write a color.
bool WriteBoundingBox (const BoundingBox &value)
 Write a bounding box.
bool WriteString (const String &value)
 Write a null-terminated string.
bool WriteFileID (const String &value)
 Write a four-letter file ID. If the string is not long enough, spaces will be appended.
bool WriteStringHash (const StringHash &value)
 Write a 32-bit StringHash.
bool WriteBuffer (const PODVector< unsigned char > &buffer)
 Write a buffer, with size encoded as VLE.
bool WriteResourceRef (const ResourceRef &value)
 Write a resource reference.
bool WriteResourceRefList (const ResourceRefList &value)
 Write a resource reference list.
bool WriteVariant (const Variant &value)
 Write a variant.
bool WriteVariantData (const Variant &value)
 Write a variant without the type information.
bool WriteVariantVector (const VariantVector &value)
 Write a variant vector.
bool WriteStringVector (const StringVector &value)
 Write a variant vector.
bool WriteVariantMap (const VariantMap &value)
 Write a variant map.
bool WriteVLE (unsigned value)
 Write a variable-length encoded unsigned integer, which can use 29 bits maximum.
bool WriteNetID (unsigned value)
 Write a 24-bit network object ID.
bool WriteLine (const String &value)
 Write a text line. Char codes 13 & 10 will be automatically appended.

Private Attributes

unsigned char * buffer_
 Pointer to the memory area.
bool readOnly_
 Read-only flag.

Additional Inherited Members

- Protected Attributes inherited from Urho3D::Deserializer
unsigned position_
 Stream position.
unsigned size_
 Stream size.

Detailed Description

Memory area that can be read and written to as a stream.

The documentation for this class was generated from the following files:
  • Source/Urho3D/IO/MemoryBuffer.h
  • Source/Urho3D/IO/MemoryBuffer.cpp