4 * The PC side of the video support (responsible for actually displaying /
7 * Copyright (c) 2005 Nathan Keynes.
9 * This program is free software; you can redistribute it and/or modify
10 * it under the terms of the GNU General Public License as published by
11 * the Free Software Foundation; either version 2 of the License, or
12 * (at your option) any later version.
14 * This program is distributed in the hope that it will be useful,
15 * but WITHOUT ANY WARRANTY; without even the implied warranty of
16 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
17 * GNU General Public License for more details.
20 #ifndef lxdream_display_H
21 #define lxdream_display_H 1
23 #define GL_GLEXT_PROTOTYPES 1
32 #include <OpenGL/gl.h>
33 #include <OpenGL/glext.h>
44 * Supported colour formats. Note that BGRA4444 is only ever used for texture
45 * rendering (it's not valid for display purposes).
47 #define COLFMT_BGRA1555 0
48 #define COLFMT_RGB565 1
49 #define COLFMT_BGRA4444 2
50 #define COLFMT_YUV422 3 /* 8-bit YUV (texture source only) */
51 #define COLFMT_BGR888 4 /* 24-bit BGR */
52 #define COLFMT_BGRA8888 5
53 #define COLFMT_INDEX4 6 /* 4 bit indexed colour (texture source only) */
54 #define COLFMT_INDEX8 7 /* 8-bit indexed colour (texture source only) */
55 #define COLFMT_BGR0888 8 /* 32-bit BGR */
56 #define COLFMT_RGB888 9 /* 24-bit RGB (ie GL native) */
59 * The standard display size (for the purposes of mouse inputs, etc, is 640x480 -
60 * events should be adjusted accordingly if this is not the actual window size.
62 #define DISPLAY_WIDTH 640
63 #define DISPLAY_HEIGHT 480
65 struct colour_format {
66 GLint type, format, int_format;
69 extern struct colour_format colour_formats[];
71 extern int colour_format_bytes[];
74 * Structure to hold pixel data held in GL buffers.
76 struct render_buffer {
80 uint32_t colour_format;
81 sh4addr_t address; /* Address buffer was rendered to, or -1 for unrendered */
82 uint32_t size; /* Size of buffer in bytes, must be width*height*bpp */
83 gboolean inverted;/* True if the buffer is upside down */
85 GLuint tex_id; /* texture bound to render buffer, if any (0 = none).
86 * The render buffer does not own the texture */
87 unsigned int buf_id; /* driver-specific buffer id, if applicable */
88 gboolean flushed; /* True if the buffer has been flushed to vram */
92 * Structure to hold pixel data stored in pvr2 vram, as opposed to data in
99 uint32_t colour_format;
101 uint32_t size; /* Size of buffer in bytes, must be width*height*bpp */
102 gboolean inverted;/* True if the buffer is upside down */
106 struct display_capabilities {
107 int stencil_bits; /* 0 = no stencil buffer */
111 * Core video driver - exports function to setup a GL context, as well as handle
112 * keyboard input and display resultant output.
114 typedef struct display_driver {
117 * Short (<60 chars) description of the driver. This should be marked for
122 * Initialize the driver. This is called only once at startup time, and
123 * is guaranteed to be called before any other methods.
124 * @return TRUE if the driver was successfully initialized, otherwise
127 gboolean (*init_driver)(void);
130 * Cleanly shutdown the driver. Normally only called at system shutdown
133 void (*shutdown_driver)(void);
136 * Given a particular keysym, return the keycode associated with it.
137 * @param keysym The keysym to be resolved, ie "Tab"
138 * @return the display-specific keycode, or 0 if the keysym cannot
141 uint16_t (*resolve_keysym)( const gchar *keysym );
144 * Given a native system keycode, convert it to a dreamcast keyboard code.
146 uint16_t (*convert_to_dckeysym)( uint16_t keycode );
149 * Given a device-specific event code, return the corresponding keysym.
150 * The string should be newly allocated (caller will free)
152 gchar *(*get_keysym_for_keycode)( uint16_t keycode );
155 * Create a render target with the given width and height. If a texture ID
156 * is supplied (non-zero), the render buffer writes its output to that texture.
157 * @param tex_id 0 or a valid GL texture name which must have been initialized to
158 * the correct dimensions.
160 render_buffer_t (*create_render_buffer)( uint32_t width, uint32_t height, GLuint tex_id );
163 * Destroy the specified render buffer and release any associated
166 void (*destroy_render_buffer)( render_buffer_t buffer );
169 * Set the current rendering target to the specified buffer.
171 gboolean (*set_render_target)( render_buffer_t buffer );
174 * Complete rendering and clear the current rendering target. If the
175 * buffer has a bound texture, it will be updated if necessary.
177 void (*finish_render)( render_buffer_t buffer );
180 * Load the supplied frame buffer into the given render buffer.
181 * Included here to allow driver-specific optimizations.
183 void (*load_frame_buffer)( frame_buffer_t frame, render_buffer_t render );
186 * Display a single frame using a previously rendered GL buffer.
188 void (*display_render_buffer)( render_buffer_t buffer );
191 * Display a single blanked frame using a fixed colour for the
192 * entire frame (specified in BGR888 format).
194 void (*display_blank)( uint32_t rgb );
197 * Swap front/back window buffers
199 void (*swap_buffers)();
202 * Copy the image data from the GL buffer to the target memory buffer,
203 * using the format etc from the buffer. This may force a glFinish()
204 * but does not invalidate the buffer.
205 * @param target buffer to fill with image data, which must be large enough
206 * to accomodate the image.
207 * @param buffer Render buffer to read from.
208 * @param rowstride rowstride of the target data
209 * @param format colour format to output the data in.
211 gboolean (*read_render_buffer)( unsigned char *target, render_buffer_t buffer,
212 int rowstride, int format );
214 struct display_capabilities capabilities;
218 * Print the configured video drivers to the output stream, one to a line.
220 void print_display_drivers( FILE *out );
221 display_driver_t get_display_driver_by_name( const char *name );
222 gboolean display_set_driver( display_driver_t driver );
224 extern uint32_t pvr2_frame_counter;
226 extern display_driver_t display_driver;
228 extern struct display_driver display_gtk_driver;
229 extern struct display_driver display_osx_driver;
230 extern struct display_driver display_null_driver;
232 /****************** Input methods **********************/
234 #define MAX_MOUSE_BUTTONS 32
236 /* Pressure is 0..127 (allowing a joystick to be defined as two half-axes of 7- bits each) */
237 #define MAX_PRESSURE 0x7F
239 typedef key_binding_t input_key_callback_t;
242 * Callback to receive mouse input events
243 * @param data pointer passed in at the time the hook was registered
244 * @param buttons bitmask of button states, where bit 0 is button 0 (left), bit 1 is button
245 * 1 (middle), bit 2 is button 2 (right) and so forth.
246 * @param x Horizontal movement since the last invocation (in relative mode) or window position
247 * (in absolute mode).
248 * @param y Vertical movement since the last invocation (in relative mode) or window position
249 * (in absolute mode).
250 * @param absolute If TRUE, x and y are the current window coordinates
251 * of the mouse cursor. Otherwise, x and y are deltas from the previous mouse position.
253 typedef void (*input_mouse_callback_t)( void *data, uint32_t buttons, int32_t x, int32_t y, gboolean absolute );
255 gboolean input_register_key( const gchar *keysym, input_key_callback_t callback,
256 void *data, uint32_t value );
258 void input_unregister_key( const gchar *keysym, input_key_callback_t callback,
259 void *data, uint32_t value );
261 gboolean input_register_keygroup( lxdream_config_group_t group );
262 void input_unregister_keygroup( lxdream_config_group_t group );
263 gboolean input_keygroup_changed( void *data, lxdream_config_group_t group, unsigned key,
264 const gchar *oldval, const gchar *newval );
267 * Register a hook to receive all keyboard input events
269 gboolean input_register_keyboard_hook( input_key_callback_t callback, void *data );
270 void input_unregister_keyboard_hook( input_key_callback_t callback, void *data );
273 * Register a mouse event hook.
274 * @param relative TRUE if the caller wants relative mouse movement, FALSE for
275 * absolute mouse positioning. It's not generally possible to receive both at the same time.
277 gboolean input_register_mouse_hook( gboolean relative, input_mouse_callback_t callback, void *data );
278 void input_unregister_mouse_hook( input_mouse_callback_t callback, void *data );
280 gboolean input_is_key_valid( const gchar *keysym );
282 gboolean input_is_key_registered( const gchar *keysym );
284 uint16_t input_keycode_to_dckeysym( uint16_t keycode );
286 /********************** Display/Input methods ***********************/
289 * Auxilliary input driver - provides input separate to and in addition to the
290 * core UI/display. (primarily used for joystick devices)
292 typedef struct input_driver {
293 const char *id; /* Short identifier to display in the UI for the device (eg "JS0" ) */
296 * Given a particular keysym, return the keycode associated with it.
297 * @param keysym The keysym to be resolved, ie "Tab"
298 * @return the display-specific keycode, or 0 if the keysym cannot
301 uint16_t (*resolve_keysym)( struct input_driver *driver, const gchar *keysym );
304 * Given a device-specific event code, convert it to a dreamcast keyboard code.
305 * This is only required for actual keyboard devices, other devices should just
306 * leave this method NULL.
308 uint16_t (*convert_to_dckeysym)( struct input_driver *driver, uint16_t keycode );
311 * Given a device-specific event code, return the corresponding keysym.
312 * The string should be newly allocated (caller will free)
314 gchar *(*get_keysym_for_keycode)( struct input_driver *driver, uint16_t keycode );
317 * Destroy the input driver.
319 void (*destroy)( struct input_driver *driver );
323 extern struct input_driver system_mouse_driver;
326 * Register a new input driver (which must have a unique name)
327 * @param driver the driver to register
328 * @param max_keycode the highest possible keycode reported by the device
329 * @return TRUE on success, FALSE on failure (eg driver already registed).
331 gboolean input_register_device( input_driver_t driver, uint16_t max_keycode );
334 * Determine if the system has an input driver with the given unique ID.
335 * @param id driver id to check
336 * @return TRUE if the device exists, otherwise FALSE
338 gboolean input_has_device( const gchar *id );
341 * Unregister an input driver.
342 * @param driver the driver to unregister
343 * If the driver is not in fact registered, this function has no effect.
345 void input_unregister_device( input_driver_t driver );
348 * Called from the UI to indicate that the emulation window is focused (ie
349 * able to receive input). This method is used to gate non-UI input devices -
350 * when the display is not focused, all input events will be silently ignored.
352 void display_set_focused( gboolean has_focus );
355 * Fire a keydown event on the specified device
356 * @param input The input device source generating the event, or NULL for the
358 * @param keycode The device-specific keycode
359 * @param pressure The pressure of the key (0 to 127), where 0 is unpressed and
360 * 127 is maximum pressure. Devices without pressure sensitivity should
361 * always use MAX_PRESSURE (127)
363 void input_event_keydown( input_driver_t input, uint16_t keycode, uint32_t pressure );
365 void input_event_keyup( input_driver_t input, uint16_t keycode );
368 * Receive an input mouse down event. Normally these should be absolute events when
369 * the mouse is not grabbed, and relative when it is.
370 * @param button the button pressed, where 0 == first button
371 * @param x_axis The relative or absolute position of the mouse cursor on the X axis
372 * @param y_axis The relative or absolute position of the mouse cursor on the Y axis
373 * @param absolute If TRUE, x_axis and y_axis are the current window coordinates
374 * of the mouse cursor. Otherwise, x_axis and y_axis are deltas from the previous mouse position.
376 void input_event_mousedown( uint16_t button, int32_t x_axis, int32_t y_axis, gboolean absolute );
379 * Receive an input mouse up event. Normally these should be absolute events when
380 * the mouse is not grabbed, and relative when it is.
381 * @param button the button released, where 0 == first button
382 * @param x_axis The relative or absolute position of the mouse cursor on the X axis
383 * @param y_axis The relative or absolute position of the mouse cursor on the Y axis
384 * @param absolute If TRUE, x_axis and y_axis are the current window coordinates
385 * of the mouse cursor. Otherwise, x_axis and y_axis are deltas from the previous mouse position.
387 void input_event_mouseup( uint16_t button, int32_t x_axis, int32_t y_axis, gboolean absolute );
390 * Receive an input mouse motion event. Normally these should be absolute events when
391 * the mouse is not grabbed, and relative when it is.
392 * @param x_axis The relative or absolute position of the mouse cursor on the X axis
393 * @param y_axis The relative or absolute position of the mouse cursor on the Y axis
394 * @param absolute If TRUE, x_axis and y_axis are the current window coordinates
395 * of the mouse cursor. Otherwise, x_axis and y_axis are deltas from the previous mouse position.
397 void input_event_mousemove( int32_t x_axis, int32_t y_axis, gboolean absolute );
400 * Given a keycode and the originating input driver, return the corresponding
401 * keysym. The caller is responsible for freeing the string.
402 * @return a newly allocated string, or NULL of the keycode is unresolvable.
404 gchar *input_keycode_to_keysym( input_driver_t driver, uint16_t keycode );
406 typedef void (*display_keysym_callback_t)( void *data, const gchar *keysym );
409 * Set the keysym hook function (normally used by the UI to receive non-UI
410 * input events during configuration.
412 void input_set_keysym_hook( display_keysym_callback_t hook, void *data );
419 #endif /* !lxdream_display_H */
.