gfx_func.h

Go to the documentation of this file.
00001 /* $Id: gfx_func.h 23472 2011-12-10 12:56:37Z rubidium $ */
00002 
00003 /*
00004  * This file is part of OpenTTD.
00005  * OpenTTD is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, version 2.
00006  * OpenTTD is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
00007  * See the GNU General Public License for more details. You should have received a copy of the GNU General Public License along with OpenTTD. If not, see <http://www.gnu.org/licenses/>.
00008  */
00009 
00042 #ifndef GFX_FUNC_H
00043 #define GFX_FUNC_H
00044 
00045 #include "gfx_type.h"
00046 #include "strings_type.h"
00047 
00048 void GameLoop();
00049 
00050 void CreateConsole();
00051 
00052 extern byte _dirkeys;        
00053 extern bool _fullscreen;
00054 extern CursorVars _cursor;
00055 extern bool _ctrl_pressed;   
00056 extern bool _shift_pressed;  
00057 extern byte _fast_forward;
00058 
00059 extern bool _left_button_down;
00060 extern bool _left_button_clicked;
00061 extern bool _right_button_down;
00062 extern bool _right_button_clicked;
00063 
00064 extern DrawPixelInfo _screen;
00065 extern bool _screen_disable_anim;   
00066 
00067 extern int _num_resolutions;
00068 extern Dimension _resolutions[32];
00069 extern Dimension _cur_resolution;
00070 extern Palette _cur_palette; 
00071 
00072 void HandleKeypress(uint32 key);
00073 void HandleCtrlChanged();
00074 void HandleMouseEvents();
00075 void CSleep(int milliseconds);
00076 void UpdateWindows();
00077 
00078 void DrawMouseCursor();
00079 void ScreenSizeChanged();
00080 void GameSizeChanged();
00081 void UndrawMouseCursor();
00082 
00084 static const int DRAW_STRING_BUFFER = 2048;
00085 
00086 void RedrawScreenRect(int left, int top, int right, int bottom);
00087 void GfxScroll(int left, int top, int width, int height, int xo, int yo);
00088 
00089 Dimension GetSpriteSize(SpriteID sprid, Point *offset = NULL, ZoomLevel zoom = ZOOM_LVL_GUI);
00090 void DrawSpriteViewport(SpriteID img, PaletteID pal, int x, int y, const SubSprite *sub = NULL);
00091 void DrawSprite(SpriteID img, PaletteID pal, int x, int y, const SubSprite *sub = NULL, ZoomLevel zoom = ZOOM_LVL_GUI);
00092 
00094 enum StringAlignment {
00095   SA_LEFT        = 0 << 0, 
00096   SA_HOR_CENTER  = 1 << 0, 
00097   SA_RIGHT       = 2 << 0, 
00098   SA_HOR_MASK    = 3 << 0, 
00099 
00100   SA_TOP         = 0 << 2, 
00101   SA_VERT_CENTER = 1 << 2, 
00102   SA_BOTTOM      = 2 << 2, 
00103   SA_VERT_MASK   = 3 << 2, 
00104 
00105   SA_CENTER      = SA_HOR_CENTER | SA_VERT_CENTER, 
00106 
00107   SA_FORCE       = 1 << 4, 
00108   SA_STRIP       = 1 << 5, 
00109 };
00110 DECLARE_ENUM_AS_BIT_SET(StringAlignment)
00111 
00112 int DrawString(int left, int right, int top, const char *str, TextColour colour = TC_FROMSTRING, StringAlignment align = SA_LEFT, bool underline = false, FontSize fontsize = FS_NORMAL);
00113 int DrawString(int left, int right, int top, StringID str, TextColour colour = TC_FROMSTRING, StringAlignment align = SA_LEFT, bool underline = false, FontSize fontsize = FS_NORMAL);
00114 int DrawStringMultiLine(int left, int right, int top, int bottom, const char *str, TextColour colour = TC_FROMSTRING, StringAlignment align = (SA_TOP | SA_LEFT), bool underline = false, FontSize fontsize = FS_NORMAL);
00115 int DrawStringMultiLine(int left, int right, int top, int bottom, StringID str, TextColour colour = TC_FROMSTRING, StringAlignment align = (SA_TOP | SA_LEFT), bool underline = false, FontSize fontsize = FS_NORMAL);
00116 
00117 void DrawCharCentered(uint32 c, int x, int y, TextColour colour);
00118 
00119 void GfxFillRect(int left, int top, int right, int bottom, int colour, FillRectMode mode = FILLRECT_OPAQUE);
00120 void GfxDrawLine(int left, int top, int right, int bottom, int colour, int width = 1);
00121 void DrawBox(int x, int y, int dx1, int dy1, int dx2, int dy2, int dx3, int dy3);
00122 
00123 Dimension GetStringBoundingBox(const char *str, FontSize start_fontsize = FS_NORMAL);
00124 Dimension GetStringBoundingBox(StringID strid);
00125 uint32 FormatStringLinebreaks(char *str, const char *last, int maxw, FontSize start_fontsize = FS_NORMAL);
00126 int GetStringHeight(StringID str, int maxw);
00127 Dimension GetStringMultiLineBoundingBox(StringID str, const Dimension &suggestion);
00128 void LoadStringWidthTable(bool monospace = false);
00129 
00130 void DrawDirtyBlocks();
00131 void SetDirtyBlocks(int left, int top, int right, int bottom);
00132 void MarkWholeScreenDirty();
00133 
00134 void GfxInitPalettes();
00135 
00136 bool FillDrawPixelInfo(DrawPixelInfo *n, int left, int top, int width, int height);
00137 
00138 /* window.cpp */
00139 void DrawOverlappedWindowForAll(int left, int top, int right, int bottom);
00140 
00141 void SetMouseCursor(CursorID cursor, PaletteID pal);
00142 void SetAnimatedMouseCursor(const AnimCursor *table);
00143 void CursorTick();
00144 void UpdateCursorSize();
00145 bool ChangeResInGame(int w, int h);
00146 void SortResolutions(int count);
00147 bool ToggleFullScreen(bool fs);
00148 
00149 /* gfx.cpp */
00150 byte GetCharacterWidth(FontSize size, uint32 key);
00151 byte GetDigitWidth(FontSize size = FS_NORMAL);
00152 
00158 static inline byte GetCharacterHeight(FontSize size)
00159 {
00160   assert(size < FS_END);
00161   extern int _font_height[FS_END];
00162   return _font_height[size];
00163 }
00164 
00166 #define FONT_HEIGHT_SMALL  (GetCharacterHeight(FS_SMALL))
00167 
00169 #define FONT_HEIGHT_NORMAL (GetCharacterHeight(FS_NORMAL))
00170 
00172 #define FONT_HEIGHT_LARGE  (GetCharacterHeight(FS_LARGE))
00173 
00175 #define FONT_HEIGHT_MONO  (GetCharacterHeight(FS_MONO))
00176 
00177 extern DrawPixelInfo *_cur_dpi;
00178 
00183 extern byte _colour_gradient[COLOUR_END][8];
00184 
00185 extern bool _palette_remap_grf[];
00186 
00192 #define GREY_SCALE(level) (level)
00193 
00194 static const uint8 PC_BLACK              = GREY_SCALE(1);  
00195 static const uint8 PC_DARK_GREY          = GREY_SCALE(6);  
00196 static const uint8 PC_GREY               = GREY_SCALE(10); 
00197 static const uint8 PC_WHITE              = GREY_SCALE(15); 
00198 
00199 static const uint8 PC_VERY_DARK_RED      = 0xB2;           
00200 static const uint8 PC_DARK_RED           = 0xB4;           
00201 static const uint8 PC_RED                = 0xB8;           
00202 
00203 static const uint8 PC_VERY_DARK_BROWN    = 0x56;           
00204 
00205 static const uint8 PC_ORANGE             = 0xC2;           
00206 
00207 static const uint8 PC_YELLOW             = 0xBF;           
00208 static const uint8 PC_LIGHT_YELLOW       = 0x44;           
00209 static const uint8 PC_VERY_LIGHT_YELLOW  = 0x45;           
00210 
00211 static const uint8 PC_GREEN              = 0xD0;           
00212 
00213 static const uint8 PC_DARK_BLUE          = 0x9D;           
00214 static const uint8 PC_LIGHT_BLUE         = 0x98;           
00215 
00216 #endif /* GFX_FUNC_H */