Functions that deal with creating, connecting, or interacting with Wayland displays

Functions
Ecore_Wl2_Display *	ecore_wl2_display_connect (const char *name)
	Connect to an existing Wayland display.
void	ecore_wl2_display_disconnect (Ecore_Wl2_Display *display)
	Disconnect an existing Wayland display.
void *	ecore_wl2_display_native_get (Ecore_Wl2_Display *display)
	Retrieve the existing native wayland display.
void	ecore_wl2_display_screen_size_get (Ecore_Wl2_Display display, int w, int *h)
	Retrieves the size of the current screen.
void	ecore_wl2_display_all_screens_size_get (Ecore_Wl2_Display display, int w, int *h)
	Gets the size of all screens.
Ecore_Wl2_Window *	ecore_wl2_display_window_find (Ecore_Wl2_Display *display, unsigned int id)
	Find an Ecore_Wl2_Window based on id.
Ecore_Wl2_Display *	ecore_wl2_connected_display_get (const char *name)
	Gets the connected display object.
void	ecore_wl2_display_flush (Ecore_Wl2_Display *display)
	Push buffered wayland protocol to compositor.
void	ecore_wl2_display_sync (Ecore_Wl2_Display *display)
	The sync request asks the connected display server.

Function Documentation

Ecore_Wl2_Display* ecore_wl2_connected_display_get ( const char * name )

Gets the connected display object.

This function is typically used by clients to get an existing Wayland display.

Parameters:

name	The display target name. If `NULL`, the default display is assumed.

Returns:: The Ecore_Wl2_Display which was connected to

Since (EFL) :: 1.24

Since :: 6.0

void ecore_wl2_display_all_screens_size_get	(	Ecore_Wl2_Display *	display,
		int *	w,
		int *	h
	)

Gets the size of all screens.

Parameters:

display	The display to get all screens 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.

Ecore_Wl2_Display* ecore_wl2_display_connect ( const char * name )

Connect to an existing Wayland display.

This function is typically used by clients to connect to an existing Wayland display.

Parameters:

name	The display target name to connect to. If `NULL`, the default display is assumed.

Returns:: The Ecore_Wl2_Display which was connected to

Since (EFL) :: 1.17

Since :: 6.0

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 (EFL) :: 1.17

Since :: 6.0

void ecore_wl2_display_flush ( Ecore_Wl2_Display * display )

Push buffered wayland protocol to compositor.

Wayland protocol is only actually sent when a flush occurs, so the display should be flushed at appropriate times, such as after a commit.

Parameters:

display The display to flush

Since (EFL) :: 1.21

Since :: 6.0

void* ecore_wl2_display_native_get ( Ecore_Wl2_Display * display )

Retrieve the existing native wayland display.

Note:: The native wl_display struct is not included in the managed API list and is provided as a void pointer if the user needs to call a specific module function using that struct

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 It provided as void type

Since :: 6.0

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 (EFL) :: 1.17

void ecore_wl2_display_sync ( Ecore_Wl2_Display * display )

The sync request asks the connected display server.

Since requests are handled in-order and events are delivered in-order.

Parameters:

display The display to sync

Since :: 6.0

Ecore_Wl2_Window* ecore_wl2_display_window_find	(	Ecore_Wl2_Display *	display,
		unsigned int	id
	)

Find an Ecore_Wl2_Window based on id.

Parameters:

display	The display to search for the window
id	The id of the window to find

Returns:: The Ecore_Wl2_Window if found, or NULL if no such window exists

Since (EFL) :: 1.17

Since :: 6.0