Quellcode durchsuchen

Clarified docs.

Branimir Karadžić vor 7 Jahren
Ursprung
Commit
d1aba38a27
1 geänderte Dateien mit 3 neuen und 1 gelöschten Zeilen
  1. 3 1
      include/bgfx/bgfx.h

+ 3 - 1
include/bgfx/bgfx.h

@@ -666,7 +666,9 @@ namespace bgfx
 	///
 	typedef void (*ReleaseFn)(void* _ptr, void* _userData);
 
-	/// Memory obtained by calling `bgfx::alloc`, `bgfx::copy`, or `bgfx::makeRef`.
+	/// Memory must be obtained by calling `bgfx::alloc`, `bgfx::copy`, or `bgfx::makeRef`.
+	///
+	/// @attention It is illegal to create this structure on stack and pass it to any bgfx API.
 	///
 	/// @attention C99 equivalent is `bgfx_memory_t`.
 	///