1

/* $Id$ */

     2

     3

#ifndef GFX_H

     4

#define GFX_H

     5

     6

     7

enum WindowKeyCodes {

     8

	WKC_SHIFT = 0x8000,

     9

	WKC_CTRL  = 0x4000,

    10

	WKC_ALT   = 0x2000,

    11

	WKC_META  = 0x1000,

    12

    13

	// Special ones

    14

	WKC_NONE        =  0,

    15

	WKC_ESC         =  1,

    16

	WKC_BACKSPACE   =  2,

    17

	WKC_INSERT      =  3,

    18

	WKC_DELETE      =  4,

    19

    20

	WKC_PAGEUP      =  5,

    21

	WKC_PAGEDOWN    =  6,

    22

	WKC_END         =  7,

    23

	WKC_HOME        =  8,

    24

    25

	// Arrow keys

    26

	WKC_LEFT        =  9,

    27

	WKC_UP          = 10,

    28

	WKC_RIGHT       = 11,

    29

	WKC_DOWN        = 12,

    30

    31

	// Return & tab

    32

	WKC_RETURN      = 13,

    33

	WKC_TAB         = 14,

    34

    35

	// Numerical keyboard

    36

	WKC_NUM_0       = 16,

    37

	WKC_NUM_1       = 17,

    38

	WKC_NUM_2       = 18,

    39

	WKC_NUM_3       = 19,

    40

	WKC_NUM_4       = 20,

    41

	WKC_NUM_5       = 21,

    42

	WKC_NUM_6       = 22,

    43

	WKC_NUM_7       = 23,

    44

	WKC_NUM_8       = 24,

    45

	WKC_NUM_9       = 25,

    46

	WKC_NUM_DIV     = 26,

    47

	WKC_NUM_MUL     = 27,

    48

	WKC_NUM_MINUS   = 28,

    49

	WKC_NUM_PLUS    = 29,

    50

	WKC_NUM_ENTER   = 30,

    51

	WKC_NUM_DECIMAL = 31,

    52

    53

	// Space

    54

	WKC_SPACE       = 32,

    55

    56

	// Function keys

    57

	WKC_F1          = 33,

    58

	WKC_F2          = 34,

    59

	WKC_F3          = 35,

    60

	WKC_F4          = 36,

    61

	WKC_F5          = 37,

    62

	WKC_F6          = 38,

    63

	WKC_F7          = 39,

    64

	WKC_F8          = 40,

    65

	WKC_F9          = 41,

    66

	WKC_F10         = 42,

    67

	WKC_F11         = 43,

    68

	WKC_F12         = 44,

    69

    70

	// backquote is the key left of "1"

    71

	// we only store this key here, no matter what character is really mapped to it

    72

	// on a particular keyboard. (US keyboard: ` and ~ ; German keyboard: ^ and °)

    73

	WKC_BACKQUOTE   = 45,

    74

	WKC_PAUSE       = 46,

    75

    76

	// 0-9 are mapped to 48-57

    77

	// A-Z are mapped to 65-90

    78

	// a-z are mapped to 97-122

    79

};

    80

    81

enum GameModes {

    82

	GM_MENU,

    83

	GM_NORMAL,

    84

	GM_EDITOR

    85

};

    86

    87

void GameLoop(void);

    88

    89

void CreateConsole(void);

    90

    91

typedef int32 CursorID;

    92

typedef byte Pixel;

    93

    94

typedef struct Point {

    95

	int x,y;

    96

} Point;

    97

    98

typedef struct Rect {

    99

	int left,top,right,bottom;

   100

} Rect;

   101

   102

/** A single sprite of a list of animated cursors */

   103

struct AnimCursor {

   104

	static const CursorID LAST = MAX_UVALUE(CursorID);

   105

	CursorID sprite;   ///< Must be set to LAST_ANIM when it is the last sprite of the loop

   106

	byte display_time; ///< Amount of ticks this sprite will be shown

   107

};

   108

   109

