#include <GHOST_SystemWayland.hh>

Inherits GHOST_System.

Public Member Functions
	GHOST_SystemWayland ()
void	ime_begin (const GHOST_WindowWayland *win, int32_t x, int32_t y, int32_t w, int32_t h, bool completed) const
void	ime_end (const GHOST_WindowWayland *win) const
Public WAYLAND Utility Functions
Functionality only used for the WAYLAND implementation.
uint64_t	ms_from_input_time (const uint32_t timestamp_as_uint)
GHOST_TSuccess	pushEvent_maybe_pending (const GHOST_IEvent *event)
void	seat_active_set (const struct GWL_Seat *seat)
struct wl_seat *	wl_seat_active_get_with_input_serial (uint32_t &serial)
bool	output_unref (struct wl_output *wl_output)
void	output_scale_update (GWL_Output *output)
bool	window_surface_unref (const wl_surface *wl_surface)
bool	window_cursor_grab_set (const GHOST_TGrabCursorMode mode, const GHOST_TGrabCursorMode mode_current, int32_t init_grab_xy[2], const GHOST_Rect wrap_bounds, GHOST_TAxisFlag wrap_axis, wl_surface wl_surface, const struct GWL_WindowScaleParams &scale_params)
Public Member Functions inherited from GHOST_System
GHOST_ITimerTask *	installTimer (uint64_t delay, uint64_t interval, GHOST_TimerProcPtr timerProc, GHOST_TUserDataPtr userData=nullptr)
GHOST_TSuccess	removeTimer (GHOST_ITimerTask *timerTask)
GHOST_TSuccess	disposeWindow (GHOST_IWindow *window)
bool	validWindow (GHOST_IWindow *window)
GHOST_TSuccess	beginFullScreen (const GHOST_DisplaySetting &setting, GHOST_IWindow **window, const bool stereoVisual)
GHOST_TSuccess	updateFullScreen (const GHOST_DisplaySetting &setting, GHOST_IWindow **window)
GHOST_TSuccess	endFullScreen ()
bool	getFullScreen ()
bool	useNativePixel ()
void	useWindowFocus (const bool use_focus)
void	setAutoFocus (const bool auto_focus)
GHOST_IWindow *	getWindowUnderCursor (int32_t x, int32_t y)
void	dispatchEvents ()
GHOST_TSuccess	addEventConsumer (GHOST_IEventConsumer *consumer)
GHOST_TSuccess	removeEventConsumer (GHOST_IEventConsumer *consumer)
GHOST_TSuccess	getModifierKeyState (GHOST_TModifierKey mask, bool &isDown) const
GHOST_TSuccess	getButtonState (GHOST_TButton mask, bool &isDown) const
virtual void	setTabletAPI (GHOST_TTabletAPI api)
GHOST_TTabletAPI	getTabletAPI ()
GHOST_TSuccess	getPixelAtCursor (float r_color[3]) const
GHOST_TSuccess	pushEvent (const GHOST_IEvent *event)
GHOST_TimerManager *	getTimerManager () const
GHOST_EventManager *	getEventManager () const
GHOST_WindowManager *	getWindowManager () const
virtual GHOST_TSuccess	showMessageBox (const char , const char , const char , const char , const char *, GHOST_DialogOptions) const
virtual void	initDebug (GHOST_Debug debug)
virtual bool	isDebugEnabled ()

Public Attributes
std::mutex *	server_mutex = nullptr
std::mutex *	timer_mutex = nullptr
std::thread::id	main_thread_id
std::atomic< bool >	has_pending_actions_for_window = false
Public Attributes inherited from GHOST_System
bool	m_nativePixel
bool	m_windowFocus
bool	m_autoFocus

GHOST Implementation
WAYLAND specific implementation of the GHOST_System interface.
	GHOST_SystemWayland (bool background)
	~GHOST_SystemWayland () override
GHOST_TSuccess	init () override
bool	processEvents (bool waitForEvent) override
bool	setConsoleWindowState (GHOST_TConsoleWindowState action) override
GHOST_TSuccess	getModifierKeys (GHOST_ModifierKeys &keys) const override
GHOST_TSuccess	getButtons (GHOST_Buttons &buttons) const override
char *	getClipboard (bool selection) const override
void	putClipboard (const char *buffer, bool selection) const override
GHOST_TSuccess	hasClipboardImage () const override
uint *	getClipboardImage (int r_width, int r_height) const override
GHOST_TSuccess	putClipboardImage (uint *rgba, int width, int height) const override
uint8_t	getNumDisplays () const override
uint64_t	getMilliSeconds () const override
GHOST_TSuccess	getCursorPositionClientRelative (const GHOST_IWindow *window, int32_t &x, int32_t &y) const override
GHOST_TSuccess	setCursorPositionClientRelative (GHOST_IWindow *window, int32_t x, int32_t y) override
GHOST_TSuccess	getCursorPosition (int32_t &x, int32_t &y) const override
GHOST_TSuccess	setCursorPosition (int32_t x, int32_t y) override
void	getMainDisplayDimensions (uint32_t &width, uint32_t &height) const override
void	getAllDisplayDimensions (uint32_t &width, uint32_t &height) const override
GHOST_IContext *	createOffscreenContext (GHOST_GPUSettings gpuSettings) override
GHOST_TSuccess	disposeContext (GHOST_IContext *context) override
GHOST_IWindow *	createWindow (const char title, int32_t left, int32_t top, uint32_t width, uint32_t height, GHOST_TWindowState state, GHOST_GPUSettings gpuSettings, const bool exclusive, const bool is_dialog, const GHOST_IWindow parentWindow) override
GHOST_TCapabilityFlag	getCapabilities () const override
void	setMultitouchGestures (const bool use) override
GHOST_TSuccess	cursor_shape_set (GHOST_TStandardCursor shape)
GHOST_TSuccess	cursor_shape_check (GHOST_TStandardCursor cursorShape)
GHOST_TSuccess	cursor_shape_custom_set (const uint8_t bitmap, const uint8_t mask, int sizex, int sizey, int hotX, int hotY, bool canInvertColor)
GHOST_TSuccess	cursor_bitmap_get (GHOST_CursorBitmapRef *bitmap)
GHOST_TSuccess	cursor_visibility_set (bool visible)
bool	cursor_grab_use_software_display_get (const GHOST_TGrabCursorMode mode)

