Search
lxdream.org :: lxdream/src/display.h
lxdream 0.9.1
released Jun 29
Download Now
filename src/display.h
changeset 451:50622730f226
prev429:e581b90c3fb3
next477:9a373f2ff009
author nkeynes
date Sun Oct 21 05:15:56 2007 +0000 (12 years ago)
permissions -rw-r--r--
last change Unregister keys on controller detach
file annotate diff log raw
nkeynes@144
     1
/**
nkeynes@451
     2
 * $Id: display.h,v 1.10 2007-10-21 05:15:56 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@422
    26
#include "dream.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@144
    33
 * Supported colour formats. Note that ARGB4444 is only ever used for texture
nkeynes@144
    34
 * rendering (it's not valid for display purposes).
nkeynes@144
    35
 */
nkeynes@327
    36
#define COLFMT_ARGB1555  0
nkeynes@144
    37
#define COLFMT_RGB565    1
nkeynes@144
    38
#define COLFMT_ARGB4444  2
nkeynes@144
    39
#define COLFMT_YUV422    3 /* 8-bit YUV (texture source only) */
nkeynes@327
    40
#define COLFMT_RGB888    4 /* 24-bit RGB */
nkeynes@327
    41
#define COLFMT_ARGB8888  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@327
    44
#define COLFMT_RGB0888   8 /* 32-bit RGB */
nkeynes@327
    45
nkeynes@327
    46
struct colour_format {
nkeynes@327
    47
    GLint type, format, int_format;
nkeynes@327
    48
    int bpp;
nkeynes@327
    49
};
nkeynes@327
    50
extern struct colour_format colour_formats[];
nkeynes@144
    51
nkeynes@162
    52
extern int colour_format_bytes[];
nkeynes@162
    53
nkeynes@352
    54
/**
nkeynes@352
    55
 * Structure to hold pixel data held in GL buffers.
nkeynes@352
    56
 */
nkeynes@352
    57
typedef struct render_buffer {
nkeynes@352
    58
    uint32_t width;
nkeynes@352
    59
    uint32_t height;
nkeynes@144
    60
    uint32_t rowstride;
nkeynes@144
    61
    int colour_format;
nkeynes@352
    62
    sh4addr_t address; /* Address buffer was rendered to, or -1 for unrendered */
nkeynes@352
    63
    uint32_t size; /* Size of buffer in bytes, must be width*height*bpp */
nkeynes@352
    64
    int scale;
nkeynes@424
    65
    unsigned int buf_id; /* driver-specific buffer id, if applicable */
nkeynes@352
    66
    gboolean flushed; /* True if the buffer has been flushed to vram */
nkeynes@352
    67
} *render_buffer_t;
nkeynes@144
    68
nkeynes@144
    69
/**
nkeynes@352
    70
 * Structure to hold pixel data stored in pvr2 vram, as opposed to data in
nkeynes@352
    71
 * GL buffers.
nkeynes@352
    72
 */
nkeynes@352
    73
typedef struct frame_buffer {
nkeynes@352
    74
    uint32_t width;
nkeynes@352
    75
    uint32_t height;
nkeynes@352
    76
    uint32_t rowstride;
nkeynes@352
    77
    int colour_format;
nkeynes@352
    78
    sh4addr_t address;
nkeynes@352
    79
    uint32_t size; /* Size of buffer in bytes, must be width*height*bpp */
nkeynes@352
    80
    char *data;
nkeynes@352
    81
} * frame_buffer_t;
nkeynes@352
    82
nkeynes@352
    83
/**
nkeynes@352
    84
 * Core video driver - exports function to setup a GL context, as well as handle
nkeynes@352
    85
 * keyboard input and display resultant output.
nkeynes@144
    86
 */
nkeynes@144
    87
