1

/* $Id$ */

     2

     3

/** @file gfx.h */

     4

     5

#ifndef GFX_H

     6

#define GFX_H

     7

     8

#include "openttd.h"

     9

    10

enum WindowKeyCodes {

    11

	WKC_SHIFT = 0x8000,

    12

	WKC_CTRL  = 0x4000,

    13

	WKC_ALT   = 0x2000,

    14

	WKC_META  = 0x1000,

    15

    16

	/* Special ones */

    17

	WKC_NONE        =  0,

    18

	WKC_ESC         =  1,

    19

	WKC_BACKSPACE   =  2,

    20

	WKC_INSERT      =  3,

    21

	WKC_DELETE      =  4,

    22

    23

	WKC_PAGEUP      =  5,

    24

	WKC_PAGEDOWN    =  6,

    25

	WKC_END         =  7,

    26

	WKC_HOME        =  8,

    27

    28

	/* Arrow keys */

    29

	WKC_LEFT        =  9,

    30

	WKC_UP          = 10,

    31

	WKC_RIGHT       = 11,

    32

	WKC_DOWN        = 12,

    33

    34

	/* Return & tab */

    35

	WKC_RETURN      = 13,

    36

	WKC_TAB         = 14,

    37

    38

	/* Numerical keyboard */

    39

	WKC_NUM_0       = 16,

    40

	WKC_NUM_1       = 17,

    41

	WKC_NUM_2       = 18,

    42

	WKC_NUM_3       = 19,

    43

	WKC_NUM_4       = 20,

    44

	WKC_NUM_5       = 21,

    45

	WKC_NUM_6       = 22,

    46

	WKC_NUM_7       = 23,

    47

	WKC_NUM_8       = 24,

    48

	WKC_NUM_9       = 25,

    49

	WKC_NUM_DIV     = 26,

    50

	WKC_NUM_MUL     = 27,

    51

	WKC_NUM_MINUS   = 28,

    52

	WKC_NUM_PLUS    = 29,

    53

	WKC_NUM_ENTER   = 30,

    54

	WKC_NUM_DECIMAL = 31,

    55

    56

	/* Space */

    57

	WKC_SPACE       = 32,

    58

    59

	/* Function keys */

    60

	WKC_F1          = 33,

    61

	WKC_F2          = 34,

    62

	WKC_F3          = 35,

    63

	WKC_F4          = 36,

    64

	WKC_F5          = 37,

    65

	WKC_F6          = 38,

    66

	WKC_F7          = 39,

    67

	WKC_F8          = 40,

    68

	WKC_F9          = 41,

    69

	WKC_F10         = 42,

    70

	WKC_F11         = 43,

    71

	WKC_F12         = 44,

    72

    73

	/* backquote is the key left of "1"

    74

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

    75

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

    76

	WKC_BACKQUOTE   = 45,

    77

	WKC_PAUSE       = 46,

    78

    79

	/* 0-9 are mapped to 48-57

    80

	 * A-Z are mapped to 65-90

    81

	 * a-z are mapped to 97-122 */

    82

};

    83

    84

enum GameModes {

    85

	GM_MENU,

    86

	GM_NORMAL,

    87

	GM_EDITOR

    88

};

    89

    90

void GameLoop();

    91

    92

void CreateConsole();

    93

    94

typedef int32 CursorID;

    95

typedef byte Pixel;

    96

    97

struct Point {

    98

	int x,y;

    99

};

   100

   101

struct Rect {

   102

	int left,top,right,bottom;

   103

};

   104

   105

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

   106

struct AnimCursor {

   107

	static const CursorID LAST = MAX_UVALUE(CursorID);

   108

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

   109

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

   110

};

   111

   112

struct CursorVars {

   113

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

   114

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

   115

	SpriteID sprite; ///< current image of cursor

   116

	SpriteID pal;

   117

   118

	int wheel;       ///< mouse wheel movement

   119

   120

	/* We need two different vars to keep track of how far the scrollwheel moved.

   121

	 * OSX uses this for scrolling around the map. */

   122

	int v_wheel;

   123

	int h_wheel;

   124

   125

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

   126

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

   127

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

   128

   129

	bool visible;    ///< cursor is visible

   130

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

   131

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

   132

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

   133

};

   134

   135

struct DrawPixelInfo {

   136

	Pixel *dst_ptr;

   137

	int left, top, width, height;

   138

	int pitch;

   139

	uint16 zoom;

   140

};

   141

   142

struct Colour {

   143

	byte r;

   144

	byte g;

   145

	byte b;

   146

};

   147

   148

   149

   150

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

   151

extern bool _fullscreen;

   152

extern CursorVars _cursor;

   153

