Inheritance diagram for MOAIStream:
Detailed Description
|
Function Documentation
|
Removes a series of spans from the stream and "collapses" the remainder. Used to remove a series of regularly repeating bytes. For example, if the stream contains vertices and user wishes to remove the vertex normals.
function collapse ( MOAIStream self, number clipBase, number clipSize, number chunkSize [, number size, boolean invert ] )
- Parameters
-
MOAIStream self number clipBase Offset from the cursot to the first clip to remove. number clipSize Size of the clip to remove. number chunkSize The stride: the next clip will begin at clipBase + chunkSize. number size Optional. The amount of the stream to process. Default is stream.getLength () - stream.getCursor () boolean invert Optional. Inverts the clip. Default value is false.
- Returns
- number result
|
If the stream is backed by an internal buffer, and the buffer may be reallocated by the stream, compact () causes the buffer to be reallocated so that it more closely matches the current length of the stream. For streams that are not buffer backer or that may not be reallocated, compact () has no effect.
function compact ( MOAIStream self )
- Parameters
-
MOAIStream self
- Returns
- number
|
Forces any remaining buffered data into the stream.
function flush ( MOAIStream self )
- Parameters
-
MOAIStream self
- Returns
- nil
|
Returns the current cursor position in the stream.
function getCursor ( MOAIStream self )
- Parameters
-
MOAIStream self
- Returns
- number cursor
|
Returns the length of the stream.
function getLength ( MOAIStream self )
- Parameters
-
MOAIStream self
- Returns
- number length
|
Reads bytes from the stream.
function read ( MOAIStream self [, number byteCount ] )
- Parameters
-
MOAIStream self number byteCount Optional. Number of bytes to read. Default value is the length of the stream.
- Returns
- string bytes, number actualByteCount
|
Reads a signed 16-bit value from the stream.
function read16 ( MOAIStream self )
- Parameters
-
MOAIStream self
- Returns
- number value, number size
|
Reads a signed 32-bit value from the stream.
function read32 ( MOAIStream self )
- Parameters
-
MOAIStream self
- Returns
- number value, number size
|
Reads a signed 8-bit value from the stream.
function read8 ( MOAIStream self )
- Parameters
-
MOAIStream self
- Returns
- number value, number size
|
Reads an 8-bit boolean value from the stream.
function readBoolean ( MOAIStream self )
- Parameters
-
MOAIStream self
- Returns
- number value, number size
|
Reads a 64-bit floating point value from the stream.
function readDouble ( MOAIStream self )
- Parameters
-
MOAIStream self
- Returns
- number value, number size
|
Reads a 32-bit floating point value from the stream.
function readFloat ( MOAIStream self )
- Parameters
-
MOAIStream self
- Returns
- number value, number size
|
Reads a series of values from the stream given a format string. Valid tokens for the format string are: u8 u16 u32 f d s8 s16 s32. Tokens may be optionally separated by spaces or commas.
function readFormat ( MOAIStream self, string format )
- Parameters
-
MOAIStream self string format
- Returns
- ..., number size
|
Reads an unsigned 16-bit value from the stream.
function readU16 ( MOAIStream self )
- Parameters
-
MOAIStream self
- Returns
- number value, number size
|
Reads an unsigned 32-bit value from the stream.
function readU32 ( MOAIStream self )
- Parameters
-
MOAIStream self
- Returns
- number value, number size
|
Reads an unsigned 8-bit value from the stream.
function readU8 ( MOAIStream self )
- Parameters
-
MOAIStream self
- Returns
- number value, number size
|
Repositions the cursor in the stream.
function seek ( MOAIStream self [, number offset, number mode ] )
- Parameters
-
MOAIStream self number offset Optional. Value from the stream. Default value is 0. number mode Optional. One of MOAIStream.SEEK_CUR, MOAIStream.SEEK_END, MOAIStream.SEEK_SET. Default value is MOAIStream.SEEK_SET.
- Returns
- nil
|
Write binary data to the stream.
function write ( MOAIStream self, string bytes [, number size ] )
- Parameters
-
MOAIStream self string bytes Binary data to write. number size Optional. Number of bytes to write. Default value is the size of the string.
- Returns
- number size
|
Writes a signed 16-bit value to the stream.
function write16 ( MOAIStream self, number value )
- Parameters
-
MOAIStream self number value Value to write.
- Returns
- number size
|
Writes a signed 32-bit value to the stream.
function write32 ( MOAIStream self, number value )
- Parameters
-
MOAIStream self number value Value to write.
- Returns
- number size
|
Writes a signed 8-bit value to the stream.
function write8 ( MOAIStream self, number value )
- Parameters
-
MOAIStream self number value Value to write.
- Returns
- number size
|
Writes an 8-bit boolean value to the stream.
function writeBoolean ( MOAIStream self, boolean value )
- Parameters
-
MOAIStream self boolean value Value to write.
- Returns
- number size
|
Write a packed 32-bit color to the vertex buffer.
function writeColor32 ( MOAIStream self [, number r, number g, number b, number a ] )
- Parameters
-
MOAIStream self number r Optional. Default value is 1. number g Optional. Default value is 1. number b Optional. Default value is 1. number a Optional. Default value is 1.
- Returns
- nil
|
Writes a 64-bit floating point value to the stream.
function writeDouble ( MOAIStream self, number value )
- Parameters
-
MOAIStream self number value Value to write.
- Returns
- number size
|
Writes a 32-bit floating point value to the stream.
function writeFloat ( MOAIStream self, number value )
- Parameters
-
MOAIStream self number value Value to write.
- Returns
- number size
|
Writes a series of values to the stream given a format string. See 'readFormat' for a list of valid format tokens.
function writeFormat ( MOAIStream self, string format, ... )
- Parameters
-
MOAIStream self string format ... values Values to be written to the stream.
- Returns
- number size
|
Reads bytes from the given stream into the calling stream.
function writeStream ( MOAIStream self, MOAIStream stream [, number size ] )
- Parameters
-
MOAIStream self MOAIStream stream Value to write. number size Optional. Number of bytes to read/write. Default value is the length of the input stream.
- Returns
- number size
|
Writes an unsigned 16-bit value to the stream.
function writeU16 ( MOAIStream self, number value )
- Parameters
-
MOAIStream self number value Value to write.
- Returns
- number size
|
Writes an unsigned 32-bit value to the stream.
function writeU32 ( MOAIStream self, number value )
- Parameters
-
MOAIStream self number value Value to write.
- Returns
- number size
|
Writes an unsigned 8-bit value to the stream.
function writeU8 ( MOAIStream self, number value )
- Parameters
-
MOAIStream self number value Value to write.
- Returns
- number size
