#include <GHOST_SystemX11.hh>

Inherits GHOST_System.

Classes
struct	[struct].m_atom

Public Member Functions
	GHOST_SystemX11 ()
	~GHOST_SystemX11 () override
GHOST_TSuccess	init () override
uint64_t	getMilliSeconds () const override
uint8_t	getNumDisplays () const override
void	getMainDisplayDimensions (uint32_t &width, uint32_t &height) const override
void	getAllDisplayDimensions (uint32_t &width, uint32_t &height) const 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=false, const bool is_dialog=false, const GHOST_IWindow parentWindow=nullptr) override
GHOST_IContext *	createOffscreenContext (GHOST_GPUSettings gpuSettings) override
GHOST_TSuccess	disposeContext (GHOST_IContext *context) override
bool	processEvents (bool waitForEvent) override
GHOST_TSuccess	getCursorPosition (int32_t &x, int32_t &y) const override
GHOST_TSuccess	setCursorPosition (int32_t x, int32_t y) override
GHOST_TSuccess	getPixelAtCursor (float r_color[3]) const override
GHOST_TSuccess	getModifierKeys (GHOST_ModifierKeys &keys) const override
GHOST_TSuccess	getButtons (GHOST_Buttons &buttons) const override
GHOST_TCapabilityFlag	getCapabilities () const override
void	addDirtyWindow (GHOST_WindowX11 *bad_wind)
Display *	getXDisplay ()
uint64_t	ms_from_input_time (const Time timestamp) const
void	getClipboard_xcout (const XEvent evt, Atom sel, Atom target, unsigned char txt, unsigned long len, unsigned int *context) const
char *	getClipboard (bool selection) const override
void	putClipboard (const char *buffer, bool selection) const override
bool	setConsoleWindowState (GHOST_TConsoleWindowState) override
Message Box
GHOST_TSuccess	showMessageBox (const char title, const char message, const char help_label, const char continue_label, const char *link, GHOST_DialogOptions dialog_options) const override
Public Member Functions inherited from GHOST_System
GHOST_ITimerTask *	installTimer (uint64_t delay, uint64_t interval, GHOST_TimerProcPtr timerProc, GHOST_TUserDataPtr userData=nullptr) override
GHOST_TSuccess	removeTimer (GHOST_ITimerTask *timerTask) override
GHOST_TSuccess	disposeWindow (GHOST_IWindow *window) override
bool	validWindow (GHOST_IWindow *window) override
bool	useNativePixel () override
void	useWindowFocus (const bool use_focus) override
void	setAutoFocus (const bool auto_focus) override
GHOST_IWindow *	getWindowUnderCursor (int32_t x, int32_t y) override
void	dispatchEvents () override
GHOST_TSuccess	addEventConsumer (GHOST_IEventConsumer *consumer) override
GHOST_TSuccess	removeEventConsumer (GHOST_IEventConsumer *consumer) 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
uint32_t	getCursorPreferredLogicalSize () const override
GHOST_TSuccess	getModifierKeyState (GHOST_TModifierKey mask, bool &isDown) const override
GHOST_TSuccess	getButtonState (GHOST_TButton mask, bool &isDown) const override
void	setMultitouchGestures (const bool use) override
void	setTabletAPI (GHOST_TTabletAPI api) override
GHOST_TTabletAPI	getTabletAPI ()
GHOST_TSuccess	pushEvent (const GHOST_IEvent *event)
GHOST_TimerManager *	getTimerManager () const
GHOST_EventManager *	getEventManager () const
GHOST_WindowManager *	getWindowManager () const
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
void	initDebug (GHOST_Debug debug) override
bool	isDebugEnabled () override

Public Attributes
struct	m_atom
Public Attributes inherited from GHOST_System
bool	m_nativePixel
bool	m_windowFocus
bool	m_autoFocus

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 ()
	~GHOST_System () override
GHOST_TSuccess	exit () override
Protected Member Functions inherited from GHOST_ISystem
	GHOST_ISystem ()
virtual	~GHOST_ISystem ()=default
Protected Attributes inherited from GHOST_System
GHOST_TimerManager *	m_timerManager
GHOST_WindowManager *	m_windowManager
GHOST_EventManager *	m_eventManager
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

