#include <GHOST_System.hh>

Inherits GHOST_ISystem.

Inherited by GHOST_SystemCocoa, GHOST_SystemHeadless, GHOST_SystemSDL, GHOST_SystemWayland, GHOST_SystemWin32, and GHOST_SystemX11.

Public Member Functions
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)

virtual GHOST_IContext *	createOffscreenContext (GHOST_GPUSettings gpuSettings)=0

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	getCursorPositionClientRelative (const GHOST_IWindow *window, int32_t &x, int32_t &y) const

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

GHOST_TSuccess	getModifierKeyState (GHOST_TModifierKey mask, bool &isDown) const

GHOST_TSuccess	getButtonState (GHOST_TButton mask, bool &isDown) const

void	setMultitouchGestures (const bool use)

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	getModifierKeys (GHOST_ModifierKeys &keys) const =0

virtual GHOST_TSuccess	getButtons (GHOST_Buttons &buttons) const =0

virtual char *	getClipboard (bool selection) const =0

virtual void	putClipboard (const char *buffer, bool selection) const =0

GHOST_TSuccess	hasClipboardImage () const

uint *	getClipboardImage (int r_width, int r_height) const

GHOST_TSuccess	putClipboardImage (uint *rgba, int width, int height) 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 Member Functions inherited from GHOST_ISystem
virtual uint64_t	getMilliSeconds () const =0

virtual uint8_t	getNumDisplays () const =0

virtual void	getMainDisplayDimensions (uint32_t &width, uint32_t &height) const =0

virtual void	getAllDisplayDimensions (uint32_t &width, uint32_t &height) const =0

virtual 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)=0

virtual GHOST_TSuccess	disposeContext (GHOST_IContext *context)=0

virtual GHOST_TCapabilityFlag	getCapabilities () const =0

virtual bool	processEvents (bool waitForEvent)=0

virtual GHOST_TSuccess	getCursorPosition (int32_t &x, int32_t &y) const =0

virtual GHOST_TSuccess	setCursorPosition (int32_t x, int32_t y)=0

virtual bool	setConsoleWindowState (GHOST_TConsoleWindowState action)=0

Public Attributes
bool	m_nativePixel

bool	m_windowFocus

bool	m_autoFocus

Protected Member Functions
	GHOST_System ()

virtual	~GHOST_System ()

virtual GHOST_TSuccess	init ()

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
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

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)

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

Implementation of platform independent functionality of the GHOST_ISystem interface. GHOST_System is an abstract class because not all methods of GHOST_ISystem are implemented.

See also: GHOST_ISystem.

Definition at line 38 of file GHOST_System.hh.

Constructor & Destructor Documentation

◆ GHOST_System()

GHOST_System::GHOST_System ( )

protected

Constructor. Protected default constructor to force use of static createSystem member.

Definition at line 24 of file GHOST_System.cc.

◆ ~GHOST_System()

GHOST_System::~GHOST_System ( )

protectedvirtual

Destructor. Protected default constructor to force use of static dispose member.

Definition at line 42 of file GHOST_System.cc.

References exit().

Member Function Documentation

◆ addEventConsumer()

GHOST_TSuccess GHOST_System::addEventConsumer ( GHOST_IEventConsumer * consumer )

virtual

Adds the given event consumer to our list.

Parameters

consumer The event consumer to add.

Returns: Indication of success.

Implements GHOST_ISystem.

Definition at line 248 of file GHOST_System.cc.

References GHOST_EventManager::addConsumer(), GHOST_kFailure, and m_eventManager.

◆ beginFullScreen()

GHOST_TSuccess GHOST_System::beginFullScreen	(	const GHOST_DisplaySetting &	setting,
		GHOST_IWindow **	window,
		const bool	stereoVisual )

virtual

Begins full screen mode.

Parameters

setting	The new setting of the display.
window	Window displayed in full screen.
stereoVisual	Stereo visual for quad buffered stereo. This window is invalid after full screen has been ended.

Returns: Indication of success.

Implements GHOST_ISystem.

Definition at line 125 of file GHOST_System.cc.

