Search
lxdream.org :: lxdream/src/display.h
lxdream 0.9.1
released Jun 29
Download Now
filename src/display.h
changeset 502:c4ecae2b1b5e
prev477:9a373f2ff009
next531:f0fee3ba71d1
author nkeynes
date Thu Nov 08 11:54:16 2007 +0000 (11 years ago)
permissions -rw-r--r--
last change Add sh4ptr_t type, start converting bare pointer refs to it
view annotate diff log raw
     1 /**
     2  * $Id: display.h,v 1.12 2007-11-08 11:54:16 nkeynes Exp $
     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 dream_video_H
    21 #define dream_video_H
    23 #include <stdint.h>
    24 #include <glib.h>
    25 #include <GL/gl.h>
    26 #include "lxdream.h"
    28 #ifdef __cplusplus
    29 extern "C" {
    30 #endif
    32 /**
    33  * Supported colour formats. Note that BGRA4444 is only ever used for texture
    34  * rendering (it's not valid for display purposes).
    35  */
    36 #define COLFMT_BGRA1555  0
    37 #define COLFMT_RGB565    1
    38 #define COLFMT_BGRA4444  2
    39 #define COLFMT_YUV422    3 /* 8-bit YUV (texture source only) */
    40 #define COLFMT_BGR888    4 /* 24-bit BGR */
    41 #define COLFMT_BGRA8888  5
    42 #define COLFMT_INDEX4    6 /* 4 bit indexed colour (texture source only) */
    43 #define COLFMT_INDEX8    7 /* 8-bit indexed colour (texture source only) */
    44 #define COLFMT_BGR0888   8 /* 32-bit BGR */
    45 #define COLFMT_RGB888    9 /* 24-bit RGB (ie GL native) */
    47 struct colour_format {
    48     GLint type, format, int_format;
    49     int bpp;
    50 };
    51 extern struct colour_format colour_formats[];
    53 extern int colour_format_bytes[];
    55 /**
    56  * Structure to hold pixel data held in GL buffers.
    57  */
    58 struct render_buffer {
    59     uint32_t width;
    60     uint32_t height;
    61     uint32_t rowstride;
    62     int colour_format;
    63     sh4addr_t address; /* Address buffer was rendered to, or -1 for unrendered */
    64     uint32_t size; /* Size of buffer in bytes, must be width*height*bpp */
    65     gboolean inverted;/* True if the buffer is upside down */
    66     int scale;
    67     unsigned int buf_id; /* driver-specific buffer id, if applicable */
    68     gboolean flushed; /* True if the buffer has been flushed to vram */
    69 };
    71 /**
    72  * Structure to hold pixel data stored in pvr2 vram, as opposed to data in
    73  * GL buffers.
    74  */
    75 struct frame_buffer {
    76     uint32_t width;
    77     uint32_t height;
    78     uint32_t rowstride;
    79     int colour_format;
    80     sh4addr_t address;
    81     uint32_t size; /* Size of buffer in bytes, must be width*height*bpp */
    82     gboolean inverted;/* True if the buffer is upside down */
    83     unsigned char *data;
    84 };
    86 /**
    87  * Core video driver - exports function to setup a GL context, as well as handle
    88  * keyboard input and display resultant output.
    89  */
    90 typedef struct display_driver {
    91     char *name;
    92     /**
    93      * Initialize the driver. This is called only once at startup time, and
    94      * is guaranteed to be called before any other methods.
    95      * @return TRUE if the driver was successfully initialized, otherwise
    96      * FALSE.
    97      */
    98     gboolean (*init_driver)(void);
   100     /**
   101      * Cleanly shutdown the driver. Normally only called at system shutdown
   102      * time.
   103      */
   104     void (*shutdown_driver)(void);
   106     /**
   107      * Given a particular keysym, return the keycode associated with it.
   108      * @param keysym The keysym to be resolved, ie "Tab"
   109      * @return the display-specific keycode, or 0 if the keysym cannot
   110      * be resolved.
   111      */
   112     uint16_t (*resolve_keysym)( const gchar *keysym );
   114     /**
   115      * Create a render target with the given width and height.
   116      */
   117     render_buffer_t (*create_render_buffer)( uint32_t width, uint32_t height );
   119     /**
   120      * Destroy the specified render buffer and release any associated
   121      * resources.
   122      */
   123     void (*destroy_render_buffer)( render_buffer_t buffer );
   125     /**
   126      * Set the current rendering target to the specified buffer.
   127      */
   128     gboolean (*set_render_target)( render_buffer_t buffer );
   130     /**
   131      * Load the supplied frame buffer into the given render buffer.
   132      * Included here to allow driver-specific optimizations.
   133      */
   134     void (*load_frame_buffer)( frame_buffer_t frame, render_buffer_t render );
   136     /**
   137      * Display a single frame using a previously rendered GL buffer.
   138      */
   139     gboolean (*display_render_buffer)( render_buffer_t buffer );
   141     /**
   142      * Display a single blanked frame using a fixed colour for the
   143      * entire frame (specified in BGR888 format). 
   144      */
   145     gboolean (*display_blank)( uint32_t rgb );
   147     /**
   148      * Copy the image data from the GL buffer to the target memory buffer,
   149      * using the format etc from the buffer. This may force a glFinish()
   150      * but does not invalidate the buffer.
   151      * @param target buffer to fill with image data, which must be large enough
   152      *  to accomodate the image.
   153      * @param buffer Render buffer to read from.
   154      * @param rowstride rowstride of the target data
   155      * @param format colour format to output the data in.
   156      */
   157     gboolean (*read_render_buffer)( unsigned char *target, render_buffer_t buffer,
   158 				    int rowstride, int format );
   160 } *display_driver_t;
   162 gboolean display_set_driver( display_driver_t driver );
   164 extern uint32_t pvr2_frame_counter;
   166 extern display_driver_t display_driver;
   168 extern struct display_driver display_gtk_driver;
   169 extern struct display_driver display_null_driver;
   171 /****************** Input methods **********************/
   173 typedef void (*input_key_callback_t)( void *data, uint32_t value, gboolean isKeyDown );
   175 gboolean input_register_key( const gchar *keysym, input_key_callback_t callback,
   176 			     void *data, uint32_t value );
   178 void input_unregister_key( const gchar *keysym, input_key_callback_t callback,
   179 			   void *data, uint32_t value );
   181 gboolean input_is_key_valid( const gchar *keysym );
   183 gboolean input_is_key_registered( const gchar *keysym );
   185 void input_event_keydown( uint16_t keycode );
   187 void input_event_keyup( uint16_t keycode );
   191 #ifdef __cplusplus
   192 }
   193 #endif
   194 #endif
.