rooty/dxvk
1
0
Fork 0
mirror of https://github.com/doitsujin/dxvk.git synced 2025-01-31 05:52:11 +01:00
Code Issues Projects Releases Wiki Activity

[hud] Added some missing documentation

Browse Source
This commit is contained in:
Philip Rebohle 2018-06-28 01:18:16 +02:00
parent 832b3a9dba
commit 04bc13929f
No known key found for this signature in database
GPG Key ID: C8CC613427A31C99
1 changed files with 14 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

15
src/dxvk/hud/dxvk_hud.h
View File

@ -36,8 +36,21 @@ namespace dxvk::hud {
~Hud(); ~Hud();
/**
* \brief Update HUD
*
* Updates the data to display.
* Should be called once per frame.
*/
void update(); void update();
/**
* \brief Render HUD
*
* Renders the HUD to the given context.
* \param [in] ctx Device context
* \param [in] surfaceSize Image size, in pixels
*/
void render( void render(
const Rc<DxvkContext>& ctx, const Rc<DxvkContext>& ctx,
VkExtent2D surfaceSize); VkExtent2D surfaceSize);
@ -73,7 +86,7 @@ namespace dxvk::hud {
void renderHudElements( void renderHudElements(
const Rc<DxvkContext>& ctx); const Rc<DxvkContext>& ctx);
void updateUniformBuffer( void updateUniformBuffer(
const Rc<DxvkContext>& ctx, const Rc<DxvkContext>& ctx,
const HudUniformData& data); const HudUniformData& data);