Blender V5.3
GHOST_WindowWayland Class Reference

#include <GHOST_WindowWayland.hh>

Inherits GHOST_Window.

Public Member Functions

Public WAYLAND Direct Data Access

Expose some members via methods.

int scale_get () const
const struct GWL_WindowScaleParams & scale_params_get () const
struct wl_surface * wl_surface_get () const
const std::span< GWL_Output *const > outputs_get () const
wl_fixed_t wl_fixed_from_window (wl_fixed_t value) const
wl_fixed_t wl_fixed_to_window (wl_fixed_t value) const
GWL_XDG_WindowIcon & gwl_xdg_icon_get ()
Public WAYLAND Window Level Functions

High Level Windowing Utilities.

GHOST_TSuccess activate ()
GHOST_TSuccess deactivate ()
GHOST_TSuccess close ()
GHOST_TSuccess notify_size ()
GHOST_TSuccess notify_decor_redraw ()
Public WAYLAND Utility Functions

Functionality only used for the WAYLAND implementation.

GHOST_TSuccess cursor_shape_refresh ()
bool outputs_enter (GWL_Output *output)
bool outputs_leave (GWL_Output *output)
bool outputs_changed_update_scale ()
void outputs_changed_update_scale_tag ()
void pending_actions_handle ()
Public Member Functions inherited from GHOST_Window
 GHOST_Window (uint32_t width, uint32_t height, GHOST_TWindowState state, const GHOST_ContextParams &context_params, const bool exclusive=false)
 ~GHOST_Window () override
void setPath (const char *) override
GHOST_TWindowDecorationStyleFlags getWindowDecorationStyleFlags () override
void setWindowDecorationStyleFlags (GHOST_TWindowDecorationStyleFlags style_flags) override
void setWindowDecorationStyleSettings (GHOST_WindowDecorationStyleSettings decoration_settings) override
GHOST_TSuccess applyWindowDecorationStyle () override
GHOST_TStandardCursor getCursorShape () const override
GHOST_TSuccess setCursorShape (GHOST_TStandardCursor cursor_shape) override
GHOST_TSuccess setCustomCursorShape (const uint8_t *bitmap, const uint8_t *mask, const int size[2], const int hot_spot[2], bool can_invert_color) override
GHOST_TSuccess setCustomCursorGenerator (GHOST_CursorGenerator *cursor_generator) override
bool getCursorVisibility () const override
GHOST_TGrabCursorMode getCursorGrabMode () const
bool getCursorGrabModeIsWarp () const
GHOST_TAxisFlag getCursorGrabAxis () const
void getCursorGrabInitPos (int32_t &x, int32_t &y) const
void getCursorGrabAccum (int32_t &x, int32_t &y) const
void setCursorGrabAccum (int32_t x, int32_t y)
GHOST_TSuccess setCursorVisibility (bool visible) override
GHOST_TSuccess setCursorGrab (GHOST_TGrabCursorMode mode, GHOST_TAxisFlag wrap_axis, GHOST_Rect *bounds, int32_t mouse_ungrab_xy[2]) override
void getCursorGrabState (GHOST_TGrabCursorMode &mode, GHOST_TAxisFlag &wrap_axis, GHOST_Rect &bounds, bool &use_software_cursor) override
GHOST_TSuccess setProgressBar (float) override
GHOST_TSuccess endProgressBar () override
GHOST_TSuccess setSwapInterval (int interval) override
GHOST_TSuccess getSwapInterval (int &interval_out) override
void setAcceptDragOperation (bool can_accept) override
GHOST_TSuccess setModifiedState (bool is_unsaved_changes) override
GHOST_TDrawingContextType getDrawingContextType () override
GHOST_TSuccess setDrawingContextType (GHOST_TDrawingContextType type) override
GHOST_IContext * getDrawingContext () override
GHOST_TSuccess swapBufferAcquire () override
GHOST_TSuccess activateDrawingContext () override
GHOST_TSuccess updateDrawingContext ()
GHOST_Context * getContext ()
bool hasAlpha () const override
unsigned int getDefaultFramebuffer () override
GHOST_TUserDataPtr getUserData () const override
void setUserData (const GHOST_TUserDataPtr user_data) override
float getNativePixelSize () override
GHOST_WindowHDRInfo getHDRInfo () override
virtual void * getOSWindow () const
virtual bool canAcceptDragOperation () const
virtual GHOST_TSuccess getCursorGrabBounds (GHOST_Rect &bounds) const
Public Member Functions inherited from GHOST_IWindow
virtual ~GHOST_IWindow ()=default

