Blender V5.3
GHOST_IWindow.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
9
10#pragma once
11
12#include "GHOST_Rect.hh"
13#include "GHOST_Types.hh"
14
15#include <cstdlib>
16#include <string>
17
18class GHOST_IContext;
19
35 public:
39 virtual ~GHOST_IWindow() = default;
40
45 virtual bool getValid() const = 0;
46
52
59
65
70 virtual void setTitle(const char *title) = 0;
71
76 virtual std::string getTitle() const = 0;
77
82 virtual void setPath(const char *filepath) = 0;
83
88
94
100 GHOST_WindowDecorationStyleSettings decoration_settings) = 0;
101
106
112 virtual void getWindowBounds(GHOST_Rect &bounds) const = 0;
113
119 virtual void getClientBounds(GHOST_Rect &bounds) const = 0;
120
125 virtual GHOST_TSuccess setClientWidth(uint32_t width) = 0;
126
131 virtual GHOST_TSuccess setClientHeight(uint32_t height) = 0;
132
138 virtual GHOST_TSuccess setClientSize(uint32_t width, uint32_t height) = 0;
139
147 virtual void screenToClient(int32_t inX, int32_t inY, int32_t &outX, int32_t &outY) const = 0;
148
156 virtual void clientToScreen(int32_t inX, int32_t inY, int32_t &outX, int32_t &outY) const = 0;
157
161 virtual void setAcceptDragOperation(bool can_accept) = 0;
162
167 virtual GHOST_TWindowState getState() const = 0;
168
175
181 virtual GHOST_TSuccess setModifiedState(bool is_unsaved_changes) = 0;
182
189
195
201
207 virtual GHOST_TSuccess setSwapInterval(int interval) = 0;
208
215 virtual GHOST_TSuccess getSwapInterval(int &interval_out) = 0;
216
222
227 virtual unsigned int getDefaultFramebuffer() = 0;
228
229#ifdef WITH_VULKAN_BACKEND
231 virtual GHOST_TSuccess getVulkanSwapChainFormat(
232 GHOST_VulkanSwapChainData *r_swap_chain_data) = 0;
233#endif
234
240
245 virtual GHOST_TUserDataPtr getUserData() const = 0;
246
251 virtual void setUserData(const GHOST_TUserDataPtr user_data) = 0;
252
253 virtual bool isDialog() const = 0;
254
255 /***************************************************************************************
256 * Progress bar functionality
257 ***************************************************************************************/
258
263 virtual GHOST_TSuccess setProgressBar(float progress) = 0;
264
269
270 /***************************************************************************************
271 * Cursor management functionality
272 ***************************************************************************************/
273
279
286
288 GHOST_TAxisFlag &axis_flag,
289 GHOST_Rect &bounds,
290 bool &use_software_cursor) = 0;
291
297
306 virtual GHOST_TSuccess setCustomCursorShape(const uint8_t *bitmap,
307 const uint8_t *mask,
308 const int size[2],
309 const int hot_spot[2],
310 bool can_invert_color) = 0;
311
319
321
326 virtual bool getCursorVisibility() const = 0;
327
333 virtual GHOST_TSuccess setCursorVisibility(bool visible) = 0;
334
341 GHOST_TAxisFlag /*wrap_axis*/,
342 GHOST_Rect * /*bounds*/,
343 int32_t /*mouse_ungrab_xy*/[2])
344 {
345 return GHOST_kSuccess;
346 }
347
351 virtual float getNativePixelSize() = 0;
352
357 virtual uint16_t getDPIHint() = 0;
358
364 virtual bool hasAlpha() const
365 {
366 return false;
367 }
368
375 {
377 }
378
384
385#ifdef WITH_INPUT_IME
397 virtual void beginIME(int32_t x, int32_t y, int32_t w, int32_t h, bool completed) = 0;
398
403 virtual void endIME() = 0;
404#endif /* WITH_INPUT_IME */
405
406 MEM_CXX_CLASS_ALLOC_FUNCS("GHOST:GHOST_IWindow")
407};
void * GHOST_TUserDataPtr
GHOST_TWindowState
GHOST_TStandardCursor
GHOST_TAxisFlag
GHOST_TDrawingContextType
GHOST_TWindowOrder
GHOST_TSuccess
@ GHOST_kSuccess
GHOST_TGrabCursorMode
GHOST_TWindowTiledFlag
@ GHOST_kWindowTiledNone
GHOST_TWindowDecorationStyleFlags
SIMD_FORCE_INLINE const btScalar & w() const
Return the w value.
Definition btQuadWord.h:119
virtual void setTitle(const char *title)=0
virtual void getClientBounds(GHOST_Rect &bounds) const =0
virtual GHOST_TSuccess activateDrawingContext()=0
virtual GHOST_TSuccess getCursorBitmap(GHOST_CursorBitmapRef *bitmap)=0
virtual GHOST_TSuccess endProgressBar()=0
virtual GHOST_TSuccess setCursorShape(GHOST_TStandardCursor cursor_shape)=0
virtual void setWindowDecorationStyleSettings(GHOST_WindowDecorationStyleSettings decoration_settings)=0
virtual GHOST_TSuccess setOrder(GHOST_TWindowOrder order)=0
virtual ~GHOST_IWindow()=default
virtual void clientToScreen(int32_t inX, int32_t inY, int32_t &outX, int32_t &outY) const =0
virtual GHOST_TSuccess setClientHeight(uint32_t height)=0
virtual GHOST_TSuccess setProgressBar(float progress)=0
virtual GHOST_TSuccess setCustomCursorShape(const uint8_t *bitmap, const uint8_t *mask, const int size[2], const int hot_spot[2], bool can_invert_color)=0
virtual GHOST_TSuccess swapBufferRelease()=0
virtual bool isDialog() const =0
virtual GHOST_WindowHDRInfo getHDRInfo()=0
virtual std::string getTitle() const =0
virtual GHOST_TSuccess setClientSize(uint32_t width, uint32_t height)=0
virtual GHOST_TSuccess applyWindowDecorationStyle()=0
virtual GHOST_TSuccess setState(GHOST_TWindowState state)=0
virtual GHOST_TWindowTiledFlag getTiledEdges() const
virtual GHOST_TSuccess setClientWidth(uint32_t width)=0
virtual float getNativePixelSize()=0
virtual GHOST_IContext * getDrawingContext()=0
virtual GHOST_TSuccess setCursorVisibility(bool visible)=0
virtual GHOST_TSuccess getSwapInterval(int &interval_out)=0
virtual void setPath(const char *filepath)=0
virtual void getCursorGrabState(GHOST_TGrabCursorMode &mode, GHOST_TAxisFlag &axis_flag, GHOST_Rect &bounds, bool &use_software_cursor)=0
virtual void screenToClient(int32_t inX, int32_t inY, int32_t &outX, int32_t &outY) const =0
virtual GHOST_TSuccess swapBufferAcquire()=0
virtual void getWindowBounds(GHOST_Rect &bounds) const =0
virtual void setUserData(const GHOST_TUserDataPtr user_data)=0
virtual bool hasAlpha() const
virtual bool getCursorVisibility() const =0
virtual GHOST_TWindowDecorationStyleFlags getWindowDecorationStyleFlags()=0
virtual void setAcceptDragOperation(bool can_accept)=0
virtual GHOST_TSuccess setDrawingContextType(GHOST_TDrawingContextType type)=0
virtual bool getValid() const =0
virtual GHOST_TSuccess setSwapInterval(int interval)=0
virtual GHOST_TUserDataPtr getUserData() const =0
virtual void setWindowDecorationStyleFlags(GHOST_TWindowDecorationStyleFlags style_flags)=0
virtual GHOST_TSuccess invalidate()=0
virtual GHOST_TDrawingContextType getDrawingContextType()=0
virtual GHOST_TSuccess setCustomCursorGenerator(GHOST_CursorGenerator *cursor_generator)=0
virtual GHOST_TStandardCursor getCursorShape() const =0
virtual uint16_t getDPIHint()=0
virtual GHOST_TWindowState getState() const =0
virtual GHOST_TSuccess setCursorGrab(GHOST_TGrabCursorMode, GHOST_TAxisFlag, GHOST_Rect *, int32_t[2])
virtual GHOST_TSuccess setModifiedState(bool is_unsaved_changes)=0
virtual unsigned int getDefaultFramebuffer()=0
virtual GHOST_TSuccess hasCursorShape(GHOST_TStandardCursor cursor_shape)=0
const int state
ccl_device_inline float2 mask(const MaskType mask, const float2 a)