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@674 | 104 | uint32_t colour_format;
|
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@1251 | 114 | int depth_bits;
|
nkeynes@863 | 115 | int stencil_bits; /* 0 = no stencil buffer */
|
nkeynes@863 | 116 | };
|
nkeynes@863 | 117 |
|
nkeynes@1159 | 118 | struct vertex_buffer {
|
nkeynes@1159 | 119 | /**
|
nkeynes@1159 | 120 | * Map the buffer into the host address space (if necessary) in preparation
|
nkeynes@1159 | 121 | * for filling the buffer. This also implies a fence operation.
|
nkeynes@1159 | 122 | * @param buf previously allocated buffer
|
nkeynes@1159 | 123 | * @param size number of bytes of the buffer actually to be used. The buffer
|
nkeynes@1159 | 124 | * will be resized if necessary.
|
nkeynes@1159 | 125 | * @return a pointer to the start of the buffer.
|
nkeynes@1159 | 126 | */
|
nkeynes@1159 | 127 | void *(*map)(vertex_buffer_t buf, uint32_t size);
|
nkeynes@1159 | 128 |
|
nkeynes@1159 | 129 | /**
|
nkeynes@1159 | 130 | * Unmap the buffer, after the vertex data is written.
|
nkeynes@1159 | 131 | * @return the buffer base to use for gl*Pointer calls
|
nkeynes@1159 | 132 | */
|
nkeynes@1159 | 133 | void *(*unmap)(vertex_buffer_t buf);
|
nkeynes@1159 | 134 |
|
nkeynes@1159 | 135 | /**
|
nkeynes@1159 | 136 | * Mark the buffer as finished, indicating that the vertex data is no
|
nkeynes@1159 | 137 | * longer required (ie rendering is complete).
|
nkeynes@1159 | 138 | */
|
nkeynes@1159 | 139 | void (*finished)(vertex_buffer_t buf);
|
nkeynes@1159 | 140 |
|
nkeynes@1159 | 141 | /**
|
nkeynes@1159 | 142 | * Delete the buffer and all associated resources.
|
nkeynes@1159 | 143 | */
|
nkeynes@1159 | 144 | void (*destroy)(vertex_buffer_t buf);
|
nkeynes@1159 | 145 |
|
nkeynes@1159 | 146 | /* Private data */
|
nkeynes@1159 | 147 | void *data;
|
nkeynes@1159 | 148 | GLuint id;
|
nkeynes@1159 | 149 | uint32_t capacity;
|
nkeynes@1159 | 150 | uint32_t mapped_size;
|
nkeynes@1159 | 151 | GLuint fence;
|
nkeynes@1159 | 152 | };
|
nkeynes@1159 | 153 |
|
nkeynes@1159 | 154 |
|
nkeynes@352 | 155 | /**
|
nkeynes@352 | 156 | * Core video driver - exports function to setup a GL context, as well as handle
|
nkeynes@352 | 157 | * keyboard input and display resultant output.
|
nkeynes@144 | 158 | */
|
nkeynes@144 | 159 | typedef struct display_driver {
|
nkeynes@144 | 160 | char *name;
|
nkeynes@144 | 161 | /**
|
nkeynes@700 | 162 | * Short (<60 chars) description of the driver. This should be marked for
|
nkeynes@700 | 163 | * localization.
|
nkeynes@700 | 164 | */
|
nkeynes@700 | 165 | char *description;
|
nkeynes@700 | 166 | /**
|
nkeynes@144 | 167 | * Initialize the driver. This is called only once at startup time, and
|
nkeynes@144 | 168 | * is guaranteed to be called before any other methods.
|
nkeynes@144 | 169 | * @return TRUE if the driver was successfully initialized, otherwise
|
nkeynes@144 | 170 | * FALSE.
|
nkeynes@144 | 171 | */
|
nkeynes@144 | 172 | gboolean (*init_driver)(void);
|
nkeynes@144 | 173 |
|
nkeynes@144 | 174 | /**
|
nkeynes@144 | 175 | * Cleanly shutdown the driver. Normally only called at system shutdown
|
nkeynes@144 | 176 | * time.
|
nkeynes@144 | 177 | */
|
nkeynes@144 | 178 | void (*shutdown_driver)(void);
|
nkeynes@144 | 179 |
|
nkeynes@144 | 180 | /**
|
nkeynes@144 | 181 | * Given a particular keysym, return the keycode associated with it.
|
nkeynes@144 | 182 | * @param keysym The keysym to be resolved, ie "Tab"
|
nkeynes@144 | 183 | * @return the display-specific keycode, or 0 if the keysym cannot
|
nkeynes@144 | 184 | * be resolved.
|
nkeynes@144 | 185 | */
|
nkeynes@144 | 186 | uint16_t (*resolve_keysym)( const gchar *keysym );
|
nkeynes@144 | 187 |
|
nkeynes@144 | 188 | /**
|
nkeynes@608 | 189 | * Given a native system keycode, convert it to a dreamcast keyboard code.
|
nkeynes@608 | 190 | */
|
nkeynes@608 | 191 | uint16_t (*convert_to_dckeysym)( uint16_t keycode );
|
nkeynes@608 | 192 |
|
nkeynes@608 | 193 | /**
|
nkeynes@614 | 194 | * Given a device-specific event code, return the corresponding keysym.
|
nkeynes@614 | 195 | * The string should be newly allocated (caller will free)
|
nkeynes@614 | 196 | */
|
nkeynes@614 | 197 | gchar *(*get_keysym_for_keycode)( uint16_t keycode );
|
nkeynes@614 | 198 |
|
nkeynes@614 | 199 | /**
|
nkeynes@805 | 200 | * Create a render target with the given width and height. If a texture ID
|
nkeynes@805 | 201 | * is supplied (non-zero), the render buffer writes its output to that texture.
|
nkeynes@805 | 202 | * @param tex_id 0 or a valid GL texture name which must have been initialized to
|
nkeynes@805 | 203 | * the correct dimensions.
|
nkeynes@144 | 204 | */
|
nkeynes@805 | 205 | render_buffer_t (*create_render_buffer)( uint32_t width, uint32_t height, GLuint tex_id );
|
nkeynes@144 | 206 |
|
nkeynes@144 | 207 | /**
|
nkeynes@352 | 208 | * Destroy the specified render buffer and release any associated
|
nkeynes@352 | 209 | * resources.
|
nkeynes@144 | 210 | */
|
nkeynes@352 | 211 | void (*destroy_render_buffer)( render_buffer_t buffer );
|
nkeynes@352 | 212 |
|
nkeynes@144 | 213 | /**
|
nkeynes@352 | 214 | * Set the current rendering target to the specified buffer.
|
nkeynes@144 | 215 | */
|
nkeynes@352 | 216 | gboolean (*set_render_target)( render_buffer_t buffer );
|
nkeynes@352 | 217 |
|
nkeynes@352 | 218 | /**
|
nkeynes@805 | 219 | * Complete rendering and clear the current rendering target. If the
|
nkeynes@805 | 220 | * buffer has a bound texture, it will be updated if necessary.
|
nkeynes@805 | 221 | */
|
nkeynes@805 | 222 | void (*finish_render)( render_buffer_t buffer );
|
nkeynes@805 | 223 |
|
nkeynes@805 | 224 | /**
|
nkeynes@477 | 225 | * Load the supplied frame buffer into the given render buffer.
|
nkeynes@477 | 226 | * Included here to allow driver-specific optimizations.
|
nkeynes@352 | 227 | */
|
nkeynes@477 | 228 | void (*load_frame_buffer)( frame_buffer_t frame, render_buffer_t render );
|
nkeynes@352 | 229 |
|
nkeynes@352 | 230 | /**
|
nkeynes@352 | 231 | * Display a single frame using a previously rendered GL buffer.
|
nkeynes@352 | 232 | */
|
nkeynes@669 | 233 | void (*display_render_buffer)( render_buffer_t buffer );
|
nkeynes@144 | 234 |
|
nkeynes@144 | 235 | /**
|
nkeynes@144 | 236 | * Display a single blanked frame using a fixed colour for the
|
nkeynes@477 | 237 | * entire frame (specified in BGR888 format).
|
nkeynes@144 | 238 | */
|
nkeynes@669 | 239 | void (*display_blank)( uint32_t rgb );
|
nkeynes@144 | 240 |
|
nkeynes@144 | 241 | /**
|
nkeynes@1076 | 242 | * Swap front/back window buffers
|
nkeynes@1076 | 243 | */
|
nkeynes@1076 | 244 | void (*swap_buffers)();
|
nkeynes@1076 | 245 |
|
nkeynes@1076 | 246 | /**
|
nkeynes@352 | 247 | * Copy the image data from the GL buffer to the target memory buffer,
|
nkeynes@352 | 248 | * using the format etc from the buffer. This may force a glFinish()
|
nkeynes@352 | 249 | * but does not invalidate the buffer.
|
nkeynes@477 | 250 | * @param target buffer to fill with image data, which must be large enough
|
nkeynes@477 | 251 | * to accomodate the image.
|
nkeynes@477 | 252 | * @param buffer Render buffer to read from.
|
nkeynes@477 | 253 | * @param rowstride rowstride of the target data
|
nkeynes@477 | 254 | * @param format colour format to output the data in.
|
nkeynes@144 | 255 | */
|
nkeynes@477 | 256 | gboolean (*read_render_buffer)( unsigned char *target, render_buffer_t buffer,
|
nkeynes@736 | 257 | int rowstride, int format );
|
nkeynes@352 | 258 |
|
nkeynes@1134 | 259 | /**
|
nkeynes@1159 | 260 | * Create a new vertex buffer
|
nkeynes@1159 | 261 | */
|
nkeynes@1159 | 262 | vertex_buffer_t (*create_vertex_buffer)( );
|
nkeynes@1159 | 263 |
|
nkeynes@1159 | 264 | /**
|
nkeynes@1134 | 265 | * Dump driver-specific information about the implementation to the given stream
|
nkeynes@1134 | 266 | */
|
nkeynes@1134 | 267 | void (*print_info)( FILE *out );
|
nkeynes@1134 | 268 |
|
nkeynes@863 | 269 | struct display_capabilities capabilities;
|
nkeynes@1159 | 270 |
|
nkeynes@144 | 271 | } *display_driver_t;
|
nkeynes@144 | 272 |
|
nkeynes@700 | 273 | /**
|
nkeynes@700 | 274 | * Print the configured video drivers to the output stream, one to a line.
|
nkeynes@700 | 275 | */
|
nkeynes@700 | 276 | void print_display_drivers( FILE *out );
|
nkeynes@531 | 277 | display_driver_t get_display_driver_by_name( const char *name );
|
nkeynes@370 | 278 | gboolean display_set_driver( display_driver_t driver );
|
nkeynes@144 | 279 |
|
nkeynes@144 | 280 | extern uint32_t pvr2_frame_counter;
|
nkeynes@144 | 281 |
|
nkeynes@144 | 282 | extern display_driver_t display_driver;
|
nkeynes@144 | 283 |
|
nkeynes@144 | 284 | extern struct display_driver display_gtk_driver;
|
nkeynes@681 | 285 | extern struct display_driver display_osx_driver;
|
nkeynes@1244 | 286 | extern struct display_driver display_gl_driver;
|
nkeynes@1245 | 287 | extern struct display_driver display_egl_driver;
|
nkeynes@144 | 288 | extern struct display_driver display_null_driver;
|
nkeynes@144 | 289 |
|
nkeynes@144 | 290 | /****************** Input methods **********************/
|
nkeynes@144 | 291 |
|
nkeynes@849 | 292 | #define MAX_MOUSE_BUTTONS 32
|
nkeynes@849 | 293 |
|
nkeynes@1010 | 294 | /* Pressure is 0..127 (allowing a joystick to be defined as two half-axes of 7- bits each) */
|
nkeynes@1010 | 295 | #define MAX_PRESSURE 0x7F
|
nkeynes@1010 | 296 |
|
nkeynes@1072 | 297 | typedef key_binding_t input_key_callback_t;
|
nkeynes@144 | 298 |
|
nkeynes@608 | 299 | /**
|
nkeynes@608 | 300 | * Callback to receive mouse input events
|
nkeynes@608 | 301 | * @param data pointer passed in at the time the hook was registered
|
nkeynes@608 | 302 | * @param buttons bitmask of button states, where bit 0 is button 0 (left), bit 1 is button
|
nkeynes@608 | 303 | * 1 (middle), bit 2 is button 2 (right) and so forth.
|
nkeynes@608 | 304 | * @param x Horizontal movement since the last invocation (in relative mode) or window position
|
nkeynes@608 | 305 | * (in absolute mode).
|
nkeynes@608 | 306 | * @param y Vertical movement since the last invocation (in relative mode) or window position
|
nkeynes@608 | 307 | * (in absolute mode).
|
nkeynes@839 | 308 | * @param absolute If TRUE, x and y are the current window coordinates
|
nkeynes@839 | 309 | * of the mouse cursor. Otherwise, x and y are deltas from the previous mouse position.
|
nkeynes@608 | 310 | */
|
nkeynes@839 | 311 | typedef void (*input_mouse_callback_t)( void *data, uint32_t buttons, int32_t x, int32_t y, gboolean absolute );
|
nkeynes@608 | 312 |
|
nkeynes@144 | 313 | gboolean input_register_key( const gchar *keysym, input_key_callback_t callback,
|
nkeynes@736 | 314 | void *data, uint32_t value );
|
nkeynes@144 | 315 |
|
nkeynes@451 | 316 | void input_unregister_key( const gchar *keysym, input_key_callback_t callback,
|
nkeynes@736 | 317 | void *data, uint32_t value );
|
nkeynes@144 | 318 |
|
nkeynes@1072 | 319 | gboolean input_register_keygroup( lxdream_config_group_t group );
|
nkeynes@1072 | 320 | void input_unregister_keygroup( lxdream_config_group_t group );
|
nkeynes@1072 | 321 | gboolean input_keygroup_changed( void *data, lxdream_config_group_t group, unsigned key,
|
nkeynes@1072 | 322 | const gchar *oldval, const gchar *newval );
|
nkeynes@1072 | 323 |
|
nkeynes@608 | 324 | /**
|
nkeynes@849 | 325 | * Register a hook to receive all keyboard input events
|
nkeynes@608 | 326 | */
|
nkeynes@849 | 327 | gboolean input_register_keyboard_hook( input_key_callback_t callback, void *data );
|
nkeynes@849 | 328 | void input_unregister_keyboard_hook( input_key_callback_t callback, void *data );
|
nkeynes@608 | 329 |
|
nkeynes@608 | 330 | /**
|
nkeynes@608 | 331 | * Register a mouse event hook.
|
nkeynes@608 | 332 | * @param relative TRUE if the caller wants relative mouse movement, FALSE for
|
nkeynes@608 | 333 | * absolute mouse positioning. It's not generally possible to receive both at the same time.
|
nkeynes@608 | 334 | */
|
nkeynes@608 | 335 | gboolean input_register_mouse_hook( gboolean relative, input_mouse_callback_t callback, void *data );
|
nkeynes@608 | 336 | void input_unregister_mouse_hook( input_mouse_callback_t callback, void *data );
|
nkeynes@608 | 337 |
|
nkeynes@144 | 338 | gboolean input_is_key_valid( const gchar *keysym );
|
nkeynes@144 | 339 |
|
nkeynes@144 | 340 | gboolean input_is_key_registered( const gchar *keysym );
|
nkeynes@144 | 341 |
|
nkeynes@614 | 342 | uint16_t input_keycode_to_dckeysym( uint16_t keycode );
|
nkeynes@144 | 343 |
|
nkeynes@614 | 344 | /********************** Display/Input methods ***********************/
|
nkeynes@614 | 345 |
|
nkeynes@614 | 346 | /**
|
nkeynes@614 | 347 | * Auxilliary input driver - provides input separate to and in addition to the
|
nkeynes@614 | 348 | * core UI/display. (primarily used for joystick devices)
|
nkeynes@614 | 349 | */
|
nkeynes@614 | 350 | typedef struct input_driver {
|
nkeynes@614 | 351 | const char *id; /* Short identifier to display in the UI for the device (eg "JS0" ) */
|
nkeynes@614 | 352 |
|
nkeynes@614 | 353 | /**
|
nkeynes@614 | 354 | * Given a particular keysym, return the keycode associated with it.
|
nkeynes@614 | 355 | * @param keysym The keysym to be resolved, ie "Tab"
|
nkeynes@614 | 356 | * @return the display-specific keycode, or 0 if the keysym cannot
|
nkeynes@614 | 357 | * be resolved.
|
nkeynes@614 | 358 | */
|
nkeynes@614 | 359 | uint16_t (*resolve_keysym)( struct input_driver *driver, const gchar *keysym );
|
nkeynes@614 | 360 |
|
nkeynes@614 | 361 | /**
|
nkeynes@614 | 362 | * Given a device-specific event code, convert it to a dreamcast keyboard code.
|
nkeynes@614 | 363 | * This is only required for actual keyboard devices, other devices should just
|
nkeynes@614 | 364 | * leave this method NULL.
|
nkeynes@614 | 365 | */
|
nkeynes@614 | 366 | uint16_t (*convert_to_dckeysym)( struct input_driver *driver, uint16_t keycode );
|
nkeynes@614 | 367 |
|
nkeynes@614 | 368 | /**
|
nkeynes@614 | 369 | * Given a device-specific event code, return the corresponding keysym.
|
nkeynes@614 | 370 | * The string should be newly allocated (caller will free)
|
nkeynes@614 | 371 | */
|
nkeynes@614 | 372 | gchar *(*get_keysym_for_keycode)( struct input_driver *driver, uint16_t keycode );
|
nkeynes@614 | 373 |
|
nkeynes@614 | 374 | /**
|
nkeynes@614 | 375 | * Destroy the input driver.
|
nkeynes@614 | 376 | */
|
nkeynes@614 | 377 | void (*destroy)( struct input_driver *driver );
|
nkeynes@614 | 378 |
|
nkeynes@614 | 379 | } *input_driver_t;
|
nkeynes@614 | 380 |
|
nkeynes@849 | 381 | extern struct input_driver system_mouse_driver;
|
nkeynes@849 | 382 |
|
nkeynes@614 | 383 | /**
|
nkeynes@614 | 384 | * Register a new input driver (which must have a unique name)
|
nkeynes@614 | 385 | * @param driver the driver to register
|
nkeynes@614 | 386 | * @param max_keycode the highest possible keycode reported by the device
|
nkeynes@614 | 387 | * @return TRUE on success, FALSE on failure (eg driver already registed).
|
nkeynes@614 | 388 | */
|
nkeynes@614 | 389 | gboolean input_register_device( input_driver_t driver, uint16_t max_keycode );
|
nkeynes@614 | 390 |
|
nkeynes@614 | 391 | /**
|
nkeynes@615 | 392 | * Determine if the system has an input driver with the given unique ID.
|
nkeynes@615 | 393 | * @param id driver id to check
|
nkeynes@615 | 394 | * @return TRUE if the device exists, otherwise FALSE
|
nkeynes@615 | 395 | */
|
nkeynes@615 | 396 | gboolean input_has_device( const gchar *id );
|
nkeynes@615 | 397 |
|
nkeynes@615 | 398 | /**
|
nkeynes@614 | 399 | * Unregister an input driver.
|
nkeynes@614 | 400 | * @param driver the driver to unregister
|
nkeynes@614 | 401 | * If the driver is not in fact registered, this function has no effect.
|
nkeynes@614 | 402 | */
|
nkeynes@614 | 403 | void input_unregister_device( input_driver_t driver );
|
nkeynes@614 | 404 |
|
nkeynes@614 | 405 | /**
|
nkeynes@614 | 406 | * Called from the UI to indicate that the emulation window is focused (ie
|
nkeynes@614 | 407 | * able to receive input). This method is used to gate non-UI input devices -
|
nkeynes@614 | 408 | * when the display is not focused, all input events will be silently ignored.
|
nkeynes@614 | 409 | */
|
nkeynes@614 | 410 | void display_set_focused( gboolean has_focus );
|
nkeynes@614 | 411 |
|
nkeynes@1010 | 412 | /**
|
nkeynes@1010 | 413 | * Fire a keydown event on the specified device
|
nkeynes@1010 | 414 | * @param input The input device source generating the event, or NULL for the
|
nkeynes@1010 | 415 | * default GUI device
|
nkeynes@1010 | 416 | * @param keycode The device-specific keycode
|
nkeynes@1010 | 417 | * @param pressure The pressure of the key (0 to 127), where 0 is unpressed and
|
nkeynes@1010 | 418 | * 127 is maximum pressure. Devices without pressure sensitivity should
|
nkeynes@1010 | 419 | * always use MAX_PRESSURE (127)
|
nkeynes@1010 | 420 | */
|
nkeynes@614 | 421 | void input_event_keydown( input_driver_t input, uint16_t keycode, uint32_t pressure );
|
nkeynes@614 | 422 |
|
nkeynes@1010 | 423 | void input_event_keyup( input_driver_t input, uint16_t keycode );
|
nkeynes@144 | 424 |
|
nkeynes@839 | 425 | /**
|
nkeynes@849 | 426 | * Receive an input mouse down event. Normally these should be absolute events when
|
nkeynes@839 | 427 | * the mouse is not grabbed, and relative when it is.
|
nkeynes@849 | 428 | * @param button the button pressed, where 0 == first button
|
nkeynes@839 | 429 | * @param x_axis The relative or absolute position of the mouse cursor on the X axis
|
nkeynes@839 | 430 | * @param y_axis The relative or absolute position of the mouse cursor on the Y axis
|
nkeynes@839 | 431 | * @param absolute If TRUE, x_axis and y_axis are the current window coordinates
|
nkeynes@839 | 432 | * of the mouse cursor. Otherwise, x_axis and y_axis are deltas from the previous mouse position.
|
nkeynes@839 | 433 | */
|
nkeynes@849 | 434 | void input_event_mousedown( uint16_t button, int32_t x_axis, int32_t y_axis, gboolean absolute );
|
nkeynes@849 | 435 |
|
nkeynes@849 | 436 | /**
|
nkeynes@849 | 437 | * Receive an input mouse up event. Normally these should be absolute events when
|
nkeynes@849 | 438 | * the mouse is not grabbed, and relative when it is.
|
nkeynes@849 | 439 | * @param button the button released, where 0 == first button
|
nkeynes@849 | 440 | * @param x_axis The relative or absolute position of the mouse cursor on the X axis
|
nkeynes@849 | 441 | * @param y_axis The relative or absolute position of the mouse cursor on the Y axis
|
nkeynes@849 | 442 | * @param absolute If TRUE, x_axis and y_axis are the current window coordinates
|
nkeynes@849 | 443 | * of the mouse cursor. Otherwise, x_axis and y_axis are deltas from the previous mouse position.
|
nkeynes@849 | 444 | */
|
nkeynes@849 | 445 | void input_event_mouseup( uint16_t button, int32_t x_axis, int32_t y_axis, gboolean absolute );
|
nkeynes@849 | 446 |
|
nkeynes@849 | 447 | /**
|
nkeynes@849 | 448 | * Receive an input mouse motion event. Normally these should be absolute events when
|
nkeynes@849 | 449 | * the mouse is not grabbed, and relative when it is.
|
nkeynes@849 | 450 | * @param x_axis The relative or absolute position of the mouse cursor on the X axis
|
nkeynes@849 | 451 | * @param y_axis The relative or absolute position of the mouse cursor on the Y axis
|
nkeynes@849 | 452 | * @param absolute If TRUE, x_axis and y_axis are the current window coordinates
|
nkeynes@849 | 453 | * of the mouse cursor. Otherwise, x_axis and y_axis are deltas from the previous mouse position.
|
nkeynes@849 | 454 | */
|
nkeynes@849 | 455 | void input_event_mousemove( int32_t x_axis, int32_t y_axis, gboolean absolute );
|
nkeynes@144 | 456 |
|
nkeynes@770 | 457 | /**
|
nkeynes@770 | 458 | * Given a keycode and the originating input driver, return the corresponding
|
nkeynes@770 | 459 | * keysym. The caller is responsible for freeing the string.
|
nkeynes@770 | 460 | * @return a newly allocated string, or NULL of the keycode is unresolvable.
|
nkeynes@770 | 461 | */
|
nkeynes@770 | 462 | gchar *input_keycode_to_keysym( input_driver_t driver, uint16_t keycode );
|
nkeynes@614 | 463 |
|
nkeynes@614 | 464 | typedef void (*display_keysym_callback_t)( void *data, const gchar *keysym );
|
nkeynes@614 | 465 |
|
nkeynes@614 | 466 | /**
|
nkeynes@614 | 467 | * Set the keysym hook function (normally used by the UI to receive non-UI
|
nkeynes@614 | 468 | * input events during configuration.
|
nkeynes@614 | 469 | */
|
nkeynes@614 | 470 | void input_set_keysym_hook( display_keysym_callback_t hook, void *data );
|
nkeynes@614 | 471 |
|
nkeynes@614 | 472 |
|
nkeynes@144 | 473 |
|
nkeynes@144 | 474 | #ifdef __cplusplus
|
nkeynes@144 | 475 | }
|
nkeynes@144 | 476 | #endif
|
nkeynes@736 | 477 | #endif /* !lxdream_display_H */
|