Update UI for WebStore bundle installs.
[chromium-blink-merge.git] / native_client_sdk / src / doc / c-api.rst
blob1844cfa861a649057f1058400c8fd4ed94692842
1 .. _pepper_stable_c_index:
2 .. _c-api:
4 .. DO NOT EDIT! This document is auto-generated by doxygen/rst_index.py.
6 ##########################################
7 Pepper C API Reference (Stable)
8 ##########################################
10 This page lists the C API for Pepper 40. Apps that use this API can
11 run in Chrome 40 or higher.
13 `Interfaces <pepper_stable/c/group___interfaces.html>`__
14 =============================================================
15   * `PPB_Audio <pepper_stable/c/struct_p_p_b___audio__1__1.html>`__
17   * `PPB_AudioBuffer <pepper_stable/c/struct_p_p_b___audio_buffer__0__1.html>`__
19   * `PPB_AudioConfig <pepper_stable/c/struct_p_p_b___audio_config__1__1.html>`__
21   * `PPB_Compositor <pepper_stable/c/struct_p_p_b___compositor__0__1.html>`__
23   * `PPB_CompositorLayer <pepper_stable/c/struct_p_p_b___compositor_layer__0__2.html>`__
25   * `PPB_Console <pepper_stable/c/struct_p_p_b___console__1__0.html>`__
27   * `PPB_Core <pepper_stable/c/struct_p_p_b___core__1__0.html>`__
29   * `PPB_FileIO <pepper_stable/c/struct_p_p_b___file_i_o__1__1.html>`__
31   * `PPB_FileMapping <pepper_stable/c/struct_p_p_b___file_mapping__0__1.html>`__
33   * `PPB_FileRef <pepper_stable/c/struct_p_p_b___file_ref__1__2.html>`__
35   * `PPB_FileSystem <pepper_stable/c/struct_p_p_b___file_system__1__0.html>`__
37   * `PPB_Fullscreen <pepper_stable/c/struct_p_p_b___fullscreen__1__0.html>`__
39   * `PPB_Gamepad <pepper_stable/c/struct_p_p_b___gamepad__1__0.html>`__
41   * `PPB_Graphics2D <pepper_stable/c/struct_p_p_b___graphics2_d__1__1.html>`__
43   * `PPB_Graphics3D <pepper_stable/c/struct_p_p_b___graphics3_d__1__0.html>`__
45   * `PPB_HostResolver <pepper_stable/c/struct_p_p_b___host_resolver__1__0.html>`__
47   * `PPB_IMEInputEvent <pepper_stable/c/struct_p_p_b___i_m_e_input_event__1__0.html>`__
49   * `PPB_ImageData <pepper_stable/c/struct_p_p_b___image_data__1__0.html>`__
51   * `PPB_InputEvent <pepper_stable/c/struct_p_p_b___input_event__1__0.html>`__
53   * `PPB_Instance <pepper_stable/c/struct_p_p_b___instance__1__0.html>`__
55   * `PPB_KeyboardInputEvent <pepper_stable/c/struct_p_p_b___keyboard_input_event__1__2.html>`__
57   * `PPB_MediaStreamAudioTrack <pepper_stable/c/struct_p_p_b___media_stream_audio_track__0__1.html>`__
59   * `PPB_MediaStreamVideoTrack <pepper_stable/c/struct_p_p_b___media_stream_video_track__1__0.html>`__
61   * `PPB_MessageLoop <pepper_stable/c/struct_p_p_b___message_loop__1__0.html>`__
63   * `PPB_Messaging <pepper_stable/c/struct_p_p_b___messaging__1__2.html>`__
65   * `PPB_MouseCursor <pepper_stable/c/struct_p_p_b___mouse_cursor__1__0.html>`__
67   * `PPB_MouseInputEvent <pepper_stable/c/struct_p_p_b___mouse_input_event__1__1.html>`__
69   * `PPB_MouseLock <pepper_stable/c/struct_p_p_b___mouse_lock__1__0.html>`__
71   * `PPB_NetAddress <pepper_stable/c/struct_p_p_b___net_address__1__0.html>`__
73   * `PPB_NetworkList <pepper_stable/c/struct_p_p_b___network_list__1__0.html>`__
75   * `PPB_NetworkMonitor <pepper_stable/c/struct_p_p_b___network_monitor__1__0.html>`__
77   * `PPB_NetworkProxy <pepper_stable/c/struct_p_p_b___network_proxy__1__0.html>`__
79   * `PPB_OpenGLES2 <pepper_stable/c/struct_p_p_b___open_g_l_e_s2.html>`__
81   * `PPB_OpenGLES2 <pepper_stable/c/struct_p_p_b___open_g_l_e_s2__1__0.html>`__
83   * `PPB_OpenGLES2ChromiumEnableFeature <pepper_stable/c/struct_p_p_b___open_g_l_e_s2_chromium_enable_feature.html>`__
85   * `PPB_OpenGLES2ChromiumEnableFeature <pepper_stable/c/struct_p_p_b___open_g_l_e_s2_chromium_enable_feature__1__0.html>`__
87   * `PPB_OpenGLES2ChromiumMapSub <pepper_stable/c/struct_p_p_b___open_g_l_e_s2_chromium_map_sub.html>`__
89   * `PPB_OpenGLES2ChromiumMapSub <pepper_stable/c/struct_p_p_b___open_g_l_e_s2_chromium_map_sub__1__0.html>`__
91   * `PPB_OpenGLES2FramebufferBlit <pepper_stable/c/struct_p_p_b___open_g_l_e_s2_framebuffer_blit.html>`__
93   * `PPB_OpenGLES2FramebufferBlit <pepper_stable/c/struct_p_p_b___open_g_l_e_s2_framebuffer_blit__1__0.html>`__
95   * `PPB_OpenGLES2FramebufferMultisample <pepper_stable/c/struct_p_p_b___open_g_l_e_s2_framebuffer_multisample.html>`__
97   * `PPB_OpenGLES2FramebufferMultisample <pepper_stable/c/struct_p_p_b___open_g_l_e_s2_framebuffer_multisample__1__0.html>`__
99   * `PPB_OpenGLES2InstancedArrays <pepper_stable/c/struct_p_p_b___open_g_l_e_s2_instanced_arrays.html>`__
101   * `PPB_OpenGLES2InstancedArrays <pepper_stable/c/struct_p_p_b___open_g_l_e_s2_instanced_arrays__1__0.html>`__
103   * `PPB_OpenGLES2Query <pepper_stable/c/struct_p_p_b___open_g_l_e_s2_query.html>`__
105   * `PPB_OpenGLES2Query <pepper_stable/c/struct_p_p_b___open_g_l_e_s2_query__1__0.html>`__
107   * `PPB_OpenGLES2VertexArrayObject <pepper_stable/c/struct_p_p_b___open_g_l_e_s2_vertex_array_object.html>`__
109   * `PPB_OpenGLES2VertexArrayObject <pepper_stable/c/struct_p_p_b___open_g_l_e_s2_vertex_array_object__1__0.html>`__
111   * `PPB_TCPSocket <pepper_stable/c/struct_p_p_b___t_c_p_socket__1__1.html>`__
113   * `PPB_TextInputController <pepper_stable/c/struct_p_p_b___text_input_controller__1__0.html>`__
115   * `PPB_TouchInputEvent <pepper_stable/c/struct_p_p_b___touch_input_event__1__0.html>`__
117   * `PPB_UDPSocket <pepper_stable/c/struct_p_p_b___u_d_p_socket__1__0.html>`__
119   * `PPB_URLLoader <pepper_stable/c/struct_p_p_b___u_r_l_loader__1__0.html>`__
121   * `PPB_URLRequestInfo <pepper_stable/c/struct_p_p_b___u_r_l_request_info__1__0.html>`__
123   * `PPB_URLResponseInfo <pepper_stable/c/struct_p_p_b___u_r_l_response_info__1__0.html>`__
125   * `PPB_Var <pepper_stable/c/struct_p_p_b___var__1__2.html>`__
127   * `PPB_VarArray <pepper_stable/c/struct_p_p_b___var_array__1__0.html>`__
129   * `PPB_VarArrayBuffer <pepper_stable/c/struct_p_p_b___var_array_buffer__1__0.html>`__
131   * `PPB_VarDictionary <pepper_stable/c/struct_p_p_b___var_dictionary__1__0.html>`__
133   * `PPB_VideoDecoder <pepper_stable/c/struct_p_p_b___video_decoder__1__0.html>`__
135   * `PPB_VideoFrame <pepper_stable/c/struct_p_p_b___video_frame__0__1.html>`__
137   * `PPB_View <pepper_stable/c/struct_p_p_b___view__1__2.html>`__
139   * `PPB_WebSocket <pepper_stable/c/struct_p_p_b___web_socket__1__0.html>`__
141   * `PPB_WheelInputEvent <pepper_stable/c/struct_p_p_b___wheel_input_event__1__0.html>`__
143   * `PPP_Graphics3D <pepper_stable/c/struct_p_p_p___graphics3_d__1__0.html>`__
145   * `PPP_InputEvent <pepper_stable/c/struct_p_p_p___input_event__0__1.html>`__
147   * `PPP_Instance <pepper_stable/c/struct_p_p_p___instance__1__1.html>`__
149   * `PPP_MessageHandler <pepper_stable/c/struct_p_p_p___message_handler__0__2.html>`__
151   * `PPP_Messaging <pepper_stable/c/struct_p_p_p___messaging__1__0.html>`__
153   * `PPP_MouseLock <pepper_stable/c/struct_p_p_p___mouse_lock__1__0.html>`__
156 `Structures <pepper_stable/c/group___structs.html>`__
157 ==========================================================
158   * `PP_ArrayOutput <pepper_stable/c/struct_p_p___array_output.html>`__
160   * `PP_CompletionCallback <pepper_stable/c/struct_p_p___completion_callback.html>`__
162   * `PP_DirectoryEntry <pepper_stable/c/struct_p_p___directory_entry.html>`__
164   * `PP_FileInfo <pepper_stable/c/struct_p_p___file_info.html>`__
166   * `PP_FloatPoint <pepper_stable/c/struct_p_p___float_point.html>`__
168   * `PP_FloatRect <pepper_stable/c/struct_p_p___float_rect.html>`__
170   * `PP_FloatSize <pepper_stable/c/struct_p_p___float_size.html>`__
172   * `PP_GamepadSampleData <pepper_stable/c/struct_p_p___gamepad_sample_data.html>`__
174   * `PP_GamepadsSampleData <pepper_stable/c/struct_p_p___gamepads_sample_data.html>`__
176   * `PP_HostResolver_Hint <pepper_stable/c/struct_p_p___host_resolver___hint.html>`__
178   * `PP_ImageDataDesc <pepper_stable/c/struct_p_p___image_data_desc.html>`__
180   * `PP_InputEvent_Character <pepper_stable/c/struct_p_p___input_event___character.html>`__
182   * `PP_InputEvent_Key <pepper_stable/c/struct_p_p___input_event___key.html>`__
184   * `PP_InputEvent_Mouse <pepper_stable/c/struct_p_p___input_event___mouse.html>`__
186   * `PP_InputEvent_Wheel <pepper_stable/c/struct_p_p___input_event___wheel.html>`__
188   * `PP_NetAddress_IPv4 <pepper_stable/c/struct_p_p___net_address___i_pv4.html>`__
190   * `PP_NetAddress_IPv6 <pepper_stable/c/struct_p_p___net_address___i_pv6.html>`__
192   * `PP_Point <pepper_stable/c/struct_p_p___point.html>`__
194   * `PP_Rect <pepper_stable/c/struct_p_p___rect.html>`__
196   * `PP_Size <pepper_stable/c/struct_p_p___size.html>`__
198   * `PP_TouchPoint <pepper_stable/c/struct_p_p___touch_point.html>`__
200   * `PP_Var <pepper_stable/c/struct_p_p___var.html>`__
202   * `PP_VideoPicture <pepper_stable/c/struct_p_p___video_picture.html>`__
204   * `PP_VideoPicture <pepper_stable/c/struct_p_p___video_picture__0__1.html>`__
206   * `PP_VarValue <pepper_stable/c/union_p_p___var_value.html>`__
209 `Functions <pepper_stable/c/group___functions.html>`__
210 ===========================================================
212 `Enums <pepper_stable/c/group___enums.html>`__
213 ===================================================
215 `Typedefs <pepper_stable/c/group___typedefs.html>`__
216 =========================================================
218 `Macros <pepper_stable/c/globals_defs.html>`__
219 ===================================================
221 Files
222 =====
223   * `pp_array_output.h <pepper_stable/c/pp__array__output_8h.html>`__
225   * `pp_bool.h <pepper_stable/c/pp__bool_8h.html>`__
227   * `pp_codecs.h <pepper_stable/c/pp__codecs_8h.html>`__
229   * `pp_completion_callback.h <pepper_stable/c/pp__completion__callback_8h.html>`__
231   * `pp_directory_entry.h <pepper_stable/c/pp__directory__entry_8h.html>`__
233   * `pp_errors.h <pepper_stable/c/pp__errors_8h.html>`__
235   * `pp_file_info.h <pepper_stable/c/pp__file__info_8h.html>`__
237   * `pp_graphics_3d.h <pepper_stable/c/pp__graphics__3d_8h.html>`__
239   * `pp_input_event.h <pepper_stable/c/pp__input__event_8h.html>`__
241   * `pp_instance.h <pepper_stable/c/pp__instance_8h.html>`__
243   * `pp_module.h <pepper_stable/c/pp__module_8h.html>`__
245   * `pp_point.h <pepper_stable/c/pp__point_8h.html>`__
247   * `pp_rect.h <pepper_stable/c/pp__rect_8h.html>`__
249   * `pp_resource.h <pepper_stable/c/pp__resource_8h.html>`__
251   * `pp_size.h <pepper_stable/c/pp__size_8h.html>`__
253   * `pp_stdint.h <pepper_stable/c/pp__stdint_8h.html>`__
255   * `pp_time.h <pepper_stable/c/pp__time_8h.html>`__
257   * `pp_touch_point.h <pepper_stable/c/pp__touch__point_8h.html>`__
259   * `pp_var.h <pepper_stable/c/pp__var_8h.html>`__
261   * `ppb.h <pepper_stable/c/ppb_8h.html>`__
263   * `ppb_audio.h <pepper_stable/c/ppb__audio_8h.html>`__
265   * `ppb_audio_buffer.h <pepper_stable/c/ppb__audio__buffer_8h.html>`__
267   * `ppb_audio_config.h <pepper_stable/c/ppb__audio__config_8h.html>`__
269   * `ppb_compositor.h <pepper_stable/c/ppb__compositor_8h.html>`__
271   * `ppb_compositor_layer.h <pepper_stable/c/ppb__compositor__layer_8h.html>`__
273   * `ppb_console.h <pepper_stable/c/ppb__console_8h.html>`__
275   * `ppb_core.h <pepper_stable/c/ppb__core_8h.html>`__
277   * `ppb_file_io.h <pepper_stable/c/ppb__file__io_8h.html>`__
279   * `ppb_file_mapping.h <pepper_stable/c/ppb__file__mapping_8h.html>`__
281   * `ppb_file_ref.h <pepper_stable/c/ppb__file__ref_8h.html>`__
283   * `ppb_file_system.h <pepper_stable/c/ppb__file__system_8h.html>`__
285   * `ppb_fullscreen.h <pepper_stable/c/ppb__fullscreen_8h.html>`__
287   * `ppb_gamepad.h <pepper_stable/c/ppb__gamepad_8h.html>`__
289   * `ppb_graphics_2d.h <pepper_stable/c/ppb__graphics__2d_8h.html>`__
291   * `ppb_graphics_3d.h <pepper_stable/c/ppb__graphics__3d_8h.html>`__
293   * `ppb_host_resolver.h <pepper_stable/c/ppb__host__resolver_8h.html>`__
295   * `ppb_image_data.h <pepper_stable/c/ppb__image__data_8h.html>`__
297   * `ppb_input_event.h <pepper_stable/c/ppb__input__event_8h.html>`__
299   * `ppb_instance.h <pepper_stable/c/ppb__instance_8h.html>`__
301   * `ppb_media_stream_audio_track.h <pepper_stable/c/ppb__media__stream__audio__track_8h.html>`__
303   * `ppb_media_stream_video_track.h <pepper_stable/c/ppb__media__stream__video__track_8h.html>`__
305   * `ppb_message_loop.h <pepper_stable/c/ppb__message__loop_8h.html>`__
307   * `ppb_messaging.h <pepper_stable/c/ppb__messaging_8h.html>`__
309   * `ppb_mouse_cursor.h <pepper_stable/c/ppb__mouse__cursor_8h.html>`__
311   * `ppb_mouse_lock.h <pepper_stable/c/ppb__mouse__lock_8h.html>`__
313   * `ppb_net_address.h <pepper_stable/c/ppb__net__address_8h.html>`__
315   * `ppb_network_list.h <pepper_stable/c/ppb__network__list_8h.html>`__
317   * `ppb_network_monitor.h <pepper_stable/c/ppb__network__monitor_8h.html>`__
319   * `ppb_network_proxy.h <pepper_stable/c/ppb__network__proxy_8h.html>`__
321   * `ppb_opengles2.h <pepper_stable/c/ppb__opengles2_8h.html>`__
323   * `ppb_tcp_socket.h <pepper_stable/c/ppb__tcp__socket_8h.html>`__
325   * `ppb_text_input_controller.h <pepper_stable/c/ppb__text__input__controller_8h.html>`__
327   * `ppb_udp_socket.h <pepper_stable/c/ppb__udp__socket_8h.html>`__
329   * `ppb_url_loader.h <pepper_stable/c/ppb__url__loader_8h.html>`__
331   * `ppb_url_request_info.h <pepper_stable/c/ppb__url__request__info_8h.html>`__
333   * `ppb_url_response_info.h <pepper_stable/c/ppb__url__response__info_8h.html>`__
335   * `ppb_var.h <pepper_stable/c/ppb__var_8h.html>`__
337   * `ppb_var_array.h <pepper_stable/c/ppb__var__array_8h.html>`__
339   * `ppb_var_array_buffer.h <pepper_stable/c/ppb__var__array__buffer_8h.html>`__
341   * `ppb_var_dictionary.h <pepper_stable/c/ppb__var__dictionary_8h.html>`__
343   * `ppb_video_decoder.h <pepper_stable/c/ppb__video__decoder_8h.html>`__
345   * `ppb_video_frame.h <pepper_stable/c/ppb__video__frame_8h.html>`__
347   * `ppb_view.h <pepper_stable/c/ppb__view_8h.html>`__
349   * `ppb_websocket.h <pepper_stable/c/ppb__websocket_8h.html>`__
351   * `ppp.h <pepper_stable/c/ppp_8h.html>`__
353   * `ppp_graphics_3d.h <pepper_stable/c/ppp__graphics__3d_8h.html>`__
355   * `ppp_input_event.h <pepper_stable/c/ppp__input__event_8h.html>`__
357   * `ppp_instance.h <pepper_stable/c/ppp__instance_8h.html>`__
359   * `ppp_message_handler.h <pepper_stable/c/ppp__message__handler_8h.html>`__
361   * `ppp_messaging.h <pepper_stable/c/ppp__messaging_8h.html>`__
363   * `ppp_mouse_lock.h <pepper_stable/c/ppp__mouse__lock_8h.html>`__