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

Fixed Doxygen warnings (#3330)

This commit is contained in:
Sim Saëns 2024-07-28 20:47:56 +09:30 committed by GitHub
parent b4df15f848
commit 0de1f036d8
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
1 changed files with 14 additions and 7 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

21
include/bgfx/bgfx.h
View File

@ -1010,7 +1010,7 @@ namespace bgfx
uint32_t numCompute; //!< Number of compute calls submitted.
uint32_t numBlit; //!< Number of blit calls submitted.
uint32_t maxGpuLatency; //!< GPU driver latency.
uint32_t gpuFrameNum; //<! Frame which generated gpuTimeBegin, gpuTimeEnd.
uint32_t gpuFrameNum; //!< Frame which generated gpuTimeBegin, gpuTimeEnd.
uint16_t numDynamicIndexBuffers; //!< Number of used dynamic index buffers.
uint16_t numDynamicVertexBuffers; //!< Number of used dynamic vertex buffers.
@ -2006,7 +2006,7 @@ namespace bgfx
/// Returns supported backend API renderers.
///
/// @param[in] _max Maximum number of elements in _enum array.
/// @param[inout] _enum Array where supported renderers will be written.
/// @param[in,out] _enum Array where supported renderers will be written.
///
/// @returns Number of supported renderers.
///
@ -2192,7 +2192,8 @@ namespace bgfx
/// Print into internal debug text character-buffer (VGA-compatible text mode).
///
/// @param[in] _x, _y 2D position from top-left.
/// @param[in] _x The X coordinate (2D position from top-left)
/// @param[in] _y The Y coordinate (2D position from top-left)
/// @param[in] _attr Color palette. Where top 4-bits represent index of background, and bottom
/// 4-bits represent foreground color from standard VGA text palette (ANSI escape codes).
/// @param[in] _format `printf` style format.
@ -2209,7 +2210,8 @@ namespace bgfx
/// Print into internal debug text character-buffer (VGA-compatible text mode).
///
/// @param[in] _x, _y 2D position from top-left.
/// @param[in] _x The X coordinate (2D position from top-left)
/// @param[in] _y The Y coordinate (2D position from top-left)
/// @param[in] _attr Color palette. Where top 4-bits represent index of background, and bottom
/// 4-bits represent foreground color from standard VGA text palette (ANSI escape codes).
/// @param[in] _format `printf` style format.
@ -2227,8 +2229,10 @@ namespace bgfx
/// Draw image into internal debug text buffer.
///
/// @param[in] _x, _y 2D position from top-left.
/// @param[in] _width, _height Image width and height.
/// @param[in] _x The X coordinate (2D position from top-left)
/// @param[in] _y The Y coordinate (2D position from top-left)
/// @param[in] _width Image width
/// @param[in] _height Image height
/// @param[in] _data Raw image data (character/attribute raw encoding).
/// @param[in] _pitch Image pitch in bytes.
///
@ -3314,7 +3318,10 @@ namespace bgfx
/// Set palette color value.
///
/// @param[in] _index Index into palette.
/// @param[in] _r, _g, _b, _a RGBA floating point values.
/// @param[in] _r Red value (RGBA floating point values)
/// @param[in] _g Green value (RGBA floating point values)
/// @param[in] _b Blue value (RGBA floating point values)
/// @param[in] _a Alpha value (RGBA floating point values)
///
/// @attention C99's equivalent binding is `bgfx_set_palette_color`.
///