View Backend

Functions

wpe_view_backend_add_activity_state 

void 
wpe_view_backend_add_activity_state (struct wpe_view_backend * ,
                                     int  uint32_t)

Parameters:

–
No description available
uint32_t –
No description available
Returns (void ) –
No description available

wpe_view_backend_create 

struct wpe_view_backend *
wpe_view_backend_create ()
Returns (struct wpe_view_backend *) –
No description available

wpe_view_backend_create_with_backend_interface 

struct wpe_view_backend *
wpe_view_backend_create_with_backend_interface (struct wpe_view_backend_interface * ,
                                                void * )

Parameters:

–
No description available
–
No description available
Returns (struct wpe_view_backend *) –
No description available

wpe_view_backend_destroy 

void 
wpe_view_backend_destroy (struct wpe_view_backend * )

Parameters:

–
No description available
Returns (void ) –
No description available

wpe_view_backend_dispatch_axis_event 

void 
wpe_view_backend_dispatch_axis_event (struct wpe_view_backend * ,
                                      struct wpe_input_axis_event * )

Parameters:

–
No description available
–
No description available
Returns (void ) –
No description available

wpe_view_backend_dispatch_did_enter_fullscreen 

void 
wpe_view_backend_dispatch_did_enter_fullscreen (struct wpe_view_backend * )

Dispatchs the event that indicates fullscreen has been successfully entered.

Parameters:

–
No description available
Returns (void ) –
No description available

Since : 1.12

wpe_view_backend_dispatch_did_exit_fullscreen 

void 
wpe_view_backend_dispatch_did_exit_fullscreen (struct wpe_view_backend * )

Dispatchs the event that indicated fullscreen has been successfully entered.

Parameters:

–
No description available
Returns (void ) –
No description available

Since : 1.12

wpe_view_backend_dispatch_frame_displayed 

void 
wpe_view_backend_dispatch_frame_displayed (struct wpe_view_backend * )

Parameters:

–
No description available
Returns (void ) –
No description available

wpe_view_backend_dispatch_get_accessible 

void *
wpe_view_backend_dispatch_get_accessible (struct wpe_view_backend * backend)

Parameters:

backend –
No description available
Returns (void *) –
No description available

wpe_view_backend_dispatch_keyboard_event 

void 
wpe_view_backend_dispatch_keyboard_event (struct wpe_view_backend * ,
                                          struct wpe_input_keyboard_event * )

Parameters:

–
No description available
–
No description available
Returns (void ) –
No description available

wpe_view_backend_dispatch_pointer_event 

void 
wpe_view_backend_dispatch_pointer_event (struct wpe_view_backend * ,
                                         struct wpe_input_pointer_event * )

Parameters:

–
No description available
–
No description available
Returns (void ) –
No description available

wpe_view_backend_dispatch_pointer_lock_event 

void 
wpe_view_backend_dispatch_pointer_lock_event (struct wpe_view_backend * ,
                                              struct wpe_input_pointer_lock_event * )

Parameters:

–
No description available
–
No description available
Returns (void ) –
No description available

wpe_view_backend_dispatch_request_enter_fullscreen 

void 
wpe_view_backend_dispatch_request_enter_fullscreen (struct wpe_view_backend * )

Dispatchs the event that indicates user wants to enter DOM fullscreen state.

Parameters:

–
No description available
Returns (void ) –
No description available

Since : 1.12

wpe_view_backend_dispatch_request_exit_fullscreen 

void 
wpe_view_backend_dispatch_request_exit_fullscreen (struct wpe_view_backend * )

Dispatchs the event that indicates user wants to exit DOM fullscreen state.

Parameters:

–
No description available
Returns (void ) –
No description available

Since : 1.12

wpe_view_backend_dispatch_set_device_scale_factor 

void 
wpe_view_backend_dispatch_set_device_scale_factor (struct wpe_view_backend * ,
                                                   float  )

