RenderBuffer - stingray.RenderBuffer object reference - Stingray Lua API Reference
Description
API for manipulating buffers of data for rendering.
Other related reference items 
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 
| |
RB_INDEX_BUFFER_VIEW : integer
Describes buffer view type.
|
Related sample code
| |
RB_INTEGER_COMPONENT : integer
Component uses integer data.
|
| |
RB_NORMAL_SEMANTIC : integer
Describes semantics of component.
|
Related sample code
| |
RB_POSITION_SEMANTIC : integer
Describes semantics of component.
|
Related sample code
| |
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
| |
RB_VALIDITY_UPDATABLE : integer
Indicates that the conent of the buffer can be changed with update_buffer().
|
Related sample code
| |
RB_VERTEX_BUFFER_VIEW : integer
Describes buffer view type.
|
Related sample code
| |
RB_VERTEX_DESCRIPTION : integer
Describes a vertex buffer
|
Related sample code
Functions
| |
component_type ( format ) : integer
Returns the component type used by the format.
|
format : | integer |
A format descriptor. |
integer |
The component type used by the format. |
| |
compressed_format ( compression ) : integer
Returns a format descriptor for compressed data.
|
compression : | integer |
The type of compression RB_*. |
integer |
An integer format descriptor code. |
| |
compressed_format ( format ) : boolean
Returns true if the descriptor describes a compressed format.
|
format : | integer |
A format descriptor. |
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.
|
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. |
integer |
A handle to the buffer. |
Related sample code
Other related reference items
| |
create_description ( view, desc ) : integer
Creates a buffer description object and returns a handle to it.
|
view : | integer |
The RB_*_DESCRIPTION we are creating. |
desc : | table |
Description of the buffer. |
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
Other related reference items
| |
destroy_buffer ( handle )
Destroys a buffer created by create_buffer().
|
handle : | integer |
A handle to the buffer to be destroyed. |
| This function does not return any values. |
Related sample code
| |
destroy_description ( handle )
Destroys a previously created buffer description.
|
handle : | integer |
A description handle returned by create_description(). |
| This function does not return any values. |
Related sample code
| |
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.
|
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. |
integer |
An integer format descriptor code. |
Related sample code
Other related reference items
| |
num_bits ( format ) : integer
Returns the number of bits used by the format.
|
format : | integer |
A format descriptor. |
integer |
The number of bits used by the format. |
| |
num_components ( format ) : integer
Returns the number of components used by the format.
|
format : | integer |
A format descriptor. |
integer |
The number of components used by the format. |
| |
update_buffer ( handle, type, data )
Updates a buffer with new data.
|
handle : | integer |
A handle to the buffer to be updated. |
type : | integer |
RB_*_COMPONENT data type. |
data : | table |
New data for the buffer. |
| This function does not return any values. |
Related sample code
Other related reference items
| |
update_description ( handle, desc )
Updates a previously created buffer description.
|
handle : | integer |
A description handle returned by create_description(). |
desc : | table |
Updated description of the buffer, see create_description(). |
| This function does not return any values. |