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:
Бранимир Караџић 2019-03-20 16:47:41 -07:00
parent 758b2b268b
commit 0af6d02fcd
3 changed files with 18 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
include/bgfx/bgfx.h
View File

@ -2749,6 +2749,8 @@ namespace bgfx
/// @param[in] _pitch Pitch of input image (bytes). When _pitch is set to
/// UINT16_MAX, it will be calculated internally based on _width.
///
/// @attention It's valid to update only mutable texture. See `bgfx::createTexture2D` for more info.
///
/// @attention C99 equivalent is `bgfx_update_texture_2d`.
///
void updateTexture2D(
@ -2775,6 +2777,8 @@ namespace bgfx
/// @param[in] _depth Depth of texture block.
/// @param[in] _mem Texture update data.
///
/// @attention It's valid to update only mutable texture. See `bgfx::createTexture3D` for more info.
///
/// @attention C99 equivalent is `bgfx_update_texture_3d`.
///
void updateTexture3D(
@ -2822,6 +2826,8 @@ namespace bgfx
/// @param[in] _pitch Pitch of input image (bytes). When _pitch is set to
/// UINT16_MAX, it will be calculated internally based on _width.
///
/// @attention It's valid to update only mutable texture. See `bgfx::createTextureCube` for more info.
///
/// @attention C99 equivalent is `bgfx_update_texture_cube`.
///
void updateTextureCube(

3
include/bgfx/c99/bgfx.h
View File

@ -1781,6 +1781,7 @@ BGFX_C_API bgfx_texture_handle_t bgfx_create_texture_cube(uint16_t _size, bool _
/**
* Update 2D texture.
* @attention It's valid to update only mutable texture. See `bgfx::createTexture2D` for more info.
*
* @param[in] _handle Texture handle.
* @param[in] _layer Layer in texture array.
@ -1798,6 +1799,7 @@ BGFX_C_API void bgfx_update_texture_2d(bgfx_texture_handle_t _handle, uint16_t _
/**
* Update 3D texture.
* @attention It's valid to update only mutable texture. See `bgfx::createTexture3D` for more info.
*
* @param[in] _handle Texture handle.
* @param[in] _mip Mip level.
@ -1814,6 +1816,7 @@ BGFX_C_API void bgfx_update_texture_3d(bgfx_texture_handle_t _handle, uint8_t _m
/**
* Update Cube texture.
* @attention It's valid to update only mutable texture. See `bgfx::createTextureCube` for more info.
*
* @param[in] _handle Texture handle.
* @param[in] _layer Layer in texture array.

9
scripts/bgfx.idl
View File

@ -1254,6 +1254,9 @@ func.createTextureCube
--- 1, expected memory layout is texture and all mips together for each array element.
--- Update 2D texture.
---
--- @attention It's valid to update only mutable texture. See `bgfx::createTexture2D` for more info.
---
func.updateTexture2D
"void"
.handle "TextureHandle" --- Texture handle.
@ -1269,6 +1272,9 @@ func.updateTexture2D
{ default = UINT16_MAX }
--- Update 3D texture.
---
--- @attention It's valid to update only mutable texture. See `bgfx::createTexture3D` for more info.
---
func.updateTexture3D
"void"
.handle "TextureHandle" --- Texture handle.
@ -1282,6 +1288,9 @@ func.updateTexture3D
.mem "const Memory*" --- Texture update data.
--- Update Cube texture.
---
--- @attention It's valid to update only mutable texture. See `bgfx::createTextureCube` for more info.
---
func.updateTextureCube
"void"
.handle "TextureHandle" --- Texture handle.