mirrors/bgfx
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Updated docs.

Browse Source
This commit is contained in:
Branimir Karadžić 2018-08-24 19:56:01 -07:00
parent f48b6c9951
commit ce8840993b
2 changed files with 11 additions and 11 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

20
include/bgfx/bgfx.h
View File

@ -2515,8 +2515,8 @@ namespace bgfx
/// Create texture from memory buffer. /// Create texture from memory buffer.
/// ///
/// @param[in] _mem DDS, KTX or PVR texture data. /// @param[in] _mem DDS, KTX or PVR texture data.
/// @param[in] _flags Default texture sampling mode is linear, and wrap mode /// @param[in] _flags Texture creation (see `BGFX_TEXTURE_*`.), and sampler (see `BGFX_SAMPLER_*`)
/// is repeat. /// flags. Default texture sampling mode is linear, and wrap mode is repeat.
/// - `BGFX_SAMPLER_[U/V/W]_[MIRROR/CLAMP]` - Mirror or clamp to edge wrap /// - `BGFX_SAMPLER_[U/V/W]_[MIRROR/CLAMP]` - Mirror or clamp to edge wrap
/// mode. /// mode.
/// - `BGFX_SAMPLER_[MIN/MAG/MIP]_[POINT/ANISOTROPIC]` - Point or anisotropic /// - `BGFX_SAMPLER_[MIN/MAG/MIP]_[POINT/ANISOTROPIC]` - Point or anisotropic
@ -2543,8 +2543,8 @@ namespace bgfx
/// @param[in] _numLayers Number of layers in texture array. Must be 1 if caps /// @param[in] _numLayers Number of layers in texture array. Must be 1 if caps
/// `BGFX_CAPS_TEXTURE_2D_ARRAY` flag is not set. /// `BGFX_CAPS_TEXTURE_2D_ARRAY` flag is not set.
/// @param[in] _format Texture format. See: `TextureFormat::Enum`. /// @param[in] _format Texture format. See: `TextureFormat::Enum`.
/// @param[in] _flags Default texture sampling mode is linear, and wrap mode /// @param[in] _flags Texture creation (see `BGFX_TEXTURE_*`.), and sampler (see `BGFX_SAMPLER_*`)
/// is repeat. /// flags. Default texture sampling mode is linear, and wrap mode is repeat.
/// - `BGFX_SAMPLER_[U/V/W]_[MIRROR/CLAMP]` - Mirror or clamp to edge wrap /// - `BGFX_SAMPLER_[U/V/W]_[MIRROR/CLAMP]` - Mirror or clamp to edge wrap
/// mode. /// mode.
/// - `BGFX_SAMPLER_[MIN/MAG/MIP]_[POINT/ANISOTROPIC]` - Point or anisotropic /// - `BGFX_SAMPLER_[MIN/MAG/MIP]_[POINT/ANISOTROPIC]` - Point or anisotropic
@ -2575,8 +2575,8 @@ namespace bgfx
/// @param[in] _numLayers Number of layers in texture array. Must be 1 if caps /// @param[in] _numLayers Number of layers in texture array. Must be 1 if caps
/// `BGFX_CAPS_TEXTURE_2D_ARRAY` flag is not set. /// `BGFX_CAPS_TEXTURE_2D_ARRAY` flag is not set.
/// @param[in] _format Texture format. See: `TextureFormat::Enum`. /// @param[in] _format Texture format. See: `TextureFormat::Enum`.
/// @param[in] _flags Default texture sampling mode is linear, and wrap mode /// @param[in] _flags Texture creation (see `BGFX_TEXTURE_*`.), and sampler (see `BGFX_SAMPLER_*`)
/// is repeat. /// flags. Default texture sampling mode is linear, and wrap mode is repeat.
/// - `BGFX_SAMPLER_[U/V/W]_[MIRROR/CLAMP]` - Mirror or clamp to edge wrap /// - `BGFX_SAMPLER_[U/V/W]_[MIRROR/CLAMP]` - Mirror or clamp to edge wrap
/// mode. /// mode.
/// - `BGFX_SAMPLER_[MIN/MAG/MIP]_[POINT/ANISOTROPIC]` - Point or anisotropic /// - `BGFX_SAMPLER_[MIN/MAG/MIP]_[POINT/ANISOTROPIC]` - Point or anisotropic
@ -2599,8 +2599,8 @@ namespace bgfx
/// @param[in] _depth Depth. /// @param[in] _depth Depth.
/// @param[in] _hasMips Indicates that texture contains full mip-map chain. /// @param[in] _hasMips Indicates that texture contains full mip-map chain.
/// @param[in] _format Texture format. See: `TextureFormat::Enum`. /// @param[in] _format Texture format. See: `TextureFormat::Enum`.
/// @param[in] _flags Default texture sampling mode is linear, and wrap mode /// @param[in] _flags Texture creation (see `BGFX_TEXTURE_*`.), and sampler (see `BGFX_SAMPLER_*`)
/// is repeat. /// flags. Default texture sampling mode is linear, and wrap mode is repeat.
/// - `BGFX_SAMPLER_[U/V/W]_[MIRROR/CLAMP]` - Mirror or clamp to edge wrap /// - `BGFX_SAMPLER_[U/V/W]_[MIRROR/CLAMP]` - Mirror or clamp to edge wrap
/// mode. /// mode.
/// - `BGFX_SAMPLER_[MIN/MAG/MIP]_[POINT/ANISOTROPIC]` - Point or anisotropic /// - `BGFX_SAMPLER_[MIN/MAG/MIP]_[POINT/ANISOTROPIC]` - Point or anisotropic
@ -2628,8 +2628,8 @@ namespace bgfx
/// @param[in] _numLayers Number of layers in texture array. Must be 1 if caps /// @param[in] _numLayers Number of layers in texture array. Must be 1 if caps
/// `BGFX_CAPS_TEXTURE_CUBE_ARRAY` flag is not set. /// `BGFX_CAPS_TEXTURE_CUBE_ARRAY` flag is not set.
/// @param[in] _format Texture format. See: `TextureFormat::Enum`. /// @param[in] _format Texture format. See: `TextureFormat::Enum`.
/// @param[in] _flags Default texture sampling mode is linear, and wrap mode /// @param[in] _flags Texture creation (see `BGFX_TEXTURE_*`.), and sampler (see `BGFX_SAMPLER_*`)
/// is repeat. /// flags. Default texture sampling mode is linear, and wrap mode is repeat.
/// - `BGFX_SAMPLER_[U/V/W]_[MIRROR/CLAMP]` - Mirror or clamp to edge wrap /// - `BGFX_SAMPLER_[U/V/W]_[MIRROR/CLAMP]` - Mirror or clamp to edge wrap
/// mode. /// mode.
/// - `BGFX_SAMPLER_[MIN/MAG/MIP]_[POINT/ANISOTROPIC]` - Point or anisotropic /// - `BGFX_SAMPLER_[MIN/MAG/MIP]_[POINT/ANISOTROPIC]` - Point or anisotropic