X11 Implementation of GHOST_System class.

See also: GHOST_System.

Definition at line 60 of file GHOST_SystemX11.hh.

Constructor & Destructor Documentation

◆ GHOST_SystemX11()

GHOST_SystemX11::GHOST_SystemX11 ( )

Constructor this class should only be instantiated by GHOST_ISystem.

Definition at line 105 of file GHOST_SystemX11.cc.

References GHOST_INTERN_ATOM, GHOST_INTERN_ATOM_IF_EXISTS, GHOST_System::GHOST_System(), GHOST_X11_ApplicationErrorHandler(), GHOST_X11_ApplicationIOErrorHandler(), m_atom, and nullptr.

Referenced by GHOST_ISystem::createSystem().

◆ ~GHOST_SystemX11()

GHOST_SystemX11::~GHOST_SystemX11 ( )

override

Destructor.

Definition at line 226 of file GHOST_SystemX11.cc.

Member Function Documentation

◆ addDirtyWindow()

void GHOST_SystemX11::addDirtyWindow ( GHOST_WindowX11 * bad_wind )

Flag a window as dirty. This will generate a GHOST window update event on a call to processEvents()

Definition at line 1832 of file GHOST_SystemX11.cc.

References GHOST_ASSERT.

◆ createOffscreenContext()

GHOST_IContext * GHOST_SystemX11::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 404 of file GHOST_SystemX11.cc.

References GHOST_GPUSettings::context_type, GHOST_GPUSettings::flags, GHOST_ContextGLX::GHOST_ContextGLX(), GHOST_ContextVK::GHOST_ContextVK(), GHOST_gpuDebugContext, GHOST_OPENGL_GLX_CONTEXT_FLAGS, GHOST_OPENGL_GLX_RESET_NOTIFICATION_STRATEGY, and GHOST_GPUSettings::preferred_device.

◆ createWindow()

GHOST_IWindow * GHOST_SystemX11::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 = false,
		const bool	is_dialog = false,
		const GHOST_IWindow *	parentWindow = nullptr )

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.
stereoVisual	Create a stereo visual for quad buffered stereo.
exclusive	Use to show the window on top and ignore others (used full-screen).
parentWindow	Parent (embedder) window.

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

Implements GHOST_ISystem.

Definition at line 353 of file GHOST_SystemX11.cc.

References GHOST_WindowManager::addWindow(), GHOST_GPUSettings::context_type, GHOST_GPUSettings::flags, getMilliSeconds(), GHOST_WindowX11::getValid(), GHOST_Event::GHOST_Event(), GHOST_gpuDebugContext, GHOST_gpuStereoVisual, GHOST_kEventWindowSize, GHOST_WindowX11::GHOST_WindowX11(), GHOST_System::m_windowManager, GHOST_GPUSettings::preferred_device, GHOST_System::pushEvent(), GHOST_WindowManager::setActiveWindow(), and state.

◆ disposeContext()

GHOST_TSuccess GHOST_SystemX11::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 457 of file GHOST_SystemX11.cc.

References GHOST_kSuccess.

◆ getAllDisplayDimensions()

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

overridevirtual

Returns the dimensions of all displays on this system.

Returns: The dimension of the main display.

Implements GHOST_ISystem.

Definition at line 345 of file GHOST_SystemX11.cc.

Referenced by getMainDisplayDimensions().

◆ getButtons()

GHOST_TSuccess GHOST_SystemX11::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 1699 of file GHOST_SystemX11.cc.

References GHOST_kButtonMaskButton4, GHOST_kButtonMaskButton5, GHOST_kButtonMaskLeft, GHOST_kButtonMaskMiddle, GHOST_kButtonMaskRight, GHOST_kFailure, GHOST_kSuccess, and GHOST_Buttons::set().

◆ getCapabilities()

GHOST_TCapabilityFlag GHOST_SystemX11::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 1820 of file GHOST_SystemX11.cc.

References GHOST_CAPABILITY_FLAG_ALL, GHOST_kCapabilityClipboardImages, GHOST_kCapabilityInputIME, and GHOST_kCapabilityWindowDecorationStyles.

◆ getClipboard()

