Blender V5.3
GHOST_ISystem.hh
Go to the documentation of this file.
1/* SPDX-FileCopyrightText: 2001-2002 NaN Holding BV. All rights reserved.
2 *
3 * SPDX-License-Identifier: GPL-2.0-or-later */
4
11
12#pragma once
13
14#include <cstdlib>
15
16#include "GHOST_IContext.hh"
17#include "GHOST_ITimerTask.hh"
18#include "GHOST_IWindow.hh"
19#include "GHOST_Types.hh"
20
22
89
104 public:
111
112 static GHOST_TSuccess createSystem(bool verbose = true, bool background = false);
114
120
125 static GHOST_ISystem *getSystem();
134 static const char *getSystemBackend();
135
137 static void setBacktraceFn(GHOST_TBacktraceFn backtrace_fn);
138
139 static bool getUseWindowFrame();
140 static void setUseWindowFrame(bool use_window_frame);
141
142 protected:
148
153 virtual ~GHOST_ISystem() = default;
154
155 public:
156 /***************************************************************************************
157 * Time(r) functionality
158 ***************************************************************************************/
159
168 virtual uint64_t getMilliSeconds() const = 0;
169
183 uint64_t interval,
184 GHOST_TimerProcPtr timer_proc,
185 GHOST_TUserDataPtr user_data = nullptr) = 0;
186
193
194 /***************************************************************************************
195 * Display/window management functionality
196 ***************************************************************************************/
197
202 virtual uint8_t getNumDisplays() const = 0;
203
208 virtual void getMainDisplayDimensions(uint32_t &width, uint32_t &height) const = 0;
209
214 virtual void getAllDisplayDimensions(uint32_t &width, uint32_t &height) const = 0;
215
233 virtual GHOST_IWindow *createWindow(const char *title,
234 int32_t left,
235 int32_t top,
236 uint32_t width,
237 uint32_t height,
239 GHOST_GPUSettings gpu_settings,
240 const bool exclusive = false,
241 const bool is_dialog = false,
242 const GHOST_IWindow *parent_window = nullptr) = 0;
243
250
257
264
270 virtual bool validWindow(GHOST_IWindow *window) = 0;
271
276 virtual bool useNativePixel() = 0;
277
284
288 virtual void useWindowFocus(const bool use_focus) = 0;
289
293 virtual void setAutoFocus(const bool auto_focus) = 0;
294
305
306 /***************************************************************************************
307 * Event management functionality
308 ***************************************************************************************/
309
315 virtual bool processEvents(bool waitForEvent) = 0;
316
321 virtual void dispatchEvents() = 0;
322
329
336
337 /***************************************************************************************
338 * Cursor management functionality
339 ***************************************************************************************/
340
348 int32_t &x,
349 int32_t &y) const = 0;
357 int32_t x,
358 int32_t y) = 0;
359
367
371 virtual uint32_t getCursorPreferredLogicalSize() const = 0;
372
381
382 /***************************************************************************************
383 * Access to mouse button and keyboard states.
384 ***************************************************************************************/
385
393
400 virtual GHOST_TSuccess getButtonState(GHOST_TButton mask, bool &is_down) const = 0;
401
406 virtual void setMultitouchGestures(const bool use) = 0;
407
412 virtual void setTabletAPI(GHOST_TTabletAPI api) = 0;
413
419 virtual GHOST_TSuccess getPixelAtCursor(float r_color[3]) const = 0;
420
421#ifdef WITH_INPUT_NDOF
426 virtual void setNDOFDeadZone(float deadzone) = 0;
427#endif
428
435
436 /***************************************************************************************
437 * Access to clipboard.
438 ***************************************************************************************/
439
447 virtual char *getClipboard(bool selection) const = 0;
448
454 virtual void putClipboard(const char *buffer, bool selection) const = 0;
455
460
467 virtual uint *getClipboardImage(int *r_width, int *r_height) const = 0;
468
475 virtual GHOST_TSuccess putClipboardImage(uint *rgba, int width, int height) const = 0;
476
477 /***************************************************************************************
478 * Window "Client Side Decorations" (CSD)
479 ***************************************************************************************/
480
481 virtual void setWindowCSD(const GHOST_CSD_Params &params) = 0;
482 virtual const GHOST_CSD_Layout &getWindowCSD_Layout() const = 0;
483
484 /***************************************************************************************
485 * Window Icon Generator.
486 ***************************************************************************************/
487
493 virtual void setIconGenerator(const GHOST_IconGenerator *icon_generator) = 0;
494
495 /***************************************************************************************
496 * System Message Box.
497 ***************************************************************************************/
498
509 virtual GHOST_TSuccess showMessageBox(const char * /*title*/,
510 const char * /*message*/,
511 const char * /*help_label*/,
512 const char * /*continue_label*/,
513 const char * /*link*/,
514 GHOST_DialogOptions /*dialog_options*/) const = 0;
515
516 /***************************************************************************************
517 * Debugging
518 ***************************************************************************************/
519
524 virtual void initDebug(GHOST_Debug debug) = 0;
525
529 virtual bool isDebugEnabled() = 0;
530
531 protected:
536 virtual GHOST_TSuccess init() = 0;
537
542 virtual GHOST_TSuccess exit() = 0;
543
546 static const char *system_backend_id_;
547
550
554 static bool use_window_frame_;
555
556 MEM_CXX_CLASS_ALLOC_FUNCS("GHOST:GHOST_ISystem")
557};
void * GHOST_TUserDataPtr
GHOST_TWindowState
void(*)(FILE *file_handle) GHOST_TBacktraceFn
GHOST_TCapabilityFlag
GHOST_TModifierKey
GHOST_TSuccess
GHOST_TButton
void(*)(GHOST_ITimerTask *task, uint64_t time) GHOST_TimerProcPtr
GHOST_TConsoleWindowState
GHOST_TTabletAPI
GHOST_DialogOptions
unsigned long long int uint64_t
static GHOST_TBacktraceFn backtrace_fn_
static GHOST_ISystem * getSystem()
virtual void putClipboard(const char *buffer, bool selection) const =0
static GHOST_TSuccess createSystem(bool verbose=true, bool background=false)
virtual GHOST_TSuccess getModifierKeyState(GHOST_TModifierKey mask, bool &is_down) const =0
static void setUseWindowFrame(bool use_window_frame)
static GHOST_TBacktraceFn getBacktraceFn()
static void setBacktraceFn(GHOST_TBacktraceFn backtrace_fn)
virtual GHOST_TSuccess showMessageBox(const char *, const char *, const char *, const char *, const char *, GHOST_DialogOptions) const =0
virtual void initDebug(GHOST_Debug debug)=0
virtual void setTabletAPI(GHOST_TTabletAPI api)=0
virtual char * getClipboard(bool selection) const =0
static GHOST_ISystem * system_
virtual GHOST_TSuccess setCursorPositionClientRelative(GHOST_IWindow *window, int32_t x, int32_t y)=0
virtual void getMainDisplayDimensions(uint32_t &width, uint32_t &height) const =0
virtual GHOST_TSuccess hasClipboardImage() const =0
virtual bool validWindow(GHOST_IWindow *window)=0
virtual GHOST_TSuccess getCursorPosition(int32_t &x, int32_t &y) 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 gpu_settings, const bool exclusive=false, const bool is_dialog=false, const GHOST_IWindow *parent_window=nullptr)=0
virtual void getAllDisplayDimensions(uint32_t &width, uint32_t &height) const =0
virtual uint * getClipboardImage(int *r_width, int *r_height) const =0
virtual GHOST_IContext * createOffscreenContext(GHOST_GPUSettings gpu_settings)=0
virtual GHOST_TSuccess addEventConsumer(GHOST_IEventConsumer *consumer)=0
virtual GHOST_TSuccess exit()=0
static const char * system_backend_id_
virtual GHOST_ITimerTask * installTimer(uint64_t delay, uint64_t interval, GHOST_TimerProcPtr timer_proc, GHOST_TUserDataPtr user_data=nullptr)=0
virtual bool isDebugEnabled()=0
virtual void useWindowFocus(const bool use_focus)=0
virtual GHOST_TSuccess disposeContext(GHOST_IContext *context)=0
virtual GHOST_TSuccess removeTimer(GHOST_ITimerTask *timerTask)=0
virtual bool useNativePixel()=0
static bool use_window_frame_
static GHOST_TSuccess disposeSystem()
virtual uint8_t getNumDisplays() const =0
virtual void setMultitouchGestures(const bool use)=0
virtual bool setConsoleWindowState(GHOST_TConsoleWindowState action)=0
static bool getUseWindowFrame()
virtual void dispatchEvents()=0
virtual void setIconGenerator(const GHOST_IconGenerator *icon_generator)=0
static const char * getSystemBackend()
virtual const GHOST_CSD_Layout & getWindowCSD_Layout() const =0
virtual GHOST_TCapabilityFlag getCapabilities() const =0
virtual uint32_t getCursorPreferredLogicalSize() const =0
virtual GHOST_TSuccess putClipboardImage(uint *rgba, int width, int height) const =0
virtual void setWindowCSD(const GHOST_CSD_Params &params)=0
virtual ~GHOST_ISystem()=default
virtual GHOST_TSuccess getButtonState(GHOST_TButton mask, bool &is_down) const =0
virtual void setAutoFocus(const bool auto_focus)=0
virtual GHOST_TSuccess getCursorPositionClientRelative(const GHOST_IWindow *window, int32_t &x, int32_t &y) const =0
virtual uint64_t getMilliSeconds() const =0
virtual GHOST_TSuccess disposeWindow(GHOST_IWindow *window)=0
virtual GHOST_TSuccess setCursorPosition(int32_t x, int32_t y)=0
virtual GHOST_TSuccess removeEventConsumer(GHOST_IEventConsumer *consumer)=0
virtual GHOST_TSuccess getPixelAtCursor(float r_color[3]) const =0
virtual GHOST_IWindow * getWindowUnderCursor(int32_t x, int32_t y)=0
virtual bool processEvents(bool waitForEvent)=0
static GHOST_TSuccess createSystemBackground()
virtual GHOST_TSuccess init()=0
const int state
ccl_device_inline float2 mask(const MaskType mask, const float2 a)