From 7115f60b91b5717d90f643fd692010905c7004db Mon Sep 17 00:00:00 2001 From: Bryan Galdrikian Date: Thu, 31 May 2018 11:36:08 -0700 Subject: Blast 1.1.3. See docs/release_notes.txt. --- docs/_source/api_globals_users_guide.txt | 200 +++++++++++++++---------------- 1 file changed, 100 insertions(+), 100 deletions(-) mode change 100644 => 100755 docs/_source/api_globals_users_guide.txt (limited to 'docs/_source/api_globals_users_guide.txt') diff --git a/docs/_source/api_globals_users_guide.txt b/docs/_source/api_globals_users_guide.txt old mode 100644 new mode 100755 index 00b35ef..834c0a8 --- a/docs/_source/api_globals_users_guide.txt +++ b/docs/_source/api_globals_users_guide.txt @@ -1,100 +1,100 @@ -/*! \page pageglobalsapi Globals API (NvBlastGlobals) - -The NvBlastGlobals library is a utility library which is used by NvBlastTk (see \ref pagehlapi) and some extensions (see \ref pageextapi) and samples. - -It provides a global allocator, error callback, and profiler API. - -
-\section globalsallocator Allocator - -Include NvBlastGlobals.h -
- -A global allocator with interface - -\code -Nv::Blast::AllocatorCallback -\endcode - -may be set by the user with the function - -\code -NvBlastGlobalSetAllocatorCallback -\endcode - -and accessed using - -\code -NvBlastGlobalGetAllocatorCallback -\endcode - -An internal, default allocator is used if the user does not set their own, or if NULL is passed into NvBlastGlobalSetAllocatorCallback. - -This allocator is used by NvBlastTk, as well as any extension that allocates memory. In addition, utility macros are provided such as -NVBLAST_ALLOC, NVBLAST_FREE, NVBLAST_NEW, and NVBLAST_DELETE. - -
-\section globalserror Error Callback - -Include NvBlastGlobals.h - -A global error message callback with interface - -\code -Nv::Blast::ErrorCallback -\endcode - -may be set by the user with the function - -\code -NvBlastGlobalSetErrorCallback -\endcode - -and accessed using - -\code -NvBlastGlobalGetErrorCallback -\endcode - -An internal, default error callback is used if the user does not set their own, or if NULL is passed into NvBlastGlobalSetErrorCallback. - -This error callback is used by NvBlastTk, as well as many extensions. In addition, utility macros are provided such as -NVBLAST_LOG_ERROR and NVBLAST_LOG_WARNING. - -Finally, a function with signature given by NvBlastLog is provided which uses the global error callback, - -\code -Nv::Blast::logLL -\endcode - -This function may be passed into any NvBlast&tm; function's log parameter. - -
-\section globalsprofiler Profiler API - -Include NvBlastProfiler.h -
- -BlastTk contains many profiling zones which use the global profiler which can be accessed in this library. The user may implement -the interface - -\code -Nv::Blast::ProfilerCallback -\endcode - -and pass it to the globals library using - -\code -NvBlastProfilerSetCallback -\endcode - -A NULL pointer may be passed in, disabling profiling. Profiler features are only active in checked, debug and profile builds. - -The granularity of events reported can be selected with - -\code -NvBlastProfilerSetDetail -\endcode - -
-*/ +/*! \page pageglobalsapi Globals API (NvBlastGlobals) + +The NvBlastGlobals library is a utility library which is used by NvBlastTk (see \ref pagehlapi) and some extensions (see \ref pageextapi) and samples. + +It provides a global allocator, error callback, and profiler API. + +
+\section globalsallocator Allocator + +Include NvBlastGlobals.h +
+ +A global allocator with interface + +\code +Nv::Blast::AllocatorCallback +\endcode + +may be set by the user with the function + +\code +NvBlastGlobalSetAllocatorCallback +\endcode + +and accessed using + +\code +NvBlastGlobalGetAllocatorCallback +\endcode + +An internal, default allocator is used if the user does not set their own, or if NULL is passed into NvBlastGlobalSetAllocatorCallback. + +This allocator is used by NvBlastTk, as well as any extension that allocates memory. In addition, utility macros are provided such as +NVBLAST_ALLOC, NVBLAST_FREE, NVBLAST_NEW, and NVBLAST_DELETE. + +
+\section globalserror Error Callback + +Include NvBlastGlobals.h + +A global error message callback with interface + +\code +Nv::Blast::ErrorCallback +\endcode + +may be set by the user with the function + +\code +NvBlastGlobalSetErrorCallback +\endcode + +and accessed using + +\code +NvBlastGlobalGetErrorCallback +\endcode + +An internal, default error callback is used if the user does not set their own, or if NULL is passed into NvBlastGlobalSetErrorCallback. + +This error callback is used by NvBlastTk, as well as many extensions. In addition, utility macros are provided such as +NVBLAST_LOG_ERROR and NVBLAST_LOG_WARNING. + +Finally, a function with signature given by NvBlastLog is provided which uses the global error callback, + +\code +Nv::Blast::logLL +\endcode + +This function may be passed into any NvBlast&tm; function's log parameter. + +
+\section globalsprofiler Profiler API + +Include NvBlastProfiler.h +
+ +BlastTk contains many profiling zones which use the global profiler which can be accessed in this library. The user may implement +the interface + +\code +Nv::Blast::ProfilerCallback +\endcode + +and pass it to the globals library using + +\code +NvBlastProfilerSetCallback +\endcode + +A NULL pointer may be passed in, disabling profiling. Profiler features are only active in checked, debug and profile builds. + +The granularity of events reported can be selected with + +\code +NvBlastProfilerSetDetail +\endcode + +
+*/ -- cgit v1.2.3