2 * $Id: display.h,v 1.4 2007-01-27 12:03:53 nkeynes Exp $
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.
32 * Supported colour formats. Note that ARGB4444 is only ever used for texture
33 * rendering (it's not valid for display purposes).
35 #define COLFMT_ARGB1555 0
36 #define COLFMT_RGB565 1
37 #define COLFMT_ARGB4444 2
38 #define COLFMT_YUV422 3 /* 8-bit YUV (texture source only) */
39 #define COLFMT_RGB888 4 /* 24-bit RGB */
40 #define COLFMT_ARGB8888 5
41 #define COLFMT_INDEX4 6 /* 4 bit indexed colour (texture source only) */
42 #define COLFMT_INDEX8 7 /* 8-bit indexed colour (texture source only) */
43 #define COLFMT_RGB0888 8 /* 32-bit RGB */
45 struct colour_format {
46 GLint type, format, int_format;
49 extern struct colour_format colour_formats[];
51 extern int colour_format_bytes[];
53 typedef struct video_buffer {
63 * Core video driver - expected to directly support an OpenGL context
65 typedef struct display_driver {
68 * Initialize the driver. This is called only once at startup time, and
69 * is guaranteed to be called before any other methods.
70 * @return TRUE if the driver was successfully initialized, otherwise
73 gboolean (*init_driver)(void);
76 * Cleanly shutdown the driver. Normally only called at system shutdown
79 void (*shutdown_driver)(void);
82 * Given a particular keysym, return the keycode associated with it.
83 * @param keysym The keysym to be resolved, ie "Tab"
84 * @return the display-specific keycode, or 0 if the keysym cannot
87 uint16_t (*resolve_keysym)( const gchar *keysym );
90 * Set the current display format to the specified values. This is
91 * called immediately prior to any display frame call where the
92 * parameters have changed from the previous frame
94 gboolean (*set_display_format)( uint32_t hres, uint32_t vres,
98 * Set the current rendering format to the specified values. This is
99 * called immediately prior to starting rendering of a frame where the
100 * parameters have changed from the previous frame. Note that the driver
101 * is not required to precisely support the requested colour format.
103 * This method is also responsible for setting up an appropriate GL
104 * context for the main engine to render into.
106 * @param hres The horizontal resolution (ie 640)
107 * @param vres The vertical resolution (ie 480)
108 * @param colour_fmt The colour format of the buffer (ie COLFMT_ARGB4444)
109 * @param texture Flag indicating that the frame being rendered is a
110 * texture, rather than a display frame.
112 gboolean (*set_render_format)( uint32_t hres, uint32_t vres,
113 int colour_fmt, gboolean texture );
115 * Display a single frame using the supplied pixmap data. Is assumed to
116 * invalidate the current GL front buffer (but not the back buffer).
118 gboolean (*display_frame)( video_buffer_t buffer );
121 * Display a single blanked frame using a fixed colour for the
122 * entire frame (specified in RGB888 format). Is assumed to invalidate
123 * the current GL front buffer (but not the back buffer).
125 gboolean (*display_blank_frame)( uint32_t rgb );
128 * Promote the current render back buffer to the front buffer
130 void (*display_back_buffer)( void );
133 void video_open( void );
134 void video_update_frame( void );
135 void video_update_size( int, int, int );
137 extern uint32_t pvr2_frame_counter;
139 extern display_driver_t display_driver;
141 extern struct display_driver display_gtk_driver;
142 extern struct display_driver display_null_driver;
144 /****************** Input methods **********************/
146 typedef void (*input_key_callback_t)( void *data, uint32_t value, gboolean isKeyDown );
148 gboolean input_register_key( const gchar *keysym, input_key_callback_t callback,
149 void *data, uint32_t value );
151 void input_unregister_key( const gchar *keysym );
153 gboolean input_is_key_valid( const gchar *keysym );
155 gboolean input_is_key_registered( const gchar *keysym );
157 void input_event_keydown( uint16_t keycode );
159 void input_event_keyup( uint16_t keycode );
.