2
include/bgfx/defines.h
View File

@ -337,7 +337,7 @@
/// Texture creation flags. /// Texture creation flags.
#define BGFX_TEXTURE_NONE UINT64_C(0x0000000000000000) //!< #define BGFX_TEXTURE_NONE UINT64_C(0x0000000000000000) //!<
#define BGFX_TEXTURE_MSAA_SAMPLE UINT64_C(0x0000000800000000) //!< Texture will be used for MSAA sampling. #define BGFX_TEXTURE_MSAA_SAMPLE UINT64_C(0x0000000800000000) //!< Texture will be used for MSAA sampling.
#define BGFX_TEXTURE_RT UINT64_C(0x0000001000000000) //!< #define BGFX_TEXTURE_RT UINT64_C(0x0000001000000000) //!< Render target no MSAA.
#define BGFX_TEXTURE_RT_MSAA_X2 UINT64_C(0x0000002000000000) //!< Render target MSAAx2 mode. #define BGFX_TEXTURE_RT_MSAA_X2 UINT64_C(0x0000002000000000) //!< Render target MSAAx2 mode.
#define BGFX_TEXTURE_RT_MSAA_X4 UINT64_C(0x0000003000000000) //!< Render target MSAAx4 mode. #define BGFX_TEXTURE_RT_MSAA_X4 UINT64_C(0x0000003000000000) //!< Render target MSAAx4 mode.
#define BGFX_TEXTURE_RT_MSAA_X8 UINT64_C(0x0000004000000000) //!< Render target MSAAx8 mode. #define BGFX_TEXTURE_RT_MSAA_X8 UINT64_C(0x0000004000000000) //!< Render target MSAAx8 mode.