References GHOST_WindowManager::beginFullScreen(), createFullScreenWindow(), GHOST_DisplayManager::getCurrentDisplaySetting(), GHOST_WindowManager::getFullScreen(), GHOST_ASSERT, GHOST_kFailure, GHOST_kSuccess, GHOST_PRINT, GHOST_DisplayManager::kMainDisplay, m_displayManager, m_preFullScreenSetting, m_windowManager, and GHOST_DisplayManager::setCurrentDisplaySetting().

◆ createFullScreenWindow()

GHOST_TSuccess GHOST_System::createFullScreenWindow	(	GHOST_Window **	window,
		const GHOST_DisplaySetting &	settings,
		const bool	stereoVisual )

protected

Creates a full-screen window.

Parameters

window The window created.

Returns: Indication of success.

Definition at line 405 of file GHOST_System.cc.

References GHOST_GPUSettings::context_type, GHOST_ISystem::createWindow(), GHOST_GPUSettings::flags, GHOST_ASSERT, GHOST_gpuStereoVisual, GHOST_kFailure, GHOST_kSuccess, GHOST_kWindowStateNormal, and m_displayManager.

Referenced by beginFullScreen().

◆ createOffscreenContext()

virtual GHOST_IContext * GHOST_System::createOffscreenContext ( GHOST_GPUSettings gpuSettings )

pure virtual

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_ISystem.

Implemented in GHOST_SystemCocoa, GHOST_SystemHeadless, GHOST_SystemSDL, GHOST_SystemWayland, GHOST_SystemWin32, and GHOST_SystemX11.

◆ dispatchEvents()

void GHOST_System::dispatchEvents ( )

virtual

Inherited from GHOST_ISystem but left pure virtual

virtual bool processEvents(bool waitForEvent) = 0; Dispatches all the events on the stack. The event stack will be empty afterwards.

Implements GHOST_ISystem.

Definition at line 232 of file GHOST_System.cc.

References GHOST_EventManager::dispatchEvents(), GHOST_TimerManager::fireTimers(), GHOST_ISystem::getMilliSeconds(), m_eventManager, and m_timerManager.

Referenced by GHOST_SystemWin32::processWindowSizeEvent(), and GHOST_SystemWin32::s_wndProc().

◆ disposeWindow()

GHOST_TSuccess GHOST_System::disposeWindow ( GHOST_IWindow * window )

virtual

Dispose a window.

Parameters

window Pointer to the window to be disposed.

Returns: Indication of success.

Implements GHOST_ISystem.

Definition at line 93 of file GHOST_System.cc.

References endFullScreen(), GHOST_WindowManager::getFullScreenWindow(), GHOST_WindowManager::getWindowFound(), GHOST_kFailure, m_eventManager, m_windowManager, GHOST_WindowManager::removeWindow(), and GHOST_EventManager::removeWindowEvents().

◆ endFullScreen()

GHOST_TSuccess GHOST_System::endFullScreen ( )

virtual

Ends full screen mode.

Returns: Indication of success.

Implements GHOST_ISystem.

Definition at line 173 of file GHOST_System.cc.

References GHOST_WindowManager::endFullScreen(), GHOST_WindowManager::getFullScreen(), GHOST_ASSERT, GHOST_kFailure, GHOST_kSuccess, GHOST_DisplayManager::kMainDisplay, m_displayManager, m_preFullScreenSetting, m_windowManager, and GHOST_DisplayManager::setCurrentDisplaySetting().

Referenced by disposeWindow(), and exit().

◆ exit()

GHOST_TSuccess GHOST_System::exit ( )

protectedvirtual

Shut the system down.

Returns: Indication of success.

Implements GHOST_ISystem.

Reimplemented in GHOST_SystemWin32.

Definition at line 379 of file GHOST_System.cc.

References endFullScreen(), getFullScreen(), GHOST_kSuccess, m_displayManager, m_eventManager, m_timerManager, and m_windowManager.

Referenced by GHOST_SystemWin32::exit(), and ~GHOST_System().

◆ getButtons()

virtual GHOST_TSuccess GHOST_System::getButtons ( GHOST_Buttons & buttons ) const

pure virtual

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

