Pepper_56_C_interfaces
Pepper_56_C_interfaces
 All Classes Files Functions Variables Typedefs Enumerations Enumerator Macros Groups
Public Attributes | List of all members
PPB_Instance_1_0 Struct Reference
Interfaces

#include <ppb_instance.h>

Public Attributes

PP_Bool(* BindGraphics )(PP_Instance instance, PP_Resource device)
 
PP_Bool(* IsFullFrame )(PP_Instance instance)
 

Detailed Description

The PPB_Instance interface contains pointers to functions related to the module instance on a web page.

Member Data Documentation

PP_Bool(* PPB_Instance_1_0::BindGraphics)(PP_Instance instance, PP_Resource device)

BindGraphics() binds the given graphics as the current display surface. The contents of this device is what will be displayed in the instance'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.

Any previously-bound device will be released. It is an error to bind a device when it is already bound to another 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.

Binding a device will invalidate that portion of the web page to flush the contents of the new device to the screen.

Parameters
[in]instanceA PP_Instance identifying one instance of a module.
[in]deviceA PP_Resource corresponding to a graphics device.
Returns
PP_Bool containing PP_TRUE if bind was successful or PP_FALSE if the device was not the correct type. On success, a reference to the device will be held by the instance, so the caller can release its reference if it chooses.
PP_Bool(* PPB_Instance_1_0::IsFullFrame)(PP_Instance instance)

IsFullFrame() determines if the instance is full-frame. Such an instance 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 module.

Parameters
[in]instanceA PP_Instance identifying one instance of a module.
Returns
A PP_Bool containing PP_TRUE if the instance is full-frame.
The documentation for this struct was generated from the following file: