scratchfoundation/bgfx
1
0
Fork 0
mirror of https://github.com/scratchfoundation/bgfx.git synced 2024-11-28 18:45:54 -05:00
Code Issues Projects Releases Packages Wiki Activity Actions

Updated docs.

Browse source
This commit is contained in:
bkaradzic 2013-04-04 09:51:42 -07:00
parent 6ef213583b
commit 7b7e235a8e
1 changed files with 8 additions and 7 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

15
include/bgfx.h
View file

@ -587,8 +587,8 @@ namespace bgfx
/// Allocate transient index buffer. /// Allocate transient index buffer.
/// ///
/// @param[out] _tib is valid for the duration of frame, and it can be reused for /// @param[out] _tib is valid for the duration of frame, and it can be
/// multiple draw calls. /// reused for multiple draw calls.
/// @param _num number of indices to allocate. /// @param _num number of indices to allocate.
void allocTransientIndexBuffer(TransientIndexBuffer* _tib, uint16_t _num); void allocTransientIndexBuffer(TransientIndexBuffer* _tib, uint16_t _num);
@ -597,8 +597,8 @@ namespace bgfx
/// Allocate transient vertex buffer. /// Allocate transient vertex buffer.
/// ///
/// @param[out] _tvb is valid for the duration of frame, and it can be reused for /// @param[out] _tvb is valid for the duration of frame, and it can be
/// multiple draw calls. /// reused for multiple draw calls.
/// @param _num number of vertices to allocate. /// @param _num number of vertices to allocate.
/// @param _decl vertex declaration. /// @param _decl vertex declaration.
void allocTransientVertexBuffer(TransientVertexBuffer* _tvb, uint16_t _num, const VertexDecl& _decl); void allocTransientVertexBuffer(TransientVertexBuffer* _tvb, uint16_t _num, const VertexDecl& _decl);
@ -667,7 +667,8 @@ namespace bgfx
void updateTexture3D(TextureHandle _handle, uint8_t _mip, uint16_t _x, uint16_t _y, uint16_t _z, uint16_t _width, uint16_t _height, uint16_t _depth, const Memory* _mem); void updateTexture3D(TextureHandle _handle, uint8_t _mip, uint16_t _x, uint16_t _y, uint16_t _z, uint16_t _width, uint16_t _height, uint16_t _depth, const Memory* _mem);
/// Update Cube texture. /// Update Cube texture.
/// @param _side Cubemap side, where 0 is +X, 1 is -X, 2 is +Y, 3 is -Y, 4 is +Z, and 5 is -Z. /// @param _side Cubemap side, where 0 is +X, 1 is -X, 2 is +Y, 3 is
/// -Y, 4 is +Z, and 5 is -Z.
void updateTextureCube(TextureHandle _handle, uint8_t _side, uint8_t _mip, uint16_t _x, uint16_t _y, uint16_t _width, uint16_t _height, const Memory* _mem); void updateTextureCube(TextureHandle _handle, uint8_t _side, uint8_t _mip, uint16_t _x, uint16_t _y, uint16_t _width, uint16_t _height, const Memory* _mem);
/// Destroy texture. /// Destroy texture.
@ -758,8 +759,8 @@ namespace bgfx
/// ///
/// @param _mtx pointer to first matrix in array. /// @param _mtx pointer to first matrix in array.
/// @param _num number of matrices in array. /// @param _num number of matrices in array.
/// @returns index into matrix cache in case the same model matrix has to /// @returns index into matrix cache in case the same model matrix has
/// be used for other draw primitive call. /// to be used for other draw primitive call.
uint32_t setTransform(const void* _mtx, uint16_t _num = 1); uint32_t setTransform(const void* _mtx, uint16_t _num = 1);
/// Set model matrix from matrix cache for draw primitive. /// Set model matrix from matrix cache for draw primitive.