typedef struct CursorVars {

   110

	Point pos, size, offs, delta; ///< position, size, offset from top-left, and movement

   111

	Point draw_pos, draw_size;    ///< position and size bounding-box for drawing

   112

	SpriteID sprite; ///< current image of cursor

   113

	SpriteID pal;

   114

   115

	int wheel;       ///< mouse wheel movement

   116

	const AnimCursor *animate_list; ///< in case of animated cursor, list of frames

   117

	const AnimCursor *animate_cur;  ///< in case of animated cursor, current frame

   118

	uint animate_timeout;           ///< in case of animated cursor, number of ticks to show the current cursor

   119

   120

	bool visible;    ///< cursor is visible

   121

	bool dirty;      ///< the rect occupied by the mouse is dirty (redraw)

   122

	bool fix_at;     ///< mouse is moving, but cursor is not (used for scrolling)

   123

	bool in_window;  ///< mouse inside this window, determines drawing logic

   124

} CursorVars;

   125

   126

typedef struct DrawPixelInfo {

   127

	Pixel *dst_ptr;

   128

	int left, top, width, height;

   129

	int pitch;

   130

	uint16 zoom;

   131

} DrawPixelInfo;

   132

   133

typedef struct Colour {

   134

	byte r;

   135

	byte g;

   136

	byte b;

   137

} Colour;

   138

   139

   140

   141

extern byte _dirkeys;        // 1 = left, 2 = up, 4 = right, 8 = down

   142

extern bool _fullscreen;

   143

extern CursorVars _cursor;

   144

extern bool _ctrl_pressed;   // Is Ctrl pressed?

   145

extern bool _shift_pressed;  // Is Shift pressed?

   146

extern byte _fast_forward;

   147

   148

extern bool _left_button_down;

   149

extern bool _left_button_clicked;

   150

extern bool _right_button_down;

   151

extern bool _right_button_clicked;

   152

   153

extern DrawPixelInfo _screen;

   154

extern bool _exit_game;

   155

extern bool _networking;         ///< are we in networking mode?

   156

extern byte _game_mode;

   157

extern byte _pause;

   158

   159

extern int _pal_first_dirty;

   160

extern int _pal_last_dirty;

   161

extern int _num_resolutions;

   162

extern uint16 _resolutions[32][2];

   163

extern uint16 _cur_resolution[2];

   164

extern Colour _cur_palette[256];

   165

   166

void HandleKeypress(uint32 key);

   167

void HandleMouseEvents(void);

   168

void CSleep(int milliseconds);

   169

void UpdateWindows(void);

   170

   171

uint32 InteractiveRandom(void); /* Used for random sequences that are not the same on the other end of the multiplayer link */

   172

uint InteractiveRandomRange(uint max);

   173

void DrawTextMessage(void);

   174

void DrawMouseCursor(void);

   175

void ScreenSizeChanged(void);

   176

void HandleExitGameRequest(void);

   177

void GameSizeChanged(void);

   178

void UndrawMouseCursor(void);

   179

   180

#include "helpers.hpp"

   181

   182

typedef enum FontSizes {

   183

	FS_NORMAL,

   184

	FS_SMALL,

   185

	FS_LARGE,

   186

	FS_END,

   187

} FontSize;

   188

   189

DECLARE_POSTFIX_INCREMENT(FontSize);

   190

   191

void RedrawScreenRect(int left, int top, int right, int bottom);

   192

void GfxScroll(int left, int top, int width, int height, int xo, int yo);

   193

   194

   195

// XXX doesn't really belong here, but the only

   196

// consumers always use it in conjunction with DoDrawString()

   197

#define UPARROW   "\xEE\x8A\x80"

   198

#define DOWNARROW "\xEE\x8A\xAA"

   199

   200

   201

int DrawStringCentered(int x, int y, StringID str, uint16 color);

   202

int DrawStringCenteredTruncated(int xl, int xr, int y, StringID str, uint16 color);

   203

int DoDrawStringCentered(int x, int y, const char *str, uint16 color);

   204

   205

int DrawString(int x, int y, StringID str, uint16 color);

   206

int DrawStringTruncated(int x, int y, StringID str, uint16 color, uint maxw);

   207

   208