GHOST Implementation

WAYLAND specific implementation of the GHOST_Window interface.

GHOST_TSuccess hasCursorShape (GHOST_TStandardCursor cursor_shape) override
 GHOST_WindowWayland (GHOST_SystemWayland *system, const char *title, int32_t left, int32_t top, uint32_t width, uint32_t height, GHOST_TWindowState state, const GHOST_IWindow *parent_window, GHOST_TDrawingContextType type, const bool is_dialog, const GHOST_ContextParams &context_params, const bool exclusive, const GHOST_GPUDevice &preferred_device)
 ~GHOST_WindowWayland () override
GHOST_TSuccess swapBufferRelease () override
uint16_t getDPIHint () override
GHOST_TWindowTiledFlag getTiledEdges () const override
GHOST_TSuccess setWindowCursorGrab (GHOST_TGrabCursorMode mode) override
GHOST_TSuccess setWindowCursorShape (GHOST_TStandardCursor shape) override
GHOST_TSuccess setWindowCustomCursorGenerator (GHOST_CursorGenerator *cursor_generator) override
GHOST_TSuccess setWindowCustomCursorShape (const uint8_t *bitmap, const uint8_t *mask, const int size[2], const int hot_spot[2], bool can_invert_color) override
bool getCursorGrabUseSoftwareDisplay () override
GHOST_TSuccess getCursorBitmap (GHOST_CursorBitmapRef *bitmap) override
bool getValid () const override
void setTitle (const char *title) override
std::string getTitle () const override
void getWindowBounds (GHOST_Rect &bounds) const override
void getClientBounds (GHOST_Rect &bounds) const override
GHOST_TSuccess setClientWidth (uint32_t width) override
GHOST_TSuccess setClientHeight (uint32_t height) override
GHOST_TSuccess setClientSize (uint32_t width, uint32_t height) override
void screenToClient (int32_t inX, int32_t inY, int32_t &outX, int32_t &outY) const override
void clientToScreen (int32_t inX, int32_t inY, int32_t &outX, int32_t &outY) const override
GHOST_TSuccess setWindowCursorVisibility (bool visible) override
GHOST_TSuccess setState (GHOST_TWindowState state) override
GHOST_TWindowState getState () const override
GHOST_TSuccess invalidate () override
GHOST_TSuccess setOrder (GHOST_TWindowOrder order) override
bool isDialog () const override

Additional Inherited Members

Protected Member Functions inherited from GHOST_Window
virtual bool getModifiedState ()
GHOST_TSuccess releaseNativeHandles ()
Protected Attributes inherited from GHOST_Window
GHOST_TDrawingContextType drawing_context_type_
GHOST_TUserDataPtr user_data_
bool cursor_visible_
GHOST_TGrabCursorMode cursor_grab_
GHOST_TAxisFlag cursor_grab_axis_
int32_t cursor_grab_init_pos_ [2]
int32_t cursor_grab_accum_pos_ [2]
GHOST_Rect cursor_grab_bounds_
GHOST_TStandardCursor cursor_shape_
bool progress_bar_visible_
bool can_accept_drag_operation_
bool is_unsaved_changes_
bool full_screen_
GHOST_TWindowDecorationStyleFlags window_decoration_style_flags_
GHOST_WindowDecorationStyleSettings window_decoration_style_settings_
GHOST_ContextParams want_context_params_
uint32_t full_screen_width_
uint32_t full_screen_height_
float native_pixel_size_
GHOST_WindowHDRInfo hdr_info_ = GHOST_WINDOW_HDR_INFO_NONE

Detailed Description

Definition at line 105 of file GHOST_WindowWayland.hh.

Constructor & Destructor Documentation

◆ GHOST_WindowWayland()

