Class MemoryWriteStream

Direct memory writing stream that uses a single allocation buffer.

Inheritance

Stream

WriteStream

MemoryWriteStream

Inherited Members

Stream::_hasError

Stream::CanRead()

WriteStream::CanWrite()

WriteStream::data

WriteStream::DEPRECATED("Use Write method") void WriteString(const StringView& data)

Stream::HasError()

WriteStream::lock

Stream::Stream()

WriteStream::useDouble

WriteStream::Write(const StringView& data)

WriteStream::Write(const StringView& data, int16 lock)

WriteStream::Write(const StringAnsiView& data)

WriteStream::Write(const StringAnsiView& data, int8 lock)

WriteStream::Write(const CommonValue& data)

WriteStream::Write(const VariantType& data)

WriteStream::Write(const Variant& data)

WriteStream::Write(const T& data)

WriteStream::Write(const T* data)

WriteStream::Write(const ScriptingObjectReference<T>& v)

WriteStream::Write(const SoftObjectReference<T>& v)

WriteStream::Write(const AssetReference<T>& v)

WriteStream::Write(const WeakAssetReference<T>& v)

WriteStream::Write(const SoftAssetReference<T>& v)

WriteStream::Write(const Span<T>& data)

WriteStream::Write(const Array<T, AllocationType>& data)

WriteStream::Write(const Dictionary<KeyType, ValueType, AllocationType>& data)

WriteStream::Write(const BoundingBox& box, bool useDouble=false)

WriteStream::Write(const BoundingSphere& sphere, bool useDouble=false)

WriteStream::Write(const Transform& transform, bool useDouble=false)

WriteStream::Write(const Ray& ray, bool useDouble=false)

WriteStream::WriteBOM()

WriteStream::WriteBool(bool data)

WriteStream::WriteByte(byte data)

WriteStream::WriteChar(char data)

WriteStream::WriteChar(Char data)

WriteStream::WriteDouble(double data)

WriteStream::WriteFloat(float data)

WriteStream::WriteInt16(int16 data)

WriteStream::WriteInt32(int32 data)

WriteStream::WriteInt64(int64 data)

WriteStream::WriteInt8(int8 data)

WriteStream::WriteJson(ISerializable* obj, const void* otherObj=nullptr)

WriteStream::WriteJson(const StringAnsiView& json)

WriteStream::WriteText(const char* text, int32 length)

WriteStream::WriteText(const Char* text, int32 length)

WriteStream::WriteText(const StringView& text)

WriteStream::WriteText(const StringAnsiView& text)

WriteStream::WriteUint16(uint16 data)

WriteStream::WriteUint32(uint32 data)

WriteStream::WriteUint64(uint64 data)

WriteStream::WriteUint8(uint8 data)

Stream::~Stream()

Assembly: FlaxEngine.dll

File: Engine/Serialization/MemoryWriteStream.h

Syntax

public class MemoryWriteStream : public WriteStream

Constructors

~MemoryWriteStream()

Destructor

Declaration

public ~MemoryWriteStream()

MemoryWriteStream()

Initializes a new instance of the MemoryWriteStream class.

Declaration

public MemoryWriteStream()

MemoryWriteStream(uint32 capacity)

Initializes a new instance of the MemoryWriteStream class.

Declaration

public MemoryWriteStream(uint32 capacity)

Parameters

uint32 capacity Initial write buffer capacity (in bytes).

Methods

Close()

Close the stream

Declaration

public virtual void Close() override

Overrides

Stream::Close()

Flush()

Flush the stream buffers

Declaration

public virtual void Flush() override

Overrides

Stream::Flush()

GetCapacity()

Gets the current capacity of the stream.

Declaration

public uint32 GetCapacity() const

Returns

uint32

GetHandle()

Gets the pointer to the buffer in memory.

Declaration

public byte* GetHandle() const

Returns

byte

GetLength()

Gets current stream length (capacity in bytes).

Declaration

public uint32 GetLength() const

Returns

uint32

GetPosition()

Gets current position in the stream (in bytes).

Declaration

public uint32 GetPosition() const

Returns

uint32

Move()

Skips the data from the target buffer without writing to it. Moves the write pointer in the buffer forward.

Declaration

public T* Move()

Returns

T The pointer to the data in memory.

Type Parameters

typename T

Move(uint32 bytes)

Skips bytes from the target buffer without writing to it. Moves the write pointer in the buffer forward.

Declaration

public void* Move(uint32 bytes)

Parameters

uint32 bytes The amount of bytes to skip.

Returns

void The pointer to the target bytes in memory.

Reset(uint32 capacity)

Cleanups the buffers, resets the position and allocated the new memory chunk.

Declaration

public void Reset(uint32 capacity)

Parameters

uint32 capacity Initial write buffer capacity (in bytes).

SaveToFile(const StringView& path)

Saves current buffer contents to the file.

Declaration

public bool SaveToFile(const StringView& path) const

Parameters

StringView path The file path.

Returns

bool True if cannot save data, otherwise false.

SetPosition(uint32 seek)

Set new position in the stream

Declaration

public virtual void SetPosition(uint32 seek) override

Parameters

uint32 seek New position in the stream

Overrides

Stream::SetPosition(uint32 seek)

WriteBytes(const void* data, uint32 bytes)

Writes bytes to the stream.

Declaration

public virtual void WriteBytes(const void* data, uint32 bytes) override

Parameters

void data Pointer to data to write.

uint32 bytes Amount of bytes to write.

Overrides

WriteStream::WriteBytes(const void* data, uint32 bytes)