From 26eec1438ee9aa2c4d29355cd51ef4a1dde80611 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Branimir=20Karad=C5=BEi=C4=87?= Date: Tue, 31 Jan 2017 22:08:37 -0800 Subject: [PATCH] Updated docs. --- include/bgfx/bgfx.h | 15 ++++++++------- 1 file changed, 8 insertions(+), 7 deletions(-) diff --git a/include/bgfx/bgfx.h b/include/bgfx/bgfx.h index dfea79d03..2dc340ec3 100644 --- a/include/bgfx/bgfx.h +++ b/include/bgfx/bgfx.h @@ -1639,9 +1639,9 @@ namespace bgfx /// - `BGFX_TEXTURE_[MIN/MAG/MIP]_[POINT/ANISOTROPIC]` - Point or anisotropic /// sampling. /// - /// @param[in] _mem Texture data. If `_mem` is non-NULL, created texture will be immutable. - /// When `_numLayers` is more than 1, expected memory layout is texture and all mips together - /// for each array element. + /// @param[in] _mem Texture data. If `_mem` is non-NULL, created texture will be immutable. If + /// `_mem` is NULL content of the texture is uninitialized. When `_numLayers` is more than + /// 1, expected memory layout is texture and all mips together for each array element. /// /// @attention C99 equivalent is `bgfx_create_texture_2d`. /// @@ -1695,7 +1695,8 @@ namespace bgfx /// - `BGFX_TEXTURE_[MIN/MAG/MIP]_[POINT/ANISOTROPIC]` - Point or anisotropic /// sampling. /// - /// @param[in] _mem Texture data. If `_mem` is non-NULL, created texture will be immutable. + /// @param[in] _mem Texture data. If `_mem` is non-NULL, created texture will be immutable. If + /// `_mem` is NULL content of the texture is uninitialized. /// /// @attention C99 equivalent is `bgfx_create_texture_3d`. /// @@ -1723,9 +1724,9 @@ namespace bgfx /// - `BGFX_TEXTURE_[MIN/MAG/MIP]_[POINT/ANISOTROPIC]` - Point or anisotropic /// sampling. /// - /// @param[in] _mem Texture data. If `_mem` is non-NULL, created texture will be immutable. - /// When `_numLayers` is more than 1, expected memory layout is cubemap texture and all mips - /// together for each array element. + /// @param[in] _mem Texture data. If `_mem` is non-NULL, created texture will be immutable. If + /// `_mem` is NULL content of the texture is uninitialized. When `_numLayers` is more than + /// 1, expected memory layout is texture and all mips together for each array element. /// /// @attention C99 equivalent is `bgfx_create_texture_cube`. ///