Public WAYLAND Direct Data Access
Expose some members via methods.
GHOST_TimerManager *	ghost_timer_manager ()
struct wl_display *	wl_display_get ()
struct wl_compositor *	wl_compositor_get ()
struct zwp_primary_selection_device_manager_v1 *	wp_primary_selection_manager_get ()
struct xdg_activation_v1 *	xdg_activation_manager_get ()
struct zwp_pointer_gestures_v1 *	wp_pointer_gestures_get ()
struct wp_fractional_scale_manager_v1 *	wp_fractional_scale_manager_get ()
struct wp_viewporter *	wp_viewporter_get ()
struct xdg_wm_base *	xdg_decor_shell_get ()
struct zxdg_decoration_manager_v1 *	xdg_decor_manager_get ()
const std::vector< GWL_Output * > &	outputs_get () const
struct wl_shm *	wl_shm_get () const
static const char *	xdg_app_id_get ()

Additional Inherited Members
Static Public Member Functions inherited from GHOST_ISystem
static GHOST_TSuccess	createSystem (bool verbose, bool background)
static GHOST_TSuccess	createSystemBackground ()
static GHOST_TSuccess	disposeSystem ()
static GHOST_ISystem *	getSystem ()
static const char *	getSystemBackend ()
static GHOST_TBacktraceFn	getBacktraceFn ()
static void	setBacktraceFn (GHOST_TBacktraceFn backtrace_fn)
Protected Member Functions inherited from GHOST_System
	GHOST_System ()
virtual	~GHOST_System ()
virtual GHOST_TSuccess	exit ()
GHOST_TSuccess	createFullScreenWindow (GHOST_Window **window, const GHOST_DisplaySetting &settings, const bool stereoVisual)
Protected Member Functions inherited from GHOST_ISystem
	GHOST_ISystem ()
virtual	~GHOST_ISystem ()
Protected Attributes inherited from GHOST_System
GHOST_DisplayManager *	m_displayManager
GHOST_TimerManager *	m_timerManager
GHOST_WindowManager *	m_windowManager
GHOST_EventManager *	m_eventManager
GHOST_DisplaySetting	m_preFullScreenSetting
bool	m_multitouchGestures
GHOST_TTabletAPI	m_tabletAPI
bool	m_is_debug_enabled
Static Protected Attributes inherited from GHOST_ISystem
static GHOST_ISystem *	m_system = nullptr
static const char *	m_system_backend_id = nullptr
static GHOST_TBacktraceFn	m_backtrace_fn = nullptr

Detailed Description

Definition at line 143 of file GHOST_SystemWayland.hh.

Constructor & Destructor Documentation

◆ GHOST_SystemWayland() [1/2]

GHOST_SystemWayland::GHOST_SystemWayland ( bool background )

◆ GHOST_SystemWayland() [2/2]

GHOST_SystemWayland::GHOST_SystemWayland ( )

inline

Definition at line 146 of file GHOST_SystemWayland.hh.

References GHOST_SystemWayland(), and true.

◆ ~GHOST_SystemWayland()

GHOST_SystemWayland::~GHOST_SystemWayland ( )

override

Definition at line 7483 of file GHOST_SystemWayland.cc.

Member Function Documentation

◆ createOffscreenContext()

GHOST_IContext * GHOST_SystemWayland::createOffscreenContext ( GHOST_GPUSettings gpuSettings )

overridevirtual

Create a new off-screen context. Never explicitly delete the context, use disposeContext() instead.

Returns: The new context (or 0 if creation failed).

Implements GHOST_System.

Definition at line 8281 of file GHOST_SystemWayland.cc.

References GHOST_GPUSettings::context_type, GHOST_GPUSettings::flags, GHOST_gpuDebugContext, GHOST_OPENGL_EGL_CONTEXT_FLAGS, GHOST_OPENGL_EGL_RESET_NOTIFICATION_STRATEGY, GHOST_PRINT, GHOST_GPUSettings::preferred_device, server_mutex, wl_compositor_get(), wl_egl_window_create, wl_egl_window_destroy, and wl_surface.

◆ createWindow()

GHOST_IWindow * GHOST_SystemWayland::createWindow	(	const char *	title,
		int32_t	left,
		int32_t	top,
		uint32_t	width,
		uint32_t	height,
		GHOST_TWindowState	state,
		GHOST_GPUSettings	gpuSettings,
		const bool	exclusive,
		const bool	is_dialog,
		const GHOST_IWindow *	parentWindow )

overridevirtual

Create a new window. The new window is added to the list of windows managed. Never explicitly delete the window, use disposeWindow() instead.

