Functions that deal with creating, destroying, or interacting with Wayland windows

Functions
Ecore_Wl2_Window *	ecore_wl2_window_new (Ecore_Wl2_Display display, Ecore_Wl2_Window parent, int x, int y, int w, int h)
	Create a new Ecore_Wl2_Window.
int	ecore_wl2_window_id_get (Ecore_Wl2_Window *window)
	Get the window id associated with an Ecore_Wl2_Window.
void	ecore_wl2_window_show (Ecore_Wl2_Window *window)
	Show a given Ecore_Wl2_Window.
void	ecore_wl2_window_hide (Ecore_Wl2_Window *window)
	Hide a given Ecore_Wl2_Window.
void	ecore_wl2_window_free (Ecore_Wl2_Window *window)
	Free a given Ecore_Wl2_Window.
void	ecore_wl2_window_raise (Ecore_Wl2_Window *window)
	Raise a given Ecore_Wl2_Window.
void	ecore_wl2_window_lower (Ecore_Wl2_Window *window)
	Lower the target window.
void	ecore_wl2_window_activate (Ecore_Wl2_Window *window)
	Activate the target window.
void	ecore_wl2_window_buffer_attach (Ecore_Wl2_Window win, void buffer, int x, int y, Eina_Bool implicit)
	Attach a buffer to a window.
void	ecore_wl2_window_damage (Ecore_Wl2_Window window, Eina_Rectangle rects, unsigned int count)
	Specifies the area of the window's surface that needs updating internally calling wl_surface_damage.
Eina_Bool	ecore_wl2_window_alpha_get (Ecore_Wl2_Window *window)
	Get if a given window is alpha.
void	ecore_wl2_window_alpha_set (Ecore_Wl2_Window *window, Eina_Bool alpha)
	Set a given window's alpha property.
void	ecore_wl2_window_title_set (Ecore_Wl2_Window window, const char title)
	Set the title of a given window.
const char *	ecore_wl2_window_title_get (Ecore_Wl2_Window *window)
	Get the title of a given window.
Ecore_Wl2_Display *	ecore_wl2_window_display_get (const Ecore_Wl2_Window *window)
	Get which display a given window is using.
void	ecore_wl2_window_focus_skip_set (Ecore_Wl2_Window *window, Eina_Bool focus_skip)
	Set if this window should ignore focus requests.
Eina_Bool	ecore_wl2_window_focus_skip_get (Ecore_Wl2_Window *window)
	Get if this window ignores focus requests.
void	ecore_wl2_window_video_has (Ecore_Wl2_Window *window, Eina_Bool has)
	Register the tizen protocol to provide video through the window's surface.
void	ecore_wl2_window_commit (Ecore_Wl2_Window *window, Eina_Bool flush)
	Commit the surface of a wayland window.
Ecore_Wl2_Frame_Cb_Handle *	ecore_wl2_window_frame_callback_add (Ecore_Wl2_Window window, Ecore_Wl2_Frame_Cb cb, void data)
	Add a callback that fires when the window's surface_frame callback fires.
void	ecore_wl2_window_frame_callback_del (Ecore_Wl2_Frame_Cb_Handle *handle)
	Delete a callback that fires when the window's surface_frame callback fires.
Eina_Bool	ecore_wl2_window_keygrab_set (Ecore_Wl2_Window win, const char key, int mod, int not_mod, int priority, Ecore_Wl2_Window_Keygrab_Mode grab_mode)
	Sets keygrab value of the window.
Eina_Bool	ecore_wl2_window_keygrab_unset (Ecore_Wl2_Window win, const char key, int mod, int any_mod)
	Unsets keygrab value of the window.
Eina_List *	ecore_wl2_window_keygrab_list_set (Ecore_Wl2_Window win, Eina_List infos)
	Sets keygrab values of the window.
Eina_List *	ecore_wl2_window_keygrab_list_unset (Ecore_Wl2_Window win, Eina_List infos)
	Unsets keygrab values of the window.
