Explorar el Código

Updated docs.

Branimir Karadžić hace 8 años
padre
commit
b383159633
Se han modificado 1 ficheros con 28 adiciones y 2 borrados
  1. 28 2
      include/bgfx/bgfx.h

+ 28 - 2
include/bgfx/bgfx.h

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