char * GHOST_SystemX11::getClipboard ( bool selection ) const

overridevirtual

Returns unsigned char from CUT_BUFFER0

Parameters

selection Get selection, X11 only feature.

Returns: Returns the Clipboard indicated by Flag.

Implements GHOST_System.

Definition at line 2243 of file GHOST_SystemX11.cc.

References free(), getClipboard_xcout(), GHOST_WindowManager::getWindows(), GHOST_WindowX11::getXWindow(), m_atom, GHOST_System::m_windowManager, txt_cut_buffer, txt_select_buffer, XCLIB_XCOUT_FALLBACK, XCLIB_XCOUT_FALLBACK_COMP, XCLIB_XCOUT_FALLBACK_TEXT, XCLIB_XCOUT_FALLBACK_UTF8, and XCLIB_XCOUT_NONE.

◆ getClipboard_xcout()

void GHOST_SystemX11::getClipboard_xcout	(	const XEvent *	evt,
		Atom	sel,
		Atom	target,
		unsigned char **	txt,
		unsigned long *	len,
		unsigned int *	context ) const

Helped function for get data from the clipboard.

Definition at line 2043 of file GHOST_SystemX11.cc.

References free(), GHOST_WindowManager::getWindows(), GHOST_WindowX11::getXWindow(), len(), m_atom, GHOST_System::m_windowManager, XCLIB_XCOUT_FALLBACK_COMP, XCLIB_XCOUT_FALLBACK_TEXT, XCLIB_XCOUT_FALLBACK_UTF8, XCLIB_XCOUT_INCR, XCLIB_XCOUT_NONE, and XCLIB_XCOUT_SENTCONVSEL.

Referenced by getClipboard().

◆ getCursorPosition()

GHOST_TSuccess GHOST_SystemX11::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 1756 of file GHOST_SystemX11.cc.

References getCursorPosition_impl(), x, and y.

Referenced by getPixelAtCursor(), and setCursorPosition().

◆ getMainDisplayDimensions()

void GHOST_SystemX11::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 335 of file GHOST_SystemX11.cc.

References getAllDisplayDimensions().

◆ getMilliSeconds()

uint64_t GHOST_SystemX11::getMilliSeconds ( ) const

overridevirtual

Inherited from GHOST_ISystem

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

Returns: The number of milliseconds.

Implements GHOST_ISystem.

Definition at line 260 of file GHOST_SystemX11.cc.

References GHOST_ASSERT.

Referenced by createWindow(), ms_from_input_time(), and processEvents().

◆ getModifierKeys()

GHOST_TSuccess GHOST_SystemX11::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 1650 of file GHOST_SystemX11.cc.

References GHOST_kModifierKeyLeftAlt, GHOST_kModifierKeyLeftControl, GHOST_kModifierKeyLeftHyper, GHOST_kModifierKeyLeftOS, GHOST_kModifierKeyLeftShift, GHOST_kModifierKeyRightAlt, GHOST_kModifierKeyRightControl, GHOST_kModifierKeyRightHyper, GHOST_kModifierKeyRightOS, GHOST_kModifierKeyRightShift, GHOST_kSuccess, and GHOST_ModifierKeys::set().

◆ getNumDisplays()

uint8_t GHOST_SystemX11::getNumDisplays ( ) const

overridevirtual

Returns the number of displays on this system.

Returns: The number of displays.

Implements GHOST_ISystem.

Definition at line 330 of file GHOST_SystemX11.cc.

◆ getPixelAtCursor()

GHOST_TSuccess GHOST_SystemX11::getPixelAtCursor ( float r_color[3] ) const

overridevirtual

Get the color of the pixel at the current mouse cursor location

Parameters

r_color returned sRGB float colors

Returns: Success value (true == successful and supported by platform)

Reimplemented from GHOST_System.

Definition at line 1611 of file GHOST_SystemX11.cc.

References getCursorPosition(), GHOST_kFailure, GHOST_kSuccess, x, and y.

◆ getXDisplay()

Display * GHOST_SystemX11::getXDisplay ( )

inline

return a pointer to the X11 display structure

Definition at line 191 of file GHOST_SystemX11.hh.

References Display.

◆ init()

GHOST_TSuccess GHOST_SystemX11::init ( )