Ecore_Wl2_Egl_Window *	ecore_wl2_egl_window_create (Ecore_Wl2_Window *window, int w, int h)
	Creates wl_egl_window.
void	ecore_wl2_egl_window_destroy (Ecore_Wl2_Egl_Window *egl_win)
	Destroy a given Ecore_Wl2_Egl_Window.
void *	ecore_wl2_egl_window_native_get (Ecore_Wl2_Egl_Window *egl_win)
	Gets the wl_egl_window that this ecore_wl2_egl_window is using.
void	ecore_wl2_egl_window_resize_with_rotation (Ecore_Wl2_Egl_Window *egl_win, int dx, int dy, int w, int h, int rotation)
	Ecore_Wl2_Egl_Window resize with rotation.
void *	ecore_wl2_window_native_surface_get (Ecore_Wl2_Window *window)
	Get the native surface(wl_surface) which belongs to this window.
Eina_Bool	ecore_wl2_window_video_surface_create (Ecore_Wl2_Window *win)
	Create a video surface for a given window.
void *	ecore_wl2_window_video_surface_get (Ecore_Wl2_Window *win)
	Get video surface for a given window.
Eina_Bool	ecore_wl2_window_video_surface_destroy (Ecore_Wl2_Window *win)
	Destroy a video surface for a given window.
Eina_Bool	ecore_wl2_window_video_surface_sync_set (Ecore_Wl2_Window *win, Eina_Bool sync)
	Set video surface for a given window to synchronized mode the default commit behaviour is synchronized mode.
Eina_Bool	ecore_wl2_window_video_surface_destination_set (Ecore_Wl2_Window *win, int x, int y, int w, int h)
	Set destination area of video surface for a given window.
int	ecore_wl2_window_render_sync_fd_create (Ecore_Wl2_Window *win, Ecore_Wl2_Window_Render_Sync_Type sync_type)
	Create a file descriptor for rendering sync for a given window.
void	ecore_wl2_window_background_blur_set (Ecore_Wl2_Window *window, int radius, int rx, int ry)
	Set the background blur radius of a given window.
int	ecore_wl2_window_background_blur_get (Ecore_Wl2_Window *window)
	Get the background blur radius of a given window.
void	ecore_wl2_window_behind_blur_set (Ecore_Wl2_Window *window, int radius)
	Sets the behind blur radius of a given window.
int	ecore_wl2_window_behind_blur_get (Ecore_Wl2_Window *window)
	Gets the behind blur radius of a given window.
Eina_Bool	ecore_wl2_window_pointer_constraints_lock_pointer (Ecore_Wl2_Window *win)
	Lock pointer to a window with constraints.
Eina_Bool	ecore_wl2_window_pointer_constraints_unlock_pointer (Ecore_Wl2_Window *win)
	Unlock pointer from constraints.
void	ecore_wl2_window_locked_pointer_region_set (Ecore_Wl2_Window *win, int x, int y, int w, int h)
	Set locked pointer region for a window.
void	ecore_wl2_window_locked_pointer_cursor_position_hint_set (Ecore_Wl2_Window *win, int x, int y)
	Set cursor position hint for locked pointer to prevent cursor jump.
void	ecore_wl2_window_cursor_visible_set (Ecore_Wl2_Window *win, Eina_Bool visible)
	Set cursor visibility for a window.
Eina_Bool	ecore_wl2_window_keyboard_grab (Ecore_Wl2_Window *win, unsigned int subtype)
	Grab keyboard input for a window.
Eina_Bool	ecore_wl2_window_keyboard_ungrab (Ecore_Wl2_Window *win)
	Release keyboard grab for a window.
Eina_Bool	ecore_wl2_window_relative_motion_grab (Ecore_Wl2_Window *win, Ecore_Wl2_Pointer_Boundary boundary)
	Grab relative pointer motion for a window.
Eina_Bool	ecore_wl2_window_relative_motion_ungrab (Ecore_Wl2_Window *win)
	Release relative pointer motion grab for a window.