GHOST_WindowWayland::GHOST_WindowWayland ( GHOST_SystemWayland * system,
const char * title,
int32_t left,
int32_t top,
uint32_t width,
uint32_t height,
GHOST_TWindowState state,
const GHOST_IWindow * parent_window,
GHOST_TDrawingContextType type,
const bool is_dialog,
const GHOST_ContextParams & context_params,
const bool exclusive,
const GHOST_GPUDevice & preferred_device )

Definition at line 1774 of file GHOST_WindowWayland.cc.

References GWL_ImageDescriptionWait::done, FRACTIONAL_DENOMINATOR, GHOST_ASSERT, GHOST_kFailure, GHOST_kSuccess, GHOST_kWindowStateFullScreen, GHOST_PRINT, GHOST_Window::GHOST_Window(), GHOST_WindowWayland(), ghost_wl_display_report_error_if_set(), ghost_wl_surface_tag(), gwl_round_int2_by(), gwl_round_int_test(), gwl_window_frame_pending_fractional_scale_set_notest(), gwl_window_state_set(), gwl_window_title_set(), GHOST_WindowHDRInfo::hdr_enabled, GHOST_Window::hdr_info_, image_description_listener, GWL_XDG_Decor_Window::initial_bounds, GWL_XDG_Decor_Window::initial_configure_seen, outputs_changed_update_scale(), outputs_uniform_scale_or_default(), GWL_ImageDescriptionWait::ready, GHOST_WindowHDRInfo::sdr_white_level, GHOST_SystemWayland::server_mutex, GHOST_Window::setDrawingContextType(), GHOST_Window::setSwapInterval(), GHOST_ContextVK_WindowInfo::size, state, GHOST_SystemWayland::supports_color_manager_extended_srgb_linear(), GHOST_SystemWayland::supports_color_manager_feature_windows_scrgb(), GWL_XDG_Decor_Window::surface, GWL_XDG_Decor_Window::toplevel, GWL_XDG_Decor_Window::toplevel_decor, UNPACK2, GHOST_ContextParams::use_alpha, GHOST_Window::want_context_params_, GHOST_WindowHDRInfo::wide_gamut_enabled, wl_display, wl_display_dispatch, wl_display_dispatch_queue, wl_display_flush, GHOST_SystemWayland::wl_display_get(), wl_egl_window_create, wl_proxy_set_queue, wl_surface_listener, GHOST_SystemWayland::wp_color_manager_get(), GHOST_SystemWayland::wp_color_manager_queue_get(), wp_fractional_scale_listener, GHOST_SystemWayland::wp_fractional_scale_manager_get(), GHOST_SystemWayland::xdg_app_id_get(), xdg_surface_listener, xdg_toplevel_decoration_v1_listener, and xdg_toplevel_listener.

Referenced by GHOST_SystemWayland::createWindow(), GHOST_WindowWayland(), and setWindowCursorShape().

◆ ~GHOST_WindowWayland()

Member Function Documentation

◆ activate()

GHOST_TSuccess GHOST_WindowWayland::activate ( )

Set the window as active and send an GHOST_kEventWindowActivate event.

Note
The current active state is not checked, the caller is responsible for not activating windows which are already active.

Definition at line 2715 of file GHOST_WindowWayland.cc.

References GHOST_kEventWindowActivate, and GHOST_kFailure.

Referenced by gwl_window_frame_update_from_pending_no_lock().

◆ clientToScreen()

void GHOST_WindowWayland::clientToScreen ( int32_t inX,
int32_t inY,
int32_t & outX,
int32_t & outY ) const
overridevirtual

Converts a point in client rectangle coordinates to screen coordinates.

Parameters
inXThe x-coordinate in the client rectangle.
inYThe y-coordinate in the client rectangle.
outXThe x-coordinate on the screen.
outYThe y-coordinate on the screen.

Implements GHOST_IWindow.

Definition at line 2474 of file GHOST_WindowWayland.cc.

◆ close()

GHOST_TSuccess GHOST_WindowWayland::close ( )

Definition at line 2709 of file GHOST_WindowWayland.cc.

References GHOST_kEventWindowClose.

Referenced by xdg_toplevel_handle_close().

◆ cursor_shape_refresh()

GHOST_TSuccess GHOST_WindowWayland::cursor_shape_refresh ( )