Parameters

buttons The state of the buttons.

Returns: Indication of success.

Implemented in GHOST_SystemCocoa, GHOST_SystemHeadless, GHOST_SystemSDL, GHOST_SystemWayland, GHOST_SystemWin32, and GHOST_SystemX11.

Referenced by getButtonState().

◆ getButtonState()

GHOST_TSuccess GHOST_System::getButtonState	(	GHOST_TButton	mask,
		bool &	isDown ) const

virtual

Returns the state of a mouse button (outside the message queue).

Parameters

mask	The button state to retrieve.
isDown	Button state.

Returns: Indication of success.

Implements GHOST_ISystem.

Definition at line 319 of file GHOST_System.cc.

References GHOST_Buttons::get(), and getButtons().

◆ getClipboard()

virtual char * GHOST_System::getClipboard ( bool selection ) const

pure virtual

Returns the selection buffer

Parameters

selection Only used on X11.

Returns: Returns the clipboard data

Implements GHOST_ISystem.

Implemented in GHOST_SystemCocoa, GHOST_SystemHeadless, GHOST_SystemSDL, GHOST_SystemWayland, GHOST_SystemWin32, and GHOST_SystemX11.

◆ getClipboardImage()

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

virtual

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.

Implements GHOST_ISystem.

Reimplemented in GHOST_SystemCocoa, GHOST_SystemWayland, and GHOST_SystemWin32.

Definition at line 52 of file GHOST_System.cc.

◆ getCursorPositionClientRelative()

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

virtual

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.

Implements GHOST_ISystem.

Reimplemented in GHOST_SystemWayland.

Definition at line 284 of file GHOST_System.cc.

References GHOST_ISystem::getCursorPosition(), GHOST_kSuccess, and GHOST_IWindow::screenToClient().

◆ getEventManager()

GHOST_EventManager * GHOST_System::getEventManager ( ) const

inline

Returns: A pointer to our event manager.

Definition at line 448 of file GHOST_System.hh.

References m_eventManager.

Referenced by GHOST_SystemWayland::processEvents(), and GHOST_SystemWin32::s_wndProc().

◆ getFullScreen()

bool GHOST_System::getFullScreen ( )

virtual

Returns current full screen mode status.

Returns: The current status.

Implements GHOST_ISystem.

Definition at line 190 of file GHOST_System.cc.

References GHOST_WindowManager::getFullScreen(), and m_windowManager.

Referenced by exit().

◆ getModifierKeys()

virtual GHOST_TSuccess GHOST_System::getModifierKeys ( GHOST_ModifierKeys & keys ) const

pure virtual

Returns the state of all modifier keys.

Parameters

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

Returns: Indication of success.

Implemented in GHOST_SystemCocoa, GHOST_SystemHeadless, GHOST_SystemSDL, GHOST_SystemWayland, GHOST_SystemWin32, and GHOST_SystemX11.

Referenced by getModifierKeyState().

◆ getModifierKeyState()

GHOST_TSuccess GHOST_System::getModifierKeyState	(	GHOST_TModifierKey	mask,
		bool &	isDown ) const

virtual

Inherited from GHOST_ISystem but left pure virtual

GHOST_TSuccess getCursorPosition(int32_t& x, int32_t& y) const = 0;
GHOST_TSuccess setCursorPosition(int32_t x, int32_t y)

Returns the state of a modifier key (outside the message queue).

Parameters

mask	The modifier key state to retrieve.
isDown	The state of a modifier key (true == pressed).

Returns: Indication of success.

Implements GHOST_ISystem.

Definition at line 307 of file GHOST_System.cc.

References GHOST_ModifierKeys::get(), and getModifierKeys().

◆ getPixelAtCursor()

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

virtual

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)

Implements GHOST_ISystem.

Reimplemented in GHOST_SystemCocoa, GHOST_SystemWin32, and GHOST_SystemX11.

Definition at line 346 of file GHOST_System.cc.

References GHOST_kFailure.

◆ getTabletAPI()

GHOST_TTabletAPI GHOST_System::getTabletAPI ( )

Definition at line 341 of file GHOST_System.cc.

