scratchfoundation/bgfx
1
0
Fork 0
mirror of https://github.com/scratchfoundation/bgfx.git synced 2024-11-28 10:35:43 -05:00
Code Issues Projects Releases Packages Wiki Activity Actions

Updated docs.

Browse source
This commit is contained in:
bkaradzic 2013-07-07 11:59:43 -07:00
parent da5d390262
commit c4f6068c80
1 changed files with 20 additions and 8 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

28
include/bgfx.h
View file

@ -745,7 +745,7 @@ namespace bgfx
/// Set view name. /// Set view name.
/// ///
/// @param _id view id. /// @param _id View id.
/// @param _name View name. /// @param _name View name.
/// ///
/// NOTE: /// NOTE:
@ -761,11 +761,12 @@ namespace bgfx
/// Set view clear flags. /// Set view clear flags.
/// ///
/// @param _id view id. /// @param _id View id.
/// @param _flags clear flags. See: BGFX_CLEAR_* /// @param _flags Clear flags. Use BGFX_CLEAR_NONE to remove any clear
/// @param _rgba color clear value. /// operation. See: BGFX_CLEAR_*.
/// @param _depth depth clear value. /// @param _rgba Color clear value.
/// @param _stencil stencil clear value. /// @param _depth Depth clear value.
/// @param _stencil Stencil clear value.
/// ///
void setViewClear(uint8_t _id, uint8_t _flags, uint32_t _rgba = 0x000000ff, float _depth = 1.0f, uint8_t _stencil = 0); void setViewClear(uint8_t _id, uint8_t _flags, uint32_t _rgba = 0x000000ff, float _depth = 1.0f, uint8_t _stencil = 0);
@ -779,11 +780,22 @@ namespace bgfx
/// Set mulitple views into sequential mode. /// Set mulitple views into sequential mode.
void setViewSeqMask(uint32_t _viewMask, bool _enabled); void setViewSeqMask(uint32_t _viewMask, bool _enabled);
/// Set view render target. View without render target draws primitives /// Set view render target.
/// into default backbuffer. ///
/// @param _id View id.
/// @param _handle Render target handle. Passing BGFX_INVALID_HANDLE as
/// render target handle will draw primitives from this view into
/// default backbuffer.
///
void setViewRenderTarget(uint8_t _id, RenderTargetHandle _handle); void setViewRenderTarget(uint8_t _id, RenderTargetHandle _handle);
/// Set view render target for multiple views. /// Set view render target for multiple views.
///
/// @param _viewMask View mask.
/// @param _handle Render target handle. Passing BGFX_INVALID_HANDLE as
/// render target handle will draw primitives from this view into
/// default backbuffer.
///
void setViewRenderTargetMask(uint32_t _viewMask, RenderTargetHandle _handle); void setViewRenderTargetMask(uint32_t _viewMask, RenderTargetHandle _handle);
/// Set view view and projection matrices, all draw primitives in this /// Set view view and projection matrices, all draw primitives in this