rubidium@8123: /* $Id$ */
rubidium@8123: 
rubidium@8123: /** @file gfx_func.h Functions related to the gfx engine. */
rubidium@8123: 
rubidium@8123: /**
rubidium@8123:  * @defgroup dirty Dirty
rubidium@8123:  *
rubidium@8123:  * Handles the repaint of some part of the screen.
rubidium@8123:  *
rubidium@8123:  * Some places in the code are called functions which makes something "dirty".
rubidium@8123:  * This has nothing to do with making a Tile or Window darker or less visible.
rubidium@8123:  * This term comes from memory caching and is used to define an object must
rubidium@8123:  * be repaint. If some data of an object (like a Tile, Window, Vehicle, whatever)
rubidium@8123:  * are changed which are so extensive the object must be repaint its marked
rubidium@8123:  * as "dirty". The video driver repaint this object instead of the whole screen
rubidium@8123:  * (this is btw. also possible if needed). This is used to avoid a
rubidium@8123:  * flickering of the screen by the video driver constantly repainting it.
rubidium@8123:  *
rubidium@8123:  * This whole mechanism is controlled by an rectangle defined in #_invalid_rect. This
rubidium@8123:  * rectangle defines the area on the screen which must be repaint. If a new object
rubidium@8123:  * needs to be repainted this rectangle is extended to 'catch' the object on the
rubidium@8123:  * screen. At some point (which is normaly uninteressted for patch writers) this
rubidium@8123:  * rectangle is send to the video drivers method
rubidium@8123:  * VideoDriver::MakeDirty and it is truncated back to an empty rectangle. At some
rubidium@8123:  * later point (which is uninteressted, too) the video driver
rubidium@8123:  * repaints all these saved rectangle instead of the whole screen and drop the
rubidium@8123:  * rectangle informations. Then a new round begins by marking objects "dirty".
rubidium@8123:  *
rubidium@8123:  * @see VideoDriver::MakeDirty
rubidium@8123:  * @see _invalid_rect
rubidium@8123:  * @see _screen
rubidium@8123:  */
rubidium@8123: 
rubidium@8123: 
rubidium@8123: #ifndef GFX_FUNC_H
rubidium@8123: #define GFX_FUNC_H
rubidium@8123: 
rubidium@8123: #include "gfx_type.h"
rubidium@8123: #include "strings_type.h"
rubidium@8123: 
rubidium@8123: void GameLoop();
rubidium@8123: 
rubidium@8123: void CreateConsole();
rubidium@8123: 
rubidium@8123: extern byte _dirkeys;        ///< 1 = left, 2 = up, 4 = right, 8 = down
rubidium@8123: extern bool _fullscreen;
rubidium@8123: extern CursorVars _cursor;
rubidium@8123: extern bool _ctrl_pressed;   ///< Is Ctrl pressed?
rubidium@8123: extern bool _shift_pressed;  ///< Is Shift pressed?
rubidium@8123: extern byte _fast_forward;
rubidium@8123: 
rubidium@8123: extern bool _left_button_down;
rubidium@8123: extern bool _left_button_clicked;
rubidium@8123: extern bool _right_button_down;
rubidium@8123: extern bool _right_button_clicked;
rubidium@8123: 
rubidium@8123: extern DrawPixelInfo _screen;
frosch@8249: extern bool _screen_disable_anim;   ///< Disable palette animation (important for 32bpp-anim blitter during giant screenshot)
rubidium@8123: 
rubidium@8123: extern int _pal_first_dirty;
rubidium@8123: extern int _pal_count_dirty;
rubidium@8123: extern int _num_resolutions;
smatz@9533: extern Dimension _resolutions[32];
smatz@9533: extern Dimension _cur_resolution;
smatz@9551: extern Colour _cur_palette[256]; ///< Current palette. Entry 0 has to be always fully transparent!
rubidium@8123: 
rubidium@8123: void HandleKeypress(uint32 key);
smatz@8586: void HandleCtrlChanged();
rubidium@8123: void HandleMouseEvents();
rubidium@8123: void CSleep(int milliseconds);
rubidium@8123: void UpdateWindows();
rubidium@8123: 
rubidium@8123: void DrawMouseCursor();
rubidium@8123: void ScreenSizeChanged();
rubidium@8123: void GameSizeChanged();
rubidium@8123: void UndrawMouseCursor();
rubidium@8123: 
rubidium@9901: enum {
rubidium@9901: 	/* Size of the buffer used for drawing strings. */
rubidium@9901: 	DRAW_STRING_BUFFER = 1024,
rubidium@9901: };
rubidium@9901: 
rubidium@8123: void RedrawScreenRect(int left, int top, int right, int bottom);
rubidium@8123: void GfxScroll(int left, int top, int width, int height, int xo, int yo);
rubidium@8123: 
rubidium@8123: void DrawSprite(SpriteID img, SpriteID pal, int x, int y, const SubSprite *sub = NULL);
rubidium@8123: 
rubidium@8123: int DrawStringCentered(int x, int y, StringID str, uint16 color);
rubidium@8123: int DrawStringCenteredTruncated(int xl, int xr, int y, StringID str, uint16 color);
rubidium@8123: int DoDrawStringCentered(int x, int y, const char *str, uint16 color);
rubidium@8123: 
rubidium@8123: int DrawString(int x, int y, StringID str, uint16 color);
rubidium@8123: int DrawStringTruncated(int x, int y, StringID str, uint16 color, uint maxw);
rubidium@8123: 
frosch@9882: int DoDrawString(const char *string, int x, int y, uint16 real_colour, bool parse_string_also_when_clipped = false);
rubidium@8123: int DoDrawStringTruncated(const char *str, int x, int y, uint16 color, uint maxw);
rubidium@8123: 
rubidium@8123: void DrawStringCenterUnderline(int x, int y, StringID str, uint16 color);
rubidium@8123: void DrawStringCenterUnderlineTruncated(int xl, int xr, int y, StringID str, uint16 color);
rubidium@8123: 
rubidium@8123: int DrawStringRightAligned(int x, int y, StringID str, uint16 color);
rubidium@8123: void DrawStringRightAlignedTruncated(int x, int y, StringID str, uint16 color, uint maxw);
rubidium@8123: void DrawStringRightAlignedUnderline(int x, int y, StringID str, uint16 color);
rubidium@8123: 
rubidium@8737: void DrawCharCentered(uint32 c, int x, int y, uint16 color);
rubidium@8737: 
frosch@9607: void GfxFillRect(int left, int top, int right, int bottom, int color, FillRectMode mode = FILLRECT_OPAQUE);
rubidium@8123: void GfxDrawLine(int left, int top, int right, int bottom, int color);
rubidium@8123: void DrawBox(int x, int y, int dx1, int dy1, int dx2, int dy2, int dx3, int dy3);
rubidium@8123: 
rubidium@8123: Dimension GetStringBoundingBox(const char *str);
rubidium@8123: uint32 FormatStringLinebreaks(char *str, int maxw);
smatz@9682: int GetStringHeight(StringID str, int maxw);
rubidium@8123: void LoadStringWidthTable();
rubidium@8123: void DrawStringMultiCenter(int x, int y, StringID str, int maxw);
rubidium@8123: uint DrawStringMultiLine(int x, int y, StringID str, int maxw, int maxh = -1);
rubidium@8123: 
rubidium@8123: /**
rubidium@8123:  * Let the dirty blocks repainting by the video driver.
rubidium@8123:  *
rubidium@8123:  * @ingroup dirty
rubidium@8123:  */
rubidium@8123: void DrawDirtyBlocks();
rubidium@8123: 
rubidium@8123: /**
rubidium@8123:  * Set a new dirty block.
rubidium@8123:  *
rubidium@8123:  * @ingroup dirty
rubidium@8123:  */
rubidium@8123: void SetDirtyBlocks(int left, int top, int right, int bottom);
rubidium@8123: 
rubidium@8123: /**
rubidium@8123:  * Marks the whole screen as dirty.
rubidium@8123:  *
rubidium@8123:  * @ingroup dirty
rubidium@8123:  */
rubidium@8123: void MarkWholeScreenDirty();
rubidium@8123: 
rubidium@8123: void GfxInitPalettes();
rubidium@8123: 
rubidium@8123: bool FillDrawPixelInfo(DrawPixelInfo* n, int left, int top, int width, int height);
rubidium@8123: 
rubidium@8123: /* window.cpp */
rubidium@8123: void DrawOverlappedWindowForAll(int left, int top, int right, int bottom);
rubidium@8123: 
rubidium@8123: void SetMouseCursor(SpriteID sprite, SpriteID pal);
rubidium@8123: void SetAnimatedMouseCursor(const AnimCursor *table);
rubidium@8123: void CursorTick();
rubidium@8123: bool ChangeResInGame(int w, int h);
rubidium@8123: void SortResolutions(int count);
belugas@8171: bool ToggleFullScreen(bool fs);
rubidium@8123: 
rubidium@8123: /* gfx.cpp */
rubidium@8123: #define ASCII_LETTERSTART 32
rubidium@8123: extern FontSize _cur_fontsize;
rubidium@8123: 
rubidium@8123: byte GetCharacterWidth(FontSize size, uint32 key);
rubidium@8123: 
rubidium@9773: /**
rubidium@9773:  * Get height of a character for a given font size.
rubidium@9773:  * @param size Font size to get height of
rubidium@9773:  * @return     Height of characters in the given font (pixels)
rubidium@9773:  */
rubidium@8123: static inline byte GetCharacterHeight(FontSize size)
rubidium@8123: {
rubidium@8123: 	switch (size) {
rubidium@8123: 		default: NOT_REACHED();
rubidium@8123: 		case FS_NORMAL: return 10;
rubidium@8123: 		case FS_SMALL:  return 6;
rubidium@8123: 		case FS_LARGE:  return 18;
rubidium@8123: 	}
rubidium@8123: }
rubidium@8123: 
rubidium@8123: extern DrawPixelInfo *_cur_dpi;
rubidium@8123: 
rubidium@8123: /**
rubidium@8123:  * All 16 colour gradients
rubidium@8123:  * 8 colours per gradient from darkest (0) to lightest (7)
rubidium@8123:  */
belugas@9850: extern byte _colour_gradient[COLOUR_END][8];
rubidium@8123: 
rubidium@9995: extern PaletteType _use_palette;
rubidium@10062: extern bool _palette_remap_grf[];
rubidium@10062: extern const byte *_palette_remap;
rubidium@10062: extern const byte *_palette_reverse_remap;
rubidium@8123: 
rubidium@8123: #endif /* GFX_FUNC_H */