Typedefs
typedef enum _Ecore_Wl2_Window_Render_Sync_Type	Ecore_Wl2_Window_Render_Sync_Type
	Defines the types to create a file descriptor which is used for informing render event on the native surface.

Typedef Documentation

typedef enum _Ecore_Wl2_Window_Render_Sync_Type Ecore_Wl2_Window_Render_Sync_Type

Defines the types to create a file descriptor which is used for informing render event on the native surface.

See also:: ecore_wl2_window_render_sync_fd_create

Since :: 6.0

Enumeration Type Documentation

enum _Ecore_Wl2_Window_Render_Sync_Type

Defines the types to create a file descriptor which is used for informing render event on the native surface.

See also:: ecore_wl2_window_render_sync_fd_create

Since :: 6.0

Enumerator:

ECORE_WL2_WINDOW_RENDER_SYNC_COMMIT	To get commit event emitted after calling wl_surface_commit
ECORE_WL2_WINDOW_RENDER_SYNC_PRESENT	To get presentation event emitted after the compositor draws

Function Documentation

Ecore_Wl2_Egl_Window* ecore_wl2_egl_window_create	(	Ecore_Wl2_Window *	window,
		int	w,
		int	h
	)

Creates wl_egl_window.

Create wl_egl_window through the connected wl_surface of ecore_wl2_window.

Parameters:

window	The Ecore_Wl2_Window
w	The width of wl_egl_window
h	The height of wl_egl_window

Returns:: The newly created Ecore_Wl2_Egl_Window

Since :: 6.0

void ecore_wl2_egl_window_destroy ( Ecore_Wl2_Egl_Window * egl_win )

Destroy a given Ecore_Wl2_Egl_Window.

Parameters:

egl_win The Ecore_Wl2_Egl_Window to destroy

Since :: 6.0

void* ecore_wl2_egl_window_native_get ( Ecore_Wl2_Egl_Window * egl_win )

Gets the wl_egl_window that this ecore_wl2_egl_window is using.

Cast the wl_egl_window struct pointer not included in the Managed API to void pointer This pointer can be used as an argument to the function passed to wl_egl_window.

Parameters:

egl_win The Ecore_Wl2_Egl_Window

Returns:: The wl_egl_window, it provided as void type

Since :: 6.0

void ecore_wl2_egl_window_resize_with_rotation	(	Ecore_Wl2_Egl_Window *	egl_win,
		int	dx,
		int	dy,
		int	w,
		int	h,
		int	rotation
	)

Ecore_Wl2_Egl_Window resize with rotation.

Parameters:

egl_win	The Ecore_Wl2_Egl_Window
dx	The x coord resize
dy	The y coord resize
w	The width of Ecore_Wl2_Egl_Window
h	The height of Ecore_Wl2_Egl_Window
rotation	The angle of rotation

Since :: 6.0

void ecore_wl2_window_activate ( Ecore_Wl2_Window * window )

Activate the target window.

Parameters:

window The target window

Since :: 6.0

Eina_Bool ecore_wl2_window_alpha_get ( Ecore_Wl2_Window * window )

Get if a given window is alpha.

Parameters:

window The window to get if is alpha

Returns:: EINA_TRUE if window is alpha, EINA_FALSE otherwise

Since (EFL) :: 1.17

Since :: 6.0

void ecore_wl2_window_alpha_set	(	Ecore_Wl2_Window *	window,
		Eina_Bool	alpha
	)

Set a given window's alpha property.

Parameters:

window	The window on which to set the alpha property
alpha	EINA_TRUE to set window as alpha, EINA_FALSE otherwise

Since (EFL) :: 1.17

Since :: 6.0

int ecore_wl2_window_background_blur_get ( Ecore_Wl2_Window * window )

Get the background blur radius of a given window.

Deprecated:: Deprecated since 10.0.

Parameters:

window The window to get the background blur radius

Returns:: radius The radius of the blur effect

Since :: 9.0

void ecore_wl2_window_background_blur_set	(	Ecore_Wl2_Window *	window,
		int	radius,
		int	rx,
		int	ry
	)

