mirrors
/
bgfx
mirror of https://github.com/bkaradzic/bgfx
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Changes to API reference (#3286) 

* Update bgfx.rst

Added Texture Flags BGFX_TEXTURE_* in Textures section under TextureFormat

* Update bgfx.h

Added a specific mention that Texture creation BGFX_TEXTURE_* flags can be used, in both relevant createFrameBuffer prototypes
This commit is contained in:
kschoice-fr 2024-05-05 08:52:43 +02:00 committed by GitHub
parent 1437b5c966
commit 2dfc9d14b6
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
2 changed files with 19 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

16
docs/bgfx.rst
View File

@ -318,7 +318,7 @@ State Flags
.. doxygendefine:: BGFX_STATE_BLEND_FACTOR
.. doxygendefine:: BGFX_STATE_BLEND_INV_FACTOR
**Blend Equaation**
**Blend Equation**
.. doxygendefine:: BGFX_STATE_BLEND_EQUATION_ADD
.. doxygendefine:: BGFX_STATE_BLEND_EQUATION_SUB
@ -550,6 +550,20 @@ Textures
.. doxygenstruct:: bgfx::TextureFormat
:members:
**Texture Flags**
.. doxygendefine:: BGFX_TEXTURE_MSAA_SAMPLE
.. doxygendefine:: BGFX_TEXTURE_RT
.. doxygendefine:: BGFX_TEXTURE_COMPUTE_WRITE
.. doxygendefine:: BGFX_TEXTURE_SRGB
.. doxygendefine:: BGFX_TEXTURE_BLIT_DST
.. doxygendefine:: BGFX_TEXTURE_READ_BACK
.. doxygendefine:: BGFX_TEXTURE_RT_MSAA_X2
.. doxygendefine:: BGFX_TEXTURE_RT_MSAA_X4
.. doxygendefine:: BGFX_TEXTURE_RT_MSAA_X8
.. doxygendefine:: BGFX_TEXTURE_RT_MSAA_X16
.. doxygendefine:: BGFX_TEXTURE_RT_WRITE_ONLY
.. doxygenfunction:: bgfx::isTextureValid
.. doxygenstruct:: bgfx::TextureInfo

6
include/bgfx/bgfx.h
View File

@ -3070,7 +3070,8 @@ namespace bgfx
/// @param[in] _width Texture width.
/// @param[in] _height Texture height.
/// @param[in] _format Texture format. See: `TextureFormat::Enum`.
/// @param[in] _textureFlags Default texture sampling mode is linear, and wrap mode
/// @param[in] _textureFlags Texture creation (see `BGFX_TEXTURE_*`.), and sampler (see `BGFX_SAMPLER_*`)
/// 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
/// mode.
@ -3094,7 +3095,8 @@ namespace bgfx
/// @param[in] _ratio Frame buffer size in respect to back-buffer size. See:
/// `BackbufferRatio::Enum`.
/// @param[in] _format Texture format. See: `TextureFormat::Enum`.
/// @param[in] _textureFlags Default texture sampling mode is linear, and wrap mode
/// @param[in] _textureFlags Texture creation (see `BGFX_TEXTURE_*`.), and sampler (see `BGFX_SAMPLER_*`)
/// 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
/// mode.