Refresh the cursor using the cursor assigned to this window.

Note
This is needed because in GHOST the cursor is per window, where as in WAYLAND the cursor is set per-seat (and per input device). When an input device enters a window, this function must run.

Definition at line 2778 of file GHOST_WindowWayland.cc.

References GHOST_Window::cursor_shape_, GHOST_kSuccess, gwl_window_cursor_shape_refresh(), gwl_window_pending_actions_tag(), and PENDING_WINDOW_CURSOR_SHAPE_REFRESH.

Referenced by cursor_shape_refresh_for_pointer(), pointer_handle_enter(), setWindowCustomCursorGenerator(), tablet_tool_handle_frame(), tablet_tool_handle_proximity_in(), and touch_seat_handle_down().

◆ deactivate()

GHOST_TSuccess GHOST_WindowWayland::deactivate ( )

De-activate the window and send a GHOST_kEventWindowDeactivate event.

Note
The current active state is not checked, the caller is responsible for not de-activating windows that aren't active.

Definition at line 2737 of file GHOST_WindowWayland.cc.

References GHOST_kEventWindowDeactivate.

Referenced by gwl_window_frame_update_from_pending_no_lock().

◆ getClientBounds()

void GHOST_WindowWayland::getClientBounds ( GHOST_Rect & bounds) const
overridevirtual

Returns the client rectangle dimensions. The left and top members of the rectangle are always zero.

Parameters
boundsThe bounding rectangle of the client area of the window.

Implements GHOST_IWindow.

Definition at line 2431 of file GHOST_WindowWayland.cc.

References GHOST_Rect::set(), and UNPACK2.

Referenced by getCursorPositionClientRelative_impl(), getWindowBounds(), relative_pointer_handle_relative_motion_impl(), and setWindowCursorGrab().

◆ getCursorBitmap()

GHOST_TSuccess GHOST_WindowWayland::getCursorBitmap ( GHOST_CursorBitmapRef * bitmap)
overridevirtual

Reimplemented from GHOST_Window.

Definition at line 2399 of file GHOST_WindowWayland.cc.

◆ getCursorGrabUseSoftwareDisplay()

bool GHOST_WindowWayland::getCursorGrabUseSoftwareDisplay ( )
overridevirtual

Return true when a software cursor should be used.

Reimplemented from GHOST_Window.

Definition at line 2347 of file GHOST_WindowWayland.cc.

References GHOST_Window::cursor_grab_.

◆ getDPIHint()

uint16_t GHOST_WindowWayland::getDPIHint ( )
overridevirtual

Returns the recommended DPI for this window.

Returns
The recommended DPI for this window.

Reimplemented from GHOST_Window.

Definition at line 2488 of file GHOST_WindowWayland.cc.

References base_dpi, and gwl_window_fractional_to_viewport().

◆ getState()

GHOST_TWindowState GHOST_WindowWayland::getState ( ) const
overridevirtual

Returns the state of the window (normal, minimized, maximized).

Returns
The state of the window.

Implements GHOST_IWindow.

Definition at line 2530 of file GHOST_WindowWayland.cc.

References gwl_window_state_get().

◆ getTiledEdges()

GHOST_TWindowTiledFlag GHOST_WindowWayland::getTiledEdges ( ) const
overridevirtual

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 from GHOST_IWindow.

Definition at line 2483 of file GHOST_WindowWayland.cc.

◆ getTitle()

std::string GHOST_WindowWayland::getTitle ( ) const
overridevirtual

Returns the title displayed in the title bar.

Returns
The title displayed in the title bar.

Implements GHOST_IWindow.

Definition at line 2420 of file GHOST_WindowWayland.cc.

◆ getValid()

bool GHOST_WindowWayland::getValid ( ) const
overridevirtual

Returns indication as to whether the window is valid.

Returns
The validity of the window.

Reimplemented from GHOST_Window.

Definition at line 2407 of file GHOST_WindowWayland.cc.

References GHOST_Window::getValid().

Referenced by GHOST_SystemWayland::createWindow().

◆ getWindowBounds()

void GHOST_WindowWayland::getWindowBounds ( GHOST_Rect & bounds) const
overridevirtual

Returns the window rectangle dimensions. These are screen coordinates.

