Blender  V3.3
Public Member Functions | List of all members
GHOST_SystemNULL Class Reference

#include <GHOST_SystemNULL.h>

Inheritance diagram for GHOST_SystemNULL:
GHOST_System GHOST_ISystem

Public Member Functions

 GHOST_SystemNULL ()
 
 ~GHOST_SystemNULL ()
 
bool processEvents (bool waitForEvent)
 
int setConsoleWindowState (GHOST_TConsoleWindowState action)
 
GHOST_TSuccess getModifierKeys (GHOST_ModifierKeys &keys) const
 
GHOST_TSuccess getButtons (GHOST_Buttons &buttons) const
 
char * getClipboard (bool selection) const
 
void putClipboard (const char *buffer, bool selection) const
 
uint64_t getMilliSeconds () const
 
uint8_t getNumDisplays () const
 
GHOST_TSuccess getCursorPosition (int32_t &x, int32_t &y) const
 
GHOST_TSuccess setCursorPosition (int32_t x, int32_t y)
 
void getMainDisplayDimensions (uint32_t &width, uint32_t &height) const
 
void getAllDisplayDimensions (uint32_t &width, uint32_t &height) const
 
GHOST_IContextcreateOffscreenContext (GHOST_GLSettings glSettings)
 
GHOST_TSuccess disposeContext (GHOST_IContext *context)
 
GHOST_TSuccess init ()
 
GHOST_IWindowcreateWindow (const char *title, int32_t left, int32_t top, uint32_t width, uint32_t height, GHOST_TWindowState state, GHOST_TDrawingContextType type, GHOST_GLSettings glSettings, const bool exclusive, const bool is_dialog, const GHOST_IWindow *parentWindow)
 
GHOST_IWindowgetWindowUnderCursor (int32_t x, int32_t y)
 
- Public Member Functions inherited from GHOST_System
GHOST_ITimerTaskinstallTimer (uint64_t delay, uint64_t 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)
 
bool supportsCursorWarp (void)
 
bool supportsWindowPosition (void)
 
void useWindowFocus (const bool use_focus)
 
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 (void)
 
GHOST_TSuccess pushEvent (GHOST_IEvent *event)
 
GHOST_TimerManagergetTimerManager () const
 
GHOST_EventManagergetEventManager () const
 
GHOST_WindowManagergetWindowManager () 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 ()
 

Additional Inherited Members

- Static Public Member Functions inherited from GHOST_ISystem
static GHOST_TSuccess createSystem ()
 
static GHOST_TSuccess disposeSystem ()
 
static GHOST_ISystemgetSystem ()
 
static GHOST_TBacktraceFn getBacktraceFn ()
 
static void setBacktraceFn (GHOST_TBacktraceFn backtrace_fn)
 
- 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_DisplayManagerm_displayManager
 
GHOST_TimerManagerm_timerManager
 
GHOST_WindowManagerm_windowManager
 
GHOST_EventManagerm_eventManager
 
GHOST_DisplaySetting m_preFullScreenSetting
 
bool m_multitouchGestures
 
GHOST_TTabletAPI m_tabletAPI
 
bool m_is_debug_enabled
 
- Static Protected Attributes inherited from GHOST_ISystem
static GHOST_ISystemm_system = nullptr
 
static GHOST_TBacktraceFn m_backtrace_fn = nullptr
 

Detailed Description

Definition at line 17 of file GHOST_SystemNULL.h.

Constructor & Destructor Documentation

◆ GHOST_SystemNULL()

GHOST_SystemNULL::GHOST_SystemNULL ( )
inline

Definition at line 19 of file GHOST_SystemNULL.h.

◆ ~GHOST_SystemNULL()

GHOST_SystemNULL::~GHOST_SystemNULL ( )
inline

Definition at line 22 of file GHOST_SystemNULL.h.

Member Function Documentation

◆ createOffscreenContext()

GHOST_IContext* GHOST_SystemNULL::createOffscreenContext ( GHOST_GLSettings  glSettings)
inlinevirtual

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

◆ createWindow()

