1

/* $Id$ */

     2

     3

/** @file gfx.h */

     4

     5

/**

     6

 * @defgroup dirty Dirty

     7

 *

     8

 * Handles the repaint of some part of the screen.

     9

 *

    10

 * Some places in the code are called functions which makes something "dirty".

    11

 * This has nothing to do with making a Tile or Window darker or less visible.

    12

 * This term comes from memory caching and is used to define an object must

    13

 * be repaint. If some data of an object (like a Tile, Window, Vehicle, whatever)

    14

 * are changed which are so extensive the object must be repaint its marked

    15

 * as "dirty". The video driver repaint this object instead of the whole screen

    16

 * (this is btw. also possible if needed). This is used to avoid a

    17

 * flickering of the screen by the video driver constantly repainting it.

    18

 *

    19

 * This whole mechanism is controlled by an rectangle defined in #_invalid_rect. This

    20

 * rectangle defines the area on the screen which must be repaint. If a new object

    21

 * needs to be repainted this rectangle is extended to 'catch' the object on the

    22

 * screen. At some point (which is normaly uninteressted for patch writers) this

    23

 * rectangle is send to the video drivers method

    24

 * VideoDriver::MakeDirty and it is truncated back to an empty rectangle. At some

    25

 * later point (which is uninteressted, too) the video driver

    26

 * repaints all these saved rectangle instead of the whole screen and drop the

    27

 * rectangle informations. Then a new round begins by marking objects "dirty".

    28

 *

    29

 * @see VideoDriver::MakeDirty

    30

 * @see _invalid_rect

    31

 * @see _screen

    32

 */

    33

    34

    35

#ifndef GFX_H

    36

#define GFX_H

    37

    38

#include "openttd.h"

    39

#include "core/math_func.hpp"

    42

#include "zoom.hpp"

    43

    44

enum WindowKeyCodes {

    45

	WKC_SHIFT = 0x8000,

    46

	WKC_CTRL  = 0x4000,

    47

	WKC_ALT   = 0x2000,

    48

	WKC_META  = 0x1000,

    49

    50

	/* Special ones */

    51

	WKC_NONE        =  0,

    52

	WKC_ESC         =  1,

    53

	WKC_BACKSPACE   =  2,

    54

	WKC_INSERT      =  3,

    55

	WKC_DELETE      =  4,

    56

    57

	WKC_PAGEUP      =  5,

    58

	WKC_PAGEDOWN    =  6,

    59

	WKC_END         =  7,

    60

	WKC_HOME        =  8,

    61

    62

	/* Arrow keys */

    63

	WKC_LEFT        =  9,

    64

	WKC_UP          = 10,

    65

	WKC_RIGHT       = 11,

    66

	WKC_DOWN        = 12,

    67

    68

	/* Return & tab */

    69

	WKC_RETURN      = 13,

    70

	WKC_TAB         = 14,

    71

    72

	/* Space */

    73

	WKC_SPACE       = 32,

    74

    75

	/* Function keys */

    76

	WKC_F1          = 33,

    77

	WKC_F2          = 34,

    78

	WKC_F3          = 35,

    79

	WKC_F4          = 36,

    80

	WKC_F5          = 37,

    81

	WKC_F6          = 38,

    82

	WKC_F7          = 39,

    83

	WKC_F8          = 40,

    84

	WKC_F9          = 41,

    85

	WKC_F10         = 42,

    86

	WKC_F11         = 43,

    87

	WKC_F12         = 44,

    88

    89

	/* Backquote is the key left of "1"

    90

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

    91

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

    92

	WKC_BACKQUOTE   = 45,

    93

	WKC_PAUSE       = 46,

    94

    95

	/* 0-9 are mapped to 48-57

    96

	 * A-Z are mapped to 65-90

    97

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

    98

    99

	/* Numerical keyboard */

   100

	WKC_NUM_0       = 128,

   101

	WKC_NUM_1       = 129,

   102

	WKC_NUM_2       = 130,

   103

	WKC_NUM_3       = 131,

   104

	WKC_NUM_4       = 132,

   105

	WKC_NUM_5       = 133,

   106

	WKC_NUM_6       = 134,

   107

	WKC_NUM_7       = 135,

   108

	WKC_NUM_8       = 136,

   109

	WKC_NUM_9       = 137,

   110