Parameters

title	The name of the window (displayed in the title bar of the window if the OS supports it).
left	The coordinate of the left edge of the window.
top	The coordinate of the top edge of the window.
width	The width the window.
height	The height the window.
state	The state of the window when opened.
gpuSettings	Misc GPU settings.
exclusive	Use to show the window on top and ignore others (used full-screen).
is_dialog	Stay on top of parent window, no icon in taskbar, can't be minimized.
parentWindow	Parent (embedder) window

Returns: The new window (or 0 if creation failed).

Implements GHOST_ISystem.

Definition at line 8408 of file GHOST_SystemWayland.cc.

References GHOST_GPUSettings::context_type, GHOST_GPUSettings::flags, getMilliSeconds(), GHOST_WindowWayland::getValid(), GHOST_gpuDebugContext, GHOST_gpuStereoVisual, GHOST_kEventWindowSize, left, GHOST_System::m_windowManager, GHOST_GPUSettings::preferred_device, pushEvent, state, and top.

◆ cursor_bitmap_get()

GHOST_TSuccess GHOST_SystemWayland::cursor_bitmap_get ( GHOST_CursorBitmapRef * bitmap )

Definition at line 8596 of file GHOST_SystemWayland.cc.

References GWL_Seat::cursor, GWL_Cursor::custom_data, GHOST_CursorBitmapRef::data, GHOST_CursorBitmapRef::data_size, GHOST_kFailure, GHOST_kSuccess, gwl_display_seat_active_get(), GHOST_CursorBitmapRef::hot_spot, GWL_Cursor::image, GWL_Cursor::is_custom, UNLIKELY, and GWL_Cursor::wl.

◆ cursor_grab_use_software_display_get()

bool GHOST_SystemWayland::cursor_grab_use_software_display_get ( const GHOST_TGrabCursorMode mode )

Definition at line 8670 of file GHOST_SystemWayland.cc.

References cursor_is_software(), gwl_display_seat_active_get(), UNLIKELY, and GWL_Seat::use_pointer_software_confine.

◆ cursor_shape_check()

GHOST_TSuccess GHOST_SystemWayland::cursor_shape_check ( GHOST_TStandardCursor cursorShape )

Definition at line 8503 of file GHOST_SystemWayland.cc.

References GHOST_kFailure, GHOST_kSuccess, gwl_display_seat_active_get(), gwl_seat_cursor_find_from_shape(), and UNLIKELY.

◆ cursor_shape_custom_set()

GHOST_TSuccess GHOST_SystemWayland::cursor_shape_custom_set	(	const uint8_t *	bitmap,
		const uint8_t *	mask,
		int	sizex,
		int	sizey,
		int	hotX,
		int	hotY,
		bool	canInvertColor )

◆ cursor_shape_set()

GHOST_TSuccess GHOST_SystemWayland::cursor_shape_set ( GHOST_TStandardCursor shape )

Definition at line 8469 of file GHOST_SystemWayland.cc.

References GWL_Cursor::buffer, GWL_Seat::cursor, GHOST_kFailure, GHOST_kSuccess, gwl_display_seat_active_get(), gwl_seat_cursor_buffer_set_current(), gwl_seat_cursor_find_from_shape(), GWL_Cursor::image, image(), GWL_Cursor::is_custom, GWL_Cursor::theme_cursor, GWL_Cursor::theme_cursor_name, UNLIKELY, GWL_Cursor::visible, GWL_Cursor::wl, and wl_cursor_image_get_buffer.

Referenced by gwl_window_cursor_shape_refresh().

◆ cursor_visibility_set()

GHOST_TSuccess GHOST_SystemWayland::cursor_visibility_set ( bool visible )

Definition at line 8623 of file GHOST_SystemWayland.cc.

References GWL_Seat::cursor, CURSOR_VISIBLE_ALWAYS_SET, GHOST_kFailure, GHOST_kSuccess, gwl_display_seat_active_get(), gwl_seat_cursor_visible_set(), GWL_Cursor::is_hardware, and UNLIKELY.

◆ disposeContext()

GHOST_TSuccess GHOST_SystemWayland::disposeContext ( GHOST_IContext * context )

overridevirtual

Dispose of a context.

Parameters

context Pointer to the context to be disposed.

Returns: Indication of success.

Implements GHOST_ISystem.

Definition at line 8367 of file GHOST_SystemWayland.cc.

References GHOST_kDrawingContextTypeNone, GHOST_kSuccess, server_mutex, wl_egl_window_destroy, and wl_surface.

◆ getAllDisplayDimensions()

void GHOST_SystemWayland::getAllDisplayDimensions	(	uint32_t &	width,
		uint32_t &	height ) const

overridevirtual

Returns the combine dimensions of all monitors.

Returns: The dimension of the workspace.

Implements GHOST_ISystem.

Definition at line 8251 of file GHOST_SystemWayland.cc.

References ELEM, INT32_MAX, INT32_MIN, output, server_mutex, UNPACK2, and xy.

◆ getButtons()

GHOST_TSuccess GHOST_SystemWayland::getButtons ( GHOST_Buttons & buttons ) const

overridevirtual

Returns the state of the mouse buttons (outside the message queue).

Parameters

buttons The state of the buttons.

Returns: Indication of success.

Implements GHOST_System.

Definition at line 7697 of file GHOST_SystemWayland.cc.

References GWL_SeatStatePointer::buttons, GHOST_kFailure, GHOST_kSuccess, gwl_display_seat_active_get(), gwl_seat_state_pointer_active(), server_mutex, and UNLIKELY.