GHOST_IWindow* GHOST_SystemNULL::createWindow ( const char *  title,
int32_t  left,
int32_t  top,
uint32_t  width,
uint32_t  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
titleThe name of the window (displayed in the title bar of the window if the OS supports it).
leftThe coordinate of the left edge of the window.
topThe coordinate of the top edge of the window.
widthThe width the window.
heightThe height the window.
stateThe state of the window when opened.
typeThe type of drawing context installed in this window.
glSettingsMisc OpenGL settings.
exclusiveUse to show the window on top and ignore others (used full-screen).
is_dialogStay on top of parent window, no icon in taskbar, can't be minimized.
parentWindowParent (embedder) window
Returns
The new window (or 0 if creation failed).

Implements GHOST_ISystem.

Definition at line 94 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
contextPointer to the context to be disposed.
Returns
Indication of success.

Implements GHOST_ISystem.

Definition at line 74 of file GHOST_SystemNULL.h.

References GHOST_kFailure.

◆ getAllDisplayDimensions()

void GHOST_SystemNULL::getAllDisplayDimensions ( uint32_t width,
uint32_t height 
) const
inlinevirtual

Returns the combine dimensions of all monitors.

Returns
The dimension of the workspace.

Implements GHOST_ISystem.

Definition at line 67 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
buttonsThe state of the buttons.
Returns
Indication of success.

Implements GHOST_System.

Definition at line 37 of file GHOST_SystemNULL.h.

References GHOST_kSuccess.

◆ getClipboard()

char* GHOST_SystemNULL::getClipboard ( bool  selection) const
inlinevirtual

Returns the selection buffer

Parameters
selectionOnly used on X11.
Returns
Returns the clipboard data

Implements GHOST_System.

Definition at line 41 of file GHOST_SystemNULL.h.

◆ getCursorPosition()

GHOST_TSuccess GHOST_SystemNULL::getCursorPosition ( int32_t x,
int32_t y 
) const
inlinevirtual

Returns the current location of the cursor (location in screen coordinates)

Parameters
xThe x-coordinate of the cursor.
yThe y-coordinate of the cursor.
Returns
Indication of success.

Implements GHOST_ISystem.

Definition at line 56 of file GHOST_SystemNULL.h.

References GHOST_kFailure.

◆ getMainDisplayDimensions()

void GHOST_SystemNULL::getMainDisplayDimensions ( uint32_t width,
uint32_t 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 64 of file GHOST_SystemNULL.h.

◆ getMilliSeconds()

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

◆ getModifierKeys()

GHOST_TSuccess GHOST_SystemNULL::getModifierKeys ( GHOST_ModifierKeys keys) const
inlinevirtual

Returns the state of all modifier keys.

Parameters
keysThe state of all modifier keys (true == pressed).
Returns
Indication of success.

Implements GHOST_System.

Definition at line 33 of file GHOST_SystemNULL.h.

References GHOST_kSuccess.

◆ getNumDisplays()

uint8_t GHOST_SystemNULL::getNumDisplays ( ) const
inlinevirtual

Returns the number of displays on this system.

Returns
The number of displays.

Implements GHOST_ISystem.

Definition at line 52 of file GHOST_SystemNULL.h.

◆ getWindowUnderCursor()

GHOST_IWindow* GHOST_SystemNULL::getWindowUnderCursor ( int32_t  x,
int32_t  y 
)
inlinevirtual

Get the Window under the cursor.

Parameters
xThe x-coordinate of the cursor.
yThe y-coordinate of the cursor.
Returns
The window under the cursor or nullptr if none.

Reimplemented from GHOST_System.

Definition at line 118 of file GHOST_SystemNULL.h.

◆ init()

GHOST_TSuccess GHOST_SystemNULL::init ( )
inlinevirtual

Initialize the system.

Returns
Indication of success.

Reimplemented from GHOST_System.

Definition at line 79 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
waitForEventFlag to wait for an event (or return immediately).
Returns
Indication of the presence of events.

Implements GHOST_ISystem.

Definition at line 25 of file GHOST_SystemNULL.h.

◆ putClipboard()

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

Put data to the Clipboard

Parameters
bufferThe buffer to copy to the clipboard.
selectionThe clipboard to copy too only used on X11.

Implements GHOST_System.

Definition at line 45 of file GHOST_SystemNULL.h.

◆ setConsoleWindowState()

int GHOST_SystemNULL::setConsoleWindowState ( GHOST_TConsoleWindowState  action)
inlinevirtual

Set the Console State

Parameters
actionconsole state
Returns
current status (1 -visible, 0 - hidden)

Implements GHOST_ISystem.

Definition at line 29 of file GHOST_SystemNULL.h.

◆ setCursorPosition()

GHOST_TSuccess GHOST_SystemNULL::setCursorPosition ( int32_t  x,
int32_t  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
xThe x-coordinate of the cursor.
yThe y-coordinate of the cursor.
Returns
Indication of success.

Implements GHOST_ISystem.

Definition at line 60 of file GHOST_SystemNULL.h.

References GHOST_kFailure.


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