Parameters
boundsThe bounding rectangle of the window.

Implements GHOST_IWindow.

Definition at line 2426 of file GHOST_WindowWayland.cc.

References getClientBounds().

◆ gwl_xdg_icon_get()

GWL_XDG_WindowIcon & GHOST_WindowWayland::gwl_xdg_icon_get ( )

◆ hasCursorShape()

GHOST_TSuccess GHOST_WindowWayland::hasCursorShape ( GHOST_TStandardCursor cursor_shape)
overridevirtual

Test if the standard cursor shape is supported by current platform.

Returns
Indication of success.

Implements GHOST_IWindow.

Definition at line 2269 of file GHOST_WindowWayland.cc.

◆ invalidate()

GHOST_TSuccess GHOST_WindowWayland::invalidate ( )
overridevirtual

Invalidates the contents of this window.

Returns
Indication of success.

Implements GHOST_IWindow.

Definition at line 2538 of file GHOST_WindowWayland.cc.

References GHOST_kSuccess.

◆ isDialog()

bool GHOST_WindowWayland::isDialog ( ) const
overridevirtual

Reimplemented from GHOST_Window.

Definition at line 2556 of file GHOST_WindowWayland.cc.

◆ notify_decor_redraw()

GHOST_TSuccess GHOST_WindowWayland::notify_decor_redraw ( )

◆ notify_size()

GHOST_TSuccess GHOST_WindowWayland::notify_size ( )

Definition at line 2756 of file GHOST_WindowWayland.cc.

References GHOST_kEventWindowSize.

Referenced by gwl_window_frame_pending_size_set().

◆ outputs_changed_update_scale()

◆ outputs_changed_update_scale_tag()

◆ outputs_enter()

bool GHOST_WindowWayland::outputs_enter ( GWL_Output * output)

Definition at line 2928 of file GHOST_WindowWayland.cc.

References output.

Referenced by surface_handle_enter().

◆ outputs_get()

const std::span< GWL_Output *const > GHOST_WindowWayland::outputs_get ( ) const

◆ outputs_leave()

bool GHOST_WindowWayland::outputs_leave ( GWL_Output * output)

Definition at line 2938 of file GHOST_WindowWayland.cc.

References output.

Referenced by GHOST_SystemWayland::output_unref(), and surface_handle_leave().

◆ pending_actions_handle()

void GHOST_WindowWayland::pending_actions_handle ( )

◆ scale_get()

int GHOST_WindowWayland::scale_get ( ) const

Definition at line 2645 of file GHOST_WindowWayland.cc.

Referenced by setCursorGrab_use_software_confine().

◆ scale_params_get()

const GWL_WindowScaleParams & GHOST_WindowWayland::scale_params_get ( ) const

◆ screenToClient()

void GHOST_WindowWayland::screenToClient ( int32_t inX,
int32_t inY,
int32_t & outX,
int32_t & outY ) const
overridevirtual

Converts a point in screen coordinates to client rectangle coordinates

Parameters
inXThe x-coordinate on the screen.
inYThe y-coordinate on the screen.
outXThe x-coordinate in the client rectangle.
outYThe y-coordinate in the client rectangle.

Implements GHOST_IWindow.

Definition at line 2465 of file GHOST_WindowWayland.cc.

◆ setClientHeight()

GHOST_TSuccess GHOST_WindowWayland::setClientHeight ( uint32_t height)
overridevirtual

Resizes client rectangle height.

Parameters
heightThe new height of the client area of the window.

Implements GHOST_IWindow.

Definition at line 2442 of file GHOST_WindowWayland.cc.

References setClientSize().

◆ setClientSize()

GHOST_TSuccess GHOST_WindowWayland::setClientSize ( uint32_t width,
uint32_t height )
overridevirtual

Resizes client rectangle.

Parameters
widthThe new width of the client area of the window.
heightThe new height of the client area of the window.

Implements GHOST_IWindow.

Definition at line 2447 of file GHOST_WindowWayland.cc.

References GWL_WindowFrame::buffer_scale, GHOST_kSuccess, gwl_round_int2_by(), gwl_window_frame_pending_size_set(), and GWL_WindowFrame::size.

Referenced by setClientHeight(), and setClientWidth().

