#include <GHOST_ISystem.h>

Inherited by GHOST_System.

Public Member Functions
virtual GHOST_TUns64	getMilliSeconds () const =0

virtual GHOST_ITimerTask *	installTimer (GHOST_TUns64 delay, GHOST_TUns64 interval, GHOST_TimerProcPtr timerProc, GHOST_TUserDataPtr userData=NULL)=0

virtual GHOST_TSuccess	removeTimer (GHOST_ITimerTask *timerTask)=0

virtual GHOST_TUns8	getNumDisplays () const =0

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

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

virtual GHOST_IWindow *	createWindow (const char title, GHOST_TInt32 left, GHOST_TInt32 top, GHOST_TUns32 width, GHOST_TUns32 height, GHOST_TWindowState state, GHOST_TDrawingContextType type, GHOST_GLSettings glSettings, const bool exclusive=false, const bool is_dialog=false, const GHOST_IWindow parentWindow=NULL)=0

virtual GHOST_TSuccess	disposeWindow (GHOST_IWindow *window)=0

virtual GHOST_IContext *	createOffscreenContext (GHOST_GLSettings glSettings)=0

virtual GHOST_TSuccess	disposeContext (GHOST_IContext *context)=0

virtual bool	validWindow (GHOST_IWindow *window)=0

virtual GHOST_TSuccess	beginFullScreen (const GHOST_DisplaySetting &setting, GHOST_IWindow **window, const bool stereoVisual, const bool alphaBackground=0)=0

virtual GHOST_TSuccess	updateFullScreen (const GHOST_DisplaySetting &setting, GHOST_IWindow **window)=0

virtual GHOST_TSuccess	endFullScreen (void)=0

virtual bool	getFullScreen (void)=0

virtual bool	useNativePixel (void)=0

virtual void	useWindowFocus (const bool use_focus)=0

virtual bool	processEvents (bool waitForEvent)=0

virtual void	dispatchEvents ()=0

virtual GHOST_TSuccess	addEventConsumer (GHOST_IEventConsumer *consumer)=0

virtual GHOST_TSuccess	removeEventConsumer (GHOST_IEventConsumer *consumer)=0

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

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

virtual GHOST_TSuccess	getModifierKeyState (GHOST_TModifierKeyMask mask, bool &isDown) const =0

virtual GHOST_TSuccess	getButtonState (GHOST_TButtonMask mask, bool &isDown) const =0

virtual void	setTabletAPI (GHOST_TTabletAPI api)=0

virtual int	toggleConsole (int action)=0

virtual GHOST_TUns8 *	getClipboard (bool selection) const =0

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

virtual GHOST_TSuccess	showMessageBox (const char , const char , const char , const char , const char *, GHOST_DialogOptions) const =0

virtual void	initDebug (bool is_debug_enabled)=0

virtual bool	isDebugEnabled ()=0

Static Public Member Functions
static GHOST_TSuccess	createSystem ()

static GHOST_TSuccess	disposeSystem ()

static GHOST_ISystem *	getSystem ()

Protected Member Functions
	GHOST_ISystem ()

virtual	~GHOST_ISystem ()

virtual GHOST_TSuccess	init ()=0

virtual GHOST_TSuccess	exit ()=0

Static Protected Attributes
static GHOST_ISystem *	m_system = NULL

Detailed Description

Interface for classes that provide access to the operating system. There should be only one system class in an application. Therefore, the routines to create and dispose the system are static. Provides:

Time(r) management.
Display/window management (windows are only created on the main display).
Event management.
Cursor shape management (no custom cursors for now).
Access to the state of the mouse buttons and the keyboard.
Menus for windows with events generated when they are accessed (this is work in progress).

Definition at line 132 of file GHOST_ISystem.h.

Constructor & Destructor Documentation

◆ GHOST_ISystem()

GHOST_ISystem::GHOST_ISystem ( )

inlineprotected

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

Definition at line 157 of file GHOST_ISystem.h.

◆ ~GHOST_ISystem()

virtual GHOST_ISystem::~GHOST_ISystem ( )

inlineprotectedvirtual

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

Definition at line 165 of file GHOST_ISystem.h.

Member Function Documentation

◆ addEventConsumer()

virtual GHOST_TSuccess GHOST_ISystem::addEventConsumer ( GHOST_IEventConsumer * consumer )

pure virtual

Adds the given event consumer to our list.

Parameters

consumer The event consumer to add.

Returns: Indication of success.

Implemented in GHOST_System.

Referenced by GHOST_AddEventConsumer(), and main().

◆ beginFullScreen()

