Moai SDK  1.5 revision 1 (MoaiEdition)
MOAIVertexBuffer Class Reference

Inherits MOAILuaObject.

List of all members.

Function List

  bless
  release
  reserve
  reserveVerts
  reset
  setFormat
  writeColor32
  writeFloat
  writeInt8
  writeInt16
  writeInt32

Function Documentation

Call this after initializing the buffer and settings it vertices to prepare it for use.


function bless ( MOAIVertexBuffer self )
Parameters:
self ( MOAIVertexBuffer )
Returns:
nil

Releases any memory associated with buffer.


function release ( MOAIVertexBuffer self )
Parameters:
self ( MOAIVertexBuffer )
Returns:
nil

Sets capacity of buffer in bytes.


function reserve ( MOAIVertexBuffer self, number size )
Parameters:
self ( MOAIVertexBuffer )
size ( number )
Returns:
nil

Sets capacity of buffer in vertices. This function should only be used after attaching a valid MOAIVertexFormat to the buffer.


function reserveVerts ( MOAIVertexBuffer self, number size )
Parameters:
self ( MOAIVertexBuffer )
size ( number )
Returns:
nil

Resets the vertex stream writing to the head of the stream.


function reset ( MOAIVertexBuffer self )
Parameters:
self ( MOAIVertexBuffer )
Returns:
nil

Sets the vertex format for the buffer.


function setFormat ( MOAIVertexBuffer self, MOAIVertexFormat format )
Parameters:
self ( MOAIVertexBuffer )
format ( MOAIVertexFormat )
Returns:
nil

Write a packed 32-bit color to the vertex buffer.


function writeColor32 ( MOAIVertexBuffer self [, number r, number g, number b, number a ] )
Parameters:
self ( MOAIVertexBuffer )
r ( number ) Optional. Default value is 1.
g ( number ) Optional. Default value is 1.
b ( number ) Optional. Default value is 1.
a ( number ) Optional. Default value is 1.
Returns:
nil

Write a 32-bit float to the vertex buffer.


function writeFloat ( MOAIVertexBuffer self [, number f ] )
Parameters:
self ( MOAIVertexBuffer )
f ( number ) Optional. Default value is 0.
Returns:
nil

Write an 16-bit integer to the vertex buffer.


function writeInt16 ( MOAIVertexBuffer self [, number i ] )
Parameters:
self ( MOAIVertexBuffer )
i ( number ) Optional. Default value is 0.
Returns:
nil

Write an 32-bit integer to the vertex buffer.


function writeInt32 ( MOAIVertexBuffer self [, number i ] )
Parameters:
self ( MOAIVertexBuffer )
i ( number ) Optional. Default value is 0.
Returns:
nil

Write an 8-bit integer to the vertex buffer.


function writeInt8 ( MOAIVertexBuffer self [, number i ] )
Parameters:
self ( MOAIVertexBuffer )
i ( number ) Optional. Default value is 0.
Returns:
nil