Set the background blur radius of a given window.

Deprecated:: Deprecated since 10.0.

Parameters:

window	The window to set the background blur radius
radius	The radius of the blur effect
rx	The radius of the rounded corners in x direction
ry	The radius of the rounded corners in y direction

Since :: 9.0

int ecore_wl2_window_behind_blur_get ( Ecore_Wl2_Window * window )

Gets the behind blur radius of a given window.

Deprecated:: Deprecated since 10.0.

Parameters:

window The window to get the behind blur radius

Returns:: radius The radius of the blur effect

Since :: 9.0

void ecore_wl2_window_behind_blur_set	(	Ecore_Wl2_Window *	window,
		int	radius
	)

Sets the behind blur radius of a given window.

Deprecated:: Deprecated since 10.0.

Parameters:

window	The window to set the behind blur radius
radius	The radius of the blur effect

Since :: 9.0

void ecore_wl2_window_buffer_attach	(	Ecore_Wl2_Window *	win,
		void *	buffer,
		int	x,
		int	y,
		Eina_Bool	implicit
	)

Attach a buffer to a window.

Note that the GL stack my attach buffers to a surface - we should call this function at that time (with a NULL buffer) to track whether a surface has a valid buffer. That is, call with implicit true and buffer NULL at the time of glSwapBuffers.

Parameters:

window	The target window
buffer	The buffer to attach
x	X offset from corner
y	Y offset from corner
implicit	True if an external library is doing the actual attaching

Since (EFL) :: 1.21

Since :: 6.0

void ecore_wl2_window_commit	(	Ecore_Wl2_Window *	window,
		Eina_Bool	flush
	)

Commit the surface of a wayland window.

If flush is set this generates a wl_surface_commit(), otherwise it is expected that some other call in the very near future (such as eglSwapBuffers) will cause an implicit flush.

A surface that has been commit will be in the "pending" state until the compositor tells us it's time to draw again via a frame callback.

Parameters:

window	The window whose surface we want to commit
flush	EINA_TRUE if we need to flush immediately.

Since (EFL) :: 1.21

Since :: 6.0

void ecore_wl2_window_cursor_visible_set	(	Ecore_Wl2_Window *	win,
		Eina_Bool	visible
	)

Set cursor visibility for a window.

Parameters:

win	The window to set cursor visibility
visible	EINA_TRUE to show cursor, EINA_FALSE to hide

This function controls whether the cursor is visible when over the specified window.

Since :: 8.0

void ecore_wl2_window_damage	(	Ecore_Wl2_Window *	window,
		Eina_Rectangle *	rects,
		unsigned int	count
	)

Specifies the area of the window's surface that needs updating internally calling wl_surface_damage.

Parameters:

window	The target window
rects	The rect area that will cause damage
count	The number of rects

Since :: 6.0

Ecore_Wl2_Display* ecore_wl2_window_display_get ( const Ecore_Wl2_Window * window )

Get which display a given window is using.

Parameters:

window The window to get the display of

Returns:: The Ecore_Wl2_Display that this window is using, or NULL otherwise

Since (EFL) :: 1.17

Since :: 6.0

Eina_Bool ecore_wl2_window_focus_skip_get ( Ecore_Wl2_Window * window )

Get if this window ignores focus requests.

Parameters:

window The window to get the focus skip value from

Returns:: EINA_TRUE if a window should skip focus requests, EINA_FALSE otherwise

Since (EFL) :: 1.20

Since :: 6.0

void ecore_wl2_window_focus_skip_set	(	Ecore_Wl2_Window *	window,
		Eina_Bool	focus_skip
	)

Set if this window should ignore focus requests.

Parameters:

window	The window to set ignore focus requests on
focus_skip	EINA_TRUE if this window should skip focus requests, EINA_FALSE otherwise

Since (EFL) :: 1.20

Since :: 6.0

Ecore_Wl2_Frame_Cb_Handle* ecore_wl2_window_frame_callback_add	(	Ecore_Wl2_Window *	window,
		Ecore_Wl2_Frame_Cb	cb,
		void *	data
	)

