scratchfoundation/bgfx
1
0
Fork 0
mirror of https://github.com/scratchfoundation/bgfx.git synced 2025-03-22 21:06:42 -04:00
Code Issues Projects Releases Packages Wiki Activity Actions

Updated docs.

Browse source
This commit is contained in:
Branimir Karadžić 2015-01-28 21:22:45 -08:00
parent 3de816bf34
commit 4eb9fe0127
1 changed files with 16 additions and 3 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

19
include/bgfx.h
View file

@ -637,10 +637,16 @@ namespace bgfx
/// Create empty dynamic index buffer. /// Create empty dynamic index buffer.
/// ///
/// @param _num Number of indices. /// @param _num Number of indices.
/// @param _flags `BGFX_BUFFER_*` flags. /// @param _flags Buffer creation flags.
/// `BGFX_BUFFER_COMPUTE_READ` - compute shader will read buffer.
/// `BGFX_BUFFER_COMPUTE_WRITE` - compute shader will write into buffer.
/// `BGFX_BUFFER_ALLOW_RESIZE` buffer can be resized if updated with different size buffer.
/// ///
/// @remarks /// @remarks
/// Only 16-bit index buffer is supported. /// 1. Only 16-bit index buffer is supported.
///
/// 2. When buffer is created with `BGFX_BUFFER_COMPUTE_WRITE` flag it cannot be updated
/// from CPU.
/// ///
DynamicIndexBufferHandle createDynamicIndexBuffer(uint32_t _num, uint8_t _flags = BGFX_BUFFER_NONE); DynamicIndexBufferHandle createDynamicIndexBuffer(uint32_t _num, uint8_t _flags = BGFX_BUFFER_NONE);
@ -670,7 +676,14 @@ namespace bgfx
/// ///
/// @param _num Number of vertices. /// @param _num Number of vertices.
/// @param _decl Vertex declaration. /// @param _decl Vertex declaration.
/// @param _flags `BGFX_BUFFER_*` flags. /// @param _flags Buffer creation flags.
/// `BGFX_BUFFER_COMPUTE_READ` - compute shader will read buffer.
/// `BGFX_BUFFER_COMPUTE_WRITE` - compute shader will write into buffer.
/// `BGFX_BUFFER_ALLOW_RESIZE` buffer can be resized if updated with different size buffer.
///
/// @remarks
/// When buffer is created with `BGFX_BUFFER_COMPUTE_WRITE` flag it cannot be updated
/// from CPU.
/// ///
DynamicVertexBufferHandle createDynamicVertexBuffer(uint16_t _num, const VertexDecl& _decl, uint8_t _flags = BGFX_BUFFER_NONE); DynamicVertexBufferHandle createDynamicVertexBuffer(uint16_t _num, const VertexDecl& _decl, uint8_t _flags = BGFX_BUFFER_NONE);