ScummVM API documentation
Public Member Functions | List of all members
Twp::OutMemStream Class Reference
Inheritance diagram for Twp::OutMemStream:
Common::SeekableWriteStream Common::WriteStream Common::Stream

Public Member Functions

bool open (byte *buf, int64 bufSize)
 
uint32 write (const void *dataPtr, uint32 dataSize) override
 
int64 pos () const override
 
int64 size () const override
 
bool seek (int64 offset, int whence=SEEK_SET) override
 
virtual bool seek (int64 offset, int whence=SEEK_SET)=0
 
virtual int64 size () const =0
 
- Public Member Functions inherited from Common::WriteStream
virtual uint32 write (const void *dataPtr, uint32 dataSize)=0
 
virtual bool flush ()
 
virtual void finalize ()
 
virtual int64 pos () const =0
 
void writeByte (byte value)
 
void writeSByte (int8 value)
 
void writeUint16LE (uint16 value)
 
void writeUint32LE (uint32 value)
 
void writeUint64LE (uint64 value)
 
void writeUint16BE (uint16 value)
 
void writeUint32BE (uint32 value)
 
void writeUint64BE (uint64 value)
 
FORCEINLINE void writeSint16LE (int16 value)
 
FORCEINLINE void writeSint32LE (int32 value)
 
FORCEINLINE void writeSint64LE (int64 value)
 
FORCEINLINE void writeSint16BE (int16 value)
 
FORCEINLINE void writeSint32BE (int32 value)
 
FORCEINLINE void writeSint64BE (int64 value)
 
FORCEINLINE void writeFloatLE (float value)
 
FORCEINLINE void writeFloatBE (float value)
 
FORCEINLINE void writeDoubleLE (double value)
 
FORCEINLINE void writeDoubleBE (double value)
 
template<class TDataFormat , class... T>
bool writeMultiple (const TDataFormat &dataFormat, const T &...values)
 
template<class... T>
bool writeMultipleEndian (bool isLittle, const T &...values)
 
template<class... T>
bool writeMultipleLE (const T &...values)
 
template<class... T>
bool writeMultipleBE (const T &...values)
 
uint32 writeStream (ReadStream *stream, uint32 dataSize)
 
uint32 writeStream (ReadStream *stream)
 
void writeString (const String &str)
 
- Public Member Functions inherited from Common::Stream
virtual bool err () const
 
virtual void clearErr ()
 

Member Function Documentation

◆ write()

uint32 Twp::OutMemStream::write ( const void *  dataPtr,
uint32  dataSize 
)
overridevirtual

Write data into the stream. Subclasses must implement this method. All other write methods are implemented using it.

Note
The semantics of any implementation of this method is supposed to match that of ISO C fwrite().
Parameters
dataPtrPointer to the data to be written.
dataSizeNumber of bytes to be written.
Returns
The number of bytes that were actually written.

Implements Common::WriteStream.

◆ pos()

int64 Twp::OutMemStream::pos ( ) const
overridevirtual

Obtain the current value of the stream position indicator.

Returns
The current position indicator, or -1 if an error occurred.

Implements Common::WriteStream.

◆ size()

int64 Twp::OutMemStream::size ( ) const
overridevirtual

Obtain the current size of the stream, measured in bytes.

If this value is unknown or cannot be computed, -1 is returned.

Returns
The size of the stream, or -1 if an error occurred.

Implements Common::SeekableWriteStream.

◆ seek()

bool Twp::OutMemStream::seek ( int64  offset,
int  whence = SEEK_SET 
)
overridevirtual

Set the stream position indicator for the stream.

The new position, measured in bytes, is obtained by adding offset bytes to the position specified by whence. If whence is set to SEEK_SET, SEEK_CUR, or SEEK_END, the offset is relative to the start of the file, the current position indicator, or end-of-stream, respectively. A successful call to the seek() method clears the end-of-stream indicator for the stream.

Note
The semantics of any implementation of this method is supposed to match that of ISO C fseek().
Parameters
offsetThe relative offset in bytes.
whenceThe seek reference: SEEK_SET, SEEK_CUR, or SEEK_END.
Returns
True on success, false in case of a failure.

Implements Common::SeekableWriteStream.

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