From 6ef213583bf471a6fbcacd126ffb32a0f4f5e2a4 Mon Sep 17 00:00:00 2001 From: bkaradzic Date: Thu, 4 Apr 2013 09:48:20 -0700 Subject: [PATCH] Updated docs. --- include/bgfx.h | 14 +++++++++++++- 1 file changed, 13 insertions(+), 1 deletion(-) diff --git a/include/bgfx.h b/include/bgfx.h index b694c115e..507ab0827 100644 --- a/include/bgfx.h +++ b/include/bgfx.h @@ -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.