소스 검색

Updated docs.

Branimir Karadžić 10 년 전
부모
커밋
f7c8562f93
1개의 변경된 파일35개의 추가작업 그리고 0개의 파일을 삭제
  1. 35 0
      include/bgfx.h

+ 35 - 0
include/bgfx.h

@@ -1645,42 +1645,77 @@ namespace bgfx
 
 	/// Set compute index buffer.
 	///
+	/// @param[in] _stage Compute stage.
+	/// @param[in] _handle Index buffer handle.
+	/// @param[in] _access Buffer access. See `Access::Enum`.
+	///
 	/// @attention C99 equivalent is `bgfx_set_compute_index_buffer`.
 	///
 	void setBuffer(uint8_t _stage, IndexBufferHandle _handle, Access::Enum _access);
 
 	/// Set compute vertex buffer.
 	///
+	/// @param[in] _stage Compute stage.
+	/// @param[in] _handle Vertex buffer handle.
+	/// @param[in] _access Buffer access. See `Access::Enum`.
+	///
 	/// @attention C99 equivalent is `bgfx_set_compute_vertex_buffer`.
 	///
 	void setBuffer(uint8_t _stage, VertexBufferHandle _handle, Access::Enum _access);
 
 	/// Set compute dynamic index buffer.
 	///
+	/// @param[in] _stage Compute stage.
+	/// @param[in] _handle Dynamic index buffer handle.
+	/// @param[in] _access Buffer access. See `Access::Enum`.
+	///
 	/// @attention C99 equivalent is `bgfx_set_compute_dynamic_index_buffer`.
 	///
 	void setBuffer(uint8_t _stage, DynamicIndexBufferHandle _handle, Access::Enum _access);
 
 	/// Set compute dynamic vertex buffer.
 	///
+	/// @param[in] _stage Compute stage.
+	/// @param[in] _handle Dynamic vertex buffer handle.
+	/// @param[in] _access Buffer access. See `Access::Enum`.
+	///
 	/// @attention C99 equivalent is `bgfx_set_compute_dynamic_vertex_buffer`.
 	///
 	void setBuffer(uint8_t _stage, DynamicVertexBufferHandle _handle, Access::Enum _access);
 
 	/// Set compute indirect buffer.
 	///
+	/// @param[in] _stage Compute stage.
+	/// @param[in] _handle Indirect buffer handle.
+	/// @param[in] _access Buffer access. See `Access::Enum`.
+	///
 	/// @attention C99 equivalent is `bgfx_set_compute_indirect_buffer`.
 	///
 	void setBuffer(uint8_t _stage, IndirectBufferHandle _handle, Access::Enum _access);
 
 	/// Set compute image from texture.
 	///
+	/// @param[in] _stage Texture unit.
+	/// @param[in] _sampler Program sampler.
+	/// @param[in] _handle Texture handle.
+	/// @param[in] _mip Mip level.
+	/// @param[in] _access Texture access. See `Access::Enum`.
+	/// @param[in] _format Texture format. See: `TextureFormat::Enum`.
+	///
 	/// @attention C99 equivalent is `bgfx_set_image`.
 	///
 	void setImage(uint8_t _stage, UniformHandle _sampler, TextureHandle _handle, uint8_t _mip, Access::Enum _access, TextureFormat::Enum _format = TextureFormat::Count);
 
 	/// Set compute image from frame buffer texture.
 	///
+	/// @param[in] _stage Texture unit.
+	/// @param[in] _sampler Program sampler.
+	/// @param[in] _handle Frame buffer handle.
+	/// @param[in] _attachment Attachment index.
+	/// @param[in] _mip Mip level.
+	/// @param[in] _access Texture access. See `Access::Enum`.
+	/// @param[in] _format Texture format. See: `TextureFormat::Enum`.
+	///
 	/// @attention C99 equivalent is `bgfx_set_image_from_frame_buffer`.
 	///
 	void setImage(uint8_t _stage, UniformHandle _sampler, FrameBufferHandle _handle, uint8_t _attachment, Access::Enum _access, TextureFormat::Enum _format = TextureFormat::Count);