References m_tabletAPI.

Referenced by GHOST_WindowWin32::GHOST_WindowWin32(), and GHOST_WindowWin32::usingTabletAPI().

◆ getTimerManager()

GHOST_TimerManager * GHOST_System::getTimerManager ( ) const

inline

Returns: The timer manager.

Definition at line 443 of file GHOST_System.hh.

References m_timerManager.

Referenced by GHOST_SystemSDL::processEvents(), GHOST_SystemWayland::processEvents(), GHOST_SystemWin32::processEvents(), and GHOST_SystemX11::processEvents().

◆ getWindowManager()

GHOST_WindowManager * GHOST_System::getWindowManager ( ) const

inline

Returns: A pointer to our window manager.

Definition at line 453 of file GHOST_System.hh.

References m_windowManager.

Referenced by GHOST_WindowWayland::activate(), GHOST_WindowWayland::deactivate(), GHOST_SystemWin32::driveTrackpad(), gwl_window_activate(), gwl_window_frame_update_from_pending_no_lock(), GHOST_SystemWayland::output_scale_update(), GHOST_SystemWayland::output_unref(), GHOST_SystemWayland::processEvents(), GHOST_SystemWin32::processTrackpad(), GHOST_SystemWin32::processWindowEvent(), GHOST_NDOFManager::sendMotionEvent(), GHOST_DisplayManagerSDL::setCurrentDisplaySetting(), GHOST_SystemWin32::setTabletAPI(), GHOST_WindowWayland::setWindowCursorShape(), GHOST_WindowWayland::setWindowCustomCursorShape(), GHOST_NDOFManager::updateButton(), and GHOST_WindowWin32::~GHOST_WindowWin32().

◆ getWindowUnderCursor()

GHOST_IWindow * GHOST_System::getWindowUnderCursor	(	int32_t	x,
		int32_t	y )

virtual

Get the Window under the cursor.

Parameters

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

Returns: The window under the cursor or nullptr if none.

Implements GHOST_ISystem.

Reimplemented in GHOST_SystemCocoa, GHOST_SystemHeadless, and GHOST_SystemWin32.

Definition at line 202 of file GHOST_System.cc.

References bounds(), GHOST_IWindow::getClientBounds(), GHOST_IWindow::getState(), GHOST_WindowManager::getWindows(), GHOST_kWindowStateMinimized, and m_windowManager.

◆ hasClipboardImage()

GHOST_TSuccess GHOST_System::hasClipboardImage ( void ) const

virtual

Returns GHOST_kSuccess if the clipboard contains an image.

Implements GHOST_ISystem.

Reimplemented in GHOST_SystemCocoa, GHOST_SystemWayland, and GHOST_SystemWin32.

Definition at line 47 of file GHOST_System.cc.

References GHOST_kFailure.

◆ init()

GHOST_TSuccess GHOST_System::init ( )

protectedvirtual

Initialize the system.

Returns: Indication of success.

Implements GHOST_ISystem.

Reimplemented in GHOST_SystemCocoa, GHOST_SystemHeadless, GHOST_SystemWayland, GHOST_SystemWin32, and GHOST_SystemX11.

Definition at line 360 of file GHOST_System.cc.

References GHOST_EventManager::addConsumer(), GHOST_kFailure, GHOST_kSuccess, m_eventManager, m_timerManager, and m_windowManager.

Referenced by GHOST_SystemCocoa::init(), GHOST_SystemHeadless::init(), GHOST_SystemWayland::init(), GHOST_SystemWin32::init(), and GHOST_SystemX11::init().

◆ initDebug()

void GHOST_System::initDebug ( GHOST_Debug debug )

virtual

Specify whether debug messages are to be shown.

Parameters

debug Flag for systems to debug.

Implements GHOST_ISystem.

Reimplemented in GHOST_SystemWin32.

Definition at line 455 of file GHOST_System.cc.

References GHOST_Debug::flags, GHOST_kDebugDefault, and m_is_debug_enabled.

Referenced by GHOST_SystemWin32::initDebug().

◆ installTimer()

