Prechádzať zdrojové kódy

Merge pull request #726 from rogual/master

Document bgfx::touch.
Branimir Karadžić 9 rokov pred
rodič
commit
c3ece49892
1 zmenil súbory, kde vykonal 8 pridanie a 1 odobranie
  1. 8 1
      include/bgfx/bgfx.h

+ 8 - 1
include/bgfx/bgfx.h

@@ -2361,7 +2361,14 @@ namespace bgfx
 		, uint32_t _flags = UINT32_MAX
 		, uint32_t _flags = UINT32_MAX
 		);
 		);
 
 
-	/// Touch view.
+	/// Submit an empty primitive for rendering. Uniforms and draw state
+	/// will be applied but no geometry will be submitted.
+	///
+	/// These empty draw calls will sort before ordinary draw calls.
+	///
+	/// @param[in] _id View id.
+	/// @returns Number of draw calls.
+	///
 	uint32_t touch(uint8_t _id);
 	uint32_t touch(uint8_t _id);
 
 
 	/// Submit primitive for rendering.
 	/// Submit primitive for rendering.