lxdream 0.9.1| filename | src/display.h |
| changeset | 805:b355f7b3ff2e |
| prev | 770:429ff505c450 |
| next | 839:51f1c4195790 |
| author | nkeynes |
| date | Sun Aug 24 02:43:28 2008 +0000 (15 years ago) |
| permissions | -rw-r--r-- |
| last change | Fix mask correctness of MMU/general IO registers, add unknown/undoced register at FF00002C |
| view | annotate | diff | log | raw |
1 /**
2 * $Id$
3 *
4 * The PC side of the video support (responsible for actually displaying /
5 * rendering frames)
6 *
7 * Copyright (c) 2005 Nathan Keynes.
8 *
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.
13 *
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.
18 */
20 #ifndef lxdream_display_H
21 #define lxdream_display_H 1
23 #define GL_GLEXT_PROTOTYPES 1
25 #include <stdint.h>
26 #include <stdio.h>
27 #include <glib.h>
28 #include "lxdream.h"
29 #include "gettext.h"
30 #ifdef APPLE_BUILD
31 #include <OpenGL/gl.h>
32 #include <OpenGL/glext.h>
33 #else
34 #include <GL/gl.h>
35 #include <GL/glext.h>
36 #endif
38 #ifdef __cplusplus
39 extern "C" {
40 #endif
42 /**
43 * Supported colour formats. Note that BGRA4444 is only ever used for texture
44 * rendering (it's not valid for display purposes).
45 */
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) */
57 struct colour_format {
58 GLint type, format, int_format;
59 int bpp;
60 };
61 extern struct colour_format colour_formats[];
63 extern int colour_format_bytes[];
65 /**
66 * Structure to hold pixel data held in GL buffers.
67 */
68 struct render_buffer {
69 uint32_t width;
70 uint32_t height;
71 uint32_t rowstride;
72 uint32_t colour_format;
73 sh4addr_t address; /* Address buffer was rendered to, or -1 for unrendered */
74 uint32_t size; /* Size of buffer in bytes, must be width*height*bpp */
75 gboolean inverted;/* True if the buffer is upside down */
76 uint32_t scale;
77 GLuint tex_id; /* texture bound to render buffer, if any (0 = none).
78 * The render buffer does not own the texture */
79 unsigned int buf_id; /* driver-specific buffer id, if applicable */
80 gboolean flushed; /* True if the buffer has been flushed to vram */
81 };
83 /**
84 * Structure to hold pixel data stored in pvr2 vram, as opposed to data in
85 * GL buffers.
86 */
87 struct frame_buffer {
88 uint32_t width;
89 uint32_t height;
90 uint32_t rowstride;
91 uint32_t colour_format;
92 sh4addr_t address;
93 uint32_t size; /* Size of buffer in bytes, must be width*height*bpp */
94 gboolean inverted;/* True if the buffer is upside down */
95 unsigned char *data;
96 };
98 /**
99 * Core video driver - exports function to setup a GL context, as well as handle
100 * keyboard input and display resultant output.
101 */
102 typedef struct display_driver {
103 char *name;
104 /**
105 * Short (<60 chars) description of the driver. This should be marked for
106 * localization.
107 */
108 char *description;
109 /**
110 * Initialize the driver. This is called only once at startup time, and
111 * is guaranteed to be called before any other methods.
112 * @return TRUE if the driver was successfully initialized, otherwise
113 * FALSE.
114 */
115 gboolean (*init_driver)(void);
117 /**
118 * Cleanly shutdown the driver. Normally only called at system shutdown
119 * time.
120 */
121 void (*shutdown_driver)(void);
123 /**
124 * Given a particular keysym, return the keycode associated with it.
125 * @param keysym The keysym to be resolved, ie "Tab"
126 * @return the display-specific keycode, or 0 if the keysym cannot
127 * be resolved.
128 */
129 uint16_t (*resolve_keysym)( const gchar *keysym );
131 /**
132 * Given a native system keycode, convert it to a dreamcast keyboard code.
133 */
134 uint16_t (*convert_to_dckeysym)( uint16_t keycode );
136 /**
137 * Given a device-specific event code, return the corresponding keysym.
138 * The string should be newly allocated (caller will free)
139 */
140 gchar *(*get_keysym_for_keycode)( uint16_t keycode );
142 /**
143 * Create a render target with the given width and height. If a texture ID
144 * is supplied (non-zero), the render buffer writes its output to that texture.
145 * @param tex_id 0 or a valid GL texture name which must have been initialized to
146 * the correct dimensions.
147 */
148 render_buffer_t (*create_render_buffer)( uint32_t width, uint32_t height, GLuint tex_id );
150 /**
151 * Destroy the specified render buffer and release any associated
152 * resources.
153 */
154 void (*destroy_render_buffer)( render_buffer_t buffer );
156 /**
157 * Set the current rendering target to the specified buffer.
158 */
159 gboolean (*set_render_target)( render_buffer_t buffer );
161 /**
162 * Complete rendering and clear the current rendering target. If the
163 * buffer has a bound texture, it will be updated if necessary.
164 */
165 void (*finish_render)( render_buffer_t buffer );
167 /**
168 * Load the supplied frame buffer into the given render buffer.
169 * Included here to allow driver-specific optimizations.
170 */
171 void (*load_frame_buffer)( frame_buffer_t frame, render_buffer_t render );
173 /**
174 * Display a single frame using a previously rendered GL buffer.
175 */
176 void (*display_render_buffer)( render_buffer_t buffer );
178 /**
179 * Display a single blanked frame using a fixed colour for the
180 * entire frame (specified in BGR888 format).
181 */
182 void (*display_blank)( uint32_t rgb );
184 /**
185 * Copy the image data from the GL buffer to the target memory buffer,
186 * using the format etc from the buffer. This may force a glFinish()
187 * but does not invalidate the buffer.
188 * @param target buffer to fill with image data, which must be large enough
189 * to accomodate the image.
190 * @param buffer Render buffer to read from.
191 * @param rowstride rowstride of the target data
192 * @param format colour format to output the data in.
193 */
194 gboolean (*read_render_buffer)( unsigned char *target, render_buffer_t buffer,
195 int rowstride, int format );
197 } *display_driver_t;
199 /**
200 * Print the configured video drivers to the output stream, one to a line.
201 */
202 void print_display_drivers( FILE *out );
203 display_driver_t get_display_driver_by_name( const char *name );
204 gboolean display_set_driver( display_driver_t driver );
206 extern uint32_t pvr2_frame_counter;
208 extern display_driver_t display_driver;
210 extern struct display_driver display_gtk_driver;
211 extern struct display_driver display_osx_driver;
212 extern struct display_driver display_null_driver;
214 /****************** Input methods **********************/
216 typedef void (*input_key_callback_t)( void *data, uint32_t value, uint32_t pressure, gboolean isKeyDown );
218 /**
219 * Callback to receive mouse input events
220 * @param data pointer passed in at the time the hook was registered
221 * @param buttons bitmask of button states, where bit 0 is button 0 (left), bit 1 is button
222 * 1 (middle), bit 2 is button 2 (right) and so forth.
223 * @param x Horizontal movement since the last invocation (in relative mode) or window position
224 * (in absolute mode).
225 * @param y Vertical movement since the last invocation (in relative mode) or window position
226 * (in absolute mode).
227 */
228 typedef void (*input_mouse_callback_t)( void *data, uint32_t buttons, int32_t x, int32_t y );
230 gboolean input_register_key( const gchar *keysym, input_key_callback_t callback,
231 void *data, uint32_t value );
233 void input_unregister_key( const gchar *keysym, input_key_callback_t callback,
234 void *data, uint32_t value );
236 /**
237 * Register a hook to receive all input events
238 */
239 gboolean input_register_hook( input_key_callback_t callback, void *data );
240 void input_unregister_hook( input_key_callback_t callback, void *data );
242 /**
243 * Register a mouse event hook.
244 * @param relative TRUE if the caller wants relative mouse movement, FALSE for
245 * absolute mouse positioning. It's not generally possible to receive both at the same time.
246 */
247 gboolean input_register_mouse_hook( gboolean relative, input_mouse_callback_t callback, void *data );
248 void input_unregister_mouse_hook( input_mouse_callback_t callback, void *data );
250 gboolean input_is_key_valid( const gchar *keysym );
252 gboolean input_is_key_registered( const gchar *keysym );
254 uint16_t input_keycode_to_dckeysym( uint16_t keycode );
256 /********************** Display/Input methods ***********************/
258 /**
259 * Auxilliary input driver - provides input separate to and in addition to the
260 * core UI/display. (primarily used for joystick devices)
261 */
262 typedef struct input_driver {
263 const char *id; /* Short identifier to display in the UI for the device (eg "JS0" ) */
265 /**
266 * Given a particular keysym, return the keycode associated with it.
267 * @param keysym The keysym to be resolved, ie "Tab"
268 * @return the display-specific keycode, or 0 if the keysym cannot
269 * be resolved.
270 */
271 uint16_t (*resolve_keysym)( struct input_driver *driver, const gchar *keysym );
273 /**
274 * Given a device-specific event code, convert it to a dreamcast keyboard code.
275 * This is only required for actual keyboard devices, other devices should just
276 * leave this method NULL.
277 */
278 uint16_t (*convert_to_dckeysym)( struct input_driver *driver, uint16_t keycode );
280 /**
281 * Given a device-specific event code, return the corresponding keysym.
282 * The string should be newly allocated (caller will free)
283 */
284 gchar *(*get_keysym_for_keycode)( struct input_driver *driver, uint16_t keycode );
286 /**
287 * Destroy the input driver.
288 */
289 void (*destroy)( struct input_driver *driver );
291 } *input_driver_t;
293 /**
294 * Register a new input driver (which must have a unique name)
295 * @param driver the driver to register
296 * @param max_keycode the highest possible keycode reported by the device
297 * @return TRUE on success, FALSE on failure (eg driver already registed).
298 */
299 gboolean input_register_device( input_driver_t driver, uint16_t max_keycode );
301 /**
302 * Determine if the system has an input driver with the given unique ID.
303 * @param id driver id to check
304 * @return TRUE if the device exists, otherwise FALSE
305 */
306 gboolean input_has_device( const gchar *id );
308 /**
309 * Unregister an input driver.
310 * @param driver the driver to unregister
311 * If the driver is not in fact registered, this function has no effect.
312 */
313 void input_unregister_device( input_driver_t driver );
315 /**
316 * Called from the UI to indicate that the emulation window is focused (ie
317 * able to receive input). This method is used to gate non-UI input devices -
318 * when the display is not focused, all input events will be silently ignored.
319 */
320 void display_set_focused( gboolean has_focus );
322 void input_event_keydown( input_driver_t input, uint16_t keycode, uint32_t pressure );
324 void input_event_keyup( input_driver_t input, uint16_t keycode, uint32_t pressure );
326 void input_event_mouse( uint32_t buttons, int32_t x_axis, int32_t y_axis );
328 /**
329 * Given a keycode and the originating input driver, return the corresponding
330 * keysym. The caller is responsible for freeing the string.
331 * @return a newly allocated string, or NULL of the keycode is unresolvable.
332 */
333 gchar *input_keycode_to_keysym( input_driver_t driver, uint16_t keycode );
335 typedef void (*display_keysym_callback_t)( void *data, const gchar *keysym );
337 /**
338 * Set the keysym hook function (normally used by the UI to receive non-UI
339 * input events during configuration.
340 */
341 void input_set_keysym_hook( display_keysym_callback_t hook, void *data );
345 #ifdef __cplusplus
346 }
347 #endif
348 #endif /* !lxdream_display_H */
.