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