filename | src/display.h |
changeset | 1282:9f445c5e252b |
prev | 1256:a9d29fe74bf3 |
author | nkeynes |
date | Tue Mar 27 08:23:52 2012 +1000 (12 years ago) |
permissions | -rw-r--r-- |
last change | Android: Preserve render buffers when switching away from app. - fix gl_read_render_buffer + gl_load_frame_buffer to work in GLES a) glReadPixels only (guaranteed to) work for GL_RGBA,GL_UNSIGNED_BYTE b) glTexSubImage2D can only load GL_RGBA into a GL_RGBA render buffer. |
file | annotate | diff | log | raw |
nkeynes@144 | 1 | /** |
nkeynes@561 | 2 | * $Id$ |
nkeynes@144 | 3 | * |
nkeynes@144 | 4 | * The PC side of the video support (responsible for actually displaying / |
nkeynes@144 | 5 | * rendering frames) |
nkeynes@144 | 6 | * |
nkeynes@144 | 7 | * Copyright (c) 2005 Nathan Keynes. |
nkeynes@144 | 8 | * |
nkeynes@144 | 9 | * This program is free software; you can redistribute it and/or modify |
nkeynes@144 | 10 | * it under the terms of the GNU General Public License as published by |
nkeynes@144 | 11 | * the Free Software Foundation; either version 2 of the License, or |
nkeynes@144 | 12 | * (at your option) any later version. |
nkeynes@144 | 13 | * |
nkeynes@144 | 14 | * This program is distributed in the hope that it will be useful, |
nkeynes@144 | 15 | * but WITHOUT ANY WARRANTY; without even the implied warranty of |
nkeynes@144 | 16 | * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the |
nkeynes@144 | 17 | * GNU General Public License for more details. |
nkeynes@144 | 18 | */ |
nkeynes@144 | 19 | |
nkeynes@736 | 20 | #ifndef lxdream_display_H |
nkeynes@736 | 21 | #define lxdream_display_H 1 |
nkeynes@144 | 22 | |
nkeynes@669 | 23 | #define GL_GLEXT_PROTOTYPES 1 |
nkeynes@669 | 24 | |
nkeynes@144 | 25 | #include <stdint.h> |
nkeynes@700 | 26 | #include <stdio.h> |
nkeynes@144 | 27 | #include <glib.h> |
nkeynes@540 | 28 | #include "lxdream.h" |
nkeynes@755 | 29 | #include "gettext.h" |
nkeynes@1072 | 30 | #include "config.h" |
nkeynes@540 | 31 | #ifdef APPLE_BUILD |
nkeynes@540 | 32 | #include <OpenGL/gl.h> |
nkeynes@540 | 33 | #include <OpenGL/glext.h> |
nkeynes@540 | 34 | #else |
nkeynes@1239 | 35 | #if HAVE_GLES2 |
nkeynes@1239 | 36 | #include <GLES2/gl2.h> |
nkeynes@1239 | 37 | #include <GLES2/gl2ext.h> |
nkeynes@1239 | 38 | #else |
nkeynes@327 | 39 | #include <GL/gl.h> |
nkeynes@540 | 40 | #include <GL/glext.h> |
nkeynes@540 | 41 | #endif |
nkeynes@1239 | 42 | #endif |
nkeynes@144 | 43 | |
nkeynes@144 | 44 | #ifdef __cplusplus |
nkeynes@144 | 45 | extern "C" { |
nkeynes@144 | 46 | #endif |
nkeynes@144 | 47 | |
nkeynes@144 | 48 | /** |
nkeynes@477 | 49 | * Supported colour formats. Note that BGRA4444 is only ever used for texture |
nkeynes@144 | 50 | * rendering (it's not valid for display purposes). |
nkeynes@144 | 51 | */ |
nkeynes@477 | 52 | #define COLFMT_BGRA1555 0 |
nkeynes@144 | 53 | #define COLFMT_RGB565 1 |
nkeynes@477 | 54 | #define COLFMT_BGRA4444 2 |
nkeynes@144 | 55 | #define COLFMT_YUV422 3 /* 8-bit YUV (texture source only) */ |
nkeynes@477 | 56 | #define COLFMT_BGR888 4 /* 24-bit BGR */ |
nkeynes@477 | 57 | #define COLFMT_BGRA8888 5 |
nkeynes@144 | 58 | #define COLFMT_INDEX4 6 /* 4 bit indexed colour (texture source only) */ |
nkeynes@144 | 59 | #define COLFMT_INDEX8 7 /* 8-bit indexed colour (texture source only) */ |
nkeynes@477 | 60 | #define COLFMT_BGR0888 8 /* 32-bit BGR */ |
nkeynes@477 | 61 | #define COLFMT_RGB888 9 /* 24-bit RGB (ie GL native) */ |
nkeynes@327 | 62 | |
nkeynes@850 | 63 | /** |
nkeynes@850 | 64 | * The standard display size (for the purposes of mouse inputs, etc, is 640x480 - |
nkeynes@850 | 65 | * events should be adjusted accordingly if this is not the actual window size. |
nkeynes@850 | 66 | */ |
nkeynes@850 | 67 | #define DISPLAY_WIDTH 640 |
nkeynes@850 | 68 | #define DISPLAY_HEIGHT 480 |
nkeynes@850 | 69 | |
nkeynes@327 | 70 | struct colour_format { |
nkeynes@327 | 71 | GLint type, format, int_format; |
nkeynes@327 | 72 | int bpp; |
nkeynes@327 | 73 | }; |
nkeynes@327 | 74 | extern struct colour_format colour_formats[]; |
nkeynes@144 | 75 | |
nkeynes@162 | 76 | extern int colour_format_bytes[]; |
nkeynes@162 | 77 | |
nkeynes@352 | 78 | /** |
nkeynes@352 | 79 | * Structure to hold pixel data held in GL buffers. |
nkeynes@352 | 80 | */ |
nkeynes@477 | 81 | struct render_buffer { |
nkeynes@352 | 82 | uint32_t width; |
nkeynes@352 | 83 | uint32_t height; |
nkeynes@144 | 84 | uint32_t rowstride; |
nkeynes@674 | 85 | uint32_t colour_format; |
nkeynes@352 | 86 | sh4addr_t address; /* Address buffer was rendered to, or -1 for unrendered */ |
nkeynes@352 | 87 | uint32_t size; /* Size of buffer in bytes, must be width*height*bpp */ |
nkeynes@477 | 88 | gboolean inverted;/* True if the buffer is upside down */ |
nkeynes@674 | 89 | uint32_t scale; |
nkeynes@805 | 90 | GLuint tex_id; /* texture bound to render buffer, if any (0 = none). |
nkeynes@805 | 91 | * The render buffer does not own the texture */ |
nkeynes@424 | 92 | unsigned int buf_id; /* driver-specific buffer id, if applicable */ |
nkeynes@352 | 93 | gboolean flushed; /* True if the buffer has been flushed to vram */ |
nkeynes@477 | 94 | }; |
nkeynes@144 | 95 | |
nkeynes@144 | 96 | /** |
nkeynes@352 | 97 | * Structure to hold pixel data stored in pvr2 vram, as opposed to data in |
nkeynes@352 | 98 | * GL buffers. |
nkeynes@352 | 99 | */ |
nkeynes@477 | 100 | struct frame_buffer { |
nkeynes@352 | 101 | uint32_t width; |
nkeynes@352 | 102 | uint32_t height; |
nkeynes@352 | 103 | uint32_t rowstride; |
nkeynes@1282 | 104 | uint32_t colour_format; /* Colour format that the dreamcast expects the data to be in */ |
nkeynes@352 | 105 | sh4addr_t address; |
nkeynes@352 | 106 | uint32_t size; /* Size of buffer in bytes, must be width*height*bpp */ |
nkeynes@477 | 107 | gboolean inverted;/* True if the buffer is upside down */ |
nkeynes@502 | 108 | unsigned char *data; |
nkeynes@477 | 109 | }; |
nkeynes@352 | 110 | |
nkeynes@863 | 111 | struct display_capabilities { |
nkeynes@1134 | 112 | gboolean has_gl; |
nkeynes@1256 | 113 | gboolean has_sl; |
nkeynes@1282 | 114 | gboolean has_bgra; |
nkeynes@1251 | 115 | int depth_bits; |
nkeynes@863 | 116 | int stencil_bits; /* 0 = no stencil buffer */ |
nkeynes@863 | 117 | }; |
nkeynes@863 | 118 | |
nkeynes@1159 | 119 | struct vertex_buffer { |
nkeynes@1159 | 120 | /** |
nkeynes@1159 | 121 | * Map the buffer into the host address space (if necessary) in preparation |
nkeynes@1159 | 122 | * for filling the buffer. This also implies a fence operation. |
nkeynes@1159 | 123 | * @param buf previously allocated buffer |
nkeynes@1159 | 124 | * @param size number of bytes of the buffer actually to be used. The buffer |
nkeynes@1159 | 125 | * will be resized if necessary. |
nkeynes@1159 | 126 | * @return a pointer to the start of the buffer. |
nkeynes@1159 | 127 | */ |
nkeynes@1159 | 128 | void *(*map)(vertex_buffer_t buf, uint32_t size); |
nkeynes@1159 | 129 | |
nkeynes@1159 | 130 | /** |
nkeynes@1159 | 131 | * Unmap the buffer, after the vertex data is written. |
nkeynes@1159 | 132 | * @return the buffer base to use for gl*Pointer calls |
nkeynes@1159 | 133 | */ |
nkeynes@1159 | 134 | void *(*unmap)(vertex_buffer_t buf); |
nkeynes@1159 | 135 | |
nkeynes@1159 | 136 | /** |
nkeynes@1159 | 137 | * Mark the buffer as finished, indicating that the vertex data is no |
nkeynes@1159 | 138 | * longer required (ie rendering is complete). |
nkeynes@1159 | 139 | */ |
nkeynes@1159 | 140 | void (*finished)(vertex_buffer_t buf); |
nkeynes@1159 | 141 | |
nkeynes@1159 | 142 | /** |
nkeynes@1159 | 143 | * Delete the buffer and all associated resources. |
nkeynes@1159 | 144 | */ |
nkeynes@1159 | 145 | void (*destroy)(vertex_buffer_t buf); |
nkeynes@1159 | 146 | |
nkeynes@1159 | 147 | /* Private data */ |
nkeynes@1159 | 148 | void *data; |
nkeynes@1159 | 149 | GLuint id; |
nkeynes@1159 | 150 | uint32_t capacity; |
nkeynes@1159 | 151 | uint32_t mapped_size; |
nkeynes@1159 | 152 | GLuint fence; |
nkeynes@1159 | 153 | }; |
nkeynes@1159 | 154 | |
nkeynes@1159 | 155 | |
nkeynes@352 | 156 | /** |
nkeynes@352 | 157 | * Core video driver - exports function to setup a GL context, as well as handle |
nkeynes@352 | 158 | * keyboard input and display resultant output. |
nkeynes@144 | 159 | */ |
nkeynes@144 | 160 | typedef struct display_driver { |
nkeynes@144 | 161 | char *name; |
nkeynes@144 | 162 | /** |
nkeynes@700 | 163 | * Short (<60 chars) description of the driver. This should be marked for |
nkeynes@700 | 164 | * localization. |
nkeynes@700 | 165 | */ |
nkeynes@700 | 166 | char *description; |
nkeynes@700 | 167 | /** |
nkeynes@144 | 168 | * Initialize the driver. This is called only once at startup time, and |
nkeynes@144 | 169 | * is guaranteed to be called before any other methods. |
nkeynes@144 | 170 | * @return TRUE if the driver was successfully initialized, otherwise |
nkeynes@144 | 171 | * FALSE. |
nkeynes@144 | 172 | */ |
nkeynes@144 | 173 | gboolean (*init_driver)(void); |
nkeynes@144 | 174 | |
nkeynes@144 | 175 | /** |
nkeynes@144 | 176 | * Cleanly shutdown the driver. Normally only called at system shutdown |
nkeynes@144 | 177 | * time. |
nkeynes@144 | 178 | */ |
nkeynes@144 | 179 | void (*shutdown_driver)(void); |
nkeynes@144 | 180 | |
nkeynes@144 | 181 | /** |
nkeynes@144 | 182 | * Given a particular keysym, return the keycode associated with it. |
nkeynes@144 | 183 | * @param keysym The keysym to be resolved, ie "Tab" |
nkeynes@144 | 184 | * @return the display-specific keycode, or 0 if the keysym cannot |
nkeynes@144 | 185 | * be resolved. |
nkeynes@144 | 186 | */ |
nkeynes@144 | 187 | uint16_t (*resolve_keysym)( const gchar *keysym ); |
nkeynes@144 | 188 | |
nkeynes@144 | 189 | /** |
nkeynes@608 | 190 | * Given a native system keycode, convert it to a dreamcast keyboard code. |
nkeynes@608 | 191 | */ |
nkeynes@608 | 192 | uint16_t (*convert_to_dckeysym)( uint16_t keycode ); |
nkeynes@608 | 193 | |
nkeynes@608 | 194 | /** |
nkeynes@614 | 195 | * Given a device-specific event code, return the corresponding keysym. |
nkeynes@614 | 196 | * The string should be newly allocated (caller will free) |
nkeynes@614 | 197 | */ |
nkeynes@614 | 198 | gchar *(*get_keysym_for_keycode)( uint16_t keycode ); |
nkeynes@614 | 199 | |
nkeynes@614 | 200 | /** |
nkeynes@805 | 201 | * Create a render target with the given width and height. If a texture ID |
nkeynes@805 | 202 | * is supplied (non-zero), the render buffer writes its output to that texture. |
nkeynes@805 | 203 | * @param tex_id 0 or a valid GL texture name which must have been initialized to |
nkeynes@805 | 204 | * the correct dimensions. |
nkeynes@144 | 205 | */ |
nkeynes@805 | 206 | render_buffer_t (*create_render_buffer)( uint32_t width, uint32_t height, GLuint tex_id ); |
nkeynes@144 | 207 | |
nkeynes@144 | 208 | /** |
nkeynes@352 | 209 | * Destroy the specified render buffer and release any associated |
nkeynes@352 | 210 | * resources. |
nkeynes@144 | 211 | */ |
nkeynes@352 | 212 | void (*destroy_render_buffer)( render_buffer_t buffer ); |
nkeynes@352 | 213 | |
nkeynes@144 | 214 | /** |
nkeynes@352 | 215 | * Set the current rendering target to the specified buffer. |
nkeynes@144 | 216 | */ |
nkeynes@352 | 217 | gboolean (*set_render_target)( render_buffer_t buffer ); |
nkeynes@352 | 218 | |
nkeynes@352 | 219 | /** |
nkeynes@805 | 220 | * Complete rendering and clear the current rendering target. If the |
nkeynes@805 | 221 | * buffer has a bound texture, it will be updated if necessary. |
nkeynes@805 | 222 | */ |
nkeynes@805 | 223 | void (*finish_render)( render_buffer_t buffer ); |
nkeynes@805 | 224 | |
nkeynes@805 | 225 | /** |
nkeynes@477 | 226 | * Load the supplied frame buffer into the given render buffer. |
nkeynes@477 | 227 | * Included here to allow driver-specific optimizations. |
nkeynes@352 | 228 | */ |
nkeynes@477 | 229 | void (*load_frame_buffer)( frame_buffer_t frame, render_buffer_t render ); |
nkeynes@352 | 230 | |
nkeynes@352 | 231 | /** |
nkeynes@352 | 232 | * Display a single frame using a previously rendered GL buffer. |
nkeynes@352 | 233 | */ |
nkeynes@669 | 234 | void (*display_render_buffer)( render_buffer_t buffer ); |
nkeynes@144 | 235 | |
nkeynes@144 | 236 | /** |
nkeynes@144 | 237 | * Display a single blanked frame using a fixed colour for the |
nkeynes@477 | 238 | * entire frame (specified in BGR888 format). |
nkeynes@144 | 239 | */ |
nkeynes@669 | 240 | void (*display_blank)( uint32_t rgb ); |
nkeynes@144 | 241 | |
nkeynes@144 | 242 | /** |
nkeynes@1076 | 243 | * Swap front/back window buffers |
nkeynes@1076 | 244 | */ |
nkeynes@1076 | 245 | void (*swap_buffers)(); |
nkeynes@1076 | 246 | |
nkeynes@1076 | 247 | /** |
nkeynes@352 | 248 | * Copy the image data from the GL buffer to the target memory buffer, |
nkeynes@352 | 249 | * using the format etc from the buffer. This may force a glFinish() |
nkeynes@352 | 250 | * but does not invalidate the buffer. |
nkeynes@477 | 251 | * @param target buffer to fill with image data, which must be large enough |
nkeynes@477 | 252 | * to accomodate the image. |
nkeynes@477 | 253 | * @param buffer Render buffer to read from. |
nkeynes@477 | 254 | * @param rowstride rowstride of the target data |
nkeynes@477 | 255 | * @param format colour format to output the data in. |
nkeynes@144 | 256 | */ |
nkeynes@477 | 257 | gboolean (*read_render_buffer)( unsigned char *target, render_buffer_t buffer, |
nkeynes@736 | 258 | int rowstride, int format ); |
nkeynes@352 | 259 | |
nkeynes@1134 | 260 | /** |
nkeynes@1159 | 261 | * Create a new vertex buffer |
nkeynes@1159 | 262 | */ |
nkeynes@1159 | 263 | vertex_buffer_t (*create_vertex_buffer)( ); |
nkeynes@1159 | 264 | |
nkeynes@1159 | 265 | /** |
nkeynes@1134 | 266 | * Dump driver-specific information about the implementation to the given stream |
nkeynes@1134 | 267 | */ |
nkeynes@1134 | 268 | void (*print_info)( FILE *out ); |
nkeynes@1134 | 269 | |
nkeynes@863 | 270 | struct display_capabilities capabilities; |
nkeynes@1159 | 271 | |
nkeynes@144 | 272 | } *display_driver_t; |
nkeynes@144 | 273 | |
nkeynes@700 | 274 | /** |
nkeynes@700 | 275 | * Print the configured video drivers to the output stream, one to a line. |
nkeynes@700 | 276 | */ |
nkeynes@700 | 277 | void print_display_drivers( FILE *out ); |
nkeynes@531 | 278 | display_driver_t get_display_driver_by_name( const char *name ); |
nkeynes@370 | 279 | gboolean display_set_driver( display_driver_t driver ); |
nkeynes@144 | 280 | |
nkeynes@144 | 281 | extern uint32_t pvr2_frame_counter; |
nkeynes@144 | 282 | |
nkeynes@144 | 283 | extern display_driver_t display_driver; |
nkeynes@144 | 284 | |
nkeynes@144 | 285 | extern struct display_driver display_gtk_driver; |
nkeynes@681 | 286 | extern struct display_driver display_osx_driver; |
nkeynes@1244 | 287 | extern struct display_driver display_gl_driver; |
nkeynes@1245 | 288 | extern struct display_driver display_egl_driver; |
nkeynes@144 | 289 | extern struct display_driver display_null_driver; |
nkeynes@144 | 290 | |
nkeynes@144 | 291 | /****************** Input methods **********************/ |
nkeynes@144 | 292 | |
nkeynes@849 | 293 | #define MAX_MOUSE_BUTTONS 32 |
nkeynes@849 | 294 | |
nkeynes@1010 | 295 | /* Pressure is 0..127 (allowing a joystick to be defined as two half-axes of 7- bits each) */ |
nkeynes@1010 | 296 | #define MAX_PRESSURE 0x7F |
nkeynes@1010 | 297 | |
nkeynes@1072 | 298 | typedef key_binding_t input_key_callback_t; |
nkeynes@144 | 299 | |
nkeynes@608 | 300 | /** |
nkeynes@608 | 301 | * Callback to receive mouse input events |
nkeynes@608 | 302 | * @param data pointer passed in at the time the hook was registered |
nkeynes@608 | 303 | * @param buttons bitmask of button states, where bit 0 is button 0 (left), bit 1 is button |
nkeynes@608 | 304 | * 1 (middle), bit 2 is button 2 (right) and so forth. |
nkeynes@608 | 305 | * @param x Horizontal movement since the last invocation (in relative mode) or window position |
nkeynes@608 | 306 | * (in absolute mode). |
nkeynes@608 | 307 | * @param y Vertical movement since the last invocation (in relative mode) or window position |
nkeynes@608 | 308 | * (in absolute mode). |
nkeynes@839 | 309 | * @param absolute If TRUE, x and y are the current window coordinates |
nkeynes@839 | 310 | * of the mouse cursor. Otherwise, x and y are deltas from the previous mouse position. |
nkeynes@608 | 311 | */ |
nkeynes@839 | 312 | typedef void (*input_mouse_callback_t)( void *data, uint32_t buttons, int32_t x, int32_t y, gboolean absolute ); |
nkeynes@608 | 313 | |
nkeynes@144 | 314 | gboolean input_register_key( const gchar *keysym, input_key_callback_t callback, |
nkeynes@736 | 315 | void *data, uint32_t value ); |
nkeynes@144 | 316 | |
nkeynes@451 | 317 | void input_unregister_key( const gchar *keysym, input_key_callback_t callback, |
nkeynes@736 | 318 | void *data, uint32_t value ); |
nkeynes@144 | 319 | |
nkeynes@1072 | 320 | gboolean input_register_keygroup( lxdream_config_group_t group ); |
nkeynes@1072 | 321 | void input_unregister_keygroup( lxdream_config_group_t group ); |
nkeynes@1072 | 322 | gboolean input_keygroup_changed( void *data, lxdream_config_group_t group, unsigned key, |
nkeynes@1072 | 323 | const gchar *oldval, const gchar *newval ); |
nkeynes@1072 | 324 | |
nkeynes@608 | 325 | /** |
nkeynes@849 | 326 | * Register a hook to receive all keyboard input events |
nkeynes@608 | 327 | */ |
nkeynes@849 | 328 | gboolean input_register_keyboard_hook( input_key_callback_t callback, void *data ); |
nkeynes@849 | 329 | void input_unregister_keyboard_hook( input_key_callback_t callback, void *data ); |
nkeynes@608 | 330 | |
nkeynes@608 | 331 | /** |
nkeynes@608 | 332 | * Register a mouse event hook. |
nkeynes@608 | 333 | * @param relative TRUE if the caller wants relative mouse movement, FALSE for |
nkeynes@608 | 334 | * absolute mouse positioning. It's not generally possible to receive both at the same time. |
nkeynes@608 | 335 | */ |
nkeynes@608 | 336 | gboolean input_register_mouse_hook( gboolean relative, input_mouse_callback_t callback, void *data ); |
nkeynes@608 | 337 | void input_unregister_mouse_hook( input_mouse_callback_t callback, void *data ); |
nkeynes@608 | 338 | |
nkeynes@144 | 339 | gboolean input_is_key_valid( const gchar *keysym ); |
nkeynes@144 | 340 | |
nkeynes@144 | 341 | gboolean input_is_key_registered( const gchar *keysym ); |
nkeynes@144 | 342 | |
nkeynes@614 | 343 | uint16_t input_keycode_to_dckeysym( uint16_t keycode ); |
nkeynes@144 | 344 | |
nkeynes@614 | 345 | /********************** Display/Input methods ***********************/ |
nkeynes@614 | 346 | |
nkeynes@614 | 347 | /** |
nkeynes@614 | 348 | * Auxilliary input driver - provides input separate to and in addition to the |
nkeynes@614 | 349 | * core UI/display. (primarily used for joystick devices) |
nkeynes@614 | 350 | */ |
nkeynes@614 | 351 | typedef struct input_driver { |
nkeynes@614 | 352 | const char *id; /* Short identifier to display in the UI for the device (eg "JS0" ) */ |
nkeynes@614 | 353 | |
nkeynes@614 | 354 | /** |
nkeynes@614 | 355 | * Given a particular keysym, return the keycode associated with it. |
nkeynes@614 | 356 | * @param keysym The keysym to be resolved, ie "Tab" |
nkeynes@614 | 357 | * @return the display-specific keycode, or 0 if the keysym cannot |
nkeynes@614 | 358 | * be resolved. |
nkeynes@614 | 359 | */ |
nkeynes@614 | 360 | uint16_t (*resolve_keysym)( struct input_driver *driver, const gchar *keysym ); |
nkeynes@614 | 361 | |
nkeynes@614 | 362 | /** |
nkeynes@614 | 363 | * Given a device-specific event code, convert it to a dreamcast keyboard code. |
nkeynes@614 | 364 | * This is only required for actual keyboard devices, other devices should just |
nkeynes@614 | 365 | * leave this method NULL. |
nkeynes@614 | 366 | */ |
nkeynes@614 | 367 | uint16_t (*convert_to_dckeysym)( struct input_driver *driver, uint16_t keycode ); |
nkeynes@614 | 368 | |
nkeynes@614 | 369 | /** |
nkeynes@614 | 370 | * Given a device-specific event code, return the corresponding keysym. |
nkeynes@614 | 371 | * The string should be newly allocated (caller will free) |
nkeynes@614 | 372 | */ |
nkeynes@614 | 373 | gchar *(*get_keysym_for_keycode)( struct input_driver *driver, uint16_t keycode ); |
nkeynes@614 | 374 | |
nkeynes@614 | 375 | /** |
nkeynes@614 | 376 | * Destroy the input driver. |
nkeynes@614 | 377 | */ |
nkeynes@614 | 378 | void (*destroy)( struct input_driver *driver ); |
nkeynes@614 | 379 | |
nkeynes@614 | 380 | } *input_driver_t; |
nkeynes@614 | 381 | |
nkeynes@849 | 382 | extern struct input_driver system_mouse_driver; |
nkeynes@849 | 383 | |
nkeynes@614 | 384 | /** |
nkeynes@614 | 385 | * Register a new input driver (which must have a unique name) |
nkeynes@614 | 386 | * @param driver the driver to register |
nkeynes@614 | 387 | * @param max_keycode the highest possible keycode reported by the device |
nkeynes@614 | 388 | * @return TRUE on success, FALSE on failure (eg driver already registed). |
nkeynes@614 | 389 | */ |
nkeynes@614 | 390 | gboolean input_register_device( input_driver_t driver, uint16_t max_keycode ); |
nkeynes@614 | 391 | |
nkeynes@614 | 392 | /** |
nkeynes@615 | 393 | * Determine if the system has an input driver with the given unique ID. |
nkeynes@615 | 394 | * @param id driver id to check |
nkeynes@615 | 395 | * @return TRUE if the device exists, otherwise FALSE |
nkeynes@615 | 396 | */ |
nkeynes@615 | 397 | gboolean input_has_device( const gchar *id ); |
nkeynes@615 | 398 | |
nkeynes@615 | 399 | /** |
nkeynes@614 | 400 | * Unregister an input driver. |
nkeynes@614 | 401 | * @param driver the driver to unregister |
nkeynes@614 | 402 | * If the driver is not in fact registered, this function has no effect. |
nkeynes@614 | 403 | */ |
nkeynes@614 | 404 | void input_unregister_device( input_driver_t driver ); |
nkeynes@614 | 405 | |
nkeynes@614 | 406 | /** |
nkeynes@614 | 407 | * Called from the UI to indicate that the emulation window is focused (ie |
nkeynes@614 | 408 | * able to receive input). This method is used to gate non-UI input devices - |
nkeynes@614 | 409 | * when the display is not focused, all input events will be silently ignored. |
nkeynes@614 | 410 | */ |
nkeynes@614 | 411 | void display_set_focused( gboolean has_focus ); |
nkeynes@614 | 412 | |
nkeynes@1010 | 413 | /** |
nkeynes@1010 | 414 | * Fire a keydown event on the specified device |
nkeynes@1010 | 415 | * @param input The input device source generating the event, or NULL for the |
nkeynes@1010 | 416 | * default GUI device |
nkeynes@1010 | 417 | * @param keycode The device-specific keycode |
nkeynes@1010 | 418 | * @param pressure The pressure of the key (0 to 127), where 0 is unpressed and |
nkeynes@1010 | 419 | * 127 is maximum pressure. Devices without pressure sensitivity should |
nkeynes@1010 | 420 | * always use MAX_PRESSURE (127) |
nkeynes@1010 | 421 | */ |
nkeynes@614 | 422 | void input_event_keydown( input_driver_t input, uint16_t keycode, uint32_t pressure ); |
nkeynes@614 | 423 | |
nkeynes@1010 | 424 | void input_event_keyup( input_driver_t input, uint16_t keycode ); |
nkeynes@144 | 425 | |
nkeynes@839 | 426 | /** |
nkeynes@849 | 427 | * Receive an input mouse down event. Normally these should be absolute events when |
nkeynes@839 | 428 | * the mouse is not grabbed, and relative when it is. |
nkeynes@849 | 429 | * @param button the button pressed, where 0 == first button |
nkeynes@839 | 430 | * @param x_axis The relative or absolute position of the mouse cursor on the X axis |
nkeynes@839 | 431 | * @param y_axis The relative or absolute position of the mouse cursor on the Y axis |
nkeynes@839 | 432 | * @param absolute If TRUE, x_axis and y_axis are the current window coordinates |
nkeynes@839 | 433 | * of the mouse cursor. Otherwise, x_axis and y_axis are deltas from the previous mouse position. |
nkeynes@839 | 434 | */ |
nkeynes@849 | 435 | void input_event_mousedown( uint16_t button, int32_t x_axis, int32_t y_axis, gboolean absolute ); |
nkeynes@849 | 436 | |
nkeynes@849 | 437 | /** |
nkeynes@849 | 438 | * Receive an input mouse up event. Normally these should be absolute events when |
nkeynes@849 | 439 | * the mouse is not grabbed, and relative when it is. |
nkeynes@849 | 440 | * @param button the button released, where 0 == first button |
nkeynes@849 | 441 | * @param x_axis The relative or absolute position of the mouse cursor on the X axis |
nkeynes@849 | 442 | * @param y_axis The relative or absolute position of the mouse cursor on the Y axis |
nkeynes@849 | 443 | * @param absolute If TRUE, x_axis and y_axis are the current window coordinates |
nkeynes@849 | 444 | * of the mouse cursor. Otherwise, x_axis and y_axis are deltas from the previous mouse position. |
nkeynes@849 | 445 | */ |
nkeynes@849 | 446 | void input_event_mouseup( uint16_t button, int32_t x_axis, int32_t y_axis, gboolean absolute ); |
nkeynes@849 | 447 | |
nkeynes@849 | 448 | /** |
nkeynes@849 | 449 | * Receive an input mouse motion event. Normally these should be absolute events when |
nkeynes@849 | 450 | * the mouse is not grabbed, and relative when it is. |
nkeynes@849 | 451 | * @param x_axis The relative or absolute position of the mouse cursor on the X axis |
nkeynes@849 | 452 | * @param y_axis The relative or absolute position of the mouse cursor on the Y axis |
nkeynes@849 | 453 | * @param absolute If TRUE, x_axis and y_axis are the current window coordinates |
nkeynes@849 | 454 | * of the mouse cursor. Otherwise, x_axis and y_axis are deltas from the previous mouse position. |
nkeynes@849 | 455 | */ |
nkeynes@849 | 456 | void input_event_mousemove( int32_t x_axis, int32_t y_axis, gboolean absolute ); |
nkeynes@144 | 457 | |
nkeynes@770 | 458 | /** |
nkeynes@770 | 459 | * Given a keycode and the originating input driver, return the corresponding |
nkeynes@770 | 460 | * keysym. The caller is responsible for freeing the string. |
nkeynes@770 | 461 | * @return a newly allocated string, or NULL of the keycode is unresolvable. |
nkeynes@770 | 462 | */ |
nkeynes@770 | 463 | gchar *input_keycode_to_keysym( input_driver_t driver, uint16_t keycode ); |
nkeynes@614 | 464 | |
nkeynes@614 | 465 | typedef void (*display_keysym_callback_t)( void *data, const gchar *keysym ); |
nkeynes@614 | 466 | |
nkeynes@614 | 467 | /** |
nkeynes@614 | 468 | * Set the keysym hook function (normally used by the UI to receive non-UI |
nkeynes@614 | 469 | * input events during configuration. |
nkeynes@614 | 470 | */ |
nkeynes@614 | 471 | void input_set_keysym_hook( display_keysym_callback_t hook, void *data ); |
nkeynes@614 | 472 | |
nkeynes@614 | 473 | |
nkeynes@144 | 474 | |
nkeynes@144 | 475 | #ifdef __cplusplus |
nkeynes@144 | 476 | } |
nkeynes@144 | 477 | #endif |
nkeynes@736 | 478 | #endif /* !lxdream_display_H */ |
.