diff --git a/include/bgfx/bgfx.h b/include/bgfx/bgfx.h index 7c662d4c0..b4299eea8 100644 --- a/include/bgfx/bgfx.h +++ b/include/bgfx/bgfx.h @@ -2203,8 +2203,10 @@ namespace bgfx , uint8_t _7 = UINT8_MAX ); - /// Set view into sequential mode. Draw calls will be sorted in the same - /// order in which submit calls were called. + /// Set view sorting mode. + /// + /// @param[in] _id View id. + /// @param[in] _mode View sort mode. See `ViewMode::Enum`. /// /// @attention C99 equivalent is `bgfx_set_view_mode`. /// @@ -2290,8 +2292,13 @@ namespace bgfx /// `BGFX_STATE_BLEND_INV_FACTOR` blend modes. /// /// @remarks - /// 1. Use `BGFX_STATE_ALPHA_REF`, `BGFX_STATE_POINT_SIZE` and - /// `BGFX_STATE_BLEND_FUNC` macros to setup more complex states. + /// 1. To setup more complex states use: + /// `BGFX_STATE_ALPHA_REF(_ref)`, + /// `BGFX_STATE_POINT_SIZE(_size)`, + /// `BGFX_STATE_BLEND_FUNC(_src, _dst)`, + /// `BGFX_STATE_BLEND_FUNC_SEPARATE(_srcRGB, _dstRGB, _srcA, _dstA)` + /// `BGFX_STATE_BLEND_EQUATION(_equation)` + /// `BGFX_STATE_BLEND_EQUATION_SEPARATE(_equationRGB, _equationA)` /// 2. `BGFX_STATE_BLEND_EQUATION_ADD` is set when no other blend /// equation is specified. /// diff --git a/include/bgfx/defines.h b/include/bgfx/defines.h index f58a040bd..93572bb7b 100644 --- a/include/bgfx/defines.h +++ b/include/bgfx/defines.h @@ -71,6 +71,7 @@ #define BGFX_STATE_PT_SHIFT 48 //!< Primitive type bit shift. #define BGFX_STATE_PT_MASK UINT64_C(0x0007000000000000) //!< Primitive type bit mask. +/// See BGFX_STATE_POINT_SIZE(_size) helper macro. #define BGFX_STATE_POINT_SIZE_SHIFT 52 //!< Point size bit shift. #define BGFX_STATE_POINT_SIZE_MASK UINT64_C(0x00f0000000000000) //!< Point size bit mask. @@ -84,7 +85,6 @@ #define BGFX_STATE_RESERVED_SHIFT 61 //!< Internal bits shift. #define BGFX_STATE_RESERVED_MASK UINT64_C(0xe000000000000000) //!< Internal bits mask. -/// See BGFX_STATE_POINT_SIZE(_size) helper macro. #define BGFX_STATE_NONE UINT64_C(0x0000000000000000) //!< No state. #define BGFX_STATE_MASK UINT64_C(0xffffffffffffffff) //!< State mask.