#include <GHOST_SystemNULL.h>

Inherits GHOST_System.

Public Member Functions
	GHOST_SystemNULL ()

	~GHOST_SystemNULL ()

bool	processEvents (bool waitForEvent)

int	toggleConsole (int action)

GHOST_TSuccess	getModifierKeys (GHOST_ModifierKeys &keys) const

GHOST_TSuccess	getButtons (GHOST_Buttons &buttons) const

GHOST_TUns8 *	getClipboard (bool selection) const

void	putClipboard (GHOST_TInt8 *buffer, bool selection) const

GHOST_TUns64	getMilliSeconds () const

GHOST_TUns8	getNumDisplays () const

GHOST_TSuccess	getCursorPosition (GHOST_TInt32 &x, GHOST_TInt32 &y) const

GHOST_TSuccess	setCursorPosition (GHOST_TInt32 x, GHOST_TInt32 y)

void	getMainDisplayDimensions (GHOST_TUns32 &width, GHOST_TUns32 &height) const

void	getAllDisplayDimensions (GHOST_TUns32 &width, GHOST_TUns32 &height) const

GHOST_IContext *	createOffscreenContext (GHOST_GLSettings glSettings)

GHOST_TSuccess	disposeContext (GHOST_IContext *context)

GHOST_TSuccess	init ()

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, const bool is_dialog, const GHOST_IWindow parentWindow)

Public Member Functions inherited from GHOST_System
GHOST_ITimerTask *	installTimer (GHOST_TUns64 delay, GHOST_TUns64 interval, GHOST_TimerProcPtr timerProc, GHOST_TUserDataPtr userData=NULL)

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, const bool alphaBackground)

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

GHOST_TSuccess	endFullScreen (void)

bool	getFullScreen (void)

bool	useNativePixel (void)

void	useWindowFocus (const bool use_focus)

void	dispatchEvents ()

GHOST_TSuccess	addEventConsumer (GHOST_IEventConsumer *consumer)

GHOST_TSuccess	removeEventConsumer (GHOST_IEventConsumer *consumer)

GHOST_TSuccess	getModifierKeyState (GHOST_TModifierKeyMask mask, bool &isDown) const

GHOST_TSuccess	getButtonState (GHOST_TButtonMask mask, bool &isDown) const

void	setTabletAPI (GHOST_TTabletAPI api)

GHOST_TTabletAPI	getTabletAPI (void)

GHOST_TSuccess	pushEvent (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 (bool is_debug_enabled)

virtual bool	isDebugEnabled ()

Additional Inherited Members
Static Public Member Functions inherited from GHOST_ISystem
static GHOST_TSuccess	createSystem ()

static GHOST_TSuccess	disposeSystem ()

static GHOST_ISystem *	getSystem ()

Public Attributes inherited from GHOST_System
bool	m_nativePixel

bool	m_windowFocus

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, const bool alphaBackground=0)

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

GHOST_TTabletAPI	m_tabletAPI

bool	m_is_debug_enabled

Static Protected Attributes inherited from GHOST_ISystem
static GHOST_ISystem *	m_system = NULL

Detailed Description

Definition at line 31 of file GHOST_SystemNULL.h.

Constructor & Destructor Documentation

◆ GHOST_SystemNULL()

GHOST_SystemNULL::GHOST_SystemNULL ( )

inline

Definition at line 33 of file GHOST_SystemNULL.h.

◆ ~GHOST_SystemNULL()

GHOST_SystemNULL::~GHOST_SystemNULL ( )

inline

Definition at line 36 of file GHOST_SystemNULL.h.

Member Function Documentation

◆ createOffscreenContext()

GHOST_IContext* GHOST_SystemNULL::createOffscreenContext ( GHOST_GLSettings glSettings )

inlinevirtual

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

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

Implements GHOST_System.

Definition at line 84 of file GHOST_SystemNULL.h.

References NULL.

◆ createWindow()

GHOST_IWindow* GHOST_SystemNULL::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,
		const bool	is_dialog,
		const GHOST_IWindow *	parentWindow
	)

inlinevirtual

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

Implements GHOST_ISystem.

Definition at line 108 of file GHOST_SystemNULL.h.

References GHOST_GLSettings::flags, GHOST_glStereoVisual, height, left, state, top, type, and width.

◆ disposeContext()

GHOST_TSuccess GHOST_SystemNULL::disposeContext ( GHOST_IContext * context )

