summaryrefslogtreecommitdiffstats
path: root/ppapi/c/pp_instance.h
blob: 87d430cc9d4e88112eefad8f4f75c70b608f1950 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
/* Copyright (c) 2010 The Chromium Authors. All rights reserved.
 * Use of this source code is governed by a BSD-style license that can be
 * found in the LICENSE file.
 */
#ifndef PPAPI_C_PP_INSTANCE_H_
#define PPAPI_C_PP_INSTANCE_H_

/**
 * @file
 * Defines the API ...
 *
 * @addtogroup PP
 * @{
 */

#include "ppapi/c/pp_macros.h"
#include "ppapi/c/pp_stdint.h"

/** A PP_Instance uniquely identifies one plugin instance, which is one time
 * that a page says \<embed>. There can be multiple instances of the same plugin
 * type on a page that will all be in the same module.
 *
 * The identifier is an opaque handle assigned by the browser to the plugin. It
 * is guaranteed never to be 0, so a plugin can initialize it to 0 to
 * indicate a "NULL handle."
 */
typedef int32_t PP_Instance;
PP_COMPILE_ASSERT_SIZE_IN_BYTES(PP_Instance, 4);

/**
 * @}
 * End addtogroup PP
 */

#endif  /* PPAPI_C_PP_INSTANCE_H_ */