GHOST_ITimerTask * GHOST_System::installTimer	(	uint64_t	delay,
		uint64_t	interval,
		GHOST_TimerProcPtr	timerProc,
		GHOST_TUserDataPtr	userData = nullptr )

virtual

Installs a timer.

Note: On most operating systems, messages need to be processed in order for the timer callbacks to be invoked.

Parameters

delay	The time to wait for the first call to the #timerProc (in milliseconds).
interval	The interval between calls to the #timerProc.
timerProc	The callback invoked when the interval expires.
userData	Placeholder for user data.

Returns: A timer task (0 if timer task installation failed).

Implements GHOST_ISystem.

Definition at line 64 of file GHOST_System.cc.

References GHOST_TimerManager::addTimer(), GHOST_TimerManager::fireTimers(), GHOST_ISystem::getMilliSeconds(), GHOST_kSuccess, m_timerManager, and timer.

Referenced by gwl_seat_key_repeat_timer_add().

◆ isDebugEnabled()

bool GHOST_System::isDebugEnabled ( )

virtual

Check whether debug messages are to be shown.

Implements GHOST_ISystem.

Definition at line 460 of file GHOST_System.cc.

References m_is_debug_enabled.

◆ pushEvent()

GHOST_TSuccess GHOST_System::pushEvent ( const GHOST_IEvent * event )

Pushes an event on the stack. To dispatch it, call dispatchEvent() or dispatchEvents(). Do not delete the event!

Parameters

event The event to push on the stack.

Definition at line 272 of file GHOST_System.cc.

References GHOST_kFailure, m_eventManager, and GHOST_EventManager::pushEvent().

Referenced by gwl_window_frame_update_from_pending_no_lock(), GHOST_SystemWin32::processButtonEvent(), GHOST_SystemWin32::processPointerEvent(), GHOST_SystemWin32::processTrackpad(), GHOST_SystemWin32::processWheelEvent(), GHOST_SystemWin32::processWindowSizeEvent(), GHOST_SystemWin32::processWintabEvent(), GHOST_SystemWin32::pushDragDropEvent(), GHOST_SystemWin32::s_wndProc(), and GHOST_NDOFManager::sendMotionEvent().

◆ putClipboard()

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

pure virtual

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_ISystem.

Implemented in GHOST_SystemCocoa, GHOST_SystemHeadless, GHOST_SystemSDL, GHOST_SystemWayland, GHOST_SystemWin32, and GHOST_SystemX11.

◆ putClipboardImage()

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

virtual

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.

Implements GHOST_ISystem.

Reimplemented in GHOST_SystemCocoa, GHOST_SystemWayland, and GHOST_SystemWin32.

Definition at line 57 of file GHOST_System.cc.

References GHOST_kFailure.

◆ removeEventConsumer()

GHOST_TSuccess GHOST_System::removeEventConsumer ( GHOST_IEventConsumer * consumer )

virtual

Remove the given event consumer to our list.

Parameters

consumer The event consumer to remove.

Returns: Indication of success.

Implements GHOST_ISystem.

Definition at line 260 of file GHOST_System.cc.

References GHOST_kFailure, m_eventManager, and GHOST_EventManager::removeConsumer().

◆ removeTimer()

GHOST_TSuccess GHOST_System::removeTimer ( GHOST_ITimerTask * timerTask )

virtual

Removes a timer.

Parameters

timerTask Timer task to be removed.

Returns: Indication of success.

Implements GHOST_ISystem.

Definition at line 84 of file GHOST_System.cc.

References GHOST_kFailure, m_timerManager, and GHOST_TimerManager::removeTimer().

Referenced by gwl_seat_key_repeat_timer_remove().

◆ setAutoFocus()

void GHOST_System::setAutoFocus ( const bool auto_focus )

virtual

Focus and raise windows on mouse hover.

Implements GHOST_ISystem.

Definition at line 450 of file GHOST_System.cc.

References m_autoFocus.

◆ setCursorPositionClientRelative()

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

virtual

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.

Implements GHOST_ISystem.

Reimplemented in GHOST_SystemWayland.

Definition at line 297 of file GHOST_System.cc.

References GHOST_IWindow::clientToScreen(), and GHOST_ISystem::setCursorPosition().

