GHOST_WindowWayland.hh

Go to the documentation of this file.

/* SPDX-FileCopyrightText: 2020-2023 Blender Authors
 *
 * SPDX-License-Identifier: GPL-2.0-or-later */

 
#pragma once
 
#include "GHOST_Window.hh"
 
#include <vector>
 
#include <wayland-util.h> /* For #wl_fixed_t */

#define USE_EVENT_BACKGROUND_THREAD
 
class GHOST_SystemWayland;
 
struct GWL_Output;
struct GWL_Window;
 
class GHOST_WindowWayland : public GHOST_Window {
 public:
  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 API */
 
#ifdef USE_EVENT_BACKGROUND_THREAD
  GHOST_TSuccess swapBufferRelease() override; /* Only for assertion. */
#endif
 
  uint16_t getDPIHint() 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;
 
#ifdef WITH_INPUT_IME
  void beginIME(int32_t x, int32_t y, int32_t w, int32_t h, bool completed) override;
  void endIME() override;
#endif /* WITH_INPUT_IME */
 
  /* WAYLAND direct-data access. */
 
  int scale_get() const;
  const struct GWL_WindowScaleParams &scale_params_get() const;
 
  struct wl_surface *wl_surface_get() const;
  const std::vector<GWL_Output *> &outputs_get();
 
  wl_fixed_t wl_fixed_from_window(wl_fixed_t value) const;
  wl_fixed_t wl_fixed_to_window(wl_fixed_t value) const;
 
  /* WAYLAND window-level functions. */

  GHOST_TSuccess activate();
  GHOST_TSuccess deactivate();
 
  GHOST_TSuccess close();
  GHOST_TSuccess notify_size();
  GHOST_TSuccess notify_decor_redraw();
 
  /* WAYLAND utility functions. */

  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();
 
#ifdef USE_EVENT_BACKGROUND_THREAD
  void pending_actions_handle();
#endif
 
 private:
  GHOST_SystemWayland *system_;
  struct GWL_Window *window_;
  GHOST_GPUDevice preferred_device_;

  GHOST_Context *newDrawingContext(GHOST_TDrawingContextType type) override;
};