Add a callback that fires when the window's surface_frame callback fires.

Parameters:

window	The window to add a callback on
cb	The callback
data	User data to provide to the callback handler

Returns:: The Ecore_Wl2_Frame_Cb_Handle

See also:: ecore_wl2_window_frame_callback_del

Since (EFL) :: 1.21

Since :: 6.0

void ecore_wl2_window_frame_callback_del ( Ecore_Wl2_Frame_Cb_Handle * handle )

Delete a callback that fires when the window's surface_frame callback fires.

Parameters:

handle The callback handle obtained through ecore_wl2_window_frame_callback_add().

Since (EFL) :: 1.21

Since :: 6.0

void ecore_wl2_window_free ( Ecore_Wl2_Window * window )

Free a given Ecore_Wl2_Window.

Parameters:

window The Ecore_Wl2_Window to free

Since (EFL) :: 1.17

Since :: 6.0

void ecore_wl2_window_hide ( Ecore_Wl2_Window * window )

Hide a given Ecore_Wl2_Window.

Parameters:

window The Ecore_Wl2_Window to hide

Since (EFL) :: 1.17

Since :: 6.0

int ecore_wl2_window_id_get ( Ecore_Wl2_Window * window )

Get the window id associated with an Ecore_Wl2_Window.

Parameters:

window The Ecore_Wl2_Window of which to retrieve the window id

Returns:: The id associated with this window

Since (EFL) :: 1.17

Since :: 6.0

Eina_Bool ecore_wl2_window_keyboard_grab	(	Ecore_Wl2_Window *	win,
		unsigned int	subtype
	)

Grab keyboard input for a window.

Parameters:

win	The window to grab keyboard input for
subtype	The type of keyboard grab (0 for normal grab)

Returns:: EINA_TRUE if grab was successful, EINA_FALSE otherwise

This function grabs keyboard input events for the specified window. The subtype parameter can be used to specify special grab types.

Since :: 8.0

Eina_Bool ecore_wl2_window_keyboard_ungrab ( Ecore_Wl2_Window * win )

Release keyboard grab for a window.

Parameters:

win	The window to release keyboard grab from

Returns:: EINA_TRUE if ungrab was successful, EINA_FALSE otherwise

This function releases a previously established keyboard grab for the specified window.

See also:: ecore_wl2_window_keyboard_grab

Since :: 8.0

Eina_List * ecore_wl2_window_keygrab_list_set	(	Ecore_Wl2_Window *	win,
		Eina_List *	infos
	)

Sets keygrab values of the window.

Warning:: This is not for use by third-party applications.; third-party application can use ECORE_WL2_WINDOW_KEYGRAB_TOPMOST mode without keygrab privilege. don't use other modes. those are not for third-party application.

The returned list should be freed with eina_list_free() when you no longer need it.

Privilege Level:: platform

Privilege:: http://tizen.org/privilege/keygrab

Parameters:

win	The window
infos	The list of keys and grab modes for setting keygrab

Returns:: NULL, or the list of keys being failed keygrab set.

Exceptions:

TIZEN_ERROR_NONE	Successfully set
TIZEN_ERROR_INVALID_PARAMETER	Invalid parameter has given
TIZEN_ERROR_PERMISSION_DENIED	Privilege permission denied

Ecore_Wl2_Window_Keygrab_Info *info = malloc(sizeof(Ecore_Wl2_Window_Keygrab_Info)); info->key = "XF86AudioLowerVolume"; info->mode = ECORE_WL2_WINDOW_KEYGRAB_TOPMOST; infos = eina_list_append(infos, info);

ecore_wl2_window_keygrab_list_set(win, infos);

Since :: 6.0

Eina_List * ecore_wl2_window_keygrab_list_unset	(	Ecore_Wl2_Window *	win,
		Eina_List *	infos
	)

Unsets keygrab values of the window.

Warning:: This is not for use by third-party applications.; third-party application can use ECORE_WL2_WINDOW_KEYGRAB_TOPMOST mode without keygrab privilege. don't use other modes. those are not for third-party application.

