GPU_context.h

Go to the documentation of this file.

/*
 * This program is free software; you can redistribute it and/or
 * modify it under the terms of the GNU General Public License
 * as published by the Free Software Foundation; either version 2
 * of the License, or (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program; if not, write to the Free Software Foundation,
 * Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
 *
 * The Original Code is Copyright (C) 2016 by Mike Erwin.
 * All rights reserved.
 */
 
#pragma once
 
#include "GPU_batch.h"
#include "GPU_common.h"
 
#ifdef __cplusplus
extern "C" {
#endif
 
typedef enum eGPUBackendType {
  GPU_BACKEND_NONE = 0,
  GPU_BACKEND_OPENGL,
} eGPUBackendType;
 
void GPU_backend_init(eGPUBackendType backend);
void GPU_backend_exit(void);
 
typedef struct GPUContext GPUContext;
 
GPUContext *GPU_context_create(void *ghost_window);
void GPU_context_discard(GPUContext *);
 
void GPU_context_active_set(GPUContext *);
GPUContext *GPU_context_active_get(void);
 
/* 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);
 
#ifdef __cplusplus
}
#endif