Files
test2/source/blender/gpu/GPU_context.h
Sergey Sharybin c1bc70b711 Cleanup: Add a copyright notice to files and use SPDX format
A lot of files were missing copyright field in the header and
the Blender Foundation contributed to them in a sense of bug
fixing and general maintenance.

This change makes it explicit that those files are at least
partially copyrighted by the Blender Foundation.

Note that this does not make it so the Blender Foundation is
the only holder of the copyright in those files, and developers
who do not have a signed contract with the foundation still
hold the copyright as well.

Another aspect of this change is using SPDX format for the
header. We already used it for the license specification,
and now we state it for the copyright as well, following the
FAQ:

    https://reuse.software/faq/
2023-05-31 16:19:06 +02:00

94 lines
3.2 KiB
C

/* SPDX-FileCopyrightText: 2016 by Mike Erwin. All rights reserved.
*
* SPDX-License-Identifier: GPL-2.0-or-later */
/** \file
* \ingroup gpu
*
* This interface allow GPU to manage VAOs for multiple context and threads.
*/
#pragma once
#include "GPU_batch.h"
#include "GPU_common.h"
#include "GPU_platform.h"
#ifdef __cplusplus
extern "C" {
#endif
/* 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);
void GPU_backend_type_selection_set(const eGPUBackendType backend);
eGPUBackendType GPU_backend_type_selection_get(void);
eGPUBackendType GPU_backend_get_type(void);
/**
* Detect the most suited eGPUBackendType.
*
* - The detected backend will be set in `GPU_backend_type_selection_set`.
* - When GPU_backend_type_selection_is_overridden it checks the overridden backend.
* When not overridden it checks a default list.
* - OpenGL backend will be checked as fallback for Metal.
*
* Returns true when detection found a supported backend, otherwise returns false.
* When no supported backend is found GPU_backend_type_selection_set is called with
* GPU_BACKEND_NONE.
*/
bool GPU_backend_type_selection_detect(void);
/**
* Alter the GPU_backend_type_selection_detect to only test a specific backend
*/
void GPU_backend_type_selection_set_override(eGPUBackendType backend_type);
/**
* Check if the GPU_backend_type_selection_detect is overridden to only test a specific backend.
*/
bool GPU_backend_type_selection_is_overridden(void);
/** Opaque type hiding blender::gpu::Context. */
typedef struct GPUContext GPUContext;
GPUContext *GPU_context_create(void *ghost_window, void *ghost_context);
/**
* To be called after #GPU_context_active_set(ctx_to_destroy).
*/
void GPU_context_discard(GPUContext *);
/**
* Ctx can be NULL.
*/
void GPU_context_active_set(GPUContext *);
GPUContext *GPU_context_active_get(void);
/* Begin and end frame are used to mark the singular boundary representing the lifetime of a whole
* frame. This also acts as a divisor for ensuring workload submission and flushing, especially for
* background rendering when there is no call to present.
* This is required by explicit-API's where there is no implicit workload flushing. */
void GPU_context_begin_frame(GPUContext *ctx);
void GPU_context_end_frame(GPUContext *ctx);
/* Legacy GPU (Intel HD4000 series) do not support sharing GPU objects between GPU
* contexts. EEVEE/Workbench can create different contexts for image/preview rendering, baking or
* compiling. When a legacy GPU is detected (`GPU_use_main_context_workaround()`) any worker
* threads should use the draw manager opengl context and make sure that they are the only one
* using it by locking the main context using these two functions. */
void GPU_context_main_lock(void);
void GPU_context_main_unlock(void);
/* GPU Begin/end work blocks */
void GPU_render_begin(void);
void GPU_render_end(void);
/* For operations which need to run exactly once per frame -- even if there are no render updates.
*/
void GPU_render_step(void);
#ifdef __cplusplus
}
#endif