GPU_context.hh

Go to the documentation of this file.

/* SPDX-FileCopyrightText: 2016 by Mike Erwin. All rights reserved.
 *
 * SPDX-License-Identifier: GPL-2.0-or-later */

 
#pragma once
 
#include "GPU_platform.hh"
 
/* GPU back-ends abstract the differences between different APIs. #GPU_context_create
 * automatically initializes the back-end, and #GPU_context_discard frees it when there
 * are no more contexts. */
 
bool GPU_backend_supported();
void GPU_backend_type_selection_set(const GPUBackendType backend);
GPUBackendType GPU_backend_type_selection_get();
GPUBackendType GPU_backend_get_type();
const char *GPU_backend_get_name();

bool GPU_backend_type_selection_detect();

void GPU_backend_type_selection_set_override(GPUBackendType backend_type);

bool GPU_backend_type_selection_is_overridden();

int GPU_backend_vsync_get();
void GPU_backend_vsync_set_override(int vsync);
bool GPU_backend_vsync_is_overridden();

struct GPUContext;
 
GPUContext *GPU_context_create(void *ghost_window, void *ghost_context);
void GPU_context_discard(GPUContext *);

void GPU_context_active_set(GPUContext *);
GPUContext *GPU_context_active_get();

void GPU_context_begin_frame(GPUContext *ctx);
void GPU_context_end_frame(GPUContext *ctx);

void GPU_context_main_lock();
void GPU_context_main_unlock();

void GPU_render_begin();
void GPU_render_end();

void GPU_render_step(bool force_resource_release = false);

void GPU_backend_ghost_system_set(void *ghost_system_handle);
void *GPU_backend_ghost_system_get();
 
namespace blender::gpu {

class GPUSecondaryContext {
 private:
  void *ghost_context_;
  GPUContext *gpu_context_;
 
 public:
  GPUSecondaryContext();
  ~GPUSecondaryContext();

  void activate();
};
 
}  // namespace blender::gpu