Torne (Richard Coles) | c2e0dbd | 2013-05-09 18:35:53 +0100 | [diff] [blame] | 1 | /* Copyright (c) 2012 The Chromium Authors. All rights reserved. |
Torne (Richard Coles) | 5821806 | 2012-11-14 11:43:16 +0000 | [diff] [blame] | 2 | * Use of this source code is governed by a BSD-style license that can be |
| 3 | * found in the LICENSE file. |
| 4 | */ |
| 5 | |
Torne (Richard Coles) | c2e0dbd | 2013-05-09 18:35:53 +0100 | [diff] [blame] | 6 | /* From pp_resource.idl modified Thu Mar 28 10:09:51 2013. */ |
Torne (Richard Coles) | 5821806 | 2012-11-14 11:43:16 +0000 | [diff] [blame] | 7 | |
| 8 | #ifndef PPAPI_C_PP_RESOURCE_H_ |
| 9 | #define PPAPI_C_PP_RESOURCE_H_ |
| 10 | |
| 11 | #include "ppapi/c/pp_macros.h" |
| 12 | #include "ppapi/c/pp_stdint.h" |
| 13 | |
| 14 | /** |
| 15 | * @file |
| 16 | * This file defines the <code>PP_Resource</code> type which represents data |
| 17 | * associated with the module. |
| 18 | */ |
| 19 | |
| 20 | |
| 21 | /** |
| 22 | * @addtogroup Typedefs |
| 23 | * @{ |
| 24 | */ |
| 25 | /** |
Torne (Richard Coles) | c2e0dbd | 2013-05-09 18:35:53 +0100 | [diff] [blame] | 26 | * This typedef represents an opaque handle assigned by the browser to the |
Torne (Richard Coles) | 5821806 | 2012-11-14 11:43:16 +0000 | [diff] [blame] | 27 | * resource. The handle is guaranteed never to be 0 for a valid resource, so a |
| 28 | * module can initialize it to 0 to indicate a "NULL handle." Some interfaces |
| 29 | * may return a NULL resource to indicate failure. |
| 30 | * |
| 31 | * While a Var represents something callable to JS or from the module to |
| 32 | * the DOM, a resource has no meaning or visibility outside of the module |
| 33 | * interface. |
| 34 | * |
| 35 | * Resources are reference counted. Use <code>AddRefResource()</code> |
| 36 | * and <code>ReleaseResource()</code> in <code>ppb_core.h</code> to manage the |
| 37 | * reference count of a resource. The data will be automatically destroyed when |
| 38 | * the internal reference count reaches 0. |
| 39 | */ |
| 40 | typedef int32_t PP_Resource; |
| 41 | PP_COMPILE_ASSERT_SIZE_IN_BYTES(PP_Resource, 4); |
| 42 | /** |
| 43 | * @} |
| 44 | */ |
| 45 | |
| 46 | #endif /* PPAPI_C_PP_RESOURCE_H_ */ |
| 47 | |