Configure the device scaling factor applied to rendered content.

Set the factor by which sizes of content rendered to a web view will be multiplied by. The typical reason to set a value other than 1.0 (the default) is to produce output that will display at the intended physical size in displays with a high density of pixels.

Only values from 0.05 up to 5.0 are allowed. Setting a value outside this range will be ignored, and in debug builds execution will be aborted.

For example, a display that has a physical resolution of 3840x2160 with a scaling factor of 2.0 will make web content behave as if the screen had a size of 1920x1080, and content will be rendered at twice the size: each “logical” pixel will occupy four “physical” pixels (a 2x2 box) on the output.

Parameters:

–
No description available
–
No description available
Returns (void ) –
No description available

Since : 1.4

wpe_view_backend_dispatch_set_size 

void 
wpe_view_backend_dispatch_set_size (struct wpe_view_backend * ,
                                    int  uint32_t,
                                    int  )

Parameters:

–
No description available
uint32_t –
No description available
–
No description available
Returns (void ) –
No description available

wpe_view_backend_dispatch_touch_event 

void 
wpe_view_backend_dispatch_touch_event (struct wpe_view_backend * ,
                                       struct wpe_input_touch_event * )

Parameters:

–
No description available
–
No description available
Returns (void ) –
No description available

wpe_view_backend_get_activity_state 

int 
wpe_view_backend_get_activity_state (struct wpe_view_backend * )

Parameters:

–
No description available
Returns (int ) –
No description available

wpe_view_backend_get_renderer_host_fd 

int 
wpe_view_backend_get_renderer_host_fd (struct wpe_view_backend * )

Parameters:

–
No description available
Returns (int ) –
No description available

wpe_view_backend_get_target_refresh_rate 

int 
wpe_view_backend_get_target_refresh_rate (struct wpe_view_backend * )

Parameters:

–
No description available
Returns (int ) –
No description available

wpe_view_backend_initialize 

void 
wpe_view_backend_initialize (struct wpe_view_backend * )

Parameters:

–
No description available
Returns (void ) –
No description available

wpe_view_backend_platform_set_fullscreen 

_Bool 
wpe_view_backend_platform_set_fullscreen (struct wpe_view_backend * ,
                                          _Bool  )

Parameters:

–
No description available
–
No description available
Returns (_Bool ) –

a boolean indicating whether the operation was completed.

DOM content calls this function to request the platform to enter/exit fullscreen. The platform will attempt to change it's window fullscreen state.

Since : 1.12

wpe_view_backend_remove_activity_state 

void 
wpe_view_backend_remove_activity_state (struct wpe_view_backend * ,
                                        int  uint32_t)

Parameters:

–
No description available
uint32_t –
No description available
Returns (void ) –
No description available

wpe_view_backend_request_pointer_lock 

_Bool 
wpe_view_backend_request_pointer_lock (struct wpe_view_backend * )

Request the platform to lock the pointer.

Parameters:

–
No description available
Returns (_Bool ) –

a boolean indicating whether the operation was completed.

Since : 1.14

wpe_view_backend_request_pointer_unlock 

_Bool 
wpe_view_backend_request_pointer_unlock (struct wpe_view_backend * )

Request the platform to unlock the pointer.

Parameters:

–
No description available
Returns (_Bool ) –

a boolean indicating whether the operation was completed.

Since : 1.14

wpe_view_backend_set_backend_client 

void 
wpe_view_backend_set_backend_client (struct wpe_view_backend * ,
                                     struct wpe_view_backend_client * ,
                                     void * )

Parameters:

–
No description available
–
No description available
–
No description available
Returns (void ) –
No description available

wpe_view_backend_set_fullscreen_client 

void 
wpe_view_backend_set_fullscreen_client (struct wpe_view_backend * ,
                                        struct wpe_view_backend_fullscreen_client * ,
                                        void * )

Configure a client with callbacks invoked for DOM fullscreen requests.

This function must be only used once for a given view_backend, the client cannot be changed once it has been set.

Parameters:

–
No description available
–
No description available
–
No description available
Returns (void ) –
No description available

Since : 1.12

wpe_view_backend_set_fullscreen_handler 

void 
wpe_view_backend_set_fullscreen_handler (struct wpe_view_backend * ,
                                         wpe_view_backend_fullscreen_handler handler,
                                         void * userdata)

Handler function set by an embedder to implement fullscreening web views.

This function must be only used once for a given view_backend, the handler cannot be changed once it has been set.

Parameters:

–
No description available
handler –

Function used by an embedder to implement fullscreening web views.

userdata –

User data passed to the handler function.

Returns (void ) –
No description available

Since : 1.12

wpe_view_backend_set_input_client 

void 
wpe_view_backend_set_input_client (struct wpe_view_backend * ,
                                   struct wpe_view_backend_input_client * ,
                                   void * )

Parameters:

–
No description available
–
No description available
–
No description available
Returns (void ) –
No description available

wpe_view_backend_set_pointer_lock_handler 

void 
wpe_view_backend_set_pointer_lock_handler (struct wpe_view_backend * ,
                                           wpe_view_backend_pointer_lock_handler handler,
                                           void * userdata)

Handler function set by an embedder to implement pointer lock in web views.

This function must be only used once for a given view_backend, the handler cannot be changed once it has been set.

Parameters:

–
No description available
handler –

Function used by an embedder to implement pointer lock.

userdata –

User data passed to the handler function.

Returns (void ) –
No description available

Since : 1.14

wpe_view_backend_set_target_refresh_rate 

void 
wpe_view_backend_set_target_refresh_rate (struct wpe_view_backend * ,
                                          int  uint32_t)

Parameters:

–
No description available
uint32_t –
No description available
Returns (void ) –
No description available

Structures

wpe_view_backend_base 

struct wpe_view_backend_base {
    const struct wpe_view_backend_interface* interface;
    void* interface_data;
};

Fields

interface (struct wpe_view_backend_interface *) –
No description available
interface_data (void *) –
No description available

wpe_view_backend_client

wpe_view_backend_fullscreen_client

A view backend's fullscreen client provides a series of callback functions which are invoked at different stages when a web view becomes fullscreened and back.

Since : 1.12

wpe_view_backend_input_client

wpe_view_backend_interface 

struct wpe_view_backend_interface {
    void* (*create)(void*, struct wpe_view_backend*);
    void (*destroy)(void*);

    void (*initialize)(void*);
    int (*get_renderer_host_fd)(void*);

};

Fields

create () –
No description available
destroy () –
No description available
initialize () –
No description available
get_renderer_host_fd () –
No description available

Enumerations

wpe_view_activity_state 

enum wpe_view_activity_state {
    wpe_view_activity_state_visible   = 1 << 0,
    wpe_view_activity_state_focused   = 1 << 1,
    wpe_view_activity_state_in_window = 1 << 2
};

Members

wpe_view_activity_state_visible (1) –
No description available
wpe_view_activity_state_focused (2) –
No description available
wpe_view_activity_state_in_window (4) –
No description available

Callbacks

wpe_view_backend_fullscreen_handler 

_Bool 
(*wpe_view_backend_fullscreen_handler) (_Bool  enable)

Type of functions used by an embedder to implement fullscreening web views.

Parameters:

enable –

User data passed to the embedder.

Returns (_Bool ) –

a boolean indicating whether the operation was completed.

Since : 1.12

wpe_view_backend_pointer_lock_handler 

_Bool 
(*wpe_view_backend_pointer_lock_handler) (_Bool  enable)

Type of functions used by an embedder to implement pointer lock in web views.

Parameters:

enable –

User data passed to the embedder.

Returns (_Bool ) –

a boolean indicating whether the operation was completed.

Since : 1.14

The results of the search are