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 {
108 int stencil_bits; /* 0 = no stencil buffer */
111 struct vertex_buffer {
113 * Map the buffer into the host address space (if necessary) in preparation
114 * for filling the buffer. This also implies a fence operation.
115 * @param buf previously allocated buffer
116 * @param size number of bytes of the buffer actually to be used. The buffer
117 * will be resized if necessary.
118 * @return a pointer to the start of the buffer.
120 void *(*map)(vertex_buffer_t buf, uint32_t size);
123 * Unmap the buffer, after the vertex data is written.
124 * @return the buffer base to use for gl*Pointer calls
126 void *(*unmap)(vertex_buffer_t buf);
129 * Mark the buffer as finished, indicating that the vertex data is no
130 * longer required (ie rendering is complete).
132 void (*finished)(vertex_buffer_t buf);
135 * Delete the buffer and all associated resources.
137 void (*destroy)(vertex_buffer_t buf);
143 uint32_t mapped_size;
149 * Core video driver - exports function to setup a GL context, as well as handle
150 * keyboard input and display resultant output.
152 typedef struct display_driver {
155 * Short (<60 chars) description of the driver. This should be marked for
160 * Initialize the driver. This is called only once at startup time, and
161 * is guaranteed to be called before any other methods.
162 * @return TRUE if the driver was successfully initialized, otherwise
165 gboolean (*init_driver)(void);
168 * Cleanly shutdown the driver. Normally only called at system shutdown
171 void (*shutdown_driver)(void);
174 * Given a particular keysym, return the keycode associated with it.
175 * @param keysym The keysym to be resolved, ie "Tab"
176 * @return the display-specific keycode, or 0 if the keysym cannot
179 uint16_t (*resolve_keysym)( const gchar *keysym );
182 * Given a native system keycode, convert it to a dreamcast keyboard code.
184 uint16_t (*convert_to_dckeysym)( uint16_t keycode );
187 * Given a device-specific event code, return the corresponding keysym.
188 * The string should be newly allocated (caller will free)
190 gchar *(*get_keysym_for_keycode)( uint16_t keycode );
193 * Create a render target with the given width and height. If a texture ID
194 * is supplied (non-zero), the render buffer writes its output to that texture.
195 * @param tex_id 0 or a valid GL texture name which must have been initialized to
196 * the correct dimensions.
198 render_buffer_t (*create_render_buffer)( uint32_t width, uint32_t height, GLuint tex_id );
201 * Destroy the specified render buffer and release any associated
204 void (*destroy_render_buffer)( render_buffer_t buffer );
207 * Set the current rendering target to the specified buffer.
209 gboolean (*set_render_target)( render_buffer_t buffer );
212 * Complete rendering and clear the current rendering target. If the
213 * buffer has a bound texture, it will be updated if necessary.
215 void (*finish_render)( render_buffer_t buffer );
218 * Load the supplied frame buffer into the given render buffer.
219 * Included here to allow driver-specific optimizations.
221 void (*load_frame_buffer)( frame_buffer_t frame, render_buffer_t render );
224 * Display a single frame using a previously rendered GL buffer.
226 void (*display_render_buffer)( render_buffer_t buffer );
229 * Display a single blanked frame using a fixed colour for the
230 * entire frame (specified in BGR888 format).
232 void (*display_blank)( uint32_t rgb );
235 * Swap front/back window buffers
237 void (*swap_buffers)();
240 * Copy the image data from the GL buffer to the target memory buffer,
241 * using the format etc from the buffer. This may force a glFinish()
242 * but does not invalidate the buffer.
243 * @param target buffer to fill with image data, which must be large enough
244 * to accomodate the image.
245 * @param buffer Render buffer to read from.
246 * @param rowstride rowstride of the target data
247 * @param format colour format to output the data in.
249 gboolean (*read_render_buffer)( unsigned char *target, render_buffer_t buffer,
250 int rowstride, int format );
253 * Create a new vertex buffer
255 vertex_buffer_t (*create_vertex_buffer)( );
258 * Dump driver-specific information about the implementation to the given stream
260 void (*print_info)( FILE *out );
262 struct display_capabilities capabilities;
267 * Print the configured video drivers to the output stream, one to a line.
269 void print_display_drivers( FILE *out );
270 display_driver_t get_display_driver_by_name( const char *name );
271 gboolean display_set_driver( display_driver_t driver );
273 extern uint32_t pvr2_frame_counter;
275 extern display_driver_t display_driver;
277 extern struct display_driver display_gtk_driver;
278 extern struct display_driver display_osx_driver;
279 extern struct display_driver display_null_driver;
281 /****************** Input methods **********************/
283 #define MAX_MOUSE_BUTTONS 32
285 /* Pressure is 0..127 (allowing a joystick to be defined as two half-axes of 7- bits each) */
286 #define MAX_PRESSURE 0x7F
288 typedef key_binding_t input_key_callback_t;
291 * Callback to receive mouse input events
292 * @param data pointer passed in at the time the hook was registered
293 * @param buttons bitmask of button states, where bit 0 is button 0 (left), bit 1 is button
294 * 1 (middle), bit 2 is button 2 (right) and so forth.
295 * @param x Horizontal movement since the last invocation (in relative mode) or window position
296 * (in absolute mode).
297 * @param y Vertical movement since the last invocation (in relative mode) or window position
298 * (in absolute mode).
299 * @param absolute If TRUE, x and y are the current window coordinates
300 * of the mouse cursor. Otherwise, x and y are deltas from the previous mouse position.
302 typedef void (*input_mouse_callback_t)( void *data, uint32_t buttons, int32_t x, int32_t y, gboolean absolute );
304 gboolean input_register_key( const gchar *keysym, input_key_callback_t callback,
305 void *data, uint32_t value );
307 void input_unregister_key( const gchar *keysym, input_key_callback_t callback,
308 void *data, uint32_t value );
310 gboolean input_register_keygroup( lxdream_config_group_t group );
311 void input_unregister_keygroup( lxdream_config_group_t group );
312 gboolean input_keygroup_changed( void *data, lxdream_config_group_t group, unsigned key,
313 const gchar *oldval, const gchar *newval );
316 * Register a hook to receive all keyboard input events
318 gboolean input_register_keyboard_hook( input_key_callback_t callback, void *data );
319 void input_unregister_keyboard_hook( input_key_callback_t callback, void *data );
322 * Register a mouse event hook.
323 * @param relative TRUE if the caller wants relative mouse movement, FALSE for
324 * absolute mouse positioning. It's not generally possible to receive both at the same time.
326 gboolean input_register_mouse_hook( gboolean relative, input_mouse_callback_t callback, void *data );
327 void input_unregister_mouse_hook( input_mouse_callback_t callback, void *data );
329 gboolean input_is_key_valid( const gchar *keysym );
331 gboolean input_is_key_registered( const gchar *keysym );
333 uint16_t input_keycode_to_dckeysym( uint16_t keycode );
335 /********************** Display/Input methods ***********************/
338 * Auxilliary input driver - provides input separate to and in addition to the
339 * core UI/display. (primarily used for joystick devices)
341 typedef struct input_driver {
342 const char *id; /* Short identifier to display in the UI for the device (eg "JS0" ) */
345 * Given a particular keysym, return the keycode associated with it.
346 * @param keysym The keysym to be resolved, ie "Tab"
347 * @return the display-specific keycode, or 0 if the keysym cannot
350 uint16_t (*resolve_keysym)( struct input_driver *driver, const gchar *keysym );
353 * Given a device-specific event code, convert it to a dreamcast keyboard code.
354 * This is only required for actual keyboard devices, other devices should just
355 * leave this method NULL.
357 uint16_t (*convert_to_dckeysym)( struct input_driver *driver, uint16_t keycode );
360 * Given a device-specific event code, return the corresponding keysym.
361 * The string should be newly allocated (caller will free)
363 gchar *(*get_keysym_for_keycode)( struct input_driver *driver, uint16_t keycode );
366 * Destroy the input driver.
368 void (*destroy)( struct input_driver *driver );
372 extern struct input_driver system_mouse_driver;
375 * Register a new input driver (which must have a unique name)
376 * @param driver the driver to register
377 * @param max_keycode the highest possible keycode reported by the device
378 * @return TRUE on success, FALSE on failure (eg driver already registed).
380 gboolean input_register_device( input_driver_t driver, uint16_t max_keycode );
383 * Determine if the system has an input driver with the given unique ID.
384 * @param id driver id to check
385 * @return TRUE if the device exists, otherwise FALSE
387 gboolean input_has_device( const gchar *id );
390 * Unregister an input driver.
391 * @param driver the driver to unregister
392 * If the driver is not in fact registered, this function has no effect.
394 void input_unregister_device( input_driver_t driver );
397 * Called from the UI to indicate that the emulation window is focused (ie
398 * able to receive input). This method is used to gate non-UI input devices -
399 * when the display is not focused, all input events will be silently ignored.
401 void display_set_focused( gboolean has_focus );
404 * Fire a keydown event on the specified device
405 * @param input The input device source generating the event, or NULL for the
407 * @param keycode The device-specific keycode
408 * @param pressure The pressure of the key (0 to 127), where 0 is unpressed and
409 * 127 is maximum pressure. Devices without pressure sensitivity should
410 * always use MAX_PRESSURE (127)
412 void input_event_keydown( input_driver_t input, uint16_t keycode, uint32_t pressure );
414 void input_event_keyup( input_driver_t input, uint16_t keycode );
417 * Receive an input mouse down event. Normally these should be absolute events when
418 * the mouse is not grabbed, and relative when it is.
419 * @param button the button pressed, where 0 == first button
420 * @param x_axis The relative or absolute position of the mouse cursor on the X axis
421 * @param y_axis The relative or absolute position of the mouse cursor on the Y axis
422 * @param absolute If TRUE, x_axis and y_axis are the current window coordinates
423 * of the mouse cursor. Otherwise, x_axis and y_axis are deltas from the previous mouse position.
425 void input_event_mousedown( uint16_t button, int32_t x_axis, int32_t y_axis, gboolean absolute );
428 * Receive an input mouse up event. Normally these should be absolute events when
429 * the mouse is not grabbed, and relative when it is.
430 * @param button the button released, where 0 == first button
431 * @param x_axis The relative or absolute position of the mouse cursor on the X axis
432 * @param y_axis The relative or absolute position of the mouse cursor on the Y axis
433 * @param absolute If TRUE, x_axis and y_axis are the current window coordinates
434 * of the mouse cursor. Otherwise, x_axis and y_axis are deltas from the previous mouse position.
436 void input_event_mouseup( uint16_t button, int32_t x_axis, int32_t y_axis, gboolean absolute );
439 * Receive an input mouse motion event. Normally these should be absolute events when
440 * the mouse is not grabbed, and relative when it is.
441 * @param x_axis The relative or absolute position of the mouse cursor on the X axis
442 * @param y_axis The relative or absolute position of the mouse cursor on the Y axis
443 * @param absolute If TRUE, x_axis and y_axis are the current window coordinates
444 * of the mouse cursor. Otherwise, x_axis and y_axis are deltas from the previous mouse position.
446 void input_event_mousemove( int32_t x_axis, int32_t y_axis, gboolean absolute );
449 * Given a keycode and the originating input driver, return the corresponding
450 * keysym. The caller is responsible for freeing the string.
451 * @return a newly allocated string, or NULL of the keycode is unresolvable.
453 gchar *input_keycode_to_keysym( input_driver_t driver, uint16_t keycode );
455 typedef void (*display_keysym_callback_t)( void *data, const gchar *keysym );
458 * Set the keysym hook function (normally used by the UI to receive non-UI
459 * input events during configuration.
461 void input_set_keysym_hook( display_keysym_callback_t hook, void *data );
468 #endif /* !lxdream_display_H */
.