GHOST_SystemSDL Class Reference

#include <GHOST_SystemSDL.h>

Inherits GHOST_System.

Public Member Functions
void	addDirtyWindow (GHOST_WindowSDL *bad_wind)
	GHOST_SystemSDL ()
	~GHOST_SystemSDL ()
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 ()
GHOST_TUns8	getNumDisplays () const
GHOST_TSuccess	getCursorPosition (GHOST_TInt32 &x, GHOST_TInt32 &y) const
GHOST_TSuccess	setCursorPosition (GHOST_TInt32 x, GHOST_TInt32 y)
void	getAllDisplayDimensions (GHOST_TUns32 &width, GHOST_TUns32 &height) const
void	getMainDisplayDimensions (GHOST_TUns32 &width, GHOST_TUns32 &height) const
GHOST_IContext *	createOffscreenContext (GHOST_GLSettings glSettings)
GHOST_TSuccess	disposeContext (GHOST_IContext *context)
Public Member Functions inherited from GHOST_System
virtual GHOST_TUns64	getMilliSeconds () const
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 41 of file GHOST_SystemSDL.h.

Constructor & Destructor Documentation

GHOST_SystemSDL()

GHOST_SystemSDL::GHOST_SystemSDL

(

)

Definition at line 34 of file GHOST_SystemSDL.cpp.

~GHOST_SystemSDL()

GHOST_SystemSDL::~GHOST_SystemSDL

(

)

Definition at line 47 of file GHOST_SystemSDL.cpp.

Member Function Documentation

addDirtyWindow()

void GHOST_SystemSDL::addDirtyWindow

(

GHOST_WindowSDL *

bad_wind

)

Definition at line 729 of file GHOST_SystemSDL.cpp.

References GHOST_ASSERT, and NULL.

Referenced by GHOST_WindowSDL::invalidate().

createOffscreenContext()

GHOST_IContext * GHOST_SystemSDL::createOffscreenContext ( GHOST_GLSettings  glSettings )

virtual

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 142 of file GHOST_SystemSDL.cpp.

References context, GHOST_OPENGL_SDL_CONTEXT_FLAGS, GHOST_OPENGL_SDL_RESET_NOTIFICATION_STRATEGY, and NULL.

disposeContext()

GHOST_TSuccess GHOST_SystemSDL::disposeContext ( GHOST_IContext *  context )

virtual

Dispose of a context.

Parameters

context

Pointer to the context to be disposed.

Returns

Indication of success.

Implements GHOST_ISystem.

Definition at line 160 of file GHOST_SystemSDL.cpp.

References context, and GHOST_kSuccess.

getAllDisplayDimensions()

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

virtual

Returns the dimensions of the main display on this system.

Returns

The dimension of the main display.

Implements GHOST_ISystem.

Definition at line 121 of file GHOST_SystemSDL.cpp.

References height, and width.

getButtons()

GHOST_TSuccess GHOST_SystemSDL::getButtons ( GHOST_Buttons &  buttons ) const

virtual

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 736 of file GHOST_SystemSDL.cpp.

References GHOST_kButtonMaskLeft, GHOST_kButtonMaskMiddle, GHOST_kButtonMaskRight, GHOST_kSuccess, NULL, GHOST_Buttons::set(), and state.

getClipboard()

GHOST_TUns8 * GHOST_SystemSDL::getClipboard ( bool  selection ) const

virtual

Returns the selection buffer

Parameters

selection

Only used on X11.

Returns

Returns the clipboard data

Implements GHOST_System.

Definition at line 746 of file GHOST_SystemSDL.cpp.

getCursorPosition()

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

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.

Implements GHOST_ISystem.

Definition at line 614 of file GHOST_SystemSDL.cpp.

References GHOST_kSuccess, x, and y.

getMainDisplayDimensions()

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

virtual

Returns the dimensions of the main display on this system.

Returns

The dimension of the main display.

Implements GHOST_ISystem.

Definition at line 129 of file GHOST_SystemSDL.cpp.

References height, and width.

getMilliSeconds()

GHOST_TUns64 GHOST_SystemSDL::getMilliSeconds

(

)

Definition at line 756 of file GHOST_SystemSDL.cpp.

Referenced by processEvents().

getModifierKeys()

GHOST_TSuccess GHOST_SystemSDL::getModifierKeys ( GHOST_ModifierKeys &  keys ) const

virtual

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 167 of file GHOST_SystemSDL.cpp.

References GHOST_kModifierKeyLeftAlt, GHOST_kModifierKeyLeftControl, GHOST_kModifierKeyLeftShift, GHOST_kModifierKeyOS, GHOST_kModifierKeyRightAlt, GHOST_kModifierKeyRightControl, GHOST_kModifierKeyRightShift, GHOST_kSuccess, mod(), and GHOST_ModifierKeys::set().

getNumDisplays()

GHOST_TUns8 GHOST_SystemSDL::getNumDisplays ( ) const

virtual

Returns the number of displays on this system.

Returns

The number of displays.

Implements GHOST_ISystem.

Definition at line 137 of file GHOST_SystemSDL.cpp.

processEvents()

bool GHOST_SystemSDL::processEvents ( bool  waitForEvent )

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.

Implements GHOST_ISystem.

Definition at line 660 of file GHOST_SystemSDL.cpp.

References GHOST_TimerManager::fireTimers(), getMilliSeconds(), GHOST_System::getTimerManager(), GHOST_kFireTimeNever, next, GHOST_TimerManager::nextFireTime(), and NULL.

putClipboard()

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

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

Definition at line 751 of file GHOST_SystemSDL.cpp.

References buffer.

setCursorPosition()

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

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.

Implements GHOST_ISystem.

Definition at line 628 of file GHOST_SystemSDL.cpp.

References GHOST_kSuccess, x, and y.

toggleConsole()

int GHOST_SystemSDL::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 50 of file GHOST_SystemSDL.h.

---

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

• GHOST_SystemSDL.h
• GHOST_SystemSDL.cpp