virtual GHOST_TSuccess GHOST_ISystem::beginFullScreen	(	const GHOST_DisplaySetting &	setting,
		GHOST_IWindow **	window,
		const bool	stereoVisual,
		const bool	alphaBackground = `0`
	)

pure virtual

Begins full screen mode.

Parameters

setting	The new setting of the display.
window	Window displayed in full screen. This window is invalid after full screen has been ended.

Returns: Indication of success.

Implemented in GHOST_System.

Referenced by GHOST_BeginFullScreen(), and Application::processEvent().

◆ createOffscreenContext()

virtual GHOST_IContext* GHOST_ISystem::createOffscreenContext ( GHOST_GLSettings glSettings )

pure virtual

Create a new offscreen context. Never explicitly delete the context, use disposeContext() instead.

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

Implemented in GHOST_System, GHOST_SystemWayland, GHOST_SystemX11, GHOST_SystemWin32, GHOST_SystemSDL, GHOST_SystemNULL, and GHOST_SystemCocoa.

Referenced by GHOST_CreateOpenGLContext().

◆ createSystem()

GHOST_TSuccess GHOST_ISystem::createSystem ( )

static

Creates the one and only system.

Returns: An indication of success.

Definition at line 50 of file GHOST_ISystem.cpp.

References GHOST_kFailure, GHOST_kSuccess, init(), m_system, and NULL.

Referenced by GHOST_CreateSystem(), and main().

◆ createWindow()

virtual GHOST_IWindow* GHOST_ISystem::createWindow	(	const char *	title,
		GHOST_TInt32	left,
		GHOST_TInt32	top,
		GHOST_TUns32	width,
		GHOST_TUns32	height,
		GHOST_TWindowState	state,
		GHOST_TDrawingContextType	type,
		GHOST_GLSettings	glSettings,
		const bool	exclusive = `false`,
		const bool	is_dialog = `false`,
		const GHOST_IWindow *	parentWindow = `NULL`
	)

pure virtual

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.
type	The type of drawing context installed in this window.
glSettings	Misc OpenGL 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).

Implemented in GHOST_SystemCocoa, GHOST_SystemX11, GHOST_SystemWin32, GHOST_SystemWayland, and GHOST_SystemNULL.

Referenced by Application::Application(), GHOST_System::createFullScreenWindow(), and GHOST_CreateWindow().

◆ dispatchEvents()

virtual void GHOST_ISystem::dispatchEvents ( )

pure virtual

Retrieves events from the queue and send them to the event consumers.

Implemented in GHOST_System.

Referenced by GHOST_DispatchEvents(), and main().

◆ disposeContext()

virtual GHOST_TSuccess GHOST_ISystem::disposeContext ( GHOST_IContext * context )

pure virtual

Dispose of a context.

Parameters

context Pointer to the context to be disposed.

Returns: Indication of success.

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

Referenced by GHOST_DisposeOpenGLContext().

◆ disposeSystem()

GHOST_TSuccess GHOST_ISystem::disposeSystem ( )

static

Disposes the one and only system.

Returns: An indication of success.

Definition at line 89 of file GHOST_ISystem.cpp.

References GHOST_kFailure, GHOST_kSuccess, m_system, and NULL.

Referenced by GHOST_DisposeSystem(), and main().

◆ disposeWindow()

virtual GHOST_TSuccess GHOST_ISystem::disposeWindow ( GHOST_IWindow * window )

pure virtual

Dispose a window.

Parameters

window Pointer to the window to be disposed.

Returns: Indication of success.

Implemented in GHOST_System.

Referenced by GHOST_DisposeWindow(), Application::processEvent(), and Application::~Application().

◆ endFullScreen()

virtual GHOST_TSuccess GHOST_ISystem::endFullScreen ( void )

pure virtual

Ends full screen mode.

Returns: Indication of success.

Implemented in GHOST_System.

Referenced by GHOST_EndFullScreen(), and Application::processEvent().

◆ exit()

virtual GHOST_TSuccess GHOST_ISystem::exit ( )

protectedpure virtual

Shut the system down.

Returns: Indication of success.

Implemented in GHOST_SystemWin32, and GHOST_System.

◆ getAllDisplayDimensions()

virtual void GHOST_ISystem::getAllDisplayDimensions	(	GHOST_TUns32 &	width,
		GHOST_TUns32 &	height
	)		const

pure virtual

Returns the combine dimensions of all monitors.

Returns: The dimension of the workspace.

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

Referenced by GHOST_GetAllDisplayDimensions().

◆ getButtonState()

virtual GHOST_TSuccess GHOST_ISystem::getButtonState	(	GHOST_TButtonMask	mask,
		bool &	isDown
	)		const

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

Implemented in GHOST_System.

