GHOST_Context.hh

Go to the documentation of this file.

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

 
#pragma once
 
#include "GHOST_IContext.hh"
#include "GHOST_Types.h"
 
#include <cstdlib> /* For `nullptr`. */
 
class GHOST_Context : public GHOST_IContext {
 protected:
  static thread_local inline GHOST_Context *active_context_;
 
 public:
  GHOST_Context(const GHOST_ContextParams &context_params) : context_params_(context_params) {}

  ~GHOST_Context() override
  {
    if (active_context_ == this) {
      active_context_ = nullptr;
    }
  };

  static inline GHOST_Context *getActiveDrawingContext()
  {
    return active_context_;
  }

  GHOST_TSuccess swapBufferAcquire() override = 0;

  GHOST_TSuccess swapBufferRelease() override = 0;

  GHOST_TSuccess activateDrawingContext() override = 0;

  GHOST_TSuccess releaseDrawingContext() override = 0;

  virtual GHOST_TSuccess initializeDrawingContext() = 0;

  virtual GHOST_TSuccess updateDrawingContext()
  {
    return GHOST_kFailure;
  }

  virtual GHOST_TSuccess releaseNativeHandles() = 0;

  virtual GHOST_TSuccess setSwapInterval(int /*interval*/)
  {
    return GHOST_kFailure;
  }

  virtual GHOST_TSuccess getSwapInterval(int & /*interval*/)
  {
    return GHOST_kFailure;
  }

  void *getUserData()
  {
    return user_data_;
  }

  void setUserData(void *user_data)
  {
    user_data_ = user_data;
  }

  bool isStereoVisual() const
  {
    return context_params_.is_stereo_visual;
  }

  virtual GHOST_TVSyncModes getVSync()
  {
    return context_params_.vsync;
  }

  virtual bool isUpsideDown() const
  {
    return false;
  }

  unsigned int getDefaultFramebuffer() override
  {
    return 0;
  }
 
#ifdef WITH_VULKAN_BACKEND
  virtual GHOST_TSuccess getVulkanHandles(GHOST_VulkanHandles & /* r_handles */) override
  {
    return GHOST_kFailure;
  };
  virtual GHOST_TSuccess getVulkanSwapChainFormat(
      GHOST_VulkanSwapChainData * /*r_swap_chain_data*/) override
  {
    return GHOST_kFailure;
  }

  virtual GHOST_TSuccess setVulkanSwapBuffersCallbacks(
      std::function<void(const GHOST_VulkanSwapChainData *)> /*swap_buffer_draw_callback*/,
      std::function<void(void)> /*swap_buffer_acquired_callback*/,
      std::function<void(GHOST_VulkanOpenXRData *)> /*openxr_acquire_framebuffer_image_callback*/,
      std::function<void(GHOST_VulkanOpenXRData *)> /*openxr_release_framebuffer_image_callback*/)
      override
  {
    return GHOST_kFailure;
  }
#endif
 
 protected:
  GHOST_ContextParams context_params_;

  void *user_data_ = nullptr;
 
#ifdef WITH_OPENGL_BACKEND
  static void initClearGL();
#endif
 
  MEM_CXX_CLASS_ALLOC_FUNCS("GHOST:GHOST_Context")
};
 
#ifdef _WIN32
bool win32_chk(bool result, const char *file = nullptr, int line = 0, const char *text = nullptr);
bool win32_silent_chk(bool result);
 
#  ifndef NDEBUG
#    define WIN32_CHK(x) win32_chk((x), __FILE__, __LINE__, #x)
#  else
#    define WIN32_CHK(x) win32_chk(x)
#  endif
 
#  define WIN32_CHK_SILENT(x, silent) ((silent) ? win32_silent_chk(x) : WIN32_CHK(x))
#endif /* _WIN32 */