documentation/modules.dox

   1 /**
   2  * @defgroup Libraries Libraries
   3  * Libraries available to Native Client modules
   4  *
   5  * @defgroup audio_video Basic Multimedia Interface
   6  * @ingroup Libraries
   7  * Contains function calls for performing basic audio, video, and event polling.
   8  * All functions except nacl_audio_stream() should be called only from the
   9  * main thread.
  10  *
  11  * To use this API, include
  12  * <code>&lt;nacl/nacl_av.h></code>
  13  * and link with the
  14  * <code>av</code> library.
  15  *
  16  * @defgroup NPAPI NPAPI Extensions
  17  * @ingroup Libraries
  18  * NPAPI extensions for Native Client applications.
  19  * Native Client supports a
  20  * <a href="../../../documentation/npapi.html">subset of NPAPI</a>,
  21  * plus these extensions.
  22  * To learn about NPAPI, see
  23  * http://developer.mozilla.org/en/Plugins
  24  * and
  25  * http://developer.mozilla.org/en/Gecko_Plugin_API_Reference.
  26  *
  27  * To use this API, include
  28  * <code>&lt;nacl/nacl_npapi.h></code>
  29  * and link with the
  30  * <code>google_nacl_npruntime</code> library.
  31  *
  32  * <b>Note:</b>
  33  * NPAPI support is experimental. If you encounter security issues,
  34  * bugs, or missing features, please
  35  * <a href="http://code.google.com/p/nativeclient/issues">file an issue</a>.
  36  *
  37  * @defgroup Pthread Pthread
  38  * @ingroup Libraries
  39  * A POSIX-based threads API.
  40  *
  41  * To use this API, include
  42  * <code>&lt;pthread.h></code>
  43  * and link with the
  44  * <code>pthread</code> library.
  45  *
  46  * @defgroup SRPC SRPC
  47  * @ingroup Libraries
  48  * A simple remote procedure call API.
  49  *
  50  * To use this API, include
  51  * <code>&lt;nacl/nacl_srpc.h></code>
  52  * and link with the
  53  * <code>srpc</code> library.
  54  *
  55  * @defgroup syscalls Service Runtime Calls
  56  * A service runtime call is analogous
  57  * to a system call, in terms of performance;
  58  * for this reason, you should avoid unnecessary service runtime calls.
  59  *
  60  * To use this API, include
  61  * <code>&lt;sys/nacl_syscalls.h></code>.
  62  */