mirrors/bgfx
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Updated docs.

Browse Source
This commit is contained in:
bkaradzic 2013-04-04 09:48:20 -07:00
parent d34cd0251b
commit 6ef213583b
1 changed files with 13 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

14
include/bgfx.h
View File

@ -345,7 +345,7 @@ namespace bgfx
typedef void (*FreeFn)(void* _ptr);
/// Callback interface to implement application specific behavior.
/// Cached items are currently used only when for OpenGL binary shaders.
/// Cached items are currently used only for OpenGL binary shaders.
///
/// NOTE:
/// 'fatal' callback can be called from any thread. Other callbacks
@ -490,6 +490,18 @@ namespace bgfx
RendererType::Enum getRendererType();
/// Initialize bgfx library.
///
/// @param _callback Provide application specific callback interface.
/// See: CallbackI
///
/// @param _realloc Custom realloc function.
/// @param _free Custom free function.
///
/// NOTE: In order to properly set custom allocator realloc and free,
/// both functions must be provided. When custom allocator is not
/// specified, library uses default CRT allocator. The library assumes
/// custom allocator is thread safe.
///
void init(CallbackI* _callback = NULL, ReallocFn _realloc = NULL, FreeFn _free = NULL);
/// Shutdown bgfx library.