typedef struct display_driver {
nkeynes@144
    88
    char *name;
nkeynes@144
    89
    /**
nkeynes@144
    90
     * Initialize the driver. This is called only once at startup time, and
nkeynes@144
    91
     * is guaranteed to be called before any other methods.
nkeynes@144
    92
     * @return TRUE if the driver was successfully initialized, otherwise
nkeynes@144
    93
     * FALSE.
nkeynes@144
    94
     */
nkeynes@144
    95
    gboolean (*init_driver)(void);
nkeynes@144
    96
nkeynes@144
    97
    /**
nkeynes@144
    98
     * Cleanly shutdown the driver. Normally only called at system shutdown
nkeynes@144
    99
     * time.
nkeynes@144
   100
     */
nkeynes@144
   101
    void (*shutdown_driver)(void);
nkeynes@144
   102
nkeynes@144
   103
    /**
nkeynes@144
   104
     * Given a particular keysym, return the keycode associated with it.
nkeynes@144
   105
     * @param keysym The keysym to be resolved, ie "Tab"
nkeynes@144
   106
     * @return the display-specific keycode, or 0 if the keysym cannot
nkeynes@144
   107
     * be resolved.
nkeynes@144
   108
     */
nkeynes@144
   109
    uint16_t (*resolve_keysym)( const gchar *keysym );
nkeynes@144
   110
nkeynes@144
   111
    /**
nkeynes@352
   112
     * Create a render target with the given width and height.
nkeynes@144
   113
     */
nkeynes@352
   114
    render_buffer_t (*create_render_buffer)( uint32_t width, uint32_t height );
nkeynes@144
   115
nkeynes@144
   116
    /**
nkeynes@352
   117
     * Destroy the specified render buffer and release any associated
nkeynes@352
   118
     * resources.
nkeynes@144
   119
     */
nkeynes@352
   120
    void (*destroy_render_buffer)( render_buffer_t buffer );
nkeynes@352
   121
nkeynes@144
   122
    /**
nkeynes@352
   123
     * Set the current rendering target to the specified buffer.
nkeynes@144
   124
     */
nkeynes@352
   125
    gboolean (*set_render_target)( render_buffer_t buffer );
nkeynes@352
   126
nkeynes@352
   127
    /**
nkeynes@352
   128
     * Display a single frame using the supplied pixmap data.
nkeynes@352
   129
     */
nkeynes@352
   130
    gboolean (*display_frame_buffer)( frame_buffer_t buffer );
nkeynes@352
   131
nkeynes@352
   132
    /**
nkeynes@352
   133
     * Display a single frame using a previously rendered GL buffer.
nkeynes@352
   134
     */
nkeynes@352
   135
    gboolean (*display_render_buffer)( render_buffer_t buffer );
nkeynes@144
   136
nkeynes@144
   137
    /**
nkeynes@144
   138
     * Display a single blanked frame using a fixed colour for the
nkeynes@352
   139
     * entire frame (specified in RGB888 format). 
nkeynes@144
   140
     */
nkeynes@352
   141
    gboolean (*display_blank)( uint32_t rgb );
nkeynes@144
   142
nkeynes@144
   143
    /**
nkeynes@352
   144
     * Copy the image data from the GL buffer to the target memory buffer,
nkeynes@352
   145
     * using the format etc from the buffer. This may force a glFinish()
nkeynes@352
   146
     * but does not invalidate the buffer.
nkeynes@144
   147
     */
nkeynes@429
   148
    gboolean (*read_render_buffer)( render_buffer_t buffer, unsigned char *target );
nkeynes@352
   149
nkeynes@144
   150
} *display_driver_t;
nkeynes@144
   151
nkeynes@370
   152
gboolean display_set_driver( display_driver_t driver );
nkeynes@144
   153
nkeynes@144
   154
extern uint32_t pvr2_frame_counter;
nkeynes@144
   155
nkeynes@144
   156
extern display_driver_t display_driver;
nkeynes@144
   157
nkeynes@144
   158
extern struct display_driver display_gtk_driver;
nkeynes@144
   159
extern struct display_driver display_null_driver;
nkeynes@144
   160
nkeynes@144
   161
/****************** Input methods **********************/
nkeynes@144
   162
nkeynes@144
   163
typedef void (*input_key_callback_t)( void *data, uint32_t value, gboolean isKeyDown );
nkeynes@144
   164
nkeynes@144
   165
gboolean input_register_key( const gchar *keysym, input_key_callback_t callback,
nkeynes@144
   166
			     void *data, uint32_t value );
nkeynes@144
   167
nkeynes@451
   168
void input_unregister_key( const gchar *keysym, input_key_callback_t callback,
nkeynes@451
   169
			   void *data, uint32_t value );
nkeynes@144
   170
nkeynes@144
   171
gboolean input_is_key_valid( const gchar *keysym );
nkeynes@144
   172
nkeynes@144
   173
gboolean input_is_key_registered( const gchar *keysym );
nkeynes@144
   174
nkeynes@144
   175
void input_event_keydown( uint16_t keycode );
nkeynes@144
   176
nkeynes@144
   177
void input_event_keyup( uint16_t keycode );
nkeynes@144
   178
nkeynes@144
   179
nkeynes@144
   180
nkeynes@144
   181
#ifdef __cplusplus
nkeynes@144
   182
}
nkeynes@144
   183
#endif
nkeynes@144
   184
#endif
.