int DoDrawString(const char *string, int x, int y, uint16 color);

   209

int DoDrawStringTruncated(const char *str, int x, int y, uint16 color, uint maxw);

   210

   211

void DrawStringCenterUnderline(int x, int y, StringID str, uint16 color);

   212

void DrawStringCenterUnderlineTruncated(int xl, int xr, int y, StringID str, uint16 color);

   213

   214

int DrawStringRightAligned(int x, int y, StringID str, uint16 color);

   215

void DrawStringRightAlignedTruncated(int x, int y, StringID str, uint16 color, uint maxw);

   216

void DrawStringRightAlignedUnderline(int x, int y, StringID str, uint16 color);

   217

   218

void GfxFillRect(int left, int top, int right, int bottom, int color);

   219

void GfxDrawLine(int left, int top, int right, int bottom, int color);

   220

   221

BoundingRect GetStringBoundingBox(const char *str);

   222

uint32 FormatStringLinebreaks(char *str, int maxw);

   223

void LoadStringWidthTable(void);

   224

void DrawStringMultiCenter(int x, int y, StringID str, int maxw);

   225

uint DrawStringMultiLine(int x, int y, StringID str, int maxw);

   226

void DrawDirtyBlocks(void);

   227

void SetDirtyBlocks(int left, int top, int right, int bottom);

   228

void MarkWholeScreenDirty(void);

   229

   230

void GfxInitPalettes(void);

   231

   232

bool FillDrawPixelInfo(DrawPixelInfo* n, int left, int top, int width, int height);

   233

   234

/* window.c */

   235

void DrawOverlappedWindowForAll(int left, int top, int right, int bottom);

   236

   237

void SetMouseCursor(CursorID cursor);

   238

void SetMouseCursor(SpriteID sprite, SpriteID pal);

   239

void SetAnimatedMouseCursor(const AnimCursor *table);

   240

void CursorTick(void);

   241

void DrawMouseCursor(void);

   242

void ScreenSizeChanged(void);

   243

void UndrawMouseCursor(void);

   244

bool ChangeResInGame(int w, int h);

   245

void SortResolutions(int count);

   246

void ToggleFullScreen(bool fs);

   247

   248

/* gfx.c */

   249

#define ASCII_LETTERSTART 32

   250

extern FontSize _cur_fontsize;

   251

   252

byte GetCharacterWidth(FontSize size, uint32 key);

   253

   254

static inline byte GetCharacterHeight(FontSize size)

   255

{

   256

	switch (size) {

   257

		default: NOT_REACHED();

   258

		case FS_NORMAL: return 10;

   259

		case FS_SMALL:  return 6;

   260

		case FS_LARGE:  return 18;

   261

	}

   262

}

   263

   264

VARDEF DrawPixelInfo *_cur_dpi;

   265

   266

enum {

   267

	COLOUR_DARK_BLUE,

   268

	COLOUR_PALE_GREEN,

   269

	COLOUR_PINK,

   270

	COLOUR_YELLOW,

   271

	COLOUR_RED,

   272

	COLOUR_LIGHT_BLUE,

   273

	COLOUR_GREEN,

   274

	COLOUR_DARK_GREEN,

   275

	COLOUR_BLUE,

   276

	COLOUR_CREAM,

   277

	COLOUR_MAUVE,

   278

	COLOUR_PURPLE,

   279

	COLOUR_ORANGE,

   280

	COLOUR_BROWN,

   281

	COLOUR_GREY,

   282

	COLOUR_WHITE

   283

};

   284

   285

/**

   286

 * All 16 colour gradients

   287

 * 8 colours per gradient from darkest (0) to lightest (7)

   288

 */

   289

VARDEF byte _colour_gradient[16][8];

   290

   291

VARDEF bool _use_dos_palette;

   292

   293

typedef enum StringColorFlags {

   294

	IS_PALETTE_COLOR = 0x100, // color value is already a real palette color index, not an index of a StringColor

   295

} StringColorFlags;

   296

   297

   298

#ifdef _DEBUG

   299

extern bool _dbg_screen_rect;

   300

#endif

   301

   302

#endif /* GFX_H */