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
31 #include <OpenGL/gl.h>
32 #include <OpenGL/glext.h>
43 * Supported colour formats. Note that BGRA4444 is only ever used for texture
44 * rendering (it's not valid for display purposes).
46 #define COLFMT_BGRA1555 0
47 #define COLFMT_RGB565 1
48 #define COLFMT_BGRA4444 2
49 #define COLFMT_YUV422 3 /* 8-bit YUV (texture source only) */
50 #define COLFMT_BGR888 4 /* 24-bit BGR */
51 #define COLFMT_BGRA8888 5
52 #define COLFMT_INDEX4 6 /* 4 bit indexed colour (texture source only) */
53 #define COLFMT_INDEX8 7 /* 8-bit indexed colour (texture source only) */
54 #define COLFMT_BGR0888 8 /* 32-bit BGR */
55 #define COLFMT_RGB888 9 /* 24-bit RGB (ie GL native) */
58 * The standard display size (for the purposes of mouse inputs, etc, is 640x480 -
59 * events should be adjusted accordingly if this is not the actual window size.
61 #define DISPLAY_WIDTH 640
62 #define DISPLAY_HEIGHT 480
64 struct colour_format {
65 GLint type, format, int_format;
68 extern struct colour_format colour_formats[];
70 extern int colour_format_bytes[];
73 * Structure to hold pixel data held in GL buffers.
75 struct render_buffer {
79 uint32_t colour_format;
80 sh4addr_t address; /* Address buffer was rendered to, or -1 for unrendered */
81 uint32_t size; /* Size of buffer in bytes, must be width*height*bpp */
82 gboolean inverted;/* True if the buffer is upside down */
84 GLuint tex_id; /* texture bound to render buffer, if any (0 = none).
85 * The render buffer does not own the texture */
86 unsigned int buf_id; /* driver-specific buffer id, if applicable */
87 gboolean flushed; /* True if the buffer has been flushed to vram */
91 * Structure to hold pixel data stored in pvr2 vram, as opposed to data in
98 uint32_t colour_format;
100 uint32_t size; /* Size of buffer in bytes, must be width*height*bpp */
101 gboolean inverted;/* True if the buffer is upside down */
106 * Core video driver - exports function to setup a GL context, as well as handle
107 * keyboard input and display resultant output.
109 typedef struct display_driver {
112 * Short (<60 chars) description of the driver. This should be marked for
117 * Initialize the driver. This is called only once at startup time, and
118 * is guaranteed to be called before any other methods.
119 * @return TRUE if the driver was successfully initialized, otherwise
122 gboolean (*init_driver)(void);
125 * Cleanly shutdown the driver. Normally only called at system shutdown
128 void (*shutdown_driver)(void);
131 * Given a particular keysym, return the keycode associated with it.
132 * @param keysym The keysym to be resolved, ie "Tab"
133 * @return the display-specific keycode, or 0 if the keysym cannot
136 uint16_t (*resolve_keysym)( const gchar *keysym );
139 * Given a native system keycode, convert it to a dreamcast keyboard code.
141 uint16_t (*convert_to_dckeysym)( uint16_t keycode );
144 * Given a device-specific event code, return the corresponding keysym.
145 * The string should be newly allocated (caller will free)
147 gchar *(*get_keysym_for_keycode)( uint16_t keycode );
150 * Create a render target with the given width and height. If a texture ID
151 * is supplied (non-zero), the render buffer writes its output to that texture.
152 * @param tex_id 0 or a valid GL texture name which must have been initialized to
153 * the correct dimensions.
155 render_buffer_t (*create_render_buffer)( uint32_t width, uint32_t height, GLuint tex_id );
158 * Destroy the specified render buffer and release any associated
161 void (*destroy_render_buffer)( render_buffer_t buffer );
164 * Set the current rendering target to the specified buffer.
166 gboolean (*set_render_target)( render_buffer_t buffer );
169 * Complete rendering and clear the current rendering target. If the
170 * buffer has a bound texture, it will be updated if necessary.
172 void (*finish_render)( render_buffer_t buffer );
175 * Load the supplied frame buffer into the given render buffer.
176 * Included here to allow driver-specific optimizations.
178 void (*load_frame_buffer)( frame_buffer_t frame, render_buffer_t render );
181 * Display a single frame using a previously rendered GL buffer.
183 void (*display_render_buffer)( render_buffer_t buffer );
186 * Display a single blanked frame using a fixed colour for the
187 * entire frame (specified in BGR888 format).
189 void (*display_blank)( uint32_t rgb );
192 * Copy the image data from the GL buffer to the target memory buffer,
193 * using the format etc from the buffer. This may force a glFinish()
194 * but does not invalidate the buffer.
195 * @param target buffer to fill with image data, which must be large enough
196 * to accomodate the image.
197 * @param buffer Render buffer to read from.
198 * @param rowstride rowstride of the target data
199 * @param format colour format to output the data in.
201 gboolean (*read_render_buffer)( unsigned char *target, render_buffer_t buffer,
202 int rowstride, int format );
207 * Print the configured video drivers to the output stream, one to a line.
209 void print_display_drivers( FILE *out );
210 display_driver_t get_display_driver_by_name( const char *name );
211 gboolean display_set_driver( display_driver_t driver );
213 extern uint32_t pvr2_frame_counter;
215 extern display_driver_t display_driver;
217 extern struct display_driver display_gtk_driver;
218 extern struct display_driver display_osx_driver;
219 extern struct display_driver display_null_driver;
221 /****************** Input methods **********************/
223 #define MAX_MOUSE_BUTTONS 32
225 typedef void (*input_key_callback_t)( void *data, uint32_t value, uint32_t pressure, gboolean isKeyDown );
228 * Callback to receive mouse input events
229 * @param data pointer passed in at the time the hook was registered
230 * @param buttons bitmask of button states, where bit 0 is button 0 (left), bit 1 is button
231 * 1 (middle), bit 2 is button 2 (right) and so forth.
232 * @param x Horizontal movement since the last invocation (in relative mode) or window position
233 * (in absolute mode).
234 * @param y Vertical movement since the last invocation (in relative mode) or window position
235 * (in absolute mode).
236 * @param absolute If TRUE, x and y are the current window coordinates
237 * of the mouse cursor. Otherwise, x and y are deltas from the previous mouse position.
239 typedef void (*input_mouse_callback_t)( void *data, uint32_t buttons, int32_t x, int32_t y, gboolean absolute );
241 gboolean input_register_key( const gchar *keysym, input_key_callback_t callback,
242 void *data, uint32_t value );
244 void input_unregister_key( const gchar *keysym, input_key_callback_t callback,
245 void *data, uint32_t value );
248 * Register a hook to receive all keyboard input events
250 gboolean input_register_keyboard_hook( input_key_callback_t callback, void *data );
251 void input_unregister_keyboard_hook( input_key_callback_t callback, void *data );
254 * Register a mouse event hook.
255 * @param relative TRUE if the caller wants relative mouse movement, FALSE for
256 * absolute mouse positioning. It's not generally possible to receive both at the same time.
258 gboolean input_register_mouse_hook( gboolean relative, input_mouse_callback_t callback, void *data );
259 void input_unregister_mouse_hook( input_mouse_callback_t callback, void *data );
261 gboolean input_is_key_valid( const gchar *keysym );
263 gboolean input_is_key_registered( const gchar *keysym );
265 uint16_t input_keycode_to_dckeysym( uint16_t keycode );
267 /********************** Display/Input methods ***********************/
270 * Auxilliary input driver - provides input separate to and in addition to the
271 * core UI/display. (primarily used for joystick devices)
273 typedef struct input_driver {
274 const char *id; /* Short identifier to display in the UI for the device (eg "JS0" ) */
277 * Given a particular keysym, return the keycode associated with it.
278 * @param keysym The keysym to be resolved, ie "Tab"
279 * @return the display-specific keycode, or 0 if the keysym cannot
282 uint16_t (*resolve_keysym)( struct input_driver *driver, const gchar *keysym );
285 * Given a device-specific event code, convert it to a dreamcast keyboard code.
286 * This is only required for actual keyboard devices, other devices should just
287 * leave this method NULL.
289 uint16_t (*convert_to_dckeysym)( struct input_driver *driver, uint16_t keycode );
292 * Given a device-specific event code, return the corresponding keysym.
293 * The string should be newly allocated (caller will free)
295 gchar *(*get_keysym_for_keycode)( struct input_driver *driver, uint16_t keycode );
298 * Destroy the input driver.
300 void (*destroy)( struct input_driver *driver );
304 extern struct input_driver system_mouse_driver;
307 * Register a new input driver (which must have a unique name)
308 * @param driver the driver to register
309 * @param max_keycode the highest possible keycode reported by the device
310 * @return TRUE on success, FALSE on failure (eg driver already registed).
312 gboolean input_register_device( input_driver_t driver, uint16_t max_keycode );
315 * Determine if the system has an input driver with the given unique ID.
316 * @param id driver id to check
317 * @return TRUE if the device exists, otherwise FALSE
319 gboolean input_has_device( const gchar *id );
322 * Unregister an input driver.
323 * @param driver the driver to unregister
324 * If the driver is not in fact registered, this function has no effect.
326 void input_unregister_device( input_driver_t driver );
329 * Called from the UI to indicate that the emulation window is focused (ie
330 * able to receive input). This method is used to gate non-UI input devices -
331 * when the display is not focused, all input events will be silently ignored.
333 void display_set_focused( gboolean has_focus );
335 void input_event_keydown( input_driver_t input, uint16_t keycode, uint32_t pressure );
337 void input_event_keyup( input_driver_t input, uint16_t keycode, uint32_t pressure );
340 * Receive an input mouse down event. Normally these should be absolute events when
341 * the mouse is not grabbed, and relative when it is.
342 * @param button the button pressed, where 0 == first button
343 * @param x_axis The relative or absolute position of the mouse cursor on the X axis
344 * @param y_axis The relative or absolute position of the mouse cursor on the Y axis
345 * @param absolute If TRUE, x_axis and y_axis are the current window coordinates
346 * of the mouse cursor. Otherwise, x_axis and y_axis are deltas from the previous mouse position.
348 void input_event_mousedown( uint16_t button, int32_t x_axis, int32_t y_axis, gboolean absolute );
351 * Receive an input mouse up event. Normally these should be absolute events when
352 * the mouse is not grabbed, and relative when it is.
353 * @param button the button released, where 0 == first button
354 * @param x_axis The relative or absolute position of the mouse cursor on the X axis
355 * @param y_axis The relative or absolute position of the mouse cursor on the Y axis
356 * @param absolute If TRUE, x_axis and y_axis are the current window coordinates
357 * of the mouse cursor. Otherwise, x_axis and y_axis are deltas from the previous mouse position.
359 void input_event_mouseup( uint16_t button, int32_t x_axis, int32_t y_axis, gboolean absolute );
362 * Receive an input mouse motion event. Normally these should be absolute events when
363 * the mouse is not grabbed, and relative when it is.
364 * @param x_axis The relative or absolute position of the mouse cursor on the X axis
365 * @param y_axis The relative or absolute position of the mouse cursor on the Y axis
366 * @param absolute If TRUE, x_axis and y_axis are the current window coordinates
367 * of the mouse cursor. Otherwise, x_axis and y_axis are deltas from the previous mouse position.
369 void input_event_mousemove( int32_t x_axis, int32_t y_axis, gboolean absolute );
372 * Given a keycode and the originating input driver, return the corresponding
373 * keysym. The caller is responsible for freeing the string.
374 * @return a newly allocated string, or NULL of the keycode is unresolvable.
376 gchar *input_keycode_to_keysym( input_driver_t driver, uint16_t keycode );
378 typedef void (*display_keysym_callback_t)( void *data, const gchar *keysym );
381 * Set the keysym hook function (normally used by the UI to receive non-UI
382 * input events during configuration.
384 void input_set_keysym_hook( display_keysym_callback_t hook, void *data );
391 #endif /* !lxdream_display_H */
.