Referenced by GHOST_GetButtonState().

◆ getClipboard()

virtual GHOST_TUns8* GHOST_ISystem::getClipboard ( bool selection ) const

pure virtual

Returns the selection buffer

Returns: "unsigned char" from X11 XA_CUT_BUFFER0 buffer

Implemented in GHOST_SystemWayland, GHOST_System, GHOST_SystemX11, GHOST_SystemWin32, GHOST_SystemSDL, GHOST_SystemNULL, and GHOST_SystemCocoa.

Referenced by GHOST_getClipboard().

◆ getCursorPosition()

virtual GHOST_TSuccess GHOST_ISystem::getCursorPosition	(	GHOST_TInt32 &	x,
		GHOST_TInt32 &	y
	)		const

pure virtual

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.

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

Referenced by GHOST_GetCursorPosition().

◆ getFullScreen()

virtual bool GHOST_ISystem::getFullScreen ( void )

pure virtual

Returns current full screen mode status.

Returns: The current status.

Implemented in GHOST_System.

Referenced by GHOST_GetFullScreen(), and Application::processEvent().

◆ getMainDisplayDimensions()

virtual void GHOST_ISystem::getMainDisplayDimensions	(	GHOST_TUns32 &	width,
		GHOST_TUns32 &	height
	)		const

pure virtual

Returns the dimensions of the main display on this system.

Returns: The dimension of the main display.

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

Referenced by GHOST_GetMainDisplayDimensions().

◆ getMilliSeconds()

virtual GHOST_TUns64 GHOST_ISystem::getMilliSeconds ( ) const

pure virtual

Returns the system time. Returns the number of milliseconds since the start of the system process. Based on ANSI clock() routine.

Returns: The number of milliseconds.

Implemented in GHOST_SystemX11, GHOST_SystemWin32, GHOST_SystemNULL, GHOST_SystemCocoa, and GHOST_System.

Referenced by GHOST_GetMilliSeconds().

◆ getModifierKeyState()

virtual GHOST_TSuccess GHOST_ISystem::getModifierKeyState	(	GHOST_TModifierKeyMask	mask,
		bool &	isDown
	)		const

pure virtual

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.

Implemented in GHOST_System.

Referenced by GHOST_GetModifierKeyState(), and Application::processEvent().

◆ getNumDisplays()

virtual GHOST_TUns8 GHOST_ISystem::getNumDisplays ( ) const

pure virtual

Returns the number of displays on this system.

Returns: The number of displays.

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

Referenced by GHOST_GetNumDisplays().

◆ getSystem()

GHOST_ISystem * GHOST_ISystem::getSystem ( )

static

