diff options
| author | Anton Novoselov <[email protected]> | 2017-08-01 12:53:38 +0300 |
|---|---|---|
| committer | Anton Novoselov <[email protected]> | 2017-08-01 12:53:38 +0300 |
| commit | 236f03c0b9a4982328ed1201978f7f69d192d9b2 (patch) | |
| tree | e486f2fa39dba203563895541e92c60ed3e25759 /docs/api_docs/files/pageglobalsapi.html | |
| parent | Added screens to welcome page (diff) | |
| download | blast-236f03c0b9a4982328ed1201978f7f69d192d9b2.tar.xz blast-236f03c0b9a4982328ed1201978f7f69d192d9b2.zip | |
Blast 1.1 release (windows / linux)
see docs/release_notes.txt for details
Diffstat (limited to 'docs/api_docs/files/pageglobalsapi.html')
| -rw-r--r-- | docs/api_docs/files/pageglobalsapi.html | 79 |
1 files changed, 79 insertions, 0 deletions
diff --git a/docs/api_docs/files/pageglobalsapi.html b/docs/api_docs/files/pageglobalsapi.html new file mode 100644 index 0000000..0e0b8b5 --- /dev/null +++ b/docs/api_docs/files/pageglobalsapi.html @@ -0,0 +1,79 @@ +<html> + <head> + <title>NVIDIA(R) Blast(R) SDK 1.1 API Reference: Globals API (NvBlastGlobals)</title> + <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1"> + <LINK HREF="NVIDIA.css" REL="stylesheet" TYPE="text/css"> + </head> + + <body bgcolor="#FFFFFF"> + <div id="header"> + <hr class="first"> + <img alt="" src="blast_logo.png"> + <br> + <center> + <a class="qindex" href="main.html">Main Page</a> + <!-- <a class="qindex" href="hierarchy.html">Class Hierarchy</a> //--> + <a class="qindex" href="annotated.html">Class List</a> + <a class="qindex" href="functions.html">Class Members</a> + </center> + <hr class="second"> + </div> +<!-- Generated by Doxygen 1.5.8 --> +<div class="contents"> +<h1><a class="anchor" name="pageglobalsapi">Globals API (NvBlastGlobals) </a></h1>The NvBlastGlobals library is a utility library which is used by NvBlastTk (see <a class="el" href="pagehlapi.html">High Level (Toolkit) API (NvBlastTk)</a>) and some extensions (see <a class="el" href="pageextapi.html">Extensions (NvBlastExt)</a>) and samples.<p> +It provides a global allocator, error callback, and profiler API.<p> +<br> + <h2><a class="anchor" name="globalsallocator"> +Allocator</a></h2> +<b>Include <a class="el" href="_nv_blast_globals_8h.html">NvBlastGlobals.h</a></b> <br> +<p> +A global allocator with interface<p> +<div class="fragment"><pre class="fragment"><a class="code" href="class_nv_1_1_blast_1_1_allocator_callback.html" title="Abstract base class for an application defined memory allocator that can be used...">Nv::Blast::AllocatorCallback</a> +</pre></div><p> +may be set by the user with the function<p> +<div class="fragment"><pre class="fragment"><a class="code" href="_nv_blast_globals_8h.html#593586b9c9276aecb5a8f552f526f73b">NvBlastGlobalSetAllocatorCallback</a> +</pre></div><p> +and accessed using<p> +<div class="fragment"><pre class="fragment"><a class="code" href="_nv_blast_globals_8h.html#6960a904cca030a87f4a569d0cd6a4fa">NvBlastGlobalGetAllocatorCallback</a> +</pre></div><p> +An internal, default allocator is used if the user does not set their own, or if NULL is passed into NvBlastGlobalSetAllocatorCallback.<p> +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>.<p> +<br> + <h2><a class="anchor" name="globalserror"> +Error Callback</a></h2> +<b>Include <a class="el" href="_nv_blast_globals_8h.html">NvBlastGlobals.h</a></b><p> +A global error message callback with interface<p> +<div class="fragment"><pre class="fragment"><a class="code" href="class_nv_1_1_blast_1_1_error_callback.html" title="User defined interface class. Used by the library to emit debug information.">Nv::Blast::ErrorCallback</a> +</pre></div><p> +may be set by the user with the function<p> +<div class="fragment"><pre class="fragment"><a class="code" href="_nv_blast_globals_8h.html#67996f009abbedc2d6c769f4af11f95f">NvBlastGlobalSetErrorCallback</a> +</pre></div><p> +and accessed using<p> +<div class="fragment"><pre class="fragment"><a class="code" href="_nv_blast_globals_8h.html#dfce9f2ac7e3acfdd5c82cdbc9db0f36">NvBlastGlobalGetErrorCallback</a> +</pre></div><p> +An internal, default error callback is used if the user does not set their own, or if NULL is passed into NvBlastGlobalSetErrorCallback.<p> +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_WARNDING</b>.<p> +Finally, a function with signature given by NvBlastLog is provided which uses the global error callback,<p> +<div class="fragment"><pre class="fragment"><a class="code" href="namespace_nv_1_1_blast.html#1152c58af94417b6861e5bb3695b9ddf">Nv::Blast::logLL</a> +</pre></div><p> +This function may be passed into any NvBlast™ function's log parameter.<p> +<br> + <h2><a class="anchor" name="globalsprofiler"> +Profiler API</a></h2> +<b>Include <a class="el" href="_nv_blast_profiler_8h.html">NvBlastProfiler.h</a></b> <br> +<p> +BlastTk contains many profiling zones which use the global profiler which can be accessed in this library. The user may implement the interface<p> +<div class="fragment"><pre class="fragment"><a class="code" href="class_nv_1_1_blast_1_1_profiler_callback.html">Nv::Blast::ProfilerCallback</a> +</pre></div><p> +and pass it to the globals library using<p> +<div class="fragment"><pre class="fragment"><a class="code" href="_nv_blast_profiler_8h.html#fba345e0f5a9689ded425622ea9a659b">NvBlastProfilerSetCallback</a> +</pre></div><p> +A NULL pointer may be passed in, disabling profiling. Profiler features are only active in checked, debug and profile builds.<p> +<br> + </div> +<!-- start footer part --> +<div class="footer"> +Copyright © 2015-2017 NVIDIA Corporation, 2701 San Tomas Expressway, Santa Clara, CA 95050 U.S.A. All rights reserved. <a href="http://www.nvidia.com ">www.nvidia.com</a> +</div> +</body> +</html> |