mirrors
/
bgfx
mirror of https://github.com/bkaradzic/bgfx
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Updated docs.

This commit is contained in:
Branimir Karadžić 2017-09-07 20:42:20 -07:00
parent 8f25bc49f5
commit b383159633
1 changed files with 28 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

30
include/bgfx/bgfx.h
View File

@ -2489,6 +2489,9 @@ namespace bgfx
///
/// @param[in] _tib Transient index buffer.
///
/// @remarks
/// _tib pointer after this call is invalid.
///
/// @attention C99 equivalent is `bgfx_set_transient_index_buffer`.
///
void setIndexBuffer(const TransientIndexBuffer* _tib);
@ -2499,6 +2502,9 @@ namespace bgfx
/// @param[in] _firstIndex First index to render.
/// @param[in] _numIndices Number of indices to render.
///
/// @remarks
/// _tib pointer after this call is invalid.
///
/// @attention C99 equivalent is `bgfx_set_transient_index_buffer`.
///
void setIndexBuffer(
@ -2568,6 +2574,9 @@ namespace bgfx
/// @param[in] _stream Vertex stream.
/// @param[in] _tvb Transient vertex buffer.
///
/// @remarks
/// _tvb pointer after this call is invalid.
///
/// @attention C99 equivalent is `bgfx_set_transient_vertex_buffer`.
///
void setVertexBuffer(
@ -2582,6 +2591,9 @@ namespace bgfx
/// @param[in] _startVertex First vertex to render.
/// @param[in] _numVertices Number of vertices to render.
///
/// @remarks
/// _tvb pointer after this call is invalid.
///
/// @attention C99 equivalent is `bgfx_set_transient_vertex_buffer`.
///
void setVertexBuffer(
@ -2593,23 +2605,37 @@ namespace bgfx
/// Set instance data buffer for draw primitive.
///
/// @param[in] _idb Transient instance data buffer.
/// @param[in] _num Number of data instances.
///
/// @remarks
/// _idb pointer after this call is invalid.
///
/// @attention C99 equivalent is `bgfx_set_instance_data_buffer`.
///
void setInstanceDataBuffer(const InstanceDataBuffer* _idb, uint32_t _num = UINT32_MAX);
/// Set instance data buffer for draw primitive.
///
/// @param[in] _handle Vertex buffer.
/// @param[in] _start First instance data.
/// @param[in] _num Number of data instances.
///
/// @attention C99 equivalent is `bgfx_set_instance_data_from_vertex_buffer`.
///
void setInstanceDataBuffer(VertexBufferHandle _handle, uint32_t _startVertex, uint32_t _num);
void setInstanceDataBuffer(VertexBufferHandle _handle, uint32_t _start, uint32_t _num);
/// Set instance data buffer for draw primitive.
///
/// @param[in] _handle Vertex buffer.
/// @param[in] _start First instance data.
/// @param[in] _num Number of data instances.
///
/// @attention C99 equivalent is `bgfx_set_instance_data_from_dynamic_vertex_buffer`.
///
void setInstanceDataBuffer(
DynamicVertexBufferHandle _handle
, uint32_t _startVertex
, uint32_t _start
, uint32_t _num
);