From d81efe13245e4b367ed7adc69e572d26edeedb5e Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Branimir=20Karad=C5=BEi=C4=87?= Date: Thu, 24 Nov 2016 12:55:55 -0800 Subject: [PATCH] Updated docs. --- include/bgfx/bgfx.h | 8 +++++--- 1 file changed, 5 insertions(+), 3 deletions(-) diff --git a/include/bgfx/bgfx.h b/include/bgfx/bgfx.h index 631993632..01d6383ec 100644 --- a/include/bgfx/bgfx.h +++ b/include/bgfx/bgfx.h @@ -562,7 +562,7 @@ namespace bgfx Limits limits; - /// Supported texture formats. + /// Supported texture format capabilities flags: /// - `BGFX_CAPS_FORMAT_TEXTURE_NONE` - Texture format is not supported. /// - `BGFX_CAPS_FORMAT_TEXTURE_2D` - Texture format is supported. /// - `BGFX_CAPS_FORMAT_TEXTURE_2D_SRGB` - Texture as sRGB format is supported. @@ -581,6 +581,8 @@ namespace bgfx /// - `BGFX_CAPS_FORMAT_TEXTURE_FRAMEBUFFER_MSAA` - Texture format can be used as MSAA /// frame buffer. /// - `BGFX_CAPS_FORMAT_TEXTURE_MSAA` - Texture can be sampled as MSAA. + /// - `BGFX_CAPS_FORMAT_TEXTURE_MIP_AUTOGEN` - Texture format supports auto-generated + /// mips. uint16_t formats[TextureFormat::Count]; }; @@ -669,7 +671,7 @@ namespace bgfx /// struct Transform { - float* data; //!< Pointer to first matrix. + float* data; //!< Pointer to first 4x4 matrix. uint16_t num; //!< Number of matrices. }; @@ -690,7 +692,7 @@ namespace bgfx float fov[4]; //!< Field of view (up, down, left, right). float viewOffset[3]; //!< Eye view matrix translation adjustment. float projection[16]; //!< Eye projection matrix - float pixelsPerTanAngle[2]; //!< + float pixelsPerTanAngle[2]; //!< Number of pixels that fit in tan(angle) = 1. }; Eye eye[2];