aboutsummaryrefslogtreecommitdiffhomepage
path: root/plugin/plugin.h
blob: 902d1d7c9a7b632cb4fe4a0696b54ff2b8c7c7ef (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
#ifndef GSR_PLUGIN_H
#define GSR_PLUGIN_H

#ifdef __cplusplus
extern "C" {
#endif

#define GSR_PLUGIN_INTERFACE_MAJOR_VERSION 0
#define GSR_PLUGIN_INTERFACE_MINOR_VERSION 1

#define GSR_PLUGIN_INTERFACE_MAKE_VERSION(major, minor) (((major) << 16) | (minor))
#define GSR_PLUGIN_INTERFACE_VERSION GSR_PLUGIN_INTERFACE_MAKE_VERSION(GSR_PLUGIN_INTERFACE_MAJOR_VERSION, GSR_PLUGIN_INTERFACE_MINOR_VERSION)

#include <stdbool.h>

typedef enum {
    GSR_PLUGIN_GRAPHICS_API_EGL_ES,
    GSR_PLUGIN_GRAPHICS_API_GLX,
} gsr_plugin_graphics_api;

typedef enum {
    GSR_PLUGIN_COLOR_DEPTH_8_BITS,
    GSR_PLUGIN_COLOR_DEPTH_10_BITS,
} gsr_plugin_color_depth;

typedef struct {
    unsigned int width;
    unsigned int height;
} gsr_plugin_draw_params;

typedef struct {
    unsigned int width;
    unsigned int height;
    unsigned int fps;
    gsr_plugin_color_depth color_depth;
    gsr_plugin_graphics_api graphics_api;
} gsr_plugin_init_params;

typedef struct {
    const char *name; /* Mandatory */
    unsigned int version; /* Mandatory, can't be 0 */
    void *userdata; /* Optional */

    /* Optional, called when the plugin is expected to draw something to the current framebuffer */
    void (*draw)(const gsr_plugin_draw_params *params, void *userdata);
} gsr_plugin_init_return;

/* The plugin is expected to implement these functions and export them: */
bool gsr_plugin_init(const gsr_plugin_init_params *params, gsr_plugin_init_return *ret);
void gsr_plugin_deinit(void *userdata);

#ifdef __cplusplus
}
#endif

#endif /* GSR_PLUGIN_H */