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