From 6a1db4c2a2993d7ab3a12c3d688df103998d7b1b Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?=D0=91=D1=80=D0=B0=D0=BD=D0=B8=D0=BC=D0=B8=D1=80=20=D0=9A?= =?UTF-8?q?=D0=B0=D1=80=D0=B0=D1=9F=D0=B8=D1=9B?= Date: Tue, 14 Apr 2020 20:13:22 -0700 Subject: [PATCH] Updated docs. --- bindings/cs/bgfx.cs | 4 +++- bindings/d/funcs.d | 8 ++++++-- include/bgfx/bgfx.h | 5 +++-- include/bgfx/c99/bgfx.h | 4 +++- scripts/bgfx.idl | 4 +++- 5 files changed, 18 insertions(+), 7 deletions(-) diff --git a/bindings/cs/bgfx.cs b/bindings/cs/bgfx.cs index ac25fd0e0..32802b678 100644 --- a/bindings/cs/bgfx.cs +++ b/bindings/cs/bgfx.cs @@ -3721,7 +3721,9 @@ public static partial class bgfx /// /// Submit an empty primitive for rendering. Uniforms and draw state - /// will be applied but no geometry will be submitted. + /// will be applied but no geometry will be submitted. Useful in cases + /// when no other draw/compute primitive is submitted to view, but it's + /// desired to execute clear view. /// @remark /// These empty draw calls will sort before ordinary draw calls. /// diff --git a/bindings/d/funcs.d b/bindings/d/funcs.d index 076f77b84..879d36464 100644 --- a/bindings/d/funcs.d +++ b/bindings/d/funcs.d @@ -1449,7 +1449,9 @@ version(BindBgfx_Static) /** * Submit an empty primitive for rendering. Uniforms and draw state - * will be applied but no geometry will be submitted. + * will be applied but no geometry will be submitted. Useful in cases + * when no other draw/compute primitive is submitted to view, but it's + * desired to execute clear view. * Remarks: * These empty draw calls will sort before ordinary draw calls. * Params: @@ -3637,7 +3639,9 @@ else /** * Submit an empty primitive for rendering. Uniforms and draw state - * will be applied but no geometry will be submitted. + * will be applied but no geometry will be submitted. Useful in cases + * when no other draw/compute primitive is submitted to view, but it's + * desired to execute clear view. * Remarks: * These empty draw calls will sort before ordinary draw calls. * Params: diff --git a/include/bgfx/bgfx.h b/include/bgfx/bgfx.h index 38fc59176..bc4105334 100644 --- a/include/bgfx/bgfx.h +++ b/include/bgfx/bgfx.h @@ -1394,13 +1394,14 @@ namespace bgfx ); /// Submit an empty primitive for rendering. Uniforms and draw state - /// will be applied but no geometry will be submitted. + /// will be applied but no geometry will be submitted. Useful in cases + /// when no other draw/compute primitive is submitted to view, but it's + /// desired to execute clear view. /// /// These empty draw calls will sort before ordinary draw calls. /// /// @param[in] _id View id. /// - /// /// @attention C99 equivalent is `bgfx_encoder_touch`. /// void touch(ViewId _id); diff --git a/include/bgfx/c99/bgfx.h b/include/bgfx/c99/bgfx.h index 3b78c38d3..3d80bae75 100644 --- a/include/bgfx/c99/bgfx.h +++ b/include/bgfx/c99/bgfx.h @@ -2551,7 +2551,9 @@ BGFX_C_API void bgfx_encoder_set_texture(bgfx_encoder_t* _this, uint8_t _stage, /** * Submit an empty primitive for rendering. Uniforms and draw state - * will be applied but no geometry will be submitted. + * will be applied but no geometry will be submitted. Useful in cases + * when no other draw/compute primitive is submitted to view, but it's + * desired to execute clear view. * @remark * These empty draw calls will sort before ordinary draw calls. * diff --git a/scripts/bgfx.idl b/scripts/bgfx.idl index 67ae019a5..a1621042d 100644 --- a/scripts/bgfx.idl +++ b/scripts/bgfx.idl @@ -2340,7 +2340,9 @@ func.Encoder.setTexture --- sampling. --- Submit an empty primitive for rendering. Uniforms and draw state ---- will be applied but no geometry will be submitted. +--- will be applied but no geometry will be submitted. Useful in cases +--- when no other draw/compute primitive is submitted to view, but it's +--- desired to execute clear view. --- --- @remark --- These empty draw calls will sort before ordinary draw calls.