ppapi/api/pp_resource.idl

   1 /* Copyright (c) 2012 The Chromium Authors. All rights reserved.
   2  * Use of this source code is governed by a BSD-style license that can be
   3  * found in the LICENSE file.
   4  */
   5
   6 /**
   7  * This file defines the <code>PP_Resource</code> type which represents data
   8  * associated with the module.
   9  */
  10
  11 /**
  12  * This typedef represents an opaque handle assigned by the browser to the
  13  * resource. The handle is guaranteed never to be 0 for a valid resource, so a
  14  * module can initialize it to 0 to indicate a "NULL handle." Some interfaces
  15  * may return a NULL resource to indicate failure.
  16  *
  17  * While a Var represents something callable to JS or from the module to
  18  * the DOM, a resource has no meaning or visibility outside of the module
  19  * interface.
  20  *
  21  * Resources are reference counted. Use <code>AddRefResource()</code>
  22  * and <code>ReleaseResource()</code> in <code>ppb_core.h</code> to manage the
  23  * reference count of a resource. The data will be automatically destroyed when
  24  * the internal reference count reaches 0.
  25  */
  26 [assert_size(4)] typedef int32_t PP_Resource;
  27