Returns a pointer to the one and only system (nil if it hasn't been created).

Returns: A pointer to the system.

Definition at line 102 of file GHOST_ISystem.cpp.

References m_system.

◆ init()

virtual GHOST_TSuccess GHOST_ISystem::init ( )

protectedpure virtual

Initialize the system.

Returns: Indication of success.

Implemented in GHOST_SystemX11, GHOST_SystemWin32, GHOST_SystemNULL, GHOST_SystemCocoa, and GHOST_System.

Referenced by createSystem().

◆ initDebug()

virtual void GHOST_ISystem::initDebug ( bool is_debug_enabled )

pure virtual

Specify whether debug messages are to be shown.

Implemented in GHOST_System.

Referenced by GHOST_SystemInitDebug().

◆ installTimer()

virtual GHOST_ITimerTask* GHOST_ISystem::installTimer	(	GHOST_TUns64	delay,
		GHOST_TUns64	interval,
		GHOST_TimerProcPtr	timerProc,
		GHOST_TUserDataPtr	userData = `NULL`
	)

pure virtual

Installs a timer. Note that, 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 (in milliseconds).
timerProc	The callback invoked when the interval expires.
userData	Placeholder for user data.

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

Implemented in GHOST_System.

Referenced by Application::Application(), GHOST_InstallTimer(), and Application::processEvent().

◆ isDebugEnabled()

virtual bool GHOST_ISystem::isDebugEnabled ( )

pure virtual

Check whether debug messages are to be shown.

Implemented in GHOST_System.

Referenced by GHOST_X11_ApplicationErrorHandler(), and GHOST_X11_ApplicationIOErrorHandler().

◆ processEvents()

virtual bool GHOST_ISystem::processEvents ( bool waitForEvent )

pure virtual

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.

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

Referenced by GHOST_ProcessEvents(), and main().

◆ putClipboard()

virtual void GHOST_ISystem::putClipboard	(	GHOST_TInt8 *	buffer,
		bool	selection
	)		const

pure virtual

Put data to the Clipboard

Implemented in GHOST_SystemWayland, GHOST_System, GHOST_SystemX11, GHOST_SystemWin32, GHOST_SystemSDL, GHOST_SystemNULL, and GHOST_SystemCocoa.

Referenced by GHOST_putClipboard().

◆ removeEventConsumer()

virtual GHOST_TSuccess GHOST_ISystem::removeEventConsumer ( GHOST_IEventConsumer * consumer )

pure virtual

Removes the given event consumer to our list.

Parameters

consumer The event consumer to remove.

Returns: Indication of success.

Implemented in GHOST_System.

Referenced by GHOST_RemoveEventConsumer(), and main().

◆ removeTimer()

virtual GHOST_TSuccess GHOST_ISystem::removeTimer ( GHOST_ITimerTask * timerTask )

pure virtual

Removes a timer.

Parameters

timerTask Timer task to be removed.

Returns: Indication of success.

Implemented in GHOST_System.

Referenced by GHOST_RemoveTimer(), and Application::processEvent().

◆ setCursorPosition()

virtual GHOST_TSuccess GHOST_ISystem::setCursorPosition	(	GHOST_TInt32	x,
		GHOST_TInt32	y
	)

pure virtual

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.

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

Referenced by GHOST_SetCursorPosition(), and Application::processEvent().

◆ setTabletAPI()

virtual void GHOST_ISystem::setTabletAPI ( GHOST_TTabletAPI api )

pure virtual

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

Parameters

api	Enum indicating which API to use.

Implemented in GHOST_System.

Referenced by GHOST_SetTabletAPI().

◆ showMessageBox()

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

pure virtual

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.

Implemented in GHOST_SystemX11, GHOST_SystemWin32, and GHOST_System.

Referenced by GHOST_ShowMessageBox().

◆ toggleConsole()

virtual int GHOST_ISystem::toggleConsole ( int action )

pure virtual

Toggles console

Parameters

action

0: Hides.
1: Shows
2: Toggles
3: Hides if it runs not from command line
*: Does nothing

Returns: current status (1 -visible, 0 - hidden)

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

Referenced by GHOST_toggleConsole().

◆ updateFullScreen()

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

pure virtual

Updates the resolution while in fullscreen mode.

Parameters

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

Returns: Indication of success.

Implemented in GHOST_System.

◆ useNativePixel()

virtual bool GHOST_ISystem::useNativePixel ( void )

pure virtual

Native pixel size support (MacBook 'retina').

Implemented in GHOST_System.

Referenced by GHOST_UseNativePixels().

◆ useWindowFocus()

virtual void GHOST_ISystem::useWindowFocus ( const bool use_focus )

pure virtual

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

Implemented in GHOST_System.

Referenced by GHOST_UseWindowFocus().

◆ validWindow()

virtual bool GHOST_ISystem::validWindow ( GHOST_IWindow * window )

pure virtual

Returns whether a window is valid.

Parameters

window Pointer to the window to be checked.

Returns: Indication of validity.

Implemented in GHOST_System.

Referenced by gearsTimerProc(), GHOST_ValidWindow(), Application::processEvent(), and Application::~Application().

Member Data Documentation

◆ m_system

GHOST_ISystem * GHOST_ISystem::m_system = NULL

staticprotected

The one and only system

Definition at line 490 of file GHOST_ISystem.h.

Referenced by createSystem(), disposeSystem(), and getSystem().

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

Public Member Functions

Static Public Member Functions

Protected Member Functions

Static Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ GHOST_ISystem()

◆ ~GHOST_ISystem()

Member Function Documentation

◆ addEventConsumer()

◆ beginFullScreen()

◆ createOffscreenContext()

◆ createSystem()

◆ createWindow()

◆ dispatchEvents()

◆ disposeContext()

◆ disposeSystem()

◆ disposeWindow()

◆ endFullScreen()

◆ exit()

◆ getAllDisplayDimensions()

◆ getButtonState()

◆ getClipboard()

◆ getCursorPosition()

◆ getFullScreen()

◆ getMainDisplayDimensions()

◆ getMilliSeconds()

◆ getModifierKeyState()

◆ getNumDisplays()

◆ getSystem()

◆ init()

◆ initDebug()

◆ installTimer()

◆ isDebugEnabled()

◆ processEvents()

◆ putClipboard()

◆ removeEventConsumer()

◆ removeTimer()

◆ setCursorPosition()

◆ setTabletAPI()

◆ showMessageBox()

◆ toggleConsole()

◆ updateFullScreen()

◆ useNativePixel()

◆ useWindowFocus()

◆ validWindow()

Member Data Documentation

◆ m_system