diff options
| author | Bryan Galdrikian <[email protected]> | 2018-05-31 11:36:08 -0700 |
|---|---|---|
| committer | Bryan Galdrikian <[email protected]> | 2018-05-31 11:36:08 -0700 |
| commit | 7115f60b91b5717d90f643fd692010905c7004db (patch) | |
| tree | effd68c6978751c517d54c2f2bb5bb6e7dc93e18 /docs/_source/api_globals_users_guide.txt | |
| parent | Updating BlastTool zip (diff) | |
| download | blast-1.1.3_rc1.tar.xz blast-1.1.3_rc1.zip | |
Blast 1.1.3. See docs/release_notes.txt.v1.1.3_rc1
Diffstat (limited to 'docs/_source/api_globals_users_guide.txt')
| -rwxr-xr-x[-rw-r--r--] | docs/_source/api_globals_users_guide.txt | 200 |
1 files changed, 100 insertions, 100 deletions
diff --git a/docs/_source/api_globals_users_guide.txt b/docs/_source/api_globals_users_guide.txt index 00b35ef..834c0a8 100644..100755 --- 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. - -<br> -\section globalsallocator Allocator - -<b>Include NvBlastGlobals.h</b> -<br> - -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 -<b>NVBLAST_ALLOC</b>, <b>NVBLAST_FREE</b>, <b>NVBLAST_NEW</b>, and <b>NVBLAST_DELETE</b>. - -<br> -\section globalserror Error Callback - -<b>Include NvBlastGlobals.h</b> - -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 -<b>NVBLAST_LOG_ERROR</b> and <b>NVBLAST_LOG_WARNING</b>. - -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. - -<br> -\section globalsprofiler Profiler API - -<b>Include NvBlastProfiler.h</b> -<br> - -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 - -<br> -*/ +/*! \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.
+
+<br>
+\section globalsallocator Allocator
+
+<b>Include NvBlastGlobals.h</b>
+<br>
+
+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
+<b>NVBLAST_ALLOC</b>, <b>NVBLAST_FREE</b>, <b>NVBLAST_NEW</b>, and <b>NVBLAST_DELETE</b>.
+
+<br>
+\section globalserror Error Callback
+
+<b>Include NvBlastGlobals.h</b>
+
+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
+<b>NVBLAST_LOG_ERROR</b> and <b>NVBLAST_LOG_WARNING</b>.
+
+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.
+
+<br>
+\section globalsprofiler Profiler API
+
+<b>Include NvBlastProfiler.h</b>
+<br>
+
+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
+
+<br>
+*/
|