1

/* $Id$ */

     2

     3

/** @file gfx_func.h Functions related to the gfx engine. */

     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_FUNC_H

    36

#define GFX_FUNC_H

    37

    38

#include "gfx_type.h"

    39

#include "strings_type.h"

    40

    41

void GameLoop();

    42

    43

void CreateConsole();

    44

    45

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

    46

extern bool _fullscreen;

    47

extern CursorVars _cursor;

    48

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

    49

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

    50

extern byte _fast_forward;

    51

    52

extern bool _left_button_down;

    53

extern bool _left_button_clicked;

    54

extern bool _right_button_down;

    55

extern bool _right_button_clicked;

    56

    57

extern DrawPixelInfo _screen;

    58

extern bool _screen_disable_anim;   ///< Disable palette animation (important for 32bpp-anim blitter during giant screenshot)

    59

    60

extern int _pal_first_dirty;

    61

extern int _pal_count_dirty;

    62

extern int _num_resolutions;

    63

extern Dimension _resolutions[32];

    64

extern Dimension _cur_resolution;

    65

extern Colour _cur_palette[256]; ///< Current palette. Entry 0 has to be always fully transparent!

    66

    67

void HandleKeypress(uint32 key);

    68

void HandleCtrlChanged();

    69

void HandleMouseEvents();

    70

void CSleep(int milliseconds);

    71

void UpdateWindows();

    72

    73

void DrawMouseCursor();

    74

void ScreenSizeChanged();

    75

void GameSizeChanged();

    76

void UndrawMouseCursor();

    77

    78

enum {

    79

	/* Size of the buffer used for drawing strings. */

    80

	DRAW_STRING_BUFFER = 1024,

    81

};

    82

    83

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

    84

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

    85

    86

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

    87

    88

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

    89

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

    90

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

    91

    92

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

    93

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

    94

    95

int DoDrawString(const char *string, int x, int y, uint16 real_colour, bool parse_string_also_when_clipped = false);

    96

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

    97

    98

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

    99

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

   100

   101

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

   102

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

   103

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

   104

   105

void DrawCharCentered(uint32 c, int x, int y, uint16 color);

   106

   107

void GfxFillRect(int left, int top, int right, int bottom, int color, FillRectMode mode = FILLRECT_OPAQUE);

   108

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

   109

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

   110

   111

Dimension GetStringBoundingBox(const char *str);

   112

uint32 FormatStringLinebreaks(char *str, int maxw);

   113

int GetStringHeight(StringID str, int maxw);

   114

void LoadStringWidthTable();

   115

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

   116

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

   117

   118

/**

   119

 * Let the dirty blocks repainting by the video driver.

   120

 *

   121

 * @ingroup dirty

   122

 */

   123

void DrawDirtyBlocks();

   124

   125

/**

   126

 * Set a new dirty block.

   127

 *

   128

 * @ingroup dirty

   129

 */

   130

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

   131

   132

/**

   133

 * Marks the whole screen as dirty.

   134

 *

   135

 * @ingroup dirty

   136

 */

   137

void MarkWholeScreenDirty();

   138

   139

void GfxInitPalettes();

   140

   141

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

   142

   143

/* window.cpp */

   144

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

   145

   146

void SetMouseCursor(SpriteID sprite, SpriteID pal);

   147

void SetAnimatedMouseCursor(const AnimCursor *table);

   148

void CursorTick();

   149

bool ChangeResInGame(int w, int h);

   150

void SortResolutions(int count);

   151

bool ToggleFullScreen(bool fs);

   152

   153

/* gfx.cpp */

   154

#define ASCII_LETTERSTART 32

   155

extern FontSize _cur_fontsize;

   156

   157

byte GetCharacterWidth(FontSize size, uint32 key);

   158

   159

/**

   160

 * Get height of a character for a given font size.

   161

 * @param size Font size to get height of

   162

 * @return     Height of characters in the given font (pixels)

   163

 */

   164

static inline byte GetCharacterHeight(FontSize size)

   165

{

   166

	switch (size) {

   167

		default: NOT_REACHED();

   168

		case FS_NORMAL: return 10;

   169

		case FS_SMALL:  return 6;

   170

		case FS_LARGE:  return 18;

   171

	}

   172

}

   173

   174

extern DrawPixelInfo *_cur_dpi;

   175

   176

/**

   177

 * All 16 colour gradients

   178

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

   179

 */

   180

extern byte _colour_gradient[COLOUR_END][8];

   181

   182

extern PaletteType _use_palette;

   183

extern bool _palette_remap_grf[];

   184

extern const byte *_palette_remap;

   185

extern const byte *_palette_reverse_remap;

   186

   187

#endif /* GFX_FUNC_H */