|
Blender V5.3
|
#include <GHOST_IWindow.hh>
Inherited by GHOST_Window.
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 34 of file GHOST_IWindow.hh.
|
virtualdefault |
Destructor.
|
pure virtual |
Activates the drawing context of this window.
Implemented in GHOST_Window, and GHOST_WindowNULL.
Referenced by blender::ghost_event_proc(), blender::playanim_toscreen_ex(), blender::wm_ghostwindow_destroy(), and blender::wm_window_set_drawable().
|
pure virtual |
Apply the window decoration style using the current flags and settings.
Implemented in GHOST_Window, GHOST_WindowCocoa, and GHOST_WindowWin32.
Referenced by blender::WM_window_decoration_style_apply().
|
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_WindowCocoa, GHOST_WindowNULL, GHOST_WindowSDL, GHOST_WindowWayland, GHOST_WindowWin32, and GHOST_WindowX11.
Referenced by GHOST_System::setCursorPositionClientRelative(), and blender::wm_cursor_position_to_ghost_screen_coords().
|
pure virtual |
Hides the progress bar in the icon.
Implemented in GHOST_Window, GHOST_WindowCocoa, GHOST_WindowWin32, and GHOST_WindowX11.
Referenced by blender::WM_progress_clear().
|
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_WindowCocoa, GHOST_WindowNULL, GHOST_WindowSDL, GHOST_WindowWayland, GHOST_WindowWin32, and GHOST_WindowX11.
Referenced by blender::gpu::GLContext::activate(), GHOST_System::getWindowUnderCursor(), blender::gpu::GLContext::GLContext(), blender::playanim_window_size_get(), GHOST_Window::setCursorGrab(), and blender::wm_window_update_size_position().
|
pure virtual |
Implemented in GHOST_Window, and GHOST_WindowWayland.
Referenced by blender::wm_software_cursor_draw().
|
pure virtual |
Implemented in GHOST_Window.
Referenced by blender::wm_software_cursor_needed_for_window(), and blender::wm_window_grab_warp_region_is_set().
|
pure virtual |
|
pure virtual |
Returns the visibility state of the cursor.
Implemented in GHOST_Window.
Referenced by blender::wm_software_cursor_needed_for_window().
|
pure virtual |
Gets the OpenGL frame-buffer associated with the window's contents.
Implemented in GHOST_Window.
Referenced by blender::gpu::GLContext::GLContext().
|
pure virtual |
Returns the recommended DPI for this window.
Implemented in GHOST_Window, GHOST_WindowSDL, GHOST_WindowWayland, GHOST_WindowWin32, and GHOST_WindowX11.
Referenced by blender::playanim_toscreen_ex(), blender::playanim_window_contains_point(), blender::playanim_window_font_scale_from_dpi(), blender::WM_window_csd_draw_titlebar(), blender::WM_window_csd_rect_calc(), blender::WM_window_dpi_get_scale(), and blender::WM_window_dpi_set_userdef().
|
pure virtual |
Returns the drawing context used in this window.
Implemented in GHOST_Window.
Referenced by blender::GPU_context_create(), blender::wm_main_playanim_intern(), and blender::wm_window_ghostwindow_add().
|
pure virtual |
Returns the type of drawing context used in this window.
Implemented in GHOST_Window.
|
pure virtual |
Returns high dynamic range color information about this window.
Implemented in GHOST_Window.
Referenced by blender::WM_window_support_hdr_color().
|
pure virtual |
If this window was opened using native pixel size, return the scaling factor.
Implemented in GHOST_Window.
Referenced by blender::ghost_event_proc(), blender::playanim_window_font_scale_from_dpi(), blender::playanim_window_size_get(), blender::playanim_window_zoom(), blender::wm_cursor_arrow_move(), blender::wm_cursor_position_from_ghost_client_coords(), blender::wm_cursor_position_to_ghost_client_coords(), blender::wm_window_close_request(), blender::WM_window_dpi_get_scale(), blender::WM_window_dpi_set_userdef(), blender::WM_window_native_pixel_coords(), blender::WM_window_native_pixel_size(), blender::WM_window_native_pixel_x(), blender::WM_window_native_pixel_y(), and blender::WM_window_open().
|
pure virtual |
Returns the state of the window (normal, minimized, maximized).
Implemented in GHOST_WindowCocoa, GHOST_WindowNULL, GHOST_WindowSDL, GHOST_WindowWayland, GHOST_WindowWin32, and GHOST_WindowX11.
Referenced by GHOST_System::getWindowUnderCursor(), blender::ghost_event_proc(), blender::playanim_toscreen_ex(), blender::playanim_window_contains_point(), blender::wm_draw_update(), blender::WM_stereo3d_enabled(), blender::wm_window_fullscreen_toggle_exec(), blender::wm_window_ghostwindow_add(), blender::WM_window_open(), and blender::wm_window_raise().
|
pure virtual |
Gets the current swap interval for #swapBuffers.
| interval_out | pointer to location to return swap interval. (left untouched if there is an error) |
Implemented in GHOST_Window.
Referenced by blender::wm_window_get_swap_interval().
|
inlinevirtual |
Returns which of the window's edges the compositor has tiled, as a bit-mask of GHOST_TWindowTiledFlag. Zero when the window is free floating, or on backends that don't report tiling.
Reimplemented in GHOST_WindowWayland.
Definition at line 374 of file GHOST_IWindow.hh.
References GHOST_kWindowTiledNone.
|
pure virtual |
Returns the title displayed in the title bar.
Implemented in GHOST_WindowCocoa, GHOST_WindowNULL, GHOST_WindowSDL, GHOST_WindowWayland, GHOST_WindowWin32, and GHOST_WindowX11.
Referenced by blender::WM_window_csd_draw_titlebar().
|
pure virtual |
Returns the window user data.
Implemented in GHOST_Window.
Referenced by blender::ghost_event_proc(), and blender::WM_window_find_under_cursor().
|
pure virtual |
Returns indication as to whether the window is valid.
Implemented in GHOST_Window, GHOST_WindowCocoa, GHOST_WindowNULL, GHOST_WindowSDL, GHOST_WindowWayland, GHOST_WindowWin32, and GHOST_WindowX11.
Referenced by GHOST_SystemCocoa::createWindow().
|
pure virtual |
Returns the window rectangle dimensions. These are screen coordinates.
| bounds | The bounding rectangle of the window. |
Implemented in GHOST_WindowCocoa, GHOST_WindowNULL, GHOST_WindowSDL, GHOST_WindowWayland, GHOST_WindowWin32, and GHOST_WindowX11.
|
pure virtual |
Return the current window decoration style flags.
Implemented in GHOST_Window.
Referenced by blender::WM_window_decoration_style_flags_get().
|
inlinevirtual |
True when the window's frame-buffer has an alpha channel the compositor blends against the desktop. Only requested for client-side-decorations (see WITH_GHOST_CSD) and only true when the driver supports it; callers must handle this returning false.
Reimplemented in GHOST_Window.
Definition at line 364 of file GHOST_IWindow.hh.
|
pure virtual |
Test if the standard cursor shape is supported by current platform.
Implemented in GHOST_WindowCocoa, GHOST_WindowNULL, GHOST_WindowSDL, GHOST_WindowWayland, and GHOST_WindowX11.
Referenced by blender::WM_cursor_set().
|
pure virtual |
Invalidates the contents of this window.
Implemented in GHOST_WindowCocoa, GHOST_WindowNULL, GHOST_WindowSDL, GHOST_WindowWayland, GHOST_WindowWin32, and GHOST_WindowX11.
|
pure virtual |
Implemented in GHOST_Window, GHOST_WindowCocoa, GHOST_WindowWayland, GHOST_WindowWin32, and GHOST_WindowX11.
Referenced by blender::wm_window_copy().
|
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_WindowCocoa, GHOST_WindowNULL, GHOST_WindowSDL, GHOST_WindowWayland, GHOST_WindowWin32, and GHOST_WindowX11.
Referenced by GHOST_System::getCursorPositionClientRelative(), blender::ghost_event_proc(), and blender::wm_cursor_position_from_ghost_screen_coords().
|
pure virtual |
Tells if the ongoing drag & drop object can be accepted upon mouse drop
Implemented in GHOST_Window.
|
pure virtual |
Resizes client rectangle height.
| height | The new height of the client area of the window. |
Implemented in GHOST_WindowCocoa, GHOST_WindowNULL, GHOST_WindowSDL, GHOST_WindowWayland, GHOST_WindowWin32, and GHOST_WindowX11.
|
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_WindowCocoa, GHOST_WindowNULL, GHOST_WindowSDL, GHOST_WindowWayland, GHOST_WindowWin32, and GHOST_WindowX11.
Referenced by blender::playanim_window_zoom(), and blender::wm_window_set_size().
|
pure virtual |
Resizes client rectangle width.
| width | The new width of the client area of the window. |
Implemented in GHOST_WindowCocoa, GHOST_WindowNULL, GHOST_WindowSDL, GHOST_WindowWayland, GHOST_WindowWin32, and GHOST_WindowX11.
|
inlinevirtual |
Grabs the cursor for a modal operation.
| mode | The new grab mode of the cursor. |
Reimplemented in GHOST_Window.
Definition at line 340 of file GHOST_IWindow.hh.
References GHOST_kSuccess.
Referenced by blender::WM_cursor_grab_disable(), and blender::WM_cursor_grab_enable().
|
pure virtual |
Set the shape of the cursor.
| cursor_shape | The new cursor shape type id. |
Implemented in GHOST_Window.
Referenced by blender::WM_cursor_set().
|
pure virtual |
Shows or hides the cursor.
| visible | The new visibility state of the cursor. |
Implemented in GHOST_Window.
Referenced by blender::WM_cursor_set().
|
pure virtual |
Set the cursor generator.
| cursor_generator | An object which generates cursors. Ownership is transferred to GHOST which is responsible for calling it's free method. |
Implemented in GHOST_Window.
Referenced by blender::window_set_custom_cursor_generator(), and blender::wm_cursor_text_generator().
|
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. |
| size | The X,Y size of the cursor in pixels. |
| hot_spot | The X,Y coordinate of the cursor hot-spot. |
Implemented in GHOST_Window.
References mask().
Referenced by blender::window_set_custom_cursor_pixmap(), blender::wm_cursor_text_pixmap(), blender::wm_cursor_time_large(), and blender::wm_cursor_time_small().
|
pure virtual |
Tries to install a rendering context in this window.
| type | The type of rendering context installed. |
Implemented in GHOST_Window.
|
pure virtual |
Sets the window "modified" status, indicating unsaved changes.
| is_unsaved_changes | Unsaved changes or not. |
Implemented in GHOST_Window, and GHOST_WindowCocoa.
Referenced by blender::wm_window_title_state_refresh().
|
pure virtual |
Sets the order of the window (bottom, top).
| order | The order of the window. |
Implemented in GHOST_WindowCocoa, GHOST_WindowNULL, GHOST_WindowSDL, GHOST_WindowWayland, GHOST_WindowWin32, and GHOST_WindowX11.
Referenced by blender::wm_window_lower(), and blender::wm_window_raise().
|
pure virtual |
Sets the file name represented by this window.
| filepath | The file directory. |
Implemented in GHOST_Window, GHOST_WindowCocoa, and GHOST_WindowNULL.
Referenced by blender::wm_window_ghostwindow_ensure(), and blender::WM_window_title_refresh().
|
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_WindowCocoa, GHOST_WindowWin32, and GHOST_WindowX11.
Referenced by blender::WM_progress_set().
|
pure virtual |
Sets the state of the window (normal, minimized, maximized).
| state | The state of the window. |
Implemented in GHOST_WindowCocoa, GHOST_WindowNULL, GHOST_WindowSDL, GHOST_WindowWayland, GHOST_WindowWin32, and GHOST_WindowX11.
References state.
Referenced by blender::wm_window_fullscreen_toggle_exec(), blender::wm_window_ghostwindow_add(), blender::WM_window_open(), and blender::wm_window_raise().
|
pure virtual |
Sets the swap interval for #swapBuffers.
| interval | The swap interval to use. |
Implemented in GHOST_Window.
Referenced by blender::wm_window_set_swap_interval().
|
pure virtual |
Sets the title displayed in the title bar.
| title | The title to display in the title bar. |
Implemented in GHOST_WindowCocoa, GHOST_WindowNULL, GHOST_WindowSDL, GHOST_WindowWayland, GHOST_WindowWin32, and GHOST_WindowX11.
Referenced by blender::WM_window_title_refresh(), and blender::WM_window_title_set().
|
pure virtual |
Changes the window user data.
| user_data | The window user data. |
Implemented in GHOST_Window.
Referenced by blender::wm_file_read_setup_wm_substitute_old_window(), and blender::wm_window_ghostwindow_add().
|
pure virtual |
Set the window decoration style flags.
| style_flags | Window decoration style flags. |
Implemented in GHOST_Window.
Referenced by blender::WM_window_decoration_style_flags_set().
|
pure virtual |
Set the window decoration style settings.
| decoration_settings | Window decoration style settings. |
Implemented in GHOST_Window.
Referenced by blender::wm_window_decoration_style_set_from_theme().
|
pure virtual |
Acquire the next buffer of the swap chain.
Implemented in GHOST_Window.
Referenced by blender::playanim_toscreen_ex(), blender::wm_main_playanim_intern(), and blender::wm_window_swap_buffer_acquire().
|
pure virtual |
Swaps front and back buffers of a window.
Implemented in GHOST_Window, GHOST_WindowNULL, and GHOST_WindowWayland.
Referenced by blender::playanim_toscreen_ex(), blender::wm_main_playanim_intern(), and blender::wm_window_swap_buffer_release().