Pepper_56_C_interfaces
Pepper_56_C_interfaces
|
Functions | |
PP_INLINE struct PP_CompletionCallback | PP_MakeCompletionCallback (PP_CompletionCallback_Func func, void *user_data) |
PP_INLINE struct PP_CompletionCallback | PP_MakeOptionalCompletionCallback (PP_CompletionCallback_Func func, void *user_data) |
PP_INLINE void | PP_RunCompletionCallback (struct PP_CompletionCallback *cc, int32_t result) |
PP_INLINE struct PP_CompletionCallback | PP_BlockUntilComplete (void) |
PP_INLINE void | PP_RunAndClearCompletionCallback (struct PP_CompletionCallback *cc, int32_t res) |
PP_INLINE struct PP_Point | PP_MakePoint (int32_t x, int32_t y) |
PP_INLINE struct PP_FloatPoint | PP_MakeFloatPoint (float x, float y) |
PP_INLINE struct PP_Rect | PP_MakeRectFromXYWH (int32_t x, int32_t y, int32_t w, int32_t h) |
PP_INLINE struct PP_FloatRect | PP_MakeFloatRectFromXYWH (float x, float y, float w, float h) |
PP_INLINE struct PP_Size | PP_MakeSize (int32_t w, int32_t h) |
PP_INLINE struct PP_FloatSize | PP_MakeFloatSize (float w, float h) |
PP_INLINE struct PP_TouchPoint | PP_MakeTouchPoint (void) |
PP_INLINE struct PP_Var | PP_MakeUndefined (void) |
PP_INLINE struct PP_Var | PP_MakeNull (void) |
PP_INLINE struct PP_Var | PP_MakeBool (PP_Bool value) |
PP_INLINE struct PP_Var | PP_MakeInt32 (int32_t value) |
PP_INLINE struct PP_Var | PP_MakeDouble (double value) |
PP_EXPORT int32_t | PPP_InitializeModule (PP_Module module, PPB_GetInterface get_browser_interface) |
PP_EXPORT void | PPP_ShutdownModule (void) |
PP_EXPORT const void * | PPP_GetInterface (const char *interface_name) |
PP_INLINE double | PP_MicrosecondsDeltaToSeconds (PP_MicrosecondsDelta value) |
PP_INLINE PP_MicrosecondsDelta | PP_SecondsToMicrosecondsDelta (double value) |
PP_EXPORT int32_t | PPP_InitializeBroker (PP_ConnectInstance_Func *connect_instance_func) |
PP_EXPORT void | PPP_ShutdownBroker () |
PP_INLINE struct PP_CompletionCallback PP_BlockUntilComplete | ( | void | ) |
PP_BlockUntilComplete() is used in place of an actual completion callback to request blocking behavior. If specified, the calling thread will block until the function completes. Blocking completion callbacks are only allowed from background threads.
PP_CompletionCallback
structure. PP_MakeBool() is used to wrap a boolean value into a PP_Var
struct for passing to the browser.
[in] | value | A PP_Bool enumeration to wrap. |
PP_Var
structure. PP_INLINE struct PP_CompletionCallback PP_MakeCompletionCallback | ( | PP_CompletionCallback_Func | func, |
void * | user_data | ||
) |
PP_MakeCompletionCallback() is used to create a PP_CompletionCallback
.
Example, creating a Required callback:
Example, creating an Optional callback:
[in] | func | A PP_CompletionCallback_Func that will be called. |
[in] | user_data | A pointer to user data passed to your callback function. This is optional and is typically used to help track state when you may have multiple callbacks pending. |
PP_CompletionCallback
structure. PP_INLINE struct PP_Var PP_MakeDouble | ( | double | value | ) |
PP_MakeDouble() is used to wrap a double value into a PP_Var
struct for passing to the browser.
[in] | value | A double to wrap. |
PP_Var
structure. PP_INLINE struct PP_FloatRect PP_MakeFloatRectFromXYWH | ( | float | x, |
float | y, | ||
float | w, | ||
float | h | ||
) |
PP_MakeFloatRectFromXYWH() creates a PP_FloatRect
given x and y coordinates and width and height dimensions as float values.
[in] | x | An float value representing a horizontal coordinate of a point, starting with 0 as the left-most coordinate. |
[in] | y | An float value representing a vertical coordinate of a point, starting with 0 as the top-most coordinate. |
[in] | w | An float value representing a width. |
[in] | h | An float value representing a height. |
PP_FloatRect
structure. PP_INLINE struct PP_FloatSize PP_MakeFloatSize | ( | float | w, |
float | h | ||
) |
PP_MakeFloatSize() creates a PP_FloatSize
given a width and height as float values.
[in] | w | An float value representing a width. |
[in] | h | An float value representing a height. |
PP_FloatSize
structure. PP_INLINE struct PP_Var PP_MakeInt32 | ( | int32_t | value | ) |
PP_MakeInt32() is used to wrap a 32 bit integer value into a PP_Var
struct for passing to the browser.
[in] | value | An int32 to wrap. |
PP_Var
structure. PP_INLINE struct PP_Var PP_MakeNull | ( | void | ) |
PP_MakeNull() is used to wrap a null value into a PP_Var
struct for passing to the browser.
PP_Var
structure, PP_INLINE struct PP_CompletionCallback PP_MakeOptionalCompletionCallback | ( | PP_CompletionCallback_Func | func, |
void * | user_data | ||
) |
PP_MakeOptionalCompletionCallback() is used to create a PP_CompletionCallback with PP_COMPLETIONCALLBACK_FLAG_OPTIONAL set.
[in] | func | A PP_CompletionCallback_Func to be called on completion. |
[in] | user_data | A pointer to user data passed to be passed to the callback function. This is optional and is typically used to help track state in case of multiple pending callbacks. |
PP_INLINE struct PP_Point PP_MakePoint | ( | int32_t | x, |
int32_t | y | ||
) |
PP_MakePoint() creates a PP_Point
given the x and y coordinates as int32_t values.
[in] | x | An int32_t value representing a horizontal coordinate of a point, starting with 0 as the left-most coordinate. |
[in] | y | An int32_t value representing a vertical coordinate of a point, starting with 0 as the top-most coordinate. |
PP_Point
structure. PP_INLINE struct PP_Rect PP_MakeRectFromXYWH | ( | int32_t | x, |
int32_t | y, | ||
int32_t | w, | ||
int32_t | h | ||
) |
PP_MakeRectFromXYWH() creates a PP_Rect
given x and y coordinates and width and height dimensions as int32_t values.
[in] | x | An int32_t value representing a horizontal coordinate of a point, starting with 0 as the left-most coordinate. |
[in] | y | An int32_t value representing a vertical coordinate of a point, starting with 0 as the top-most coordinate. |
[in] | w | An int32_t value representing a width. |
[in] | h | An int32_t value representing a height. |
PP_Rect
structure. PP_INLINE struct PP_Size PP_MakeSize | ( | int32_t | w, |
int32_t | h | ||
) |
PP_MakeSize() creates a PP_Size
given a width and height as int32_t values.
[in] | w | An int32_t value representing a width. |
[in] | h | An int32_t value representing a height. |
PP_Size
structure. PP_INLINE struct PP_TouchPoint PP_MakeTouchPoint | ( | void | ) |
PP_MakeTouchPoint() creates a PP_TouchPoint
.
PP_TouchPoint
structure. PP_INLINE struct PP_Var PP_MakeUndefined | ( | void | ) |
PP_MakeUndefined() is used to wrap an undefined value into a PP_Var
struct for passing to the browser.
PP_Var
structure. PP_INLINE double PP_MicrosecondsDeltaToSeconds | ( | PP_MicrosecondsDelta | value | ) |
Converts PP_MicrosecondsDelta to seconds
PP_INLINE void PP_RunAndClearCompletionCallback | ( | struct PP_CompletionCallback * | cc, |
int32_t | res | ||
) |
PP_RunAndClearCompletionCallback() runs a callback and clears the reference to that callback.
This function is used when the null-ness of a completion callback is used as a signal for whether a completion callback has been registered. In this case, after the execution of the callback, it should be cleared. However, this introduces a conflict if the completion callback wants to schedule more work that involves the same completion callback again (for example, when reading data from an URLLoader, one would typically queue up another read callback). As a result, this function clears the pointer before the provided callback is executed.
PP_INLINE void PP_RunCompletionCallback | ( | struct PP_CompletionCallback * | cc, |
int32_t | result | ||
) |
PP_RunCompletionCallback() is used to run a callback. It invokes the callback function passing it user data specified on creation and completion |result|.
[in] | cc | A pointer to a PP_CompletionCallback that will be run. |
[in] | result | The result of the operation. Non-positive values correspond to the error codes from pp_errors.h (excluding PP_OK_COMPLETIONPENDING). Positive values indicate additional information such as bytes read. |
PP_INLINE PP_MicrosecondsDelta PP_SecondsToMicrosecondsDelta | ( | double | value | ) |
Converts seconds to PP_MicrosecondsDelta
PP_EXPORT const void* PPP_GetInterface | ( | const char * | interface_name | ) |
PPP_GetInterface() is called by the browser to query the module for interfaces it supports.
Your module must implement the PPP_Instance
interface or it will be unloaded. Other interfaces are optional.
This function is called from within browser code whenever an interface is needed. This means your plugin could be reentered via this function if you make a browser call and it needs an interface. Furthermore, you should not make any other browser calls from within your implementation to avoid reentering the browser.
As a result, your implementation of this should merely provide a lookup from the requested name to an interface pointer, via something like a big if/else block or a map, and not do any other work.
[in] | interface_name | A pointer to a "PPP" (plugin) interface name. Interface names are null-terminated ASCII strings. |
NULL
if the interface is not supported. PP_EXPORT int32_t PPP_InitializeBroker | ( | PP_ConnectInstance_Func * | connect_instance_func | ) |
PPP_InitializeBroker() is the entry point for a broker and is called by the browser when your module loads. Your code must implement this function.
Failure indicates to the browser that this broker can not be used. In this case, the broker will be unloaded.
[out] | connect_instance_func | A pointer to a connect instance function. |
PP_EXPORT int32_t PPP_InitializeModule | ( | PP_Module | module, |
PPB_GetInterface | get_browser_interface | ||
) |
PPP_InitializeModule() is the entry point for a module and is called by the browser when your module loads. Your code must implement this function.
Failure indicates to the browser that this module can not be used. In this case, the module will be unloaded and ShutdownModule will NOT be called.
[in] | module | A handle to your module. Generally you should store this value since it will be required for other API calls. |
[in] | get_browser_interface | A pointer to the function that you can use to query for browser interfaces. Generally you should store this value for future use. |
PP_OK
on success. Any other value on failure. PP_EXPORT void PPP_ShutdownBroker | ( | ) |
PPP_ShutdownBroker() is called before the broker is unloaded.
PP_EXPORT void PPP_ShutdownModule | ( | void | ) |
PPP_ShutdownModule() is sometimes called before the module is unloaded. It is not recommended that you implement this function.
There is no practical use of this function for third party modules. Its existence is because of some internal use cases inside Chrome.
Since your module runs in a separate process, there's no need to free allocated memory. There is also no need to free any resources since all of resources associated with an instance will be force-freed when that instance is deleted.
Note: This function will always be skipped on untrusted (Native Client) implementations. This function may be skipped on trusted implementations in certain circumstances when Chrome does "fast shutdown" of a web page.