inlinevirtual

Dispose of a context.

Parameters

context Pointer to the context to be disposed.

Returns: Indication of success.

Implements GHOST_ISystem.

Definition at line 88 of file GHOST_SystemNULL.h.

References GHOST_kFailure.

◆ getAllDisplayDimensions()

void GHOST_SystemNULL::getAllDisplayDimensions	(	GHOST_TUns32 &	width,
		GHOST_TUns32 &	height
	)		const

inlinevirtual

Returns the combine dimensions of all monitors.

Returns: The dimension of the workspace.

Implements GHOST_ISystem.

Definition at line 81 of file GHOST_SystemNULL.h.

◆ getButtons()

GHOST_TSuccess GHOST_SystemNULL::getButtons ( GHOST_Buttons & buttons ) const

inlinevirtual

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 51 of file GHOST_SystemNULL.h.

References GHOST_kSuccess.

◆ getClipboard()

GHOST_TUns8* GHOST_SystemNULL::getClipboard ( bool selection ) const

inlinevirtual

Returns the selection buffer

Parameters

selection Only used on X11.

Returns: Returns the clipboard data

Implements GHOST_System.

Definition at line 55 of file GHOST_SystemNULL.h.

References NULL.

◆ getCursorPosition()

GHOST_TSuccess GHOST_SystemNULL::getCursorPosition	(	GHOST_TInt32 &	x,
		GHOST_TInt32 &	y
	)		const

inlinevirtual

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 70 of file GHOST_SystemNULL.h.

References GHOST_kFailure.

◆ getMainDisplayDimensions()

void GHOST_SystemNULL::getMainDisplayDimensions	(	GHOST_TUns32 &	width,
		GHOST_TUns32 &	height
	)		const

inlinevirtual

Returns the dimensions of the main display on this system.

Returns: The dimension of the main display.

Implements GHOST_ISystem.

Definition at line 78 of file GHOST_SystemNULL.h.

◆ getMilliSeconds()

GHOST_TUns64 GHOST_SystemNULL::getMilliSeconds ( ) const

inlinevirtual

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.

Reimplemented from GHOST_System.

Definition at line 62 of file GHOST_SystemNULL.h.

◆ getModifierKeys()

GHOST_TSuccess GHOST_SystemNULL::getModifierKeys ( GHOST_ModifierKeys & keys ) const

inlinevirtual

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 47 of file GHOST_SystemNULL.h.

References GHOST_kSuccess.

◆ getNumDisplays()

GHOST_TUns8 GHOST_SystemNULL::getNumDisplays ( ) const

inlinevirtual

Returns the number of displays on this system.

Returns: The number of displays.

Implements GHOST_ISystem.

Definition at line 66 of file GHOST_SystemNULL.h.

◆ init()

GHOST_TSuccess GHOST_SystemNULL::init ( void )

inlinevirtual

Initialize the system.

Returns: Indication of success.

Reimplemented from GHOST_System.

Definition at line 93 of file GHOST_SystemNULL.h.

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

◆ processEvents()

bool GHOST_SystemNULL::processEvents ( bool waitForEvent )

inlinevirtual

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 39 of file GHOST_SystemNULL.h.

◆ putClipboard()

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

inlinevirtual

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 59 of file GHOST_SystemNULL.h.

◆ setCursorPosition()

GHOST_TSuccess GHOST_SystemNULL::setCursorPosition	(	GHOST_TInt32	x,
		GHOST_TInt32	y
	)

inlinevirtual

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 74 of file GHOST_SystemNULL.h.

References GHOST_kFailure.

◆ toggleConsole()

int GHOST_SystemNULL::toggleConsole ( int action )

inlinevirtual

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)

Implements GHOST_ISystem.

Definition at line 43 of file GHOST_SystemNULL.h.

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

GHOST_SystemNULL.h

Public Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ GHOST_SystemNULL()

◆ ~GHOST_SystemNULL()

Member Function Documentation

◆ createOffscreenContext()

◆ createWindow()

◆ disposeContext()

◆ getAllDisplayDimensions()

◆ getButtons()

◆ getClipboard()

◆ getCursorPosition()

◆ getMainDisplayDimensions()

◆ getMilliSeconds()

◆ getModifierKeys()

◆ getNumDisplays()

◆ init()

◆ processEvents()

◆ putClipboard()

◆ setCursorPosition()

◆ toggleConsole()