stingray.ProceduralMesh object reference

Description

API for manipulating procedurally generated meshes.

Related sample code

Creating meshes procedurally

Constants

MO_ALL_CONTEXTS : integer Visibility context for both regular rendering and shadow casting.

MO_DISABLE_CULLING_FLAG : integer Mesh always passes culling, i.e its bounding volume state is ignored.

Note: might significantly impact performance.

MO_LINE_LIST : integer Line list primitive

MO_SHADOW_CASTER_CONTEXT : integer Visibility context for shadow casting.

MO_SHADOW_CASTER_FLAG : integer Mesh is a part of shadow rendering.

Related sample code

Creating meshes procedurally

MO_TRIANGLE_LIST : integer Triangle list primitive.

Related sample code

Creating meshes procedurally

MO_VIEWPORT_CONTEXT : integer Visibility context for regular rendering.

MO_VIEWPORT_VISIBLE_FLAG : integer Mesh is a part of rendering.

Related sample code

Creating meshes procedurally

Functions

add_resource ( handle, resource_handle ) Adds a resource (vertex buffer or description) to a mesh.

Parameters

handle :	integer	A handle to the mesh that we are adding resources to.
resource_handle :	integer	Handle to the resource (buffer or description from RenderBuffer) that we are adding.

Returns

This function does not return any values.

Related sample code

Creating meshes procedurally

Other related reference items

stingray.ProceduralMesh.remove_resource()

clear_resources ( handle ) Removes all added resources form the mesh.

Parameters

handle :

integer

A handle to the mesh that we are clearing.

Returns

This function does not return any values.

create ( unit, node, mesh_name, flags ) : integer Creates a new mesh object and returns a handle to it.

Parameters

unit :	stingray.Unit	The unit that should own the new mesh.
node :	string	The name of the node in the unit that the mesh should be attached to.
mesh_name :	string	The name of the newly created mesh (for debugging purposes).
flags :	integer	A MO_*_FLAG value for the mesh.

Returns

integer

A handle to the newly created mesh.

Related sample code

Creating meshes procedurally

Other related reference items

stingray.ProceduralMesh.destroy_mesh()

destroy_mesh ( handle ) Destroys a mesh created by create().

Parameters

handle :

integer

A handle to the mesh to be destroyed.

Returns

This function does not return any values.

flags ( handle ) : integer Returns the MO_*_FLAG flags for the mesh.

Parameters

handle :

integer

A handle to the mesh.

Returns

integer

The MO_*_FLAG flags for the mesh.

remove_resource ( handle, resource_handle ) Removes a resource added with add_resource().

Parameters

handle :	integer	A handle to the mesh that we are removing resources from.
resource_handle :	integer	Handle to the resource (buffer or description from RenderBuffer) that we are removing.

Returns

This function does not return any values.

set_batch_info ( handle, batches ) Sets the batch/drawcall information for the mesh.

Parameters

handle :	integer	A handle to the mesh who's batches we are describing.
batches :	table	Describes the rendering bathces for the mesh.

Returns

This function does not return any values.

batches should be a table of tables, with each subtable describing one batch. The subtables should have the following fields:

• primitive_type: Type of primitives (MO_TRIANGLE_LIST, MO_LINE_LIST).
• material_index: Index into set_materials() array for this batch.
• vertex_offset: Offset into vertex data for batch.
• primitives: Number of primitives for batch.
• index_offset: Offset into index data for batch (only valid when indexed).
• vertices: Number of vertices in batch (only valid when non-indexed).
• instances: Number of instances to draw (1 equals no instancing).

Related sample code

Creating meshes procedurally

set_bounding_box ( handle, min, max ) Sets the AABB bounding box for the mesh.

Parameters

handle :	integer	A handle to the mesh.
min :	stingray.Vector3	Minimum corner of the AABB.
max :	stingray.Vector3	Maximum corner of the AABB.

Returns

This function does not return any values.

Related sample code

Creating meshes procedurally

set_flags ( handle, flags ) Sets the MO_*_FLAG flags for the mesh.

Parameters

handle :	integer	A handle to the mesh.
flags :	integer	The flags to set.

Returns

This function does not return any values.

set_materials ( handle, materials ) Sets the materials for the mesh.

Parameters

handle :	integer	A handle to the mesh who's materials we should set.
materials :	string[]	A list of materials for the mesh. The [] notation indicates that this type is an array: a table in which the keys of the members are sequential integers, and the value of each element is an instance of the type shown.

Returns

This function does not return any values.

Related sample code

Creating meshes procedurally

Other related reference items

stingray.ProceduralMesh.set_batch_info()

set_visibility ( handle, context, visible ) Sets the visiblity of the mesh in the context.

Parameters

handle :	integer	A handle to the mesh.
context :	integer	The MO_*_CONTEXT we are setting the visiblity for.
visible :	boolean	True if the mesh should be visible.

Returns

This function does not return any values.

visibility ( handle, context ) : boolean Returns the visiblity in the context.

Parameters

handle :	integer	A handle to the mesh.
context :	integer	The MO_*_CONTEXT we are checking the visiblity for.

Returns

boolean

The visiblity in the context.