stingray.RenderBuffer object reference

Description

API for manipulating buffers of data for rendering.

Other related reference items

stingray.ProceduralMesh.add_resource() stingray.ProceduralMesh.remove_resource()

Constants

RB_BINORMAL_SEMANTIC : integer Describes semantics of component.

RB_BLEND_INDICES_SEMANTIC : integer Describes semantics of component.

RB_BLEND_WEIGHTS_SEMANTIC : integer Describes semantics of component.

RB_BLOCK_COMPRESSED_1 : integer Compressed data format.

RB_BLOCK_COMPRESSED_2 : integer Compressed data format.

RB_BLOCK_COMPRESSED_3 : integer Compressed data format

RB_BLOCK_COMPRESSED_4 : integer Compressed data format

RB_BLOCK_COMPRESSED_5 : integer Compressed data format

RB_BLOCK_COMPRESSED_6 : integer Compressed data format

RB_BLOCK_COMPRESSED_7 : integer Compressed data format

RB_COLOR_SEMANTIC : integer Describes semantics of component.

RB_ETC2_R11 : integer Compressed data format

RB_ETC2_RG11 : integer Compressed data format

RB_ETC2_RGB8 : integer Compressed data format

RB_ETC2_RGB8A1 : integer Compressed data format

RB_ETC2_RGBA8 : integer Compressed data format

RB_FLOAT_COMPONENT : integer Component uses float data.

Related sample code

Creating meshes procedurally

RB_INDEX_BUFFER_VIEW : integer Describes buffer view type.

Related sample code

Creating meshes procedurally

RB_INTEGER_COMPONENT : integer Component uses integer data.

RB_NORMAL_SEMANTIC : integer Describes semantics of component.

Related sample code

Creating meshes procedurally

RB_POSITION_SEMANTIC : integer Describes semantics of component.

Related sample code

Creating meshes procedurally

RB_PVR_RGBA_2BPP : integer Compressed data format

RB_PVR_RGBA_4BPP : integer Compressed data format

RB_PVR_RGB_2BPP : integer Compressed data format

RB_PVR_RGB_4BPP : integer Compressed data format

RB_RAW_BUFFER_VIEW : integer Describes buffer view type.

RB_TANGENT_SEMANTIC : integer Describes semantics of component.

RB_TEXCOORD_SEMANTIC : integer Describes semantics of component.

RB_TEXTURE_BUFFER_VIEW : integer Describes buffer view type.

RB_TEXTURE_TYPE_2D : integer 2D texture type.

RB_TEXTURE_TYPE_3D : integer 3D texture type.

RB_TEXTURE_TYPE_CUBE : integer Cube texture type.

RB_VALIDITY_STATIC : integer Indicates that the content of a buffer is immutable.

Related sample code

Creating meshes procedurally

RB_VALIDITY_UPDATABLE : integer Indicates that the conent of the buffer can be changed with update_buffer().

Related sample code

Creating meshes procedurally

RB_VERTEX_BUFFER_VIEW : integer Describes buffer view type.

Related sample code

Creating meshes procedurally

RB_VERTEX_DESCRIPTION : integer Describes a vertex buffer

Related sample code

Creating meshes procedurally

Functions

component_type ( format ) : integer Returns the component type used by the format.

Parameters

format :

integer

A format descriptor.

Returns

integer

The component type used by the format.

compressed_format ( compression ) : integer Returns a format descriptor for compressed data.

Parameters

compression :

integer

The type of compression RB_*.

Returns

integer

An integer format descriptor code.

compressed_format ( format ) : boolean Returns true if the descriptor describes a compressed format.

Parameters

format :

integer

A format descriptor.

Returns

boolean

True if the format is compressed.

create_buffer ( validity, view, stride, data ) : integer Creates a buffer of data and returns a handle to it.

Parameters

validity :	integer	A RB_VALIDITY_* value that describes if the buffer is static or updatable.
view :	integer	A RB_*_BUFFER_VIEW describing the type of buffer we are creating.
stride :	integer	Stride of the data.
data :	table	A table of numbers with the data.

Returns

integer

A handle to the buffer.

Related sample code

Creating meshes procedurally

Other related reference items

stingray.RenderBuffer.destroy_buffer()

create_description ( view, desc ) : integer Creates a buffer description object and returns a handle to it.

Parameters

view :	integer	The RB_*_DESCRIPTION we are creating.
desc :	table	Description of the buffer.

Returns

integer

A handle to the buffer description object.

The desc should be a table of tables, with each subtable describing a vertex channel. The sub tables have the following fields:

• format: The format of the channel (as returend by format().
• semantic: The RB_*_SEMANTIC of the channel.
• vb_index: Index of vertex buffer that this channels is referring.
• set: Semantic set (i.e. TEXCOORD0, TEXCOORD1, etc).
• instance: True if vertex channel contains per-instance data.

Related sample code

Creating meshes procedurally

Other related reference items

stingray.RenderBuffer.destroy_description() stingray.RenderBuffer.update_description()

destroy_buffer ( handle ) Destroys a buffer created by create_buffer().

Parameters

handle :

integer

A handle to the buffer to be destroyed.

Returns

This function does not return any values.

Related sample code

Creating meshes procedurally

destroy_description ( handle ) Destroys a previously created buffer description.

Parameters

handle :

integer

A description handle returned by create_description().

Returns

This function does not return any values.

Related sample code

Creating meshes procedurally

format ( component_type, signed, normalize, bit_depth_x, bit_depth_y, bit_depth_z, bit_depth_w ) : integer Creates and returns a format descriptor for a piece of buffer data.

Parameters

component_type :	integer	The type of the component RB_*_COMPONENT
signed :	boolean	True if data should be treated as signed.
normalize :	boolean	True if input integer data should be normalized to 0--1 or -1 -- 1 range.
bit_depth_x :	integer	Number of bits in x components.
bit_depth_y :	integer	Number of bits in y components.
bit_depth_z :	integer	Number of bits in z components.
bit_depth_w :	integer	Number of bits in w components.

Returns

integer

An integer format descriptor code.

Related sample code

Creating meshes procedurally

Other related reference items

stingray.RenderBuffer.create_description()

num_bits ( format ) : integer Returns the number of bits used by the format.

Parameters

format :

integer

A format descriptor.

Returns

integer

The number of bits used by the format.

num_components ( format ) : integer Returns the number of components used by the format.

Parameters

format :

integer

A format descriptor.

Returns

integer

The number of components used by the format.

update_buffer ( handle, type, data ) Updates a buffer with new data.

Parameters

handle :	integer	A handle to the buffer to be updated.
type :	integer	RB_*_COMPONENT data type.
data :	table	New data for the buffer.

Returns

This function does not return any values.

Related sample code

Creating meshes procedurally

Other related reference items

stingray.RenderBuffer.RB_VALIDITY_UPDATABLE

update_description ( handle, desc ) Updates a previously created buffer description.

Parameters

handle :	integer	A description handle returned by create_description().
desc :	table	Updated description of the buffer, see create_description().

Returns

This function does not return any values.