	WKC_NUM_DIV     = 138,

   111

	WKC_NUM_MUL     = 139,

   112

	WKC_NUM_MINUS   = 140,

   113

	WKC_NUM_PLUS    = 141,

   114

	WKC_NUM_ENTER   = 142,

   115

	WKC_NUM_DECIMAL = 143,

   116

   117

	/* Other keys */

   118

	WKC_SLASH       = 144, ///< / Forward slash

   119

	WKC_SEMICOLON   = 145, ///< ; Semicolon

   120

	WKC_EQUALS      = 146, ///< = Equals

   121

	WKC_L_BRACKET   = 147, ///< [ Left square bracket

   122

	WKC_BACKSLASH   = 148, ///< \ Backslash

   123

	WKC_R_BRACKET   = 149, ///< ] Right square bracket

   124

	WKC_SINGLEQUOTE = 150, ///< ' Single quote

   125

	WKC_COMMA       = 151, ///< , Comma

   126

	WKC_PERIOD      = 152, ///< . Period

   127

	WKC_MINUS       = 153, ///< - Minus

   128

};

   129

   130

void GameLoop();

   131

   132

void CreateConsole();

   133

   134

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

   135

struct AnimCursor {

   136

	static const CursorID LAST = MAX_UVALUE(CursorID);

   137

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

   138

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

   139

};

   140

   141

struct CursorVars {

   142

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

   143

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

   144

	SpriteID sprite; ///< current image of cursor

   145

	SpriteID pal;

   146

   147

	int wheel;       ///< mouse wheel movement

   148

   149

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

   150

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

   151

	int v_wheel;

   152

	int h_wheel;

   153

   154

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

   155

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

   156

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

   157

   158

	bool visible;    ///< cursor is visible

   159

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

   160

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

   161

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

   162

};

   163

   164

struct DrawPixelInfo {

   165

	void *dst_ptr;

   166

	int left, top, width, height;

   167

	int pitch;

   168

	ZoomLevel zoom;

   169

};

   170

   171

struct Colour {

   172

	byte r;

   173

	byte g;

   174

	byte b;

   175

};

   176

   177

   178

   179

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

   180

extern bool _fullscreen;

   181

extern CursorVars _cursor;

   182

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

   183

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

   184

extern byte _fast_forward;

   185

   186

extern bool _left_button_down;

   187

extern bool _left_button_clicked;

   188

extern bool _right_button_down;

   189

extern bool _right_button_clicked;

   190

   191

extern DrawPixelInfo _screen;

   192

   193

extern int _pal_first_dirty;

   194

extern int _pal_count_dirty;

   195

extern int _num_resolutions;

   196

extern uint16 _resolutions[32][2];

   197

extern uint16 _cur_resolution[2];

   198

extern Colour _cur_palette[256];

   199

   200

void HandleKeypress(uint32 key);

   201

void HandleMouseEvents();

   202

void CSleep(int milliseconds);

   203

void UpdateWindows();

   204

   205

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

   206

uint InteractiveRandomRange(uint max);

   207

void DrawChatMessage();

   208

void DrawMouseCursor();

   209

void ScreenSizeChanged();

   210

void HandleExitGameRequest();

   211

void GameSizeChanged();

   212

void UndrawMouseCursor();

   213

   214

enum FontSize {

   215

	FS_NORMAL,

   216

	FS_SMALL,

   217

	FS_LARGE,

   218

	FS_END,

   219

};

   220

DECLARE_POSTFIX_INCREMENT(FontSize);

   221

   222

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

   223

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

   224

   225

/**

   226

 * Used to only draw a part of the sprite.

   227

 * Draw the subsprite in the rect (sprite_x_offset + left, sprite_y_offset + top) to (sprite_x_offset + right, sprite_y_offset + bottom).

   228

 * Both corners are included in the drawing area.

   229

 */

   230

struct SubSprite {

   231

	int left, top, right, bottom;

   232

};

   233

   234

void DrawSprite(SpriteID img, SpriteID pal, int x, int y, const SubSprite *sub = NULL);

   235

   236

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

   237

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

   238

#define UPARROW   "\xEE\x8A\x80"

   239

#define DOWNARROW "\xEE\x8A\xAA"

   240

   241

   242

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

   243

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

   244

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

   245

   246

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

   247

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

   248

   249

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

   250

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

   251

   252

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

   253

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

   254

   255

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

   256

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

   257

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

   258

   259

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

   260

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

   261

