Browse Source

Updated docs.

Branimir Karadžić 10 years ago
parent
commit
4a7d0d1954
1 changed files with 8 additions and 2 deletions
  1. 8 2
      include/bgfx.h

+ 8 - 2
include/bgfx.h

@@ -218,8 +218,8 @@ namespace bgfx
 	/// Cached items are currently used only for OpenGL binary shaders.
 	/// Cached items are currently used only for OpenGL binary shaders.
 	///
 	///
 	/// @remarks
 	/// @remarks
-	///   'fatal' callback can be called from any thread. Other callbacks
-	///   are called from the render thread.
+	///   'fatal' and 'trace' callbacks can be called from any thread. Other
+	///   callbacks are called from the render thread.
 	///
 	///
 	struct CallbackI
 	struct CallbackI
 	{
 	{
@@ -232,12 +232,18 @@ namespace bgfx
 		/// @param[in] _code Fatal error code.
 		/// @param[in] _code Fatal error code.
 		/// @param[in] _str More information about error.
 		/// @param[in] _str More information about error.
 		///
 		///
+		/// @remarks
+		///   Not thread safe and it can be called from any thread.
+		///
 		virtual void fatal(Fatal::Enum _code, const char* _str) = 0;
 		virtual void fatal(Fatal::Enum _code, const char* _str) = 0;
 
 
 		/// Print debug message.
 		/// Print debug message.
 		///
 		///
 		/// @param[in] _str Message.
 		/// @param[in] _str Message.
 		///
 		///
+		/// @remarks
+		///   Not thread safe and it can be called from any thread.
+		///
 		virtual void trace(const char* _str) = 0;
 		virtual void trace(const char* _str) = 0;
 
 
 		/// Return size of for cached item. Return 0 if no cached item was
 		/// Return size of for cached item. Return 0 if no cached item was