The returned list should be freed with eina_list_free() when you no longer need it.

Privilege Level:: platform

Privilege:: http://tizen.org/privilege/keygrab

Parameters:

win	The window
infos	The list of infos for unsetting keygrab

Returns:: NULL, or the list of keys being failed keygrab unset.

Exceptions:

TIZEN_ERROR_NONE	Successfully set
TIZEN_ERROR_INVALID_PARAMETER	Invalid parameter has given
TIZEN_ERROR_PERMISSION_DENIED	Privilege permission denied

Ecore_Wl2_Window_Keygrab_Info *info = malloc(sizeof(Ecore_Wl2_Window_Keygrab_Info)); info->key = "XF86AudioLowerVolume"; infos = eina_list_append(infos, info);

ecore_wl2_window_keygrab_list_unset(win, infos);

Since :: 6.0

Eina_Bool ecore_wl2_window_keygrab_set	(	Ecore_Wl2_Window *	win,
		const char *	key,
		int	mod,
		int	not_mod,
		int	priority,
		Ecore_Wl2_Window_Keygrab_Mode	grab_mode
	)

Sets keygrab value of the window.

Warning:: This is not for use by third-party applications.; third-party application can use ECORE_WL2_WINDOW_KEYGRAB_TOPMOST mode without keygrab privilege. don't use other modes. those are not for third-party application.

This function grabs the key of window using grab_mode

Privilege Level:: platform

Privilege:: http://tizen.org/privilege/keygrab

Parameters:

win	The target Ecore_Wl2_Window
key	The string is the keyname to grab
mod	A combination of modifier keys that must be present to trigger the event. Not supported yet
not_mod	A combination of modifier keys that must not be present to trigger the event. Not supported yet
priority	Not supported yet
grab_mode	Describes how the key should be grabbed, wrt. focus and stacking

Returns:: true on success, false otherwise

Exceptions:

TIZEN_ERROR_NONE	Successfully set
TIZEN_ERROR_INVALID_PARAMETER	Invalid parameter has given
TIZEN_ERROR_ALREADY_IN_PROGRESS	The key already has been grabbed
TIZEN_ERROR_PERMISSION_DENIED	Privilege permission denied

Since :: 6.0

Eina_Bool ecore_wl2_window_keygrab_unset	(	Ecore_Wl2_Window *	win,
		const char *	key,
		int	mod,
		int	any_mod
	)

Unsets keygrab value of the window.

Warning:: This is not for use by third-party applications.; third-party application can use ECORE_WL2_WINDOW_KEYGRAB_TOPMOST mode without keygrab privilege. don't use other modes. those are not for third-party application.

This function unset keygrab value. Ungrab key of window.

Privilege Level:: platform

Privilege:: http://tizen.org/privilege/keygrab

Parameters:

win	The target Ecore_Wl2_Window
key	The string is the keyname to grab
mod	A combination of modifier keys that must be present to trigger the event. Not supported yet
not_mod	A combination of modifier keys that must not be present to trigger the event. Not supported yet

Returns:: true on success, false otherwise

Exceptions:

TIZEN_ERROR_NONE	Successfully set
TIZEN_ERROR_INVALID_PARAMETER	Invalid parameter has given
TIZEN_ERROR_ALREADY_IN_PROGRESS	The key already has been grabbed
TIZEN_ERROR_PERMISSION_DENIED	Privilege permission denied

Since :: 6.0

void ecore_wl2_window_locked_pointer_cursor_position_hint_set	(	Ecore_Wl2_Window *	win,
		int	x,
		int	y
	)

Set cursor position hint for locked pointer to prevent cursor jump.

Parameters:

win	The window to set hint for
x	The x coordinate of hint position
y	The y coordinate of hint position

This function provides a hint for the cursor position when the pointer is locked. The compositor may use this to position the cursor when the lock is activated.

See also:: ecore_wl2_window_pointer_constraints_lock_pointer

