Browse Source

Updated docs.

Бранимир Караџић 5 years ago
parent
commit
6a1db4c2a2
5 changed files with 18 additions and 7 deletions
  1. 3 1
      bindings/cs/bgfx.cs
  2. 6 2
      bindings/d/funcs.d
  3. 3 2
      include/bgfx/bgfx.h
  4. 3 1
      include/bgfx/c99/bgfx.h
  5. 3 1
      scripts/bgfx.idl

+ 3 - 1
bindings/cs/bgfx.cs

@@ -3721,7 +3721,9 @@ public static partial class bgfx
 	
 	/// <summary>
 	/// 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.
 	/// </summary>

+ 6 - 2
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:

+ 3 - 2
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);

+ 3 - 1
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.
  *

+ 3 - 1
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.