◆ setMultitouchGestures()

void GHOST_System::setMultitouchGestures ( const bool use )

virtual

Enable multi-touch gestures if supported.

Parameters

use	Enable or disable.

Implements GHOST_ISystem.

Reimplemented in GHOST_SystemWayland.

Definition at line 331 of file GHOST_System.cc.

References m_multitouchGestures.

◆ setTabletAPI()

void GHOST_System::setTabletAPI ( GHOST_TTabletAPI api )

virtual

Set which tablet API to use. Only affects Windows, other platforms have a single API.

Parameters

api	Enum indicating which API to use.

Implements GHOST_ISystem.

Reimplemented in GHOST_SystemWin32.

Definition at line 336 of file GHOST_System.cc.

References m_tabletAPI.

Referenced by GHOST_SystemWin32::setTabletAPI().

◆ showMessageBox()

virtual GHOST_TSuccess GHOST_System::showMessageBox	(	const char *	,
		const char *	,
		const char *	,
		const char *	,
		const char *	,
		GHOST_DialogOptions	) const

inlinevirtual

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.

Implements GHOST_ISystem.

Reimplemented in GHOST_SystemCocoa, GHOST_SystemWin32, and GHOST_SystemX11.

Definition at line 362 of file GHOST_System.hh.

References GHOST_kFailure.

◆ updateFullScreen()

GHOST_TSuccess GHOST_System::updateFullScreen	(	const GHOST_DisplaySetting &	setting,
		GHOST_IWindow **	window )

virtual

Updates the resolution while in full-screen mode.

Parameters

setting	The new setting of the display.
window	Window displayed in full screen.

Returns: Indication of success.

Implements GHOST_ISystem.

Definition at line 158 of file GHOST_System.cc.

References GHOST_WindowManager::getFullScreen(), GHOST_ASSERT, GHOST_kFailure, GHOST_DisplayManager::kMainDisplay, m_displayManager, m_windowManager, and GHOST_DisplayManager::setCurrentDisplaySetting().

◆ useNativePixel()

bool GHOST_System::useNativePixel ( )

virtual

Native pixel size support (MacBook 'retina').

Returns: The pixel size in float.

Implements GHOST_ISystem.

Definition at line 439 of file GHOST_System.cc.

References m_nativePixel.

◆ useWindowFocus()

void GHOST_System::useWindowFocus ( const bool use_focus )

virtual

Focus window after opening, or put them in the background.

Implements GHOST_ISystem.

Definition at line 445 of file GHOST_System.cc.

References m_windowFocus.

◆ validWindow()

bool GHOST_System::validWindow ( GHOST_IWindow * window )

virtual

Returns whether a window is valid.

Parameters

window Pointer to the window to be checked.

Returns: Indication of validity.

Implements GHOST_ISystem.

Definition at line 120 of file GHOST_System.cc.

References GHOST_WindowManager::getWindowFound(), and m_windowManager.

Member Data Documentation

◆ m_autoFocus

bool GHOST_System::m_autoFocus

Definition at line 157 of file GHOST_System.hh.

Referenced by GHOST_SystemWin32::s_wndProc(), and setAutoFocus().

◆ m_displayManager

GHOST_DisplayManager* GHOST_System::m_displayManager

protected

The display manager (platform dependent).

Definition at line 410 of file GHOST_System.hh.

Referenced by beginFullScreen(), createFullScreenWindow(), endFullScreen(), exit(), GHOST_SystemWin32::getNumDisplays(), GHOST_SystemWin32::GHOST_SystemWin32(), GHOST_SystemHeadless::init(), GHOST_SystemX11::init(), and updateFullScreen().

◆ m_eventManager

GHOST_EventManager* GHOST_System::m_eventManager

protected

The event manager.

Definition at line 419 of file GHOST_System.hh.

Referenced by addEventConsumer(), dispatchEvents(), disposeWindow(), exit(), getEventManager(), init(), GHOST_SystemWin32::processEvents(), pushEvent(), and removeEventConsumer().

◆ m_is_debug_enabled

bool GHOST_System::m_is_debug_enabled