Since :: 8.0

void ecore_wl2_window_locked_pointer_region_set	(	Ecore_Wl2_Window *	win,
		int	x,
		int	y,
		int	w,
		int	h
	)

Set locked pointer region for a window.

Parameters:

win	The window to set region for
x	The x coordinate of region
y	The y coordinate of region
w	The width of region
h	The height of region

This function sets the region where the pointer is locked when ecore_wl2_window_pointer_constraints_lock_pointer() is active. The pointer will be confined to this region.

See also:: ecore_wl2_window_pointer_constraints_lock_pointer

Since :: 8.0

void ecore_wl2_window_lower ( Ecore_Wl2_Window * window )

Lower the target window.

Note:: This API call causes the ECORE_WL2_EVENT_WINDOW_LOWER event

Parameters:

window The target window

Since :: 6.0

void* ecore_wl2_window_native_surface_get ( Ecore_Wl2_Window * window )

Get the native surface(wl_surface) which belongs to this window.

Note:: The native wl_surface struct is not included in the managed API list and is provided as a void pointer

Parameters:

window The Ecore_Wl2_Window to get the surface of

Returns:: The wl_surface associated with this window It provided as void type

Since :: 6.0

Ecore_Wl2_Window* ecore_wl2_window_new	(	Ecore_Wl2_Display *	display,
		Ecore_Wl2_Window *	parent,
		int	x,
		int	y,
		int	w,
		int	h
	)

Create a new Ecore_Wl2_Window.

Parameters:

display	The Ecore_Wl2_Display on which to create this new window
parent	The Ecore_Wl2_Window which is the parent of this window
x	Initial x position of window
y	Initial y position of window
w	Initial width of window
h	Initial height of window

Returns:: The Ecore_Wl2_Window that newly creating, or NULL failure

Since (EFL) :: 1.17

Since :: 6.0

Eina_Bool ecore_wl2_window_pointer_constraints_lock_pointer ( Ecore_Wl2_Window * win )

Lock pointer to a window with constraints.

Parameters:

win	The window to lock pointer to

Returns:: EINA_TRUE if lock was successful, EINA_FALSE otherwise

This function locks the pointer to the specified window, preventing it from moving outside the window bounds. This is typically used for implementing features like first-person view controls or drawing applications where pointer confinement is needed.

See also:: ecore_wl2_window_pointer_constraints_unlock_pointer

Since :: 8.0

Eina_Bool ecore_wl2_window_pointer_constraints_unlock_pointer ( Ecore_Wl2_Window * win )

Unlock pointer from constraints.

Parameters:

win	The window to unlock pointer from

Returns:: EINA_TRUE if unlock was successful, EINA_FALSE otherwise

This function releases a previously established pointer lock for the specified window. This should be called when pointer confinement is no longer needed.

See also:: ecore_wl2_window_pointer_constraints_lock_pointer

Since :: 8.0

void ecore_wl2_window_raise ( Ecore_Wl2_Window * window )

Raise a given Ecore_Wl2_Window.

Parameters:

window The Ecore_Wl2_Window which to raise

Since (EFL) :: 1.17

Since :: 6.0

Eina_Bool ecore_wl2_window_relative_motion_grab	(	Ecore_Wl2_Window *	win,
		Ecore_Wl2_Pointer_Boundary	boundary
	)

Grab relative pointer motion for a window.

Parameters:

win	The window to grab relative motion for
boundary	The boundary type for the relative motion grab

Returns:: EINA_TRUE if grab was successful, EINA_FALSE otherwise

This function grabs relative pointer motion events for the specified window. The boundary parameter defines the edge where the relative motion should be constrained (top, bottom, left, right, or none).

This is typically used for implementing edge-scrolling or other boundary-aware pointer interactions.

See also:: Ecore_Wl2_Pointer_Boundary

Since :: 9.0

Eina_Bool ecore_wl2_window_relative_motion_ungrab ( Ecore_Wl2_Window * win )

Release relative pointer motion grab for a window.

Parameters:

win	The window to release relative motion grab from