extern bool _ctrl_pressed;   ///< Is Ctrl pressed?

   154

extern bool _shift_pressed;  ///< Is Shift pressed?

   155

extern byte _fast_forward;

   156

   157

extern bool _left_button_down;

   158

extern bool _left_button_clicked;

   159

extern bool _right_button_down;

   160

extern bool _right_button_clicked;

   161

   162

extern DrawPixelInfo _screen;

   163

extern bool _exit_game;

   164

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

   165

extern byte _game_mode;

   166

extern byte _pause_game;

   167

   168

extern int _pal_first_dirty;

   169

extern int _pal_last_dirty;

   170

extern int _num_resolutions;

   171

extern uint16 _resolutions[32][2];

   172

extern uint16 _cur_resolution[2];

   173

extern Colour _cur_palette[256];

   174

   175

void HandleKeypress(uint32 key);

   176

void HandleMouseEvents();

   177

void CSleep(int milliseconds);

   178

void UpdateWindows();

   179

   180

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

   181

uint InteractiveRandomRange(uint max);

   182

void DrawTextMessage();

   183

void DrawMouseCursor();

   184

void ScreenSizeChanged();

   185

void HandleExitGameRequest();

   186

void GameSizeChanged();

   187

void UndrawMouseCursor();

   188

   189

#include "helpers.hpp"

   190

   191

enum FontSize {

   192

	FS_NORMAL,

   193

	FS_SMALL,

   194

	FS_LARGE,

   195

	FS_END,

   196

};

   197

   198

DECLARE_POSTFIX_INCREMENT(FontSize);

   199

   200

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

   201

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

   202

   203

   204

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

   205

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

   206

#define UPARROW   "\xEE\x8A\x80"

   207

#define DOWNARROW "\xEE\x8A\xAA"

   208

   209

   210

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

   211

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

   212

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

   213

   214

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

   215

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

   216

   217

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

   218

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

   219

   220

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

   221

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

   222

   223

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

   224

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

   225

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

   226

   227

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

   228

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

   229

   230

BoundingRect GetStringBoundingBox(const char *str);

   231

uint32 FormatStringLinebreaks(char *str, int maxw);

   232

void LoadStringWidthTable();

   233

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

   234

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

   235

void DrawDirtyBlocks();

   236

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

   237

void MarkWholeScreenDirty();

   238

   239

void GfxInitPalettes();

   240

   241

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

   242

   243

/* window.cpp */

   244

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

   245

   246

void SetMouseCursor(CursorID cursor);

   247

void SetMouseCursor(SpriteID sprite, SpriteID pal);

   248

void SetAnimatedMouseCursor(const AnimCursor *table);

   249

void CursorTick();

   250

void DrawMouseCursor();

   251

void ScreenSizeChanged();

   252

void UndrawMouseCursor();

   253

bool ChangeResInGame(int w, int h);

   254

void SortResolutions(int count);

   255

void ToggleFullScreen(bool fs);

   256

   257

/* gfx.cpp */

   258

#define ASCII_LETTERSTART 32

   259

extern FontSize _cur_fontsize;

   260

   261

byte GetCharacterWidth(FontSize size, uint32 key);

   262

   263

static inline byte GetCharacterHeight(FontSize size)

   264

{

   265

	switch (size) {

   266

		default: NOT_REACHED();

   267

		case FS_NORMAL: return 10;

   268

		case FS_SMALL:  return 6;

   269

		case FS_LARGE:  return 18;

   270

	}

   271

}

   272

   273

VARDEF DrawPixelInfo *_cur_dpi;

   274

   275

enum {

   276

	COLOUR_DARK_BLUE,

   277

	COLOUR_PALE_GREEN,

   278

	COLOUR_PINK,

   279

	COLOUR_YELLOW,

   280

	COLOUR_RED,

   281

	COLOUR_LIGHT_BLUE,

   282

	COLOUR_GREEN,

   283

	COLOUR_DARK_GREEN,

   284

	COLOUR_BLUE,

   285

	COLOUR_CREAM,

   286

	COLOUR_MAUVE,

   287

	COLOUR_PURPLE,

   288

	COLOUR_ORANGE,

   289

	COLOUR_BROWN,

   290

	COLOUR_GREY,

   291

	COLOUR_WHITE

   292

};

   293

   294

/**

   295

 * All 16 colour gradients

   296

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

   297

 */

   298

VARDEF byte _colour_gradient[16][8];

   299

   300

VARDEF bool _use_dos_palette;

   301

   302

enum StringColorFlags {

   303

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

   304

};

   305

   306

   307

#ifdef _DEBUG

   308

extern bool _dbg_screen_rect;

   309

#endif

   310

   311

#endif /* GFX_H */