Search
lxdream.org :: lxdream/src/display.h
lxdream 0.9.1
released Jun 29
Download Now
filename src/display.h
changeset 531:f0fee3ba71d1
prev502:c4ecae2b1b5e
next540:a3767018a96d
author nkeynes
date Mon Nov 19 08:47:39 2007 +0000 (11 years ago)
permissions -rw-r--r--
last change Move name-to-driver mappings to display.c and audio.c respectively
Move responsibility for invoking texcache_gl_init() to the driver
file annotate diff log raw
nkeynes@144
     1
/**
nkeynes@502
     2
 * $Id: display.h,v 1.12 2007-11-08 11:54:16 nkeynes Exp $
nkeynes@144
     3
 *
nkeynes@144
     4
 * The PC side of the video support (responsible for actually displaying / 
nkeynes@144
     5
 * rendering frames)
nkeynes@144
     6
 *
nkeynes@144
     7
 * Copyright (c) 2005 Nathan Keynes.
nkeynes@144
     8
 *
nkeynes@144
     9
 * This program is free software; you can redistribute it and/or modify
nkeynes@144
    10
 * it under the terms of the GNU General Public License as published by
nkeynes@144
    11
 * the Free Software Foundation; either version 2 of the License, or
nkeynes@144
    12
 * (at your option) any later version.
nkeynes@144
    13
 *
nkeynes@144
    14
 * This program is distributed in the hope that it will be useful,
nkeynes@144
    15
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
nkeynes@144
    16
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
nkeynes@144
    17
 * GNU General Public License for more details.
nkeynes@144
    18
 */
nkeynes@144
    19
nkeynes@144
    20
#ifndef dream_video_H
nkeynes@144
    21
#define dream_video_H
nkeynes@144
    22
nkeynes@144
    23
#include <stdint.h>
nkeynes@144
    24
#include <glib.h>
nkeynes@327
    25
#include <GL/gl.h>
nkeynes@477
    26
#include "lxdream.h"
nkeynes@144
    27
nkeynes@144
    28
#ifdef __cplusplus
nkeynes@144
    29
