GHOST_IContext.hh

Go to the documentation of this file.

/* SPDX-FileCopyrightText: 2001-2002 NaN Holding BV. All rights reserved.
 *
 * SPDX-License-Identifier: GPL-2.0-or-later */

 
#pragma once
 
#include "GHOST_Types.h"
 
#ifdef WITH_VULKAN_BACKEND
#  include <functional>
#endif

class GHOST_IContext {
 public:
  virtual ~GHOST_IContext() = default;

  static GHOST_IContext *getActiveDrawingContext();

  virtual GHOST_TSuccess activateDrawingContext() = 0;

  virtual GHOST_TSuccess releaseDrawingContext() = 0;

  virtual unsigned int getDefaultFramebuffer() = 0;
  virtual GHOST_TSuccess swapBufferAcquire() = 0;

  virtual GHOST_TSuccess swapBufferRelease() = 0;
 
#ifdef WITH_VULKAN_BACKEND
  virtual GHOST_TSuccess getVulkanHandles(GHOST_VulkanHandles &r_handles) = 0;

  virtual GHOST_TSuccess getVulkanSwapChainFormat(
      GHOST_VulkanSwapChainData *r_swap_chain_data) = 0;

  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) = 0;
#endif
 
  MEM_CXX_CLASS_ALLOC_FUNCS("GHOST:GHOST_IContext")
};