protected

Definition at line 440 of file GHOST_System.hh.

Referenced by initDebug(), and isDebugEnabled().

◆ m_multitouchGestures

bool GHOST_System::m_multitouchGestures

protected

Definition at line 435 of file GHOST_System.hh.

Referenced by GHOST_SystemWin32::s_wndProc(), setMultitouchGestures(), and GHOST_SystemWayland::setMultitouchGestures().

◆ m_nativePixel

bool GHOST_System::m_nativePixel

Definition at line 144 of file GHOST_System.hh.

Referenced by GHOST_WindowCocoa::GHOST_WindowCocoa(), and useNativePixel().

◆ m_preFullScreenSetting

GHOST_DisplaySetting GHOST_System::m_preFullScreenSetting

protected

Prints all the events. Settings of the display before the display went full-screen.

Definition at line 432 of file GHOST_System.hh.

Referenced by beginFullScreen(), and endFullScreen().

◆ m_tabletAPI

GHOST_TTabletAPI GHOST_System::m_tabletAPI

protected

Which tablet API to use.

Definition at line 438 of file GHOST_System.hh.

Referenced by getTabletAPI(), and setTabletAPI().

◆ m_timerManager

GHOST_TimerManager* GHOST_System::m_timerManager

protected

The timer manager.

Definition at line 413 of file GHOST_System.hh.

Referenced by dispatchEvents(), exit(), getTimerManager(), init(), installTimer(), and removeTimer().

◆ m_windowFocus

bool GHOST_System::m_windowFocus

Definition at line 151 of file GHOST_System.hh.

Referenced by GHOST_WindowWin32::GHOST_WindowWin32(), GHOST_WindowX11::GHOST_WindowX11(), and useWindowFocus().

◆ m_windowManager

GHOST_WindowManager* GHOST_System::m_windowManager

protected

The window manager.

Definition at line 416 of file GHOST_System.hh.

Referenced by beginFullScreen(), GHOST_SystemWayland::createWindow(), GHOST_SystemWin32::createWindow(), GHOST_SystemX11::createWindow(), disposeWindow(), endFullScreen(), exit(), GHOST_SystemX11::getClipboard(), GHOST_SystemX11::getClipboard_xcout(), getFullScreen(), getWindowManager(), getWindowUnderCursor(), GHOST_SystemWin32::getWindowUnderCursor(), init(), GHOST_SystemX11::putClipboard(), updateFullScreen(), and validWindow().

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

Public Member Functions

Public Attributes

Protected Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ GHOST_System()

◆ ~GHOST_System()

Member Function Documentation

◆ addEventConsumer()

◆ beginFullScreen()

◆ createFullScreenWindow()

◆ createOffscreenContext()

◆ dispatchEvents()

◆ disposeWindow()

◆ endFullScreen()

◆ exit()

◆ getButtons()

◆ getButtonState()

◆ getClipboard()

◆ getClipboardImage()

◆ getCursorPositionClientRelative()

◆ getEventManager()

◆ getFullScreen()

◆ getModifierKeys()

◆ getModifierKeyState()

◆ getPixelAtCursor()

◆ getTabletAPI()

◆ getTimerManager()

◆ getWindowManager()

◆ getWindowUnderCursor()

◆ hasClipboardImage()

◆ init()

◆ initDebug()

◆ installTimer()

◆ isDebugEnabled()

◆ pushEvent()

◆ putClipboard()

◆ putClipboardImage()

◆ removeEventConsumer()

◆ removeTimer()

◆ setAutoFocus()

◆ setCursorPositionClientRelative()

◆ setMultitouchGestures()

◆ setTabletAPI()

◆ showMessageBox()

◆ updateFullScreen()

◆ useNativePixel()

◆ useWindowFocus()

◆ validWindow()

Member Data Documentation

◆ m_autoFocus

◆ m_displayManager

◆ m_eventManager

◆ m_is_debug_enabled

◆ m_multitouchGestures

◆ m_nativePixel

◆ m_preFullScreenSetting

◆ m_tabletAPI

◆ m_timerManager

◆ m_windowFocus

◆ m_windowManager