extern "C" {
nkeynes@144
    30
#endif
nkeynes@144
    31
nkeynes@144
    32
/**
nkeynes@477
    33
 * Supported colour formats. Note that BGRA4444 is only ever used for texture
nkeynes@144
    34
 * rendering (it's not valid for display purposes).
nkeynes@144
    35
 */
nkeynes@477
    36
#define COLFMT_BGRA1555  0
nkeynes@144
    37
#define COLFMT_RGB565    1
nkeynes@477
    38
#define COLFMT_BGRA4444  2
nkeynes@144
    39
#define COLFMT_YUV422    3 /* 8-bit YUV (texture source only) */
nkeynes@477
    40
#define COLFMT_BGR888    4 /* 24-bit BGR */
nkeynes@477
    41
#define COLFMT_BGRA8888  5
nkeynes@144
    42
#define COLFMT_INDEX4    6 /* 4 bit indexed colour (texture source only) */
nkeynes@144
    43
#define COLFMT_INDEX8    7 /* 8-bit indexed colour (texture source only) */
nkeynes@477
    44
#define COLFMT_BGR0888   8 /* 32-bit BGR */
nkeynes@477
    45
#define COLFMT_RGB888    9 /* 24-bit RGB (ie GL native) */
nkeynes@327
    46
nkeynes@327
    47
struct colour_format {
nkeynes@327
    48
    GLint type, format, int_format;
nkeynes@327
    49
    int bpp;
nkeynes@327
    50
};
nkeynes@327
    51
extern struct colour_format colour_formats[];
nkeynes@144
    52
nkeynes@162
    53
extern int colour_format_bytes[];
nkeynes@162
    54
nkeynes@352
    55
/**
nkeynes@352
    56
 * Structure to hold pixel data held in GL buffers.
nkeynes@352
    57
 */
nkeynes@477
    58
struct render_buffer {
nkeynes@352
    59
    uint32_t width;
nkeynes@352
    60
    uint32_t height;
nkeynes@144
    61
    uint32_t rowstride;
nkeynes@144
    62
    int colour_format;
nkeynes@352
    63
    sh4addr_t address; /* Address buffer was rendered to, or -1 for unrendered */
nkeynes@352
    64
    uint32_t size; /* Size of buffer in bytes, must be width*height*bpp */
nkeynes@477
    65
    gboolean inverted;/* True if the buffer is upside down */
nkeynes@352
    66
    int scale;
nkeynes@424
    67
    unsigned int buf_id; /* driver-specific buffer id, if applicable */
nkeynes@352
    68
    gboolean flushed; /* True if the buffer has been flushed to vram */
nkeynes@477
    69
};
nkeynes@144
    70
nkeynes@144
    71
/**
nkeynes@352
    72
 * Structure to hold pixel data stored in pvr2 vram, as opposed to data in
nkeynes@352
    73
 * GL buffers.
nkeynes@352
    74
 */
nkeynes@477
    75
struct frame_buffer {
nkeynes@352
    76
    uint32_t width;
nkeynes@352
    77
    uint32_t height;
nkeynes@352
    78
    uint32_t rowstride;
nkeynes@352
    79
    int colour_format;
nkeynes@352
    80
    sh4addr_t address;
nkeynes@352
    81
    uint32_t size; /* Size of buffer in bytes, must be width*height*bpp */
nkeynes@477
    82
    gboolean inverted;/* True if the buffer is upside down */
nkeynes@502
    83
    unsigned char *data;
nkeynes@477
    84
};
nkeynes@352
    85
nkeynes@352
    86
/**
nkeynes@352
    87
 * Core video driver - exports function to setup a GL context, as well as handle
nkeynes@352
    88
 * keyboard input and display resultant output.
nkeynes@144
    89
 */
nkeynes@144
    90
typedef struct display_driver {
nkeynes@144
    91
    char *name;
nkeynes@144
    92
    /**
nkeynes@144
    93
     * Initialize the driver. This is called only once at startup time, and
nkeynes@144
    94
     * is guaranteed to be called before any other methods.
nkeynes@144
    95
     * @return TRUE if the driver was successfully initialized, otherwise
nkeynes@144
    96
     * FALSE.
nkeynes@144
    97
     */
nkeynes@144
    98
    gboolean (*init_driver)(void);
nkeynes@144
    99
nkeynes@144
   100
    /**
nkeynes@144
   101
     * Cleanly shutdown the driver. Normally only called at system shutdown
nkeynes@144
   102
     * time.
nkeynes@144
   103
     */
nkeynes@144
   104
    void (*shutdown_driver)(void);
nkeynes@144
   105
nkeynes@144
   106
    /**
nkeynes@144
   107
     * Given a particular keysym, return the keycode associated with it.
nkeynes@144
   108
     * @param keysym The keysym to be resolved, ie "Tab"
nkeynes@144
   109
     * @return the display-specific keycode, or 0 if the keysym cannot
nkeynes@144
   110
     * be resolved.
nkeynes@144
   111
     */
nkeynes@144
   112
    uint16_t (*resolve_keysym)( const gchar *keysym );
nkeynes@144
   113
nkeynes@144
   114
    /**
nkeynes@352
   115
     * Create a render target with the given width and height.
nkeynes@144
   116
     */
nkeynes@352
   117
    render_buffer_t (*create_render_buffer)( uint32_t width, uint32_t height );
nkeynes@144
   118
nkeynes@144
   119
    /**
nkeynes@352
   120
     * Destroy the specified render buffer and release any associated
nkeynes@352
   121
     * resources.
nkeynes@144
   122
     */
nkeynes@352
   123
    void (*destroy_render_buffer)( render_buffer_t buffer );
nkeynes@352
   124
nkeynes@144
   125
    /**
nkeynes@352
   126
     * Set the current rendering target to the specified buffer.
nkeynes@144
   127
     */
nkeynes@352
   128
    gboolean (*set_render_target)( render_buffer_t buffer );
nkeynes@352
   129
nkeynes@352
   130
    /**
nkeynes@477
   131
     * Load the supplied frame buffer into the given render buffer.
nkeynes@477
   132
     * Included here to allow driver-specific optimizations.
nkeynes@352
   133
     */
nkeynes@477
   134
    void (*load_frame_buffer)( frame_buffer_t frame, render_buffer_t render );
nkeynes@352
   135
nkeynes@352
   136
    /**
nkeynes@352
   137
     * Display a single frame using a previously rendered GL buffer.
nkeynes@352
   138
     */
nkeynes@352
   139
    gboolean (*display_render_buffer)( render_buffer_t buffer );
nkeynes@144
   140
nkeynes@144
   141
    /**
nkeynes@144
   142
     * Display a single blanked frame using a fixed colour for the
nkeynes@477
   143
     * entire frame (specified in BGR888 format). 
nkeynes@144
   144
     */
nkeynes@352
   145
    gboolean (*display_blank)( uint32_t rgb );
nkeynes@144
   146
nkeynes@144
   147
    /**
nkeynes@352
   148
     * Copy the image data from the GL buffer to the target memory buffer,
nkeynes@352
   149
     * using the format etc from the buffer. This may force a glFinish()
nkeynes@352
   150
     * but does not invalidate the buffer.
nkeynes@477
   151
     * @param target buffer to fill with image data, which must be large enough
nkeynes@477
   152
     *  to accomodate the image.
nkeynes@477
   153
     * @param buffer Render buffer to read from.
nkeynes@477
   154
     * @param rowstride rowstride of the target data
nkeynes@477
   155
     * @param format colour format to output the data in.
nkeynes@144
   156
     */
nkeynes@477
   157
    gboolean (*read_render_buffer)( unsigned char *target, render_buffer_t buffer,
nkeynes@477
   158
				    int rowstride, int format );
nkeynes@352
   159
nkeynes@144
   160
} *display_driver_t;
nkeynes@144
   161
nkeynes@531
   162
display_driver_t get_display_driver_by_name( const char *name );
nkeynes@370
   163
gboolean display_set_driver( display_driver_t driver );
nkeynes@144
   164
nkeynes@144
   165
extern uint32_t pvr2_frame_counter;
nkeynes@144
   166
nkeynes@144
   167
extern display_driver_t display_driver;
nkeynes@144
   168
nkeynes@144
   169
extern struct display_driver display_gtk_driver;
nkeynes@144
   170
extern struct display_driver display_null_driver;
nkeynes@144
   171
nkeynes@144
   172
/****************** Input methods **********************/
nkeynes@144
   173
nkeynes@144
   174
typedef void (*input_key_callback_t)( void *data, uint32_t value, gboolean isKeyDown );
nkeynes@144
   175
nkeynes@144
   176
gboolean input_register_key( const gchar *keysym, input_key_callback_t callback,
nkeynes@144
   177
			     void *data, uint32_t value );
nkeynes@144
   178
nkeynes@451
   179
void input_unregister_key( const gchar *keysym, input_key_callback_t callback,
nkeynes@451
   180
			   void *data, uint32_t value );
nkeynes@144
   181
nkeynes@144
   182
gboolean input_is_key_valid( const gchar *keysym );
nkeynes@144
   183
nkeynes@144
   184
gboolean input_is_key_registered( const gchar *keysym );
nkeynes@144
   185
nkeynes@144
   186
void input_event_keydown( uint16_t keycode );
nkeynes@144
   187
nkeynes@144
   188
void input_event_keyup( uint16_t keycode );
nkeynes@144
   189
nkeynes@144
   190
nkeynes@144
   191
nkeynes@144
   192
#ifdef __cplusplus
nkeynes@144
   193
}
nkeynes@144
   194
#endif
nkeynes@144
   195
#endif
.