Blender
V3.3
|
#include <GHOST_IWindow.h>
Interface for GHOST windows.
You can create a window with the system's GHOST_ISystem::createWindow method.
There are two coordinate systems:
Definition at line 31 of file GHOST_IWindow.h.
|
inlinevirtual |
Destructor.
Definition at line 36 of file GHOST_IWindow.h.
|
pure virtual |
Activates the drawing context of this window.
Implemented in GHOST_WindowNULL, and GHOST_Window.
Referenced by GHOST_ActivateWindowDrawingContext(), and View().
|
pure virtual |
Implemented in GHOST_WindowWayland, GHOST_WindowX11, GHOST_WindowWin32, GHOST_WindowSDL, GHOST_WindowNULL, and GHOST_WindowCocoa.
Referenced by GHOST_WindowManager::beginFullScreen().
|
pure virtual |
Returns acceptance of the dropped object Usually called by the "object dropped" event handling function
Implemented in GHOST_Window.
|
pure virtual |
Converts a point in client rectangle coordinates to screen coordinates.
inX | The x-coordinate in the client rectangle. |
inY | The y-coordinate in the client rectangle. |
outX | The x-coordinate on the screen. |
outY | The y-coordinate on the screen. |
Implemented in GHOST_WindowWayland, GHOST_WindowX11, GHOST_WindowWin32, GHOST_WindowSDL, GHOST_WindowNULL, and GHOST_WindowCocoa.
Referenced by GHOST_ClientToScreen(), and GHOST_System::setCursorPositionClientRelative().
|
pure virtual |
Implemented in GHOST_WindowWayland, GHOST_WindowX11, GHOST_WindowWin32, GHOST_WindowSDL, GHOST_WindowNULL, and GHOST_WindowCocoa.
Referenced by GHOST_WindowManager::endFullScreen().
|
pure virtual |
Hides the progress bar in the icon
Implemented in GHOST_WindowX11, GHOST_WindowWin32, GHOST_WindowCocoa, and GHOST_Window.
Referenced by GHOST_EndProgressBar().
|
pure virtual |
Returns the client rectangle dimensions. The left and top members of the rectangle are always zero.
bounds | The bounding rectangle of the client area of the window. |
Implemented in GHOST_WindowWayland, GHOST_WindowX11, GHOST_WindowWin32, GHOST_WindowSDL, GHOST_WindowNULL, and GHOST_WindowCocoa.
Referenced by GHOST_GetClientBounds(), GHOST_Window::setCursorGrab(), and View().
|
pure virtual |
Implemented in GHOST_WindowWayland, and GHOST_Window.
Referenced by GHOST_GetCursorBitmap().
|
pure virtual |
Implemented in GHOST_Window.
|
pure virtual |
Implemented in GHOST_Window.
Referenced by GHOST_GetCursorGrabState().
|
pure virtual |
Implemented in GHOST_WindowWayland, and GHOST_Window.
|
pure virtual |
Returns the current cursor shape.
Implemented in GHOST_Window.
Referenced by GHOST_GetCursorShape().
|
pure virtual |
Returns the visibility state of the cursor.
Implemented in GHOST_Window.
Referenced by GHOST_GetCursorVisibility(), and Application::processEvent().
|
pure virtual |
Gets the OpenGL frame-buffer associated with the window's contents.
Implemented in GHOST_Window.
Referenced by GHOST_GetDefaultOpenGLFramebuffer().
|
pure virtual |
Returns the recommended DPI for this window.
Implemented in GHOST_WindowWin32, GHOST_WindowWayland, GHOST_WindowX11, GHOST_WindowSDL, and GHOST_Window.
Referenced by GHOST_GetDPIHint().
|
pure virtual |
Returns the type of drawing context used in this window.
Implemented in GHOST_Window.
Referenced by GHOST_GetDrawingContextType().
|
pure virtual |
Gets the window "modified" status, indicating unsaved changes
Implemented in GHOST_Window.
Implemented in GHOST_Window.
Referenced by GHOST_GetNativePixelSize().
|
pure virtual |
Returns the associated OS object/handle
Implemented in GHOST_WindowCocoa, and GHOST_Window.
|
pure virtual |
Returns the state of the window (normal, minimized, maximized).
Implemented in GHOST_WindowWayland, GHOST_WindowX11, GHOST_WindowWin32, GHOST_WindowSDL, GHOST_WindowNULL, and GHOST_WindowCocoa.
Referenced by GHOST_GetWindowState().
|
pure virtual |
Gets the current swap interval for swapBuffers.
intervalOut | pointer to location to return swap interval. (left untouched if there is an error) |
Implemented in GHOST_Window.
Referenced by GHOST_GetSwapInterval().
|
pure virtual |
Returns the title displayed in the title bar.
title | The title displayed in the title bar. |
Implemented in GHOST_WindowWayland, GHOST_WindowX11, GHOST_WindowWin32, GHOST_WindowSDL, GHOST_WindowNULL, and GHOST_WindowCocoa.
Referenced by GHOST_GetTitle(), and Application::processEvent().
|
pure virtual |
Returns the window user data.
Implemented in GHOST_Window.
Referenced by GHOST_GetWindowUserData().
|
pure virtual |
Returns indication as to whether the window is valid.
Implemented in GHOST_WindowX11, GHOST_WindowWin32, GHOST_WindowSDL, GHOST_WindowNULL, GHOST_WindowCocoa, and GHOST_Window.
Referenced by GHOST_WindowManager::beginFullScreen(), GHOST_SystemCocoa::createWindow(), and GHOST_GetValid().
|
pure virtual |
Returns the window rectangle dimensions. These are screen coordinates.
bounds | The bounding rectangle of the window. |
Implemented in GHOST_WindowWayland, GHOST_WindowX11, GHOST_WindowWin32, GHOST_WindowSDL, GHOST_WindowNULL, and GHOST_WindowCocoa.
Referenced by GHOST_GetWindowBounds().
|
pure virtual |
Test if the standard cursor shape is supported by current platform.
Implemented in GHOST_WindowNULL, GHOST_WindowX11, GHOST_WindowSDL, GHOST_WindowCocoa, and GHOST_WindowWayland.
Referenced by GHOST_HasCursorShape().
|
pure virtual |
Invalidates the contents of this window.
Implemented in GHOST_WindowSDL, GHOST_WindowWayland, GHOST_WindowX11, GHOST_WindowWin32, GHOST_WindowNULL, and GHOST_WindowCocoa.
Referenced by gearsTimerProc(), and GHOST_InvalidateWindow().
|
pure virtual |
Implemented in GHOST_WindowWayland, GHOST_WindowX11, GHOST_WindowWin32, GHOST_WindowCocoa, and GHOST_Window.
Referenced by GHOST_IsDialogWindow().
|
pure virtual |
Converts a point in screen coordinates to client rectangle coordinates
inX | The x-coordinate on the screen. |
inY | The y-coordinate on the screen. |
outX | The x-coordinate in the client rectangle. |
outY | The y-coordinate in the client rectangle. |
Implemented in GHOST_WindowWayland, GHOST_WindowX11, GHOST_WindowWin32, GHOST_WindowSDL, GHOST_WindowNULL, and GHOST_WindowCocoa.
Referenced by GHOST_System::getCursorPositionClientRelative(), and GHOST_ScreenToClient().
Tells if the ongoing drag'n'drop object can be accepted upon mouse drop
Implemented in GHOST_Window.
Referenced by GHOST_setAcceptDragOperation().
|
pure virtual |
Resizes client rectangle height.
height | The new height of the client area of the window. |
Implemented in GHOST_WindowWayland, GHOST_WindowX11, GHOST_WindowWin32, GHOST_WindowSDL, GHOST_WindowNULL, and GHOST_WindowCocoa.
Referenced by GHOST_SetClientHeight().
|
pure virtual |
Resizes client rectangle.
width | The new width of the client area of the window. |
height | The new height of the client area of the window. |
Implemented in GHOST_WindowWayland, GHOST_WindowX11, GHOST_WindowWin32, GHOST_WindowSDL, GHOST_WindowNULL, and GHOST_WindowCocoa.
Referenced by GHOST_SetClientSize().
|
pure virtual |
Resizes client rectangle width.
width | The new width of the client area of the window. |
Implemented in GHOST_WindowWayland, GHOST_WindowX11, GHOST_WindowWin32, GHOST_WindowSDL, GHOST_WindowNULL, and GHOST_WindowCocoa.
Referenced by GHOST_SetClientWidth().
|
inlinevirtual |
Grabs the cursor for a modal operation.
grab | The new grab state of the cursor. |
Reimplemented in GHOST_Window.
Definition at line 308 of file GHOST_IWindow.h.
References GHOST_kSuccess.
Referenced by GHOST_SetCursorGrab().
|
pure virtual |
Set the shape of the cursor.
cursorShape | The new cursor shape type id. |
Implemented in GHOST_Window.
Referenced by GHOST_SetCursorShape(), and Application::processEvent().
|
pure virtual |
Shows or hides the cursor.
visible | The new visibility state of the cursor. |
Implemented in GHOST_Window.
Referenced by GHOST_SetCursorVisibility(), and Application::processEvent().
|
pure virtual |
Set the shape of the cursor to a custom cursor.
bitmap | The bitmap data for the cursor. |
mask | The mask data for the cursor. |
hotX | The X coordinate of the cursor hot-spot. |
hotY | The Y coordinate of the cursor hot-spot. |
Implemented in GHOST_Window.
Referenced by GHOST_SetCustomCursorShape().
|
pure virtual |
Tries to install a rendering context in this window.
type | The type of rendering context installed. |
Implemented in GHOST_Window.
Referenced by GHOST_SetDrawingContextType().
|
pure virtual |
Sets the window "modified" status, indicating unsaved changes
isUnsavedChanges | Unsaved changes or not. |
Implemented in GHOST_WindowCocoa, and GHOST_Window.
Referenced by GHOST_SetWindowModifiedState().
|
pure virtual |
Sets the order of the window (bottom, top).
order | The order of the window. |
Implemented in GHOST_WindowSDL, GHOST_WindowWayland, GHOST_WindowX11, GHOST_WindowWin32, GHOST_WindowNULL, and GHOST_WindowCocoa.
Referenced by GHOST_SetWindowOrder().
|
pure virtual |
Sets the progress bar value displayed in the window/application icon
progress | The progress percentage (0.0 to 1.0). |
Implemented in GHOST_Window, GHOST_WindowX11, GHOST_WindowWin32, and GHOST_WindowCocoa.
Referenced by GHOST_SetProgressBar().
|
pure virtual |
Sets the state of the window (normal, minimized, maximized).
state | The state of the window. |
Implemented in GHOST_WindowWayland, GHOST_WindowX11, GHOST_WindowWin32, GHOST_WindowSDL, GHOST_WindowNULL, and GHOST_WindowCocoa.
Referenced by GHOST_SetWindowState().
|
pure virtual |
Sets the swap interval for swapBuffers.
interval | The swap interval to use. |
Implemented in GHOST_Window.
Referenced by GHOST_SetSwapInterval().
|
pure virtual |
Sets the title displayed in the title bar.
title | The title to display in the title bar. |
Implemented in GHOST_WindowWayland, GHOST_WindowX11, GHOST_WindowWin32, GHOST_WindowSDL, GHOST_WindowNULL, and GHOST_WindowCocoa.
Referenced by GHOST_SetTitle(), and Application::processEvent().
|
pure virtual |
Changes the window user data.
userData | The window user data. |
Implemented in GHOST_Window.
Referenced by GHOST_SetWindowUserData().
|
pure virtual |
Swaps front and back buffers of a window.
Implemented in GHOST_WindowNULL, and GHOST_Window.
Referenced by GHOST_SwapWindowBuffers(), and Application::processEvent().