◆ getCapabilities()

GHOST_TCapabilityFlag GHOST_SystemWayland::getCapabilities ( ) const

overridevirtual

Return features supported by the system back-end.

The resulting value doesn't change at run-time.

Implements GHOST_ISystem.

Definition at line 8635 of file GHOST_SystemWayland.cc.

References GHOST_ASSERT, GHOST_CAPABILITY_FLAG_ALL, GHOST_kCapabilityCursorWarp, GHOST_kCapabilityDesktopSample, GHOST_kCapabilityGPUReadFrontBuffer, GHOST_kCapabilityTrackpadPhysicalDirection, GHOST_kCapabilityWindowPosition, gwl_display_seat_active_get(), and has_wl_trackpad_physical_direction.

◆ getClipboard()

char * GHOST_SystemWayland::getClipboard ( bool selection ) const

overridevirtual

Returns the selection buffer

Parameters

selection Only used on X11.

Returns: Returns the clipboard data

Implements GHOST_System.

Definition at line 7831 of file GHOST_SystemWayland.cc.

References data, selection, server_mutex, system_clipboard_get(), and system_clipboard_get_primary_selection().

◆ getClipboardImage()

uint * GHOST_SystemWayland::getClipboardImage	(	int *	r_width,
		int *	r_height ) const

overridevirtual

Get image data from the Clipboard

Parameters

r_width	the returned image width in pixels.
r_height	the returned image height in pixels.

Returns: pointer uint array in RGBA byte order. Caller must free.

Reimplemented from GHOST_System.

Definition at line 7952 of file GHOST_SystemWayland.cc.

References ImBuf::byte_buffer, data, ImBufByteBuffer::data, GWL_Seat::data_offer_copy_paste, GWL_Seat::data_offer_copy_paste_mutex, free(), ghost_wl_mime_img_png, gwl_display_seat_active_get(), IB_rect, IMB_freeImBuf(), IMB_ibImageFromMemory(), mutex, read_buffer_from_data_offer(), server_mutex, GWL_DataOffer::types, UNLIKELY, wl_display_roundtrip, ImBuf::x, and ImBuf::y.

◆ getCursorPosition()

GHOST_TSuccess GHOST_SystemWayland::getCursorPosition	(	int32_t &	x,
		int32_t &	y ) const

overridevirtual

Returns the current location of the cursor (location in screen coordinates)

Parameters

x	The x-coordinate of the cursor.
y	The y-coordinate of the cursor.

Returns: Indication of success.

Implements GHOST_ISystem.

Definition at line 8191 of file GHOST_SystemWayland.cc.

References getCursorPositionClientRelative_impl(), GHOST_kFailure, ghost_wl_surface_user_data(), gwl_display_seat_active_get(), gwl_seat_state_pointer_active(), server_mutex, GWL_SeatStatePointer::surface_window, UNLIKELY, GWL_SeatStatePointer::wl, wl_surface, x, and y.

◆ getCursorPositionClientRelative()

GHOST_TSuccess GHOST_SystemWayland::getCursorPositionClientRelative	(	const GHOST_IWindow *	window,
		int32_t &	x,
		int32_t &	y ) const

overridevirtual

Returns the current location of the cursor (location in window coordinates)

Parameters

x	The x-coordinate of the cursor.
y	The y-coordinate of the cursor.

Returns: Indication of success.

Reimplemented from GHOST_System.

Definition at line 8155 of file GHOST_SystemWayland.cc.

References getCursorPositionClientRelative_impl(), GHOST_kFailure, gwl_display_seat_active_get(), gwl_seat_state_pointer_active(), server_mutex, GWL_SeatStatePointer::surface_window, UNLIKELY, GWL_SeatStatePointer::wl, x, and y.

◆ getMainDisplayDimensions()

void GHOST_SystemWayland::getMainDisplayDimensions	(	uint32_t &	width,
		uint32_t &	height ) const

overridevirtual

Returns the dimensions of the main display on this system.

Returns: The dimension of the main display.

Implements GHOST_ISystem.

Definition at line 8233 of file GHOST_SystemWayland.cc.

References ELEM, output, server_mutex, and UNPACK2.

◆ getMilliSeconds()

uint64_t GHOST_SystemWayland::getMilliSeconds ( ) const

overridevirtual

Returns the system time. Returns the number of milliseconds since the start of the system.

Note: The exact method used is platform dependent however monotonic methods should be used instead of wall-clock time.

Returns: The number of milliseconds.

Implements GHOST_ISystem.

Definition at line 8086 of file GHOST_SystemWayland.cc.

Referenced by createWindow(), data_device_handle_drop(), data_device_handle_enter(), data_device_handle_leave(), gwl_seat_key_repeat_timer_add(), gwl_window_frame_update_from_pending_no_lock(), keyboard_handle_enter(), ms_from_input_time(), pointer_handle_enter(), pointer_handle_frame(), processEvents(), setCursorPositionClientRelative_impl(), and window_cursor_grab_set().

◆ getModifierKeys()

GHOST_TSuccess GHOST_SystemWayland::getModifierKeys ( GHOST_ModifierKeys & keys ) const

overridevirtual

Returns the state of all modifier keys.

Parameters

keys	The state of all modifier keys (true == pressed).

Returns: Indication of success.

Implements GHOST_System.

Definition at line 7610 of file GHOST_SystemWayland.cc.