Returns:: EINA_TRUE if ungrab was successful, EINA_FALSE otherwise

This function releases a previously established relative pointer motion grab for the specified window. It should be called when boundary-aware pointer interactions (like edge-scrolling) are no longer needed.

See also:: ecore_wl2_window_relative_motion_grab

Since :: 9.0

int ecore_wl2_window_render_sync_fd_create	(	Ecore_Wl2_Window *	win,
		Ecore_Wl2_Window_Render_Sync_Type	sync_type
	)

Create a file descriptor for rendering sync for a given window.

Deprecated:: Deprecated since 10.0.

Parameters:

win	The window to create a file descriptor for rendering sync
sync_type	The one of Ecore_Wl2_Window_Render_Sync_Type to create a file descriptor

Returns:: The file descriptor. It must be closed manually by the caller using `close`

Since :: 6.0

void ecore_wl2_window_show ( Ecore_Wl2_Window * window )

Show a given Ecore_Wl2_Window.

Parameters:

window The Ecore_Wl2_Window to show

Since (EFL) :: 1.17

Since :: 6.0

const char* ecore_wl2_window_title_get ( Ecore_Wl2_Window * window )

Get the title of a given window.

Parameters:

window The window to set the title of

Returns:: A string if found, or NULL otherwise

Since (EFL) :: 1.24

Since :: 6.0

void ecore_wl2_window_title_set	(	Ecore_Wl2_Window *	window,
		const char *	title
	)

Set the title of a given window.

Parameters:

window	The window to set the title of
title	The title of the window

Since (EFL) :: 1.17

Since :: 6.0

void ecore_wl2_window_video_has	(	Ecore_Wl2_Window *	window,
		Eina_Bool	has
	)

Register the tizen protocol to provide video through the window's surface.

Parameters:

window	The target window
has	EINA_TRUE to set window has video, EINA_FALSE otherwise

Since :: 6.0

Eina_Bool ecore_wl2_window_video_surface_create ( Ecore_Wl2_Window * win )

Create a video surface for a given window.

Deprecated:: Deprecated since 10.0.

Parameters:

win	The window to create a video surface

Returns:: EINA_TRUE on success, EINA_FALSE otherwise

Since :: 6.0

Eina_Bool ecore_wl2_window_video_surface_destination_set	(	Ecore_Wl2_Window *	win,
		int	x,
		int	y,
		int	w,
		int	h
	)

Set destination area of video surface for a given window.

Deprecated:: Deprecated since 10.0.

Parameters:

win	The window to set destination area of video surface
x	X position of destination area
y	Y position of destination area
w	Width of destination area
h	Height of destination area

Returns:: EINA_TRUE on success, EINA_FALSE otherwise

Since :: 6.0

Eina_Bool ecore_wl2_window_video_surface_destroy ( Ecore_Wl2_Window * win )

Destroy a video surface for a given window.

Deprecated:: Deprecated since 10.0.

Parameters:

win	The window to destroy a video surface

Returns:: EINA_TRUE on success, EINA_FALSE otherwise

Since :: 6.0

void* ecore_wl2_window_video_surface_get ( Ecore_Wl2_Window * win )

Get video surface for a given window.

Deprecated:: Deprecated since 10.0.

Parameters:

win	The window to get video surface

Returns:: The wl_surface which is used by this window as a video surface It provided as void type

Since :: 6.0

Eina_Bool ecore_wl2_window_video_surface_sync_set	(	Ecore_Wl2_Window *	win,
		Eina_Bool	sync
	)

Set video surface for a given window to synchronized mode the default commit behaviour is synchronized mode.

Deprecated:: Deprecated since 10.0.

Parameters:

win	The window to set video surface to synchronized mode
sync	EINA_TRUE to set video surface to synchronized mode, EINA_FALSE to set video surface to desynchronized mode

Returns:: EINA_TRUE on success, EINA_FALSE otherwise

Since :: 6.0

Functions

Typedefs

Typedef Documentation

Enumeration Type Documentation

Function Documentation