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
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
|
/* 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_PPB_INSTANCE_H_
#define PPAPI_C_PPB_INSTANCE_H_
#include "ppapi/c/pp_bool.h"
#include "ppapi/c/pp_instance.h"
#include "ppapi/c/pp_resource.h"
#include "ppapi/c/pp_var.h"
#define PPB_INSTANCE_INTERFACE "PPB_Instance;0.4"
/**
* @file
* Defines the API ...
*
* @addtogroup Interfaces
* @{
*/
struct PPB_Instance {
/** Returns a reference to the DOM window containing this instance. */
struct PP_Var (*GetWindowObject)(PP_Instance instance);
/** Returns a reference to the DOM element containing this instance. */
struct PP_Var (*GetOwnerElementObject)(PP_Instance instance);
/**
* Binds the given graphics device as the current drawing surface. The
* contents of this device is what will be displayed in the plugin's area
* on the web page. The device must be a 2D or a 3D device.
*
* You can pass a NULL resource as the device parameter to unbind all
* devices from the given instance. The instance will then appear
* transparent. Re-binding the same device will return PP_TRUE and will do
* nothing. Unbinding a device will drop any pending flush callbacks.
*
* Any previously-bound device will be Release()d. It is an error to bind
* a device when it is already bound to another plugin instance. If you want
* to move a device between instances, first unbind it from the old one, and
* then rebind it to the new one.
*
* Returns PP_TRUE if the bind was successful. False means the device was not
* the correct type. On success, a reference to the device will be held by
* the plugin instance, so the caller can release its reference if it
* chooses.
*
* Binding a device will invalidate that portion of the web page to flush the
* contents of the new device to the screen.
*/
PP_Bool (*BindGraphics)(PP_Instance instance, PP_Resource device);
/**
* Returns PP_TRUE if the instance is full-frame. Such a plugin represents
* the entire document in a frame rather than an embedded resource. This can
* happen if the user does a top level navigation or the page specifies an
* iframe to a resource with a MIME type registered by the plugin.
*/
PP_Bool (*IsFullFrame)(PP_Instance instance);
/**
* Executes the given script in the context of the frame containing the
* plugin.
*
* The exception, if any, will be returned in *exception. As
* with the PPB_Var interface, the exception parameter,
* if non-NULL, must be initialized
* to a void exception or the function will immediately return. On success,
* the exception parameter will be set to a "void" var. On failure, the return
* value will be a "void" var.
*
* @param script A string containing the JavaScript to execute.
* @param exception Initialize this to NULL if you don't want exception info;
* initialize this to a void exception if you do.
* See the function description for details.
*
* @return The result of the script execution,
* or a "void" var if execution failed.
*/
struct PP_Var (*ExecuteScript)(PP_Instance instance,
struct PP_Var script,
struct PP_Var* exception);
};
/**
* @}
*/
#endif /* PPAPI_C_PPB_INSTANCE_H_ */
|