References CLOG_WARN, GWL_ModifierInfo::display_name, g_modifier_info_table, GHOST_KEY_MODIFIER_TO_INDEX, GHOST_kFailure, GHOST_kSuccess, gwl_display_seat_active_get(), GWL_Seat::key_depressed, GWL_ModifierInfo::key_l, GWL_ModifierInfo::key_r, GWL_Seat::keyboard, LOG_WL_KEYBOARD_DEPRESSED_STATE, MOD_INDEX_NUM, GWL_ModifierInfo::mod_l, GWL_ModifierInfo::mod_r, GWL_KeyboardDepressedState::mods, server_mutex, GHOST_ModifierKeys::set(), GWL_Seat::state, state, UNLIKELY, GWL_Seat::xkb, and GWL_Seat::xkb_keymap_mod_index.

◆ getNumDisplays()

uint8_t GHOST_SystemWayland::getNumDisplays ( ) const

overridevirtual

Returns the number of displays on this system.

Returns: The number of displays.

Implements GHOST_ISystem.

Definition at line 8077 of file GHOST_SystemWayland.cc.

References server_mutex.

◆ ghost_timer_manager()

GHOST_TimerManager * GHOST_SystemWayland::ghost_timer_manager ( )

Return a separate WAYLAND local timer manager to GHOST_System::getTimerManager Manipulation & access must lock with #GHOST_WaylandSystem::server_mutex.

See GWL_Display::ghost_timer_manager doc-string for details on why this is needed.

Definition at line 8907 of file GHOST_SystemWayland.cc.

Referenced by gwl_seat_key_repeat_timer_add(), gwl_seat_key_repeat_timer_remove(), and processEvents().

◆ hasClipboardImage()

GHOST_TSuccess GHOST_SystemWayland::hasClipboardImage ( void ) const

overridevirtual

Returns GHOST_kSuccess if the clipboard contains an image.

Reimplemented from GHOST_System.

Definition at line 7931 of file GHOST_SystemWayland.cc.

References GWL_Seat::data_offer_copy_paste, GHOST_kFailure, GHOST_kSuccess, ghost_wl_mime_img_png, gwl_display_seat_active_get(), server_mutex, GWL_DataOffer::types, and UNLIKELY.

◆ ime_begin()

void GHOST_SystemWayland::ime_begin	(	const GHOST_WindowWayland *	win,
		int32_t	x,
		int32_t	y,
		int32_t	w,
		int32_t	h,
		bool	completed ) const

References w(), x, and y.

◆ ime_end()

void GHOST_SystemWayland::ime_end ( const GHOST_WindowWayland * win ) const

References output, and wl_surface.

◆ init()

GHOST_TSuccess GHOST_SystemWayland::init ( )

overridevirtual

Initialize the system.

Returns: Indication of success.

Reimplemented from GHOST_System.

Definition at line 7488 of file GHOST_SystemWayland.cc.

References GHOST_kFailure, GHOST_kSuccess, and GHOST_System::init().

◆ ms_from_input_time()

uint64_t GHOST_SystemWayland::ms_from_input_time ( const uint32_t timestamp_as_uint )

Use this function instead of GHOST_System::getMilliSeconds, passing in the time-stamp from WAYLAND input to get the event time-stamp with an offset applied to make it compatible with getMilliSeconds.

Definition at line 9046 of file GHOST_SystemWayland.cc.

References GWL_DisplayTimeStamp::exact_match, getMilliSeconds(), GWL_DisplayTimeStamp::last, GWL_DisplayTimeStamp::offset, sub_abs_u64(), and UNLIKELY.

Referenced by data_device_handle_motion(), keyboard_handle_key(), pointer_handle_axis(), pointer_handle_axis_stop(), pointer_handle_button(), pointer_handle_motion(), relative_pointer_handle_relative_motion(), and tablet_tool_handle_frame().

◆ output_scale_update()

void GHOST_SystemWayland::output_scale_update ( GWL_Output * output )

◆ output_unref()

bool GHOST_SystemWayland::output_unref ( struct wl_output * wl_output )

Clear all references to this output.

