mirror of
https://github.com/libretro/RetroArch.git
synced 2024-12-14 20:59:06 +00:00
284 lines
8.4 KiB
C
284 lines
8.4 KiB
C
/* RetroArch - A frontend for libretro.
|
|
* Copyright (C) 2010-2014 - Hans-Kristian Arntzen
|
|
* Copyright (C) 2011-2016 - Daniel De Matteis
|
|
*
|
|
* RetroArch 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 Found-
|
|
* ation, either version 3 of the License, or (at your option) any later version.
|
|
*
|
|
* RetroArch 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 RetroArch.
|
|
* If not, see <http://www.gnu.org/licenses/>.
|
|
*/
|
|
|
|
#ifndef __VIDEO_CONTEXT_DRIVER_H
|
|
#define __VIDEO_CONTEXT_DRIVER_H
|
|
|
|
#include <boolean.h>
|
|
|
|
#include "video_driver.h"
|
|
|
|
#ifdef HAVE_CONFIG_H
|
|
#include "../config.h"
|
|
#endif
|
|
|
|
#ifdef __cplusplus
|
|
extern "C" {
|
|
#endif
|
|
|
|
#ifndef MAX_EGLIMAGE_TEXTURES
|
|
#define MAX_EGLIMAGE_TEXTURES 32
|
|
#endif
|
|
|
|
enum gfx_ctx_api
|
|
{
|
|
GFX_CTX_NONE = 0,
|
|
GFX_CTX_OPENGL_API,
|
|
GFX_CTX_OPENGL_ES_API,
|
|
GFX_CTX_DIRECT3D8_API,
|
|
GFX_CTX_DIRECT3D9_API,
|
|
GFX_CTX_OPENVG_API
|
|
};
|
|
|
|
enum display_metric_types
|
|
{
|
|
DISPLAY_METRIC_NONE = 0,
|
|
DISPLAY_METRIC_MM_WIDTH,
|
|
DISPLAY_METRIC_MM_HEIGHT,
|
|
DISPLAY_METRIC_DPI
|
|
};
|
|
|
|
enum gfx_ctx_ctl_state
|
|
{
|
|
GFX_CTL_NONE = 0,
|
|
GFX_CTL_CHECK_WINDOW,
|
|
GFX_CTL_FOCUS,
|
|
GFX_CTL_DESTROY,
|
|
GFX_CTL_FREE,
|
|
GFX_CTL_SWAP_BUFFERS,
|
|
GFX_CTL_HAS_WINDOWED,
|
|
GFX_CTL_UPDATE_WINDOW_TITLE,
|
|
GFX_CTL_SHOW_MOUSE,
|
|
GFX_CTL_SET,
|
|
GFX_CTL_BIND_HW_RENDER,
|
|
GFX_CTL_GET_VIDEO_OUTPUT_PREV,
|
|
GFX_CTL_GET_VIDEO_OUTPUT_NEXT,
|
|
GFX_CTL_IMAGE_BUFFER_INIT,
|
|
/* Finds next driver in graphics context driver array. */
|
|
GFX_CTL_FIND_NEXT_DRIVER,
|
|
/* Finds previous driver in graphics context driver array. */
|
|
GFX_CTL_FIND_PREV_DRIVER,
|
|
GFX_CTL_GET_VIDEO_OUTPUT_SIZE,
|
|
GFX_CTL_SWAP_INTERVAL,
|
|
GFX_CTL_PROC_ADDRESS_GET,
|
|
GFX_CTL_TRANSLATE_ASPECT,
|
|
GFX_CTL_GET_METRICS
|
|
};
|
|
|
|
typedef void (*gfx_ctx_proc_t)(void);
|
|
|
|
typedef struct gfx_ctx_driver
|
|
{
|
|
/* The opaque pointer is the underlying video driver data (e.g. gl_t for
|
|
* OpenGL contexts). Although not advised, the context driver is allowed
|
|
* to hold a pointer to it as the context never outlives the video driver.
|
|
*
|
|
* The context driver is responsible for it's own data.*/
|
|
void* (*init)(void *video_driver);
|
|
void (*destroy)(void *data);
|
|
|
|
/* Which API to bind to. */
|
|
bool (*bind_api)(void *video_driver, enum gfx_ctx_api,
|
|
unsigned major, unsigned minor);
|
|
|
|
/* Sets the swap interval. */
|
|
void (*swap_interval)(void *data, unsigned);
|
|
|
|
/* Sets video mode. Creates a window, etc. */
|
|
bool (*set_video_mode)(void*, unsigned, unsigned, bool);
|
|
|
|
/* Gets current window size.
|
|
* If not initialized yet, it returns current screen size. */
|
|
void (*get_video_size)(void*, unsigned*, unsigned*);
|
|
|
|
void (*get_video_output_size)(void*, unsigned*, unsigned*);
|
|
|
|
void (*get_video_output_prev)(void*);
|
|
|
|
void (*get_video_output_next)(void*);
|
|
|
|
bool (*get_metrics)(void *data, enum display_metric_types type,
|
|
float *value);
|
|
|
|
/* Translates a window size to an aspect ratio.
|
|
* In most cases this will be just width / height, but
|
|
* some contexts will better know which actual aspect ratio is used.
|
|
* This can be NULL to assume the default behavior.
|
|
*/
|
|
float (*translate_aspect)(void*, unsigned, unsigned);
|
|
|
|
/* Asks driver to update window title (FPS, etc). */
|
|
void (*update_window_title)(void*);
|
|
|
|
/* Queries for resize and quit events.
|
|
* Also processes events. */
|
|
void (*check_window)(void*, bool*, bool*,
|
|
unsigned*, unsigned*, unsigned);
|
|
|
|
/* Acknowledge a resize event. This is needed for some APIs.
|
|
* Most backends will ignore this. */
|
|
bool (*set_resize)(void*, unsigned, unsigned);
|
|
|
|
/* Checks if window has input focus. */
|
|
bool (*has_focus)(void*);
|
|
|
|
/* Should the screensaver be suppressed? */
|
|
bool (*suppress_screensaver)(void *data, bool enable);
|
|
|
|
/* Checks if context driver has windowed support. */
|
|
bool (*has_windowed)(void*);
|
|
|
|
/* Swaps buffers. VBlank sync depends on
|
|
* earlier calls to swap_interval. */
|
|
void (*swap_buffers)(void*);
|
|
|
|
/* Most video backends will want to use a certain input driver.
|
|
* Checks for it here. */
|
|
void (*input_driver)(void*, const input_driver_t**, void**);
|
|
|
|
/* Wraps whatever gl_proc_address() there is.
|
|
* Does not take opaque, to avoid lots of ugly wrapper code. */
|
|
gfx_ctx_proc_t (*get_proc_address)(const char*);
|
|
|
|
/* Returns true if this context supports EGLImage buffers for
|
|
* screen drawing and was initalized correctly. */
|
|
bool (*image_buffer_init)(void*, const video_info_t*);
|
|
|
|
/* Writes the frame to the EGLImage and sets image_handle to it.
|
|
* Returns true if a new image handle is created.
|
|
* Always returns true the first time it's called for a new index.
|
|
* The graphics core must handle a change in the handle correctly. */
|
|
bool (*image_buffer_write)(void*, const void *frame, unsigned width,
|
|
unsigned height, unsigned pitch, bool rgb32,
|
|
unsigned index, void **image_handle);
|
|
|
|
/* Shows or hides mouse. Can be NULL if context doesn't
|
|
* have a concept of mouse pointer. */
|
|
void (*show_mouse)(void *data, bool state);
|
|
|
|
/* Human readable string. */
|
|
const char *ident;
|
|
|
|
/* Optional. Binds HW-render offscreen context. */
|
|
void (*bind_hw_render)(void *data, bool enable);
|
|
} gfx_ctx_driver_t;
|
|
|
|
typedef struct gfx_ctx_size
|
|
{
|
|
bool *quit;
|
|
bool *resize;
|
|
unsigned *width;
|
|
unsigned *height;
|
|
} gfx_ctx_size_t;
|
|
|
|
typedef struct gfx_ctx_metrics
|
|
{
|
|
enum display_metric_types type;
|
|
float *value;
|
|
} gfx_ctx_metrics_t;
|
|
|
|
typedef struct gfx_ctx_aspect
|
|
{
|
|
float *aspect;
|
|
unsigned width;
|
|
unsigned height;
|
|
} gfx_ctx_aspect_t;
|
|
|
|
typedef struct gfx_ctx_image
|
|
{
|
|
const void *frame;
|
|
unsigned width;
|
|
unsigned height;
|
|
unsigned pitch;
|
|
unsigned index;
|
|
bool rgb32;
|
|
void **handle;
|
|
} gfx_ctx_image_t;
|
|
|
|
typedef struct gfx_ctx_input
|
|
{
|
|
const input_driver_t **input;
|
|
void **input_data;
|
|
} gfx_ctx_input_t;
|
|
|
|
typedef struct gfx_ctx_proc_address
|
|
{
|
|
const char *sym;
|
|
retro_proc_address_t addr;
|
|
} gfx_ctx_proc_address_t;
|
|
|
|
extern const gfx_ctx_driver_t gfx_ctx_sdl_gl;
|
|
extern const gfx_ctx_driver_t gfx_ctx_x_egl;
|
|
extern const gfx_ctx_driver_t gfx_ctx_wayland;
|
|
extern const gfx_ctx_driver_t gfx_ctx_glx;
|
|
extern const gfx_ctx_driver_t gfx_ctx_d3d;
|
|
extern const gfx_ctx_driver_t gfx_ctx_drm_egl;
|
|
extern const gfx_ctx_driver_t gfx_ctx_mali_fbdev;
|
|
extern const gfx_ctx_driver_t gfx_ctx_vivante_fbdev;
|
|
extern const gfx_ctx_driver_t gfx_ctx_android;
|
|
extern const gfx_ctx_driver_t gfx_ctx_ps3;
|
|
extern const gfx_ctx_driver_t gfx_ctx_wgl;
|
|
extern const gfx_ctx_driver_t gfx_ctx_videocore;
|
|
extern const gfx_ctx_driver_t gfx_ctx_bbqnx;
|
|
extern const gfx_ctx_driver_t gfx_ctx_cgl;
|
|
extern const gfx_ctx_driver_t gfx_ctx_cocoagl;
|
|
extern const gfx_ctx_driver_t gfx_ctx_emscripten;
|
|
extern const gfx_ctx_driver_t gfx_ctx_null;
|
|
|
|
/**
|
|
* gfx_ctx_init_first:
|
|
* @data : Input data.
|
|
* @ident : Identifier of graphics context driver to find.
|
|
* @api : API of higher-level graphics API.
|
|
* @major : Major version number of higher-level graphics API.
|
|
* @minor : Minor version number of higher-level graphics API.
|
|
* @hw_render_ctx : Request a graphics context driver capable of
|
|
* hardware rendering?
|
|
*
|
|
* Finds first suitable graphics context driver and initializes.
|
|
*
|
|
* Returns: graphics context driver if found, otherwise NULL.
|
|
**/
|
|
const gfx_ctx_driver_t *gfx_ctx_init_first(void *data, const char *ident,
|
|
enum gfx_ctx_api api, unsigned major, unsigned minor, bool hw_render_ctx);
|
|
|
|
bool gfx_ctx_set_video_mode(unsigned width, unsigned height,
|
|
bool fullscreen);
|
|
|
|
bool gfx_ctx_image_buffer_write(const void *frame,
|
|
unsigned width, unsigned height, unsigned pitch, bool rgb32,
|
|
unsigned index, void **image_handle);
|
|
|
|
bool gfx_ctx_suppress_screensaver(bool enable);
|
|
|
|
void gfx_ctx_get_video_size(unsigned *width, unsigned *height);
|
|
|
|
bool gfx_ctx_set_resize(unsigned width, unsigned height);
|
|
|
|
const char *gfx_ctx_get_ident(void);
|
|
|
|
void gfx_ctx_input_driver(
|
|
const input_driver_t **input, void **input_data);
|
|
|
|
bool gfx_ctx_ctl(enum gfx_ctx_ctl_state state, void *data);
|
|
|
|
#ifdef __cplusplus
|
|
}
|
|
#endif
|
|
|
|
#endif
|
|
|