overridevirtual

Initialize the system.

Returns: Indication of success.

Reimplemented from GHOST_System.

Definition at line 246 of file GHOST_SystemX11.cc.

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

◆ ms_from_input_time()

uint64_t GHOST_SystemX11::ms_from_input_time ( const Time timestamp ) const

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

Definition at line 271 of file GHOST_SystemX11.cc.

References getMilliSeconds(), UINT32_MAX, and UNLIKELY.

Referenced by processEvents().

◆ processEvents()

bool GHOST_SystemX11::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 590 of file GHOST_SystemX11.cc.

References ARRAY_SIZE, ELEM, GHOST_TimerManager::fireTimers(), getMilliSeconds(), GHOST_System::getTimerManager(), GHOST_EventKey::GHOST_EventKey(), GHOST_kEventKeyDown, ghost_key_from_keysym(), GHOST_kFireTimeNever, GHOST_PRINT, i, ms_from_input_time(), GHOST_TimerManager::nextFireTime(), processEvents(), GHOST_System::pushEvent(), and SleepTillEvent().

Referenced by processEvents().

◆ putClipboard()

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

overridevirtual

Puts buffer to system clipboard

Parameters

buffer	The buffer to copy to the clipboard.
selection	Set the selection into the clipboard, X11 only feature.

Implements GHOST_System.

Definition at line 2355 of file GHOST_SystemX11.cc.

References free(), GHOST_WindowManager::getWindows(), GHOST_WindowX11::getXWindow(), m_atom, GHOST_System::m_windowManager, txt_cut_buffer, and txt_select_buffer.

◆ setConsoleWindowState()

bool GHOST_SystemX11::setConsoleWindowState ( GHOST_TConsoleWindowState )

inlineoverridevirtual

See also: GHOST_ISystem

Implements GHOST_ISystem.

Definition at line 270 of file GHOST_SystemX11.hh.

◆ setCursorPosition()

GHOST_TSuccess GHOST_SystemX11::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 1762 of file GHOST_SystemX11.cc.

References getCursorPosition(), getCursorPosition_impl(), GHOST_kFailure, GHOST_kSuccess, x, and y.

◆ showMessageBox()

GHOST_TSuccess GHOST_SystemX11::showMessageBox	(	const char *	title,
		const char *	message,
		const char *	help_label,
		const char *	continue_label,
		const char *	link,
		GHOST_DialogOptions	dialog_options ) const

overridevirtual

Show a system message box

Parameters

title	The title of the message box.
message	The message to display.
help_label	Help button label.
continue_label	Continue button label.
link	An optional hyperlink.
dialog_options	Options how to display the message.

Reimplemented from GHOST_System.

Definition at line 2500 of file GHOST_SystemX11.cc.

References DialogData::drawButton(), e, free(), GHOST_kSuccess, GHOST_PRINTF, DialogData::height, i, DialogData::isInsideButton(), DialogData::line_height, DialogData::padding_x, split(), and DialogData::width.

Referenced by GHOST_WindowX11::GHOST_WindowX11().

Member Data Documentation

◆ m_atom

struct GHOST_SystemX11::[struct].m_atom GHOST_SystemX11::m_atom

Referenced by getClipboard(), getClipboard_xcout(), GHOST_SystemX11(), and putClipboard().

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

Classes

Public Member Functions

Public Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ GHOST_SystemX11()

◆ ~GHOST_SystemX11()

Member Function Documentation

◆ addDirtyWindow()

◆ createOffscreenContext()

◆ createWindow()

◆ disposeContext()

◆ getAllDisplayDimensions()

◆ getButtons()

◆ getCapabilities()

◆ getClipboard()

◆ getClipboard_xcout()

◆ getCursorPosition()

◆ getMainDisplayDimensions()

◆ getMilliSeconds()

Inherited from GHOST_ISystem

◆ getModifierKeys()

◆ getNumDisplays()

◆ getPixelAtCursor()

◆ getXDisplay()

◆ init()

◆ ms_from_input_time()

◆ processEvents()

◆ putClipboard()

◆ setConsoleWindowState()

◆ setCursorPosition()

◆ showMessageBox()

Member Data Documentation

◆ m_atom