Note: The compositor should have already called the wl_surface_listener.leave callback, however some compositors may not (see #103586). So remove references to the output before it's destroyed to avoid crashing.

Returns: true when any references were removed.

Definition at line 9162 of file GHOST_SystemWayland.cc.

References GHOST_System::getWindowManager(), GHOST_WindowManager::getWindows(), ghost_wl_output_own(), ghost_wl_output_user_data(), output, GWL_SeatStatePointer::outputs, GHOST_WindowWayland::outputs_changed_update_scale_tag(), GHOST_WindowWayland::outputs_leave(), GWL_Seat::pointer, and GWL_Seat::tablet.

◆ outputs_get()

const std::vector< GWL_Output * > & GHOST_SystemWayland::outputs_get ( ) const

Definition at line 8896 of file GHOST_SystemWayland.cc.

◆ processEvents()

bool GHOST_SystemWayland::processEvents ( bool waitForEvent )

overridevirtual

Retrieves events from the system and stores them in the queue.

Parameters

waitForEvent Flag to wait for an event (or return immediately).

Returns: Indication of the presence of events.

Implements GHOST_ISystem.

Definition at line 7504 of file GHOST_SystemWayland.cc.

References events_pending_default_size, GHOST_System::getEventManager(), getMilliSeconds(), GHOST_System::getTimerManager(), GHOST_IEvent::getType(), GHOST_IEvent::getWindow(), GHOST_System::getWindowManager(), GHOST_kEventWindowActivate, GHOST_kEventWindowDeactivate, ghost_timer_manager(), ghost_wl_display_event_pump(), ghost_wl_display_report_error(), has_pending_actions_for_window, lock, GHOST_WindowWayland::pending_actions_handle(), processEvents(), pushEvent, server_mutex, GHOST_WindowManager::setActiveWindow(), GHOST_WindowManager::setWindowInactive(), UNLIKELY, and wl_display_dispatch.

Referenced by processEvents().

◆ pushEvent_maybe_pending()

GHOST_TSuccess GHOST_SystemWayland::pushEvent_maybe_pending ( const GHOST_IEvent * event )

Push an event, with support for calling from a thread. NOTE: only needed for USE_EVENT_BACKGROUND_THREAD.

Definition at line 9109 of file GHOST_SystemWayland.cc.

References GHOST_kSuccess, lock, main_thread_id, and pushEvent.

Referenced by data_device_handle_drop(), dnd_events(), gwl_seat_key_repeat_timer_fn(), keyboard_depressed_state_push_events_from_change(), keyboard_handle_key(), pointer_handle_enter(), pointer_handle_frame(), relative_pointer_handle_relative_motion_impl(), tablet_tool_handle_frame(), and window_cursor_grab_set().

◆ putClipboard()

void GHOST_SystemWayland::putClipboard	(	const char *	buffer,
		bool	selection ) const

overridevirtual

Put data to the Clipboard

Parameters

buffer	The buffer to copy to the clipboard.
selection	The clipboard to copy too only used on X11.

Implements GHOST_System.

Definition at line 7915 of file GHOST_SystemWayland.cc.

References selection, server_mutex, system_clipboard_put(), and system_clipboard_put_primary_selection().

◆ putClipboardImage()

GHOST_TSuccess GHOST_SystemWayland::putClipboardImage	(	uint *	rgba,
		int	width,
		int	height ) const

overridevirtual

Put image data to the Clipboard

Parameters

rgba	uint array in RGBA byte order.
width	the image width in pixels.
height	the image height in pixels.

Reimplemented from GHOST_System.

Definition at line 8029 of file GHOST_SystemWayland.cc.

References GWL_DataSource::buffer_out, data, GWL_SimpleBuffer::data, ImBufByteBuffer::data, GWL_Seat::data_device, GWL_SimpleBuffer::data_size, GWL_Seat::data_source, data_source_listener, GWL_Seat::data_source_mutex, GWL_Seat::data_source_serial, ImBuf::encoded_buffer, ImBuf::encoded_buffer_size, ImBuf::foptions, ImBuf::ftype, GHOST_kFailure, GHOST_kSuccess, ghost_wl_mime_img_png, gwl_display_seat_active_get(), gwl_simple_buffer_free_data(), IB_mem, IB_rect, IMB_allocFromBuffer(), IMB_freeImBuf(), IMB_FTYPE_PNG, IMB_saveiff(), lock, ImbFormatOptions::quality, server_mutex, GWL_DataSource::source, UNLIKELY, GWL_DataSource::wl, and GWL_Seat::wl.

◆ seat_active_set()

void GHOST_SystemWayland::seat_active_set ( const struct GWL_Seat * seat )

Set this seat to be active.

Definition at line 9121 of file GHOST_SystemWayland.cc.

References gwl_display_seat_active_set().

Referenced by data_device_handle_enter(), keyboard_handle_enter(), pointer_handle_enter(), and tablet_tool_handle_proximity_in().

◆ setConsoleWindowState()

bool GHOST_SystemWayland::setConsoleWindowState ( GHOST_TConsoleWindowState action )

overridevirtual

Set the Console State

Parameters

action console state

Returns: current status (true: visible, 0: hidden)

Implements GHOST_ISystem.

Definition at line 7605 of file GHOST_SystemWayland.cc.

◆ setCursorPosition()

GHOST_TSuccess GHOST_SystemWayland::setCursorPosition	(	int32_t	x,
		int32_t	y )

overridevirtual

Updates the location of the cursor (location in screen coordinates). Not all operating systems allow the cursor to be moved (without the input device being moved).

Parameters

x	The x-coordinate of the cursor.
y	The y-coordinate of the cursor.

Returns: Indication of success.

Implements GHOST_ISystem.

Definition at line 8213 of file GHOST_SystemWayland.cc.

References GHOST_kFailure, ghost_wl_surface_user_data(), gwl_display_seat_active_get(), GWL_Seat::pointer, server_mutex, setCursorPositionClientRelative_impl(), UNLIKELY, wl_surface, x, and y.

◆ setCursorPositionClientRelative()

GHOST_TSuccess GHOST_SystemWayland::setCursorPositionClientRelative	(	GHOST_IWindow *	window,
		int32_t	x,
		int32_t	y )

overridevirtual

Updates the location of the cursor (location in window coordinates).

Parameters

x	The x-coordinate of the cursor.
y	The y-coordinate of the cursor.

Returns: Indication of success.

Reimplemented from GHOST_System.

Definition at line 8175 of file GHOST_SystemWayland.cc.

References GHOST_kFailure, gwl_display_seat_active_get(), server_mutex, setCursorPositionClientRelative_impl(), UNLIKELY, x, and y.

◆ setMultitouchGestures()

void GHOST_SystemWayland::setMultitouchGestures ( const bool use )

overridevirtual

Enable multi-touch gestures if supported.

Parameters

use	Enable or disable.

Reimplemented from GHOST_System.

Definition at line 8724 of file GHOST_SystemWayland.cc.

References gwl_seat_capability_pointer_multitouch_check(), gwl_seat_capability_pointer_multitouch_disable(), gwl_seat_capability_pointer_multitouch_enable(), GHOST_System::m_multitouchGestures, and server_mutex.

◆ window_cursor_grab_set()

bool GHOST_SystemWayland::window_cursor_grab_set	(	const GHOST_TGrabCursorMode	mode,
		const GHOST_TGrabCursorMode	mode_current,
		int32_t	init_grab_xy[2],
		const GHOST_Rect *	wrap_bounds,
		GHOST_TAxisFlag	wrap_axis,
		wl_surface *	wl_surface,
		const struct GWL_WindowScaleParams &	scale_params )

Definition at line 9227 of file GHOST_SystemWayland.cc.

References GWL_Seat::confined_pointer, cursor_is_software(), CURSOR_VISIBLE_ONLY_HIDE, CURSOR_VISIBLE_ONLY_SHOW, ELEM, getMilliSeconds(), GHOST_kEventCursorMove, GHOST_kGrabDisable, GHOST_kGrabHide, GHOST_kGrabNormal, GHOST_kGrabWrap, GHOST_TABLET_DATA_NONE, ghost_wl_surface_user_data(), GWL_Seat::grab_lock_xy, gwl_display_seat_active_get(), gwl_seat_cursor_visible_set(), gwl_window_scale_wl_fixed_from(), gwl_window_scale_wl_fixed_to(), GWL_Seat::locked_pointer, GHOST_Rect::m_b, GHOST_Rect::m_l, GHOST_Rect::m_r, GHOST_Rect::m_t, GWL_Seat::pointer, pushEvent_maybe_pending(), GWL_Seat::relative_pointer, relative_pointer_listener, seat_grab_state_from_mode(), setCursorGrab_use_software_confine(), GWL_Seat::system, UNLIKELY, UNPACK2, GWL_SeatStateGrab::use_confine, GWL_SeatStateGrab::use_lock, GWL_Seat::use_pointer_software_confine, GWL_Seat::wl, wl_surface, GWL_Seat::wp, and GHOST_Rect::wrapPoint().

◆ window_surface_unref()

bool GHOST_SystemWayland::window_surface_unref ( const wl_surface * wl_surface )

Clear all references to this surface to prevent accessing nullptr pointers.

Returns: true when any references were removed.

Definition at line 9137 of file GHOST_SystemWayland.cc.

References GWL_Seat::keyboard, GWL_Seat::pointer, SURFACE_CLEAR_PTR, GWL_SeatStatePointer::surface_window, GWL_Seat::surface_window_focus_dnd, GWL_Seat::tablet, GWL_Seat::wl, GWL_SeatStatePointer::wl, and wl_surface.

◆ wl_compositor_get()

wl_compositor * GHOST_SystemWayland::wl_compositor_get ( )

Definition at line 8826 of file GHOST_SystemWayland.cc.

Referenced by createOffscreenContext(), gwl_seat_capability_pointer_enable(), and tablet_seat_handle_tool_added().

◆ wl_display_get()

wl_display * GHOST_SystemWayland::wl_display_get ( )

Definition at line 8821 of file GHOST_SystemWayland.cc.

References wl_display.

Referenced by data_device_handle_drop(), GHOST_WindowWayland::GHOST_WindowWayland(), and gwl_seat_cursor_anim_begin().

◆ wl_seat_active_get_with_input_serial()

wl_seat * GHOST_SystemWayland::wl_seat_active_get_with_input_serial ( uint32_t & serial )

Definition at line 9126 of file GHOST_SystemWayland.cc.

References GWL_Seat::data_source_serial, gwl_display_seat_active_get(), GWL_Seat::seat, UNLIKELY, and GWL_Seat::wl.

Referenced by gwl_window_activate().

◆ wl_shm_get()

wl_shm * GHOST_SystemWayland::wl_shm_get ( ) const

Definition at line 8901 of file GHOST_SystemWayland.cc.

Referenced by cursor_surface_handle_enter(), cursor_surface_handle_leave(), gwl_seat_cursor_find_from_shape(), and output_scale_update().

◆ wp_fractional_scale_manager_get()

wp_fractional_scale_manager_v1 * GHOST_SystemWayland::wp_fractional_scale_manager_get ( )

Definition at line 8841 of file GHOST_SystemWayland.cc.

Referenced by GHOST_WindowWayland::GHOST_WindowWayland().

◆ wp_pointer_gestures_get()

zwp_pointer_gestures_v1 * GHOST_SystemWayland::wp_pointer_gestures_get ( )

Definition at line 8850 of file GHOST_SystemWayland.cc.

Referenced by gwl_seat_capability_pointer_multitouch_check(), gwl_seat_capability_pointer_multitouch_disable(), and gwl_seat_capability_pointer_multitouch_enable().

◆ wp_primary_selection_manager_get()

zwp_primary_selection_device_manager_v1 * GHOST_SystemWayland::wp_primary_selection_manager_get ( )

Definition at line 8831 of file GHOST_SystemWayland.cc.

◆ wp_viewporter_get()

wp_viewporter * GHOST_SystemWayland::wp_viewporter_get ( )

Definition at line 8845 of file GHOST_SystemWayland.cc.

Referenced by gwl_window_viewport_set().

◆ xdg_activation_manager_get()

xdg_activation_v1 * GHOST_SystemWayland::xdg_activation_manager_get ( )

Definition at line 8836 of file GHOST_SystemWayland.cc.

Referenced by gwl_window_activate(), and xdg_activation_handle_done().

◆ xdg_app_id_get()

const char * GHOST_SystemWayland::xdg_app_id_get ( )

static

Definition at line 8870 of file GHOST_SystemWayland.cc.

References ghost_wl_app_id.

Referenced by GHOST_WindowWayland::GHOST_WindowWayland(), and gwl_window_activate().

◆ xdg_decor_manager_get()

zxdg_decoration_manager_v1 * GHOST_SystemWayland::xdg_decor_manager_get ( )

Definition at line 8889 of file GHOST_SystemWayland.cc.

◆ xdg_decor_shell_get()

xdg_wm_base * GHOST_SystemWayland::xdg_decor_shell_get ( )

Definition at line 8884 of file GHOST_SystemWayland.cc.

References GWL_XDG_Decor_System::shell, and GWL_Display::xdg_decor.

Member Data Documentation

◆ has_pending_actions_for_window

std::atomic<bool> GHOST_SystemWayland::has_pending_actions_for_window = false

Definition at line 354 of file GHOST_SystemWayland.hh.

Referenced by gwl_window_pending_actions_tag(), and processEvents().

◆ main_thread_id

std::thread::id GHOST_SystemWayland::main_thread_id

Definition at line 352 of file GHOST_SystemWayland.hh.

Referenced by GHOST_SystemWayland(), gwl_window_cursor_shape_refresh(), gwl_window_frame_update_from_pending_no_lock(), GHOST_WindowWayland::pending_actions_handle(), pushEvent_maybe_pending(), and xdg_surface_handle_configure().

◆ server_mutex

std::mutex* GHOST_SystemWayland::server_mutex = nullptr

Lock to prevent wl_display_dispatch / wl_display_roundtrip / wl_display_flush from running at the same time.

Definition at line 340 of file GHOST_SystemWayland.hh.

Referenced by createOffscreenContext(), disposeContext(), getAllDisplayDimensions(), getButtons(), getClipboard(), getClipboardImage(), getCursorPosition(), getCursorPositionClientRelative(), getMainDisplayDimensions(), getModifierKeys(), getNumDisplays(), GHOST_SystemWayland(), GHOST_WindowWayland::GHOST_WindowWayland(), gwl_display_destroy(), gwl_display_event_thread_fn(), gwl_seat_cursor_anim_begin(), hasClipboardImage(), processEvents(), putClipboard(), putClipboardImage(), setCursorPosition(), setCursorPositionClientRelative(), and setMultitouchGestures().

◆ timer_mutex

std::mutex* GHOST_SystemWayland::timer_mutex = nullptr

Threads must lock this before manipulating GWL_Display::ghost_timer_manager.

Note: Using a separate lock to server_mutex is necessary because the server lock is already held when calling ghost_wl_display_event_pump. If manipulating the timer used the server_mutex, event pump can indirectly handle key up/down events which would lock server_mutex causing a dead-lock.

Definition at line 350 of file GHOST_SystemWayland.hh.

Referenced by GHOST_SystemWayland(), gwl_seat_capability_keyboard_disable(), keyboard_handle_enter(), keyboard_handle_key(), keyboard_handle_leave(), keyboard_handle_modifiers(), and keyboard_handle_repeat_info().

The documentation for this class was generated from the following files:

Public Member Functions

Public Attributes

GHOST Implementation

Public WAYLAND Direct Data Access

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ GHOST_SystemWayland() [1/2]

◆ GHOST_SystemWayland() [2/2]

◆ ~GHOST_SystemWayland()

Member Function Documentation

◆ createOffscreenContext()

◆ createWindow()

◆ cursor_bitmap_get()

◆ cursor_grab_use_software_display_get()

◆ cursor_shape_check()

◆ cursor_shape_custom_set()

◆ cursor_shape_set()

◆ cursor_visibility_set()

◆ disposeContext()

◆ getAllDisplayDimensions()

◆ getButtons()

◆ getCapabilities()

◆ getClipboard()

◆ getClipboardImage()

◆ getCursorPosition()

◆ getCursorPositionClientRelative()

◆ getMainDisplayDimensions()

◆ getMilliSeconds()

◆ getModifierKeys()

◆ getNumDisplays()

◆ ghost_timer_manager()

◆ hasClipboardImage()

◆ ime_begin()

◆ ime_end()

◆ init()

◆ ms_from_input_time()

◆ output_scale_update()

◆ output_unref()

◆ outputs_get()

◆ processEvents()

◆ pushEvent_maybe_pending()

◆ putClipboard()

◆ putClipboardImage()

◆ seat_active_set()

◆ setConsoleWindowState()

◆ setCursorPosition()

◆ setCursorPositionClientRelative()

◆ setMultitouchGestures()

◆ window_cursor_grab_set()

◆ window_surface_unref()

◆ wl_compositor_get()

◆ wl_display_get()

◆ wl_seat_active_get_with_input_serial()

◆ wl_shm_get()

◆ wp_fractional_scale_manager_get()

◆ wp_pointer_gestures_get()

◆ wp_primary_selection_manager_get()

◆ wp_viewporter_get()

◆ xdg_activation_manager_get()

◆ xdg_app_id_get()

◆ xdg_decor_manager_get()

◆ xdg_decor_shell_get()

Member Data Documentation

◆ has_pending_actions_for_window

◆ main_thread_id

◆ server_mutex

◆ timer_mutex