RetroArch/gfx/video_context_driver.h

259 lines
8.0 KiB
C
Raw Normal View History

/* RetroArch - A frontend for libretro.
2014-01-01 00:50:59 +00:00
* Copyright (C) 2010-2014 - Hans-Kristian Arntzen
2015-01-07 17:06:50 +00:00
* Copyright (C) 2011-2015 - 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 "../driver.h"
#ifdef HAVE_CONFIG_H
#include "../config.h"
#endif
2014-01-22 15:38:42 +00:00
#ifdef __cplusplus
extern "C" {
#endif
2015-01-12 03:19:57 +00:00
#ifndef MAX_EGLIMAGE_TEXTURES
#define MAX_EGLIMAGE_TEXTURES 32
2015-01-12 03:19:57 +00:00
#endif
2012-09-24 23:26:22 +00:00
enum gfx_ctx_api
{
GFX_CTX_OPENGL_API,
GFX_CTX_OPENGL_ES_API,
GFX_CTX_DIRECT3D8_API,
GFX_CTX_DIRECT3D9_API,
2012-09-24 23:26:22 +00:00
GFX_CTX_OPENVG_API
};
enum display_metric_types
{
DISPLAY_METRIC_NONE = 0,
DISPLAY_METRIC_MM_WIDTH,
DISPLAY_METRIC_MM_HEIGHT,
DISPLAY_METRIC_DPI,
};
2012-09-24 23:26:22 +00:00
typedef void (*gfx_ctx_proc_t)(void);
2014-09-08 15:57:18 +00:00
/* The opaque void* argument should be the overlying driver data
* (e.g. gl_t for OpenGL contexts).
*
* This will allow us in the future to have separate contexts
* to separate gl_t structs (if needed).
*
* For now, this is only relevant for D3D. */
2012-09-24 23:26:22 +00:00
typedef struct gfx_ctx_driver
{
bool (*init)(void *data);
void (*destroy)(void *data);
2012-09-24 23:26:22 +00:00
2014-09-08 15:57:18 +00:00
/* Which API to bind to. */
bool (*bind_api)(void *data, enum gfx_ctx_api,
unsigned major, unsigned minor);
2012-09-24 23:26:22 +00:00
2014-09-08 15:57:18 +00:00
/* Sets the swap interval. */
void (*swap_interval)(void *data, unsigned);
2012-09-24 23:26:22 +00:00
2014-09-08 15:57:18 +00:00
/* Sets video mode. Creates a window, etc. */
bool (*set_video_mode)(void*, unsigned, unsigned, bool);
2012-09-24 23:26:22 +00:00
2014-09-08 15:57:18 +00:00
/* Gets current window size.
* If not initialized yet, it returns current screen size. */
void (*get_video_size)(void*, unsigned*, unsigned*);
2012-09-24 23:26:22 +00:00
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);
2014-09-08 15:57:18 +00:00
/* 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);
2012-09-25 11:51:44 +00:00
2014-09-08 15:57:18 +00:00
/* Asks driver to update window title (FPS, etc). */
void (*update_window_title)(void*);
2012-09-24 23:26:22 +00:00
2014-09-08 15:57:18 +00:00
/* Queries for resize and quit events.
* Also processes events. */
void (*check_window)(void*, bool*, bool*,
unsigned*, unsigned*, unsigned);
2012-09-24 23:26:22 +00:00
2014-09-08 15:57:18 +00:00
/* Acknowledge a resize event. This is needed for some APIs.
* Most backends will ignore this. */
void (*set_resize)(void*, unsigned, unsigned);
2012-09-24 23:26:22 +00:00
2014-09-08 15:57:18 +00:00
/* Checks if window has input focus. */
bool (*has_focus)(void*);
2012-09-24 23:26:22 +00:00
2015-01-18 21:32:14 +00:00
/* Should the screensaver be suppressed? */
2015-04-10 06:05:31 +00:00
bool (*suppress_screensaver)(void *data, bool enable);
/* Checks if context driver has windowed support. */
bool (*has_windowed)(void*);
2014-09-08 15:57:18 +00:00
/* Swaps buffers. VBlank sync depends on
* earlier calls to swap_interval. */
void (*swap_buffers)(void*);
2012-09-24 23:26:22 +00:00
2014-09-08 15:57:18 +00:00
/* Most video backends will want to use a certain input driver.
* Checks for it here. */
void (*input_driver)(void*, const input_driver_t**, void**);
2012-09-24 23:26:22 +00:00
2014-09-08 15:57:18 +00:00
/* Wraps whatever gl_proc_address() there is.
* Does not take opaque, to avoid lots of ugly wrapper code. */
2012-09-24 23:26:22 +00:00
gfx_ctx_proc_t (*get_proc_address)(const char*);
2014-09-08 15:57:18 +00:00
/* Returns true if this context supports EGLImage buffers for
* screen drawing and was initalized correctly. */
2015-04-10 07:02:24 +00:00
bool (*image_buffer_init)(void*, const video_info_t*);
2014-09-08 15:57:18 +00:00
/* 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. */
2015-04-10 07:02:24 +00:00
bool (*image_buffer_write)(void*, const void *frame, unsigned width,
2014-09-08 15:57:18 +00:00
unsigned height, unsigned pitch, bool rgb32,
unsigned index, void **image_handle);
2014-09-08 15:57:18 +00:00
/* Shows or hides mouse. Can be NULL if context doesn't
* have a concept of mouse pointer. */
2015-01-18 21:32:14 +00:00
void (*show_mouse)(void *data, bool state);
2013-03-29 12:46:11 +00:00
2014-09-08 15:57:18 +00:00
/* Human readable string. */
2012-09-24 23:26:22 +00:00
const char *ident;
2014-09-08 15:57:18 +00:00
/* Optional. Binds HW-render offscreen context. */
void (*bind_hw_render)(void *data, bool enable);
2012-09-24 23:26:22 +00:00
} gfx_ctx_driver_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;
2012-09-29 09:59:08 +00:00
extern const gfx_ctx_driver_t gfx_ctx_glx;
2014-09-14 04:45:47 +00:00
extern const gfx_ctx_driver_t gfx_ctx_d3d;
2012-09-24 23:26:22 +00:00
extern const gfx_ctx_driver_t gfx_ctx_drm_egl;
2014-06-05 10:28:17 +00:00
extern const gfx_ctx_driver_t gfx_ctx_mali_fbdev;
2014-07-27 20:19:11 +00:00
extern const gfx_ctx_driver_t gfx_ctx_vivante_fbdev;
2012-10-08 22:11:11 +00:00
extern const gfx_ctx_driver_t gfx_ctx_android;
2012-09-24 23:26:22 +00:00
extern const gfx_ctx_driver_t gfx_ctx_ps3;
2012-09-30 09:26:26 +00:00
extern const gfx_ctx_driver_t gfx_ctx_wgl;
2012-09-24 23:26:22 +00:00
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_apple;
extern const gfx_ctx_driver_t gfx_ctx_emscripten;
extern const gfx_ctx_driver_t gfx_ctx_null;
2012-09-24 23:26:22 +00:00
2015-01-09 22:32:32 +00:00
/**
* 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,
2014-10-23 21:09:37 +00:00
enum gfx_ctx_api api, unsigned major, unsigned minor, bool hw_render_ctx);
2014-10-24 05:26:51 +00:00
2015-01-09 22:32:32 +00:00
/**
* find_next_context_driver:
*
* Finds next driver in graphics context driver array.
**/
2014-10-24 05:26:51 +00:00
void find_next_context_driver(void);
2015-01-09 22:32:32 +00:00
/**
* find_prev_context_driver:
*
* Finds previous driver in graphics context driver array.
**/
2014-10-24 05:26:51 +00:00
void find_prev_gfx_context_driver(void);
2012-09-24 23:26:22 +00:00
2015-04-09 16:55:22 +00:00
bool gfx_ctx_get_metrics(enum display_metric_types type, float *value);
void gfx_ctx_translate_aspect(void *data, float *aspect,
unsigned width, unsigned height);
2015-04-10 07:05:07 +00:00
bool gfx_ctx_set_video_mode(void *data,
unsigned width, unsigned height,
bool fullscreen);
void gfx_ctx_swap_buffers(void *data);
bool gfx_ctx_focus(void *data);
2015-04-10 07:02:24 +00:00
bool gfx_ctx_image_buffer_init(void *data, const video_info_t *info);
bool gfx_ctx_image_buffer_write(void *data, const void *frame,
2015-04-10 03:47:36 +00:00
unsigned width, unsigned height, unsigned pitch, bool rgb32,
unsigned index, void **image_handle);
void gfx_ctx_show_mouse(void *data, bool state);
bool gfx_ctx_has_windowed(void *data);
2015-04-10 04:10:05 +00:00
bool gfx_ctx_check_window(void *data, bool *quit, bool *resize,
unsigned *width, unsigned *height);
2015-04-10 04:13:20 +00:00
bool gfx_ctx_suppress_screensaver(void *data, bool enable);
void gfx_ctx_update_window_title(void *data);
2015-04-10 05:12:15 +00:00
void gfx_ctx_get_video_size(void *data, unsigned *width, unsigned *height);
void gfx_ctx_set_resize(void *data, unsigned width, unsigned height);
void gfx_ctx_swap_interval(void *data, unsigned interval);
2015-04-10 07:07:53 +00:00
void gfx_ctx_bind_hw_render(void *data, bool enable);
void gfx_ctx_get_video_output_size(void *data,
unsigned *width, unsigned *height);
void gfx_ctx_get_video_output_prev(void *data);
void gfx_ctx_get_video_output_next(void *data);
void gfx_ctx_free(void *data);
2015-04-10 06:53:45 +00:00
void gfx_ctx_input_driver(void *data,
const input_driver_t **input, void **input_data);
2015-04-10 03:47:36 +00:00
retro_proc_address_t gfx_ctx_get_proc_address(const char *sym);
2014-01-22 15:38:42 +00:00
#ifdef __cplusplus
}
#endif
#endif