void DrawBox(int x, int y, int dx1, int dy1, int dx2, int dy2, int dx3, int dy3);

   262

   264

uint32 FormatStringLinebreaks(char *str, int maxw);

   265

void LoadStringWidthTable();

   266

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

   267

uint DrawStringMultiLine(int x, int y, StringID str, int maxw, int maxh = -1);

   268

   269

/**

   270

 * Let the dirty blocks repainting by the video driver.

   271

 *

   272

 * @ingroup dirty

   273

 */

   274

void DrawDirtyBlocks();

   275

   276

/**

   277

 * Set a new dirty block.

   278

 *

   279

 * @ingroup dirty

   280

 */

   281

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

   282

   283

/**

   284

 * Marks the whole screen as dirty.

   285

 *

   286

 * @ingroup dirty

   287

 */

   288

void MarkWholeScreenDirty();

   289

   290

void GfxInitPalettes();

   291

   292

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

   293

   294

/* window.cpp */

   295

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

   296

   297

void SetMouseCursor(SpriteID sprite, SpriteID pal);

   298

void SetAnimatedMouseCursor(const AnimCursor *table);

   299

void CursorTick();

   300

void DrawMouseCursor();

   301

void ScreenSizeChanged();

   302

void UndrawMouseCursor();

   303

bool ChangeResInGame(int w, int h);

   304

void SortResolutions(int count);

   305

void ToggleFullScreen(bool fs);

   306

   307

/* gfx.cpp */

   308

#define ASCII_LETTERSTART 32

   309

extern FontSize _cur_fontsize;

   310

   311

byte GetCharacterWidth(FontSize size, uint32 key);

   312

   313

static inline byte GetCharacterHeight(FontSize size)

   314

{

   315

	switch (size) {

   316

		default: NOT_REACHED();

   317

		case FS_NORMAL: return 10;

   318

		case FS_SMALL:  return 6;

   319

		case FS_LARGE:  return 18;

   320

	}

   321

}

   322

   323

VARDEF DrawPixelInfo *_cur_dpi;

   324

   325

enum {

   326

	COLOUR_DARK_BLUE,

   327

	COLOUR_PALE_GREEN,

   328

	COLOUR_PINK,

   329

	COLOUR_YELLOW,

   330

	COLOUR_RED,

   331

	COLOUR_LIGHT_BLUE,

   332

	COLOUR_GREEN,

   333

	COLOUR_DARK_GREEN,

   334

	COLOUR_BLUE,

   335

	COLOUR_CREAM,

   336

	COLOUR_MAUVE,

   337

	COLOUR_PURPLE,

   338

	COLOUR_ORANGE,

   339

	COLOUR_BROWN,

   340

	COLOUR_GREY,

   341

	COLOUR_WHITE

   342

};

   343

   344

/** Colour of the strings, see _string_colormap in table/palettes.h or docs/ottd-colourtext-palette.png */

   345

enum TextColour {

   346

	TC_FROMSTRING  = 0x00,

   347

	TC_BLUE        = 0x00,

   348

	TC_SILVER      = 0x01,

   349

	TC_GOLD        = 0x02,

   350

	TC_RED         = 0x03,

   351

	TC_PURPLE      = 0x04,

   352

	TC_LIGHT_BROWN = 0x05,

   353

	TC_ORANGE      = 0x06,

   354

	TC_GREEN       = 0x07,

   355

	TC_YELLOW      = 0x08,

   356

	TC_DARK_GREEN  = 0x09,

   357

	TC_CREAM       = 0x0A,

   358

	TC_BROWN       = 0x0B,

   359

	TC_WHITE       = 0x0C,

   360

	TC_LIGHT_BLUE  = 0x0D,

   361

	TC_GREY        = 0x0E,

   362

	TC_DARK_BLUE   = 0x0F,

   363

	TC_BLACK       = 0x10,

   364

};

   365

   366

/**

   367

 * All 16 colour gradients

   368

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

   369

 */

   370

VARDEF byte _colour_gradient[16][8];

   371

   372

VARDEF bool _use_dos_palette;

   373

   374

enum StringColorFlags {

   375

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

   376

};

   377

   378

#endif /* GFX_H */