◆ setClientWidth()

GHOST_TSuccess GHOST_WindowWayland::setClientWidth ( uint32_t width)
overridevirtual

Resizes client rectangle width.

Parameters
widthThe new width of the client area of the window.

Implements GHOST_IWindow.

Definition at line 2437 of file GHOST_WindowWayland.cc.

References setClientSize().

◆ setOrder()

GHOST_TSuccess GHOST_WindowWayland::setOrder ( GHOST_TWindowOrder order)
overridevirtual

Sets the order of the window (bottom, top).

Parameters
orderThe order of the window.
Returns
Indication of success.

Implements GHOST_IWindow.

Definition at line 2543 of file GHOST_WindowWayland.cc.

References GHOST_kSuccess, GHOST_kWindowOrderTop, and gwl_window_activate().

◆ setState()

GHOST_TSuccess GHOST_WindowWayland::setState ( GHOST_TWindowState state)
overridevirtual

Sets the state of the window (normal, minimized, maximized).

Parameters
stateThe state of the window.
Returns
Indication of success.

Implements GHOST_IWindow.

Definition at line 2522 of file GHOST_WindowWayland.cc.

References GHOST_kFailure, GHOST_kSuccess, gwl_window_state_set(), and state.

◆ setTitle()

void GHOST_WindowWayland::setTitle ( const char * title)
overridevirtual

Sets the title displayed in the title bar.

Parameters
titleThe title to display in the title bar.

Implements GHOST_IWindow.

Definition at line 2412 of file GHOST_WindowWayland.cc.

References gwl_window_title_set().

◆ setWindowCursorGrab()

GHOST_TSuccess GHOST_WindowWayland::setWindowCursorGrab ( GHOST_TGrabCursorMode mode)
overridevirtual

Sets the cursor grab on the window using native window system calls.

Reimplemented from GHOST_Window.

Definition at line 2274 of file GHOST_WindowWayland.cc.

References GHOST_Window::cursor_grab_, GHOST_Window::cursor_grab_axis_, GHOST_Window::cursor_grab_init_pos_, getClientBounds(), GHOST_Window::getCursorGrabBounds(), GHOST_kFailure, GHOST_kGrabWrap, and GHOST_kSuccess.

◆ setWindowCursorShape()

◆ setWindowCursorVisibility()

GHOST_TSuccess GHOST_WindowWayland::setWindowCursorVisibility ( bool visible)
overridevirtual

Sets the cursor visibility on the window using native window system calls.

Implements GHOST_Window.

Definition at line 2505 of file GHOST_WindowWayland.cc.

References GHOST_kSuccess, wl_display, wl_display_dispatch_pending, and wl_display_flush.

◆ setWindowCustomCursorGenerator()

GHOST_TSuccess GHOST_WindowWayland::setWindowCustomCursorGenerator ( GHOST_CursorGenerator * cursor_generator)
overridevirtual

◆ setWindowCustomCursorShape()

GHOST_TSuccess GHOST_WindowWayland::setWindowCustomCursorShape ( const uint8_t * bitmap,
const uint8_t * mask,
const int size[2],
const int hot_size[2],
bool can_invert_color )
overridevirtual

Implements GHOST_Window.

Definition at line 2382 of file GHOST_WindowWayland.cc.

References GHOST_ASSERT, GHOST_kFailure, and mask().

◆ swapBufferRelease()

GHOST_TSuccess GHOST_WindowWayland::swapBufferRelease ( )
overridevirtual

Reimplemented from GHOST_Window.

Definition at line 2262 of file GHOST_WindowWayland.cc.

References GHOST_ASSERT, and GHOST_Window::swapBufferRelease().

◆ wl_fixed_from_window()

wl_fixed_t GHOST_WindowWayland::wl_fixed_from_window ( wl_fixed_t value) const

◆ wl_fixed_to_window()

wl_fixed_t GHOST_WindowWayland::wl_fixed_to_window ( wl_fixed_t value) const

◆ wl_surface_get()

wl_surface * GHOST_WindowWayland::wl_surface_get ( ) const

Definition at line 2691 of file GHOST_WindowWayland.cc.

References wl_surface.

Referenced by gwl_window_activate().


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