Functions that deal with creating, connecting, or interacting with Wayland displays.
More...
Functions that deal with creating, connecting, or interacting with Wayland displays.
◆ ecore_wl2_display_create()
EAPI Ecore_Wl2_Display* ecore_wl2_display_create |
( |
const char * |
name | ) |
|
Create a new Wayland display.
This function is typically used to create a new display for use with compositors, or to create a new display for use in nested compositors.
- Parameters
-
name | The display target name to create. If NULL , a default display name will be assigned. |
- Returns
- The newly created Ecore_Wl2_Display
- Since
- 1.17
References DBG, ECORE_FD_ERROR, ECORE_FD_READ, ecore_main_fd_handler_add(), ecore_main_fd_handler_prepare_callback_set(), eina_hash_add(), eina_hash_find(), eina_hash_string_superfast_new(), ERR, and setenv().
◆ ecore_wl2_display_destroy()
EAPI void ecore_wl2_display_destroy |
( |
Ecore_Wl2_Display * |
display | ) |
|
Destroy an existing Wayland display.
This function is typically used by servers to terminate an existing Wayland display.
- Parameters
-
display | The display to terminate |
- Since
- 1.17
◆ ecore_wl2_display_connect()
EAPI Ecore_Wl2_Display* ecore_wl2_display_connect |
( |
const char * |
name | ) |
|
◆ ecore_wl2_display_disconnect()
EAPI void ecore_wl2_display_disconnect |
( |
Ecore_Wl2_Display * |
display | ) |
|
Disconnect an existing Wayland display.
This function is typically used by clients to disconnect from an existing Wayland display.
- Parameters
-
display | The display to disconnect from |
- Since
- 1.17
◆ ecore_wl2_display_terminate()
EAPI void ecore_wl2_display_terminate |
( |
Ecore_Wl2_Display * |
display | ) |
|
Terminate a Wayland display's main loop.
This function is typically used by servers to terminate the Wayland display main loop. This is usually only called when a server encounters an error.
- Parameters
-
display | The Ecore_Wl2_Display to terminate |
- Since
- 1.17
◆ ecore_wl2_display_get()
EAPI struct wl_display* ecore_wl2_display_get |
( |
Ecore_Wl2_Display * |
display | ) |
|
Retrieve the existing Wayland display.
- Parameters
-
display | The Ecore_Wl2_Display for which to retrieve the existing Wayland display from |
- Returns
- The wl_display which this Ecore_Wl2_Display is using
- Since
- 1.17
◆ ecore_wl2_display_shm_get()
EAPI struct wl_shm* ecore_wl2_display_shm_get |
( |
Ecore_Wl2_Display * |
display | ) |
|
Retrieve the wl_shm from a given Ecore_Wl2_Display.
- Parameters
-
display | The Ecore_Wl2_Display for which to retrieve the existing Wayland shm interface from |
- Returns
- The wl_shm which this Ecore_Wl2_Display is using
- Since
- 1.17
◆ ecore_wl2_display_dmabuf_get()
EAPI void* ecore_wl2_display_dmabuf_get |
( |
Ecore_Wl2_Display * |
display | ) |
|
Retrieve the wl_dmabuf from a given Ecore_Wl2_Display.
- Parameters
-
display | The Ecore_Wl2_Display for which to retrieve the existing Wayland dmabuf interface from |
- Returns
- The wl_dmabuf which this Ecore_Wl2_Display is using
- Note
- This is intended for client use only and should be used only after ecore_wl2_display_connect(). Also, the return type is void * instead of zpw_linux_dmabuf_v1 * since we don't want to change our public API every time the version changes in wayland-protocols.
- Since
- 1.18
◆ ecore_wl2_display_globals_get()
Return an Eina_Iterator that can be used to iterate through globals.
- Parameters
-
display | The Ecore_Wl2_Display for which to return a global iterator |
- Note
- The caller of this function should free the returned Eina_Iterator when finished with it.
- Since
- 1.17
◆ ecore_wl2_display_screen_size_get()
EAPI void ecore_wl2_display_screen_size_get |
( |
Ecore_Wl2_Display * |
display, |
|
|
int * |
w, |
|
|
int * |
h |
|
) |
| |
Retrieves the size of the current screen.
- Parameters
-
display | The display to get the screen size of |
w | where to return the width. May be NULL. Returns 0 on error. |
h | where to return the height. May be NULL. Returns 0 on error. |
- Since
- 1.17
◆ ecore_wl2_display_inputs_get()
Get all the Ecore_Wl2_Input from the display.
- Parameters
-
- Returns
- A Eina_Iterator of Ecore_Wl2_Input or
NULL
on error
- Since
- 1.19
◆ ecore_wl2_display_input_find()
EAPI Ecore_Wl2_Input* ecore_wl2_display_input_find |
( |
const Ecore_Wl2_Display * |
display, |
|
|
unsigned int |
id |
|
) |
| |
Find a seat for a given display object using the seat id.
- Parameters
-
display | The display |
id | The seat id |
- Returns
- The corresponding Ecore_Wl2_Input object or
NULL
if no match is found
- Since
- 1.20
◆ ecore_wl2_display_input_find_by_name()
EAPI Ecore_Wl2_Input* ecore_wl2_display_input_find_by_name |
( |
const Ecore_Wl2_Display * |
display, |
|
|
const char * |
name |
|
) |
| |
Find a seat for a given display object using the seat id.
- Parameters
-
display | The display |
name | The seat name |
- Returns
- The corresponding Ecore_Wl2_Input object or
NULL
if no match is found
- Since
- 1.20
◆ ecore_wl2_display_registry_get()
EAPI struct wl_registry* ecore_wl2_display_registry_get |
( |
Ecore_Wl2_Display * |
display | ) |
|
Retrieves the Wayland Registry used for the current Wayland display.
- Parameters
-
display | The display to get the registry of |
- Returns
- The current wayland registry, or NULL on error
- Since
- 1.17
◆ ecore_wl2_display_sync_is_done()
EAPI Eina_Bool ecore_wl2_display_sync_is_done |
( |
const Ecore_Wl2_Display * |
display | ) |
|
Check if the display has performed a sync.
- Parameters
-
- Returns
- True if the display sync has occurred
- See also
- ECORE_WL2_EVENT_SYNC_DONE
- Since
- 1.20
◆ ecore_wl2_display_name_get()
EAPI const char* ecore_wl2_display_name_get |
( |
const Ecore_Wl2_Display * |
display | ) |
|
Get the name of the display object.
- Parameters
-
- Returns
- The name of the display object
- Since
- 1.20
◆ ecore_wl2_display_compositor_version_get()
EAPI int ecore_wl2_display_compositor_version_get |
( |
Ecore_Wl2_Display * |
disp | ) |
|
Return the version of the display's compositor object.
- Parameters
-
disp | the display to get the compositor object version from |
- Returns
- the version of the display's compositor object
- Since
- 1.17