OpenTTD
gfx.cpp
Go to the documentation of this file.
1 /* $Id: gfx.cpp 27628 2016-08-15 18:33:08Z frosch $ */
2 
3 /*
4  * This file is part of OpenTTD.
5  * 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.
6  * 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.
7  * 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/>.
8  */
9 
12 #include "stdafx.h"
13 #include "gfx_layout.h"
14 #include "progress.h"
15 #include "zoom_func.h"
16 #include "blitter/factory.hpp"
17 #include "video/video_driver.hpp"
18 #include "strings_func.h"
19 #include "settings_type.h"
20 #include "network/network.h"
21 #include "network/network_func.h"
22 #include "window_func.h"
23 #include "newgrf_debug.h"
24 
25 #include "table/palettes.h"
26 #include "table/string_colours.h"
27 #include "table/sprites.h"
28 #include "table/control_codes.h"
29 
30 #include "safeguards.h"
31 
32 byte _dirkeys;
33 bool _fullscreen;
34 byte _support8bpp;
35 CursorVars _cursor;
38 byte _fast_forward;
43 DrawPixelInfo _screen;
44 bool _screen_disable_anim = false;
45 bool _exit_game;
46 GameMode _game_mode;
50 
51 static byte _stringwidth_table[FS_END][224];
52 DrawPixelInfo *_cur_dpi;
53 byte _colour_gradient[COLOUR_END][8];
54 
55 static void GfxMainBlitterViewport(const Sprite *sprite, int x, int y, BlitterMode mode, const SubSprite *sub = NULL, SpriteID sprite_id = SPR_CURSOR_MOUSE);
56 static void GfxMainBlitter(const Sprite *sprite, int x, int y, BlitterMode mode, const SubSprite *sub = NULL, SpriteID sprite_id = SPR_CURSOR_MOUSE, ZoomLevel zoom = ZOOM_LVL_NORMAL);
57 
58 static ReusableBuffer<uint8> _cursor_backup;
59 
61 
70 static const byte *_colour_remap_ptr;
71 static byte _string_colourremap[3];
72 
73 static const uint DIRTY_BLOCK_HEIGHT = 8;
74 static const uint DIRTY_BLOCK_WIDTH = 64;
75 
76 static uint _dirty_bytes_per_line = 0;
77 static byte *_dirty_blocks = NULL;
78 extern uint _dirty_block_colour;
79 
80 void GfxScroll(int left, int top, int width, int height, int xo, int yo)
81 {
83 
84  if (xo == 0 && yo == 0) return;
85 
86  if (_cursor.visible) UndrawMouseCursor();
87 
88 #ifdef ENABLE_NETWORK
90 #endif /* ENABLE_NETWORK */
91 
92  blitter->ScrollBuffer(_screen.dst_ptr, left, top, width, height, xo, yo);
93  /* This part of the screen is now dirty. */
94  VideoDriver::GetInstance()->MakeDirty(left, top, width, height);
95 }
96 
97 
112 void GfxFillRect(int left, int top, int right, int bottom, int colour, FillRectMode mode)
113 {
115  const DrawPixelInfo *dpi = _cur_dpi;
116  void *dst;
117  const int otop = top;
118  const int oleft = left;
119 
120  if (dpi->zoom != ZOOM_LVL_NORMAL) return;
121  if (left > right || top > bottom) return;
122  if (right < dpi->left || left >= dpi->left + dpi->width) return;
123  if (bottom < dpi->top || top >= dpi->top + dpi->height) return;
124 
125  if ( (left -= dpi->left) < 0) left = 0;
126  right = right - dpi->left + 1;
127  if (right > dpi->width) right = dpi->width;
128  right -= left;
129  assert(right > 0);
130 
131  if ( (top -= dpi->top) < 0) top = 0;
132  bottom = bottom - dpi->top + 1;
133  if (bottom > dpi->height) bottom = dpi->height;
134  bottom -= top;
135  assert(bottom > 0);
136 
137  dst = blitter->MoveTo(dpi->dst_ptr, left, top);
138 
139  switch (mode) {
140  default: // FILLRECT_OPAQUE
141  blitter->DrawRect(dst, right, bottom, (uint8)colour);
142  break;
143 
144  case FILLRECT_RECOLOUR:
145  blitter->DrawColourMappingRect(dst, right, bottom, GB(colour, 0, PALETTE_WIDTH));
146  break;
147 
148  case FILLRECT_CHECKER: {
149  byte bo = (oleft - left + dpi->left + otop - top + dpi->top) & 1;
150  do {
151  for (int i = (bo ^= 1); i < right; i += 2) blitter->SetPixel(dst, i, 0, (uint8)colour);
152  dst = blitter->MoveTo(dst, 0, 1);
153  } while (--bottom > 0);
154  break;
155  }
156  }
157 }
158 
173 static inline void GfxDoDrawLine(void *video, int x, int y, int x2, int y2, int screen_width, int screen_height, uint8 colour, int width, int dash = 0)
174 {
176 
177  assert(width > 0);
178 
179  if (y2 == y || x2 == x) {
180  /* Special case: horizontal/vertical line. All checks already done in GfxPreprocessLine. */
181  blitter->DrawLine(video, x, y, x2, y2, screen_width, screen_height, colour, width, dash);
182  return;
183  }
184 
185  int grade_y = y2 - y;
186  int grade_x = x2 - x;
187 
188  /* Clipping rectangle. Slightly extended so we can ignore the width of the line. */
189  int extra = (int)CeilDiv(3 * width, 4); // not less then "width * sqrt(2) / 2"
190  Rect clip = { -extra, -extra, screen_width - 1 + extra, screen_height - 1 + extra };
191 
192  /* prevent integer overflows. */
193  int margin = 1;
194  while (INT_MAX / abs(grade_y) < max(abs(clip.left - x), abs(clip.right - x))) {
195  grade_y /= 2;
196  grade_x /= 2;
197  margin *= 2; // account for rounding errors
198  }
199 
200  /* Imagine that the line is infinitely long and it intersects with
201  * infinitely long left and right edges of the clipping rectangle.
202  * If both intersection points are outside the clipping rectangle
203  * and both on the same side of it, we don't need to draw anything. */
204  int left_isec_y = y + (clip.left - x) * grade_y / grade_x;
205  int right_isec_y = y + (clip.right - x) * grade_y / grade_x;
206  if ((left_isec_y > clip.bottom + margin && right_isec_y > clip.bottom + margin) ||
207  (left_isec_y < clip.top - margin && right_isec_y < clip.top - margin)) {
208  return;
209  }
210 
211  /* It is possible to use the line equation to further reduce the amount of
212  * work the blitter has to do by shortening the effective line segment.
213  * However, in order to get that right and prevent the flickering effects
214  * of rounding errors so much additional code has to be run here that in
215  * the general case the effect is not noticable. */
216 
217  blitter->DrawLine(video, x, y, x2, y2, screen_width, screen_height, colour, width, dash);
218 }
219 
231 static inline bool GfxPreprocessLine(DrawPixelInfo *dpi, int &x, int &y, int &x2, int &y2, int width)
232 {
233  x -= dpi->left;
234  x2 -= dpi->left;
235  y -= dpi->top;
236  y2 -= dpi->top;
237 
238  /* Check simple clipping */
239  if (x + width / 2 < 0 && x2 + width / 2 < 0 ) return false;
240  if (y + width / 2 < 0 && y2 + width / 2 < 0 ) return false;
241  if (x - width / 2 > dpi->width && x2 - width / 2 > dpi->width ) return false;
242  if (y - width / 2 > dpi->height && y2 - width / 2 > dpi->height) return false;
243  return true;
244 }
245 
246 void GfxDrawLine(int x, int y, int x2, int y2, int colour, int width, int dash)
247 {
248  DrawPixelInfo *dpi = _cur_dpi;
249  if (GfxPreprocessLine(dpi, x, y, x2, y2, width)) {
250  GfxDoDrawLine(dpi->dst_ptr, x, y, x2, y2, dpi->width, dpi->height, colour, width, dash);
251  }
252 }
253 
254 void GfxDrawLineUnscaled(int x, int y, int x2, int y2, int colour)
255 {
256  DrawPixelInfo *dpi = _cur_dpi;
257  if (GfxPreprocessLine(dpi, x, y, x2, y2, 1)) {
258  GfxDoDrawLine(dpi->dst_ptr,
259  UnScaleByZoom(x, dpi->zoom), UnScaleByZoom(y, dpi->zoom),
260  UnScaleByZoom(x2, dpi->zoom), UnScaleByZoom(y2, dpi->zoom),
261  UnScaleByZoom(dpi->width, dpi->zoom), UnScaleByZoom(dpi->height, dpi->zoom), colour, 1);
262  }
263 }
264 
278 void DrawBox(int x, int y, int dx1, int dy1, int dx2, int dy2, int dx3, int dy3)
279 {
280  /* ....
281  * .. ....
282  * .. ....
283  * .. ^
284  * <--__(dx1,dy1) /(dx2,dy2)
285  * : --__ / :
286  * : --__ / :
287  * : *(x,y) :
288  * : | :
289  * : | ..
290  * .... |(dx3,dy3)
291  * .... | ..
292  * ....V.
293  */
294 
295  static const byte colour = PC_WHITE;
296 
297  GfxDrawLineUnscaled(x, y, x + dx1, y + dy1, colour);
298  GfxDrawLineUnscaled(x, y, x + dx2, y + dy2, colour);
299  GfxDrawLineUnscaled(x, y, x + dx3, y + dy3, colour);
300 
301  GfxDrawLineUnscaled(x + dx1, y + dy1, x + dx1 + dx2, y + dy1 + dy2, colour);
302  GfxDrawLineUnscaled(x + dx1, y + dy1, x + dx1 + dx3, y + dy1 + dy3, colour);
303  GfxDrawLineUnscaled(x + dx2, y + dy2, x + dx2 + dx1, y + dy2 + dy1, colour);
304  GfxDrawLineUnscaled(x + dx2, y + dy2, x + dx2 + dx3, y + dy2 + dy3, colour);
305  GfxDrawLineUnscaled(x + dx3, y + dy3, x + dx3 + dx1, y + dy3 + dy1, colour);
306  GfxDrawLineUnscaled(x + dx3, y + dy3, x + dx3 + dx2, y + dy3 + dy2, colour);
307 }
308 
313 static void SetColourRemap(TextColour colour)
314 {
315  if (colour == TC_INVALID) return;
316 
317  /* Black strings have no shading ever; the shading is black, so it
318  * would be invisible at best, but it actually makes it illegible. */
319  bool no_shade = (colour & TC_NO_SHADE) != 0 || colour == TC_BLACK;
320  bool raw_colour = (colour & TC_IS_PALETTE_COLOUR) != 0;
321  colour &= ~(TC_NO_SHADE | TC_IS_PALETTE_COLOUR);
322 
323  _string_colourremap[1] = raw_colour ? (byte)colour : _string_colourmap[colour];
324  _string_colourremap[2] = no_shade ? 0 : 1;
325  _colour_remap_ptr = _string_colourremap;
326 }
327 
343 static int DrawLayoutLine(const ParagraphLayouter::Line *line, int y, int left, int right, StringAlignment align, bool underline, bool truncation)
344 {
345  if (line->CountRuns() == 0) return 0;
346 
347  int w = line->GetWidth();
348  int h = line->GetLeading();
349 
350  /*
351  * The following is needed for truncation.
352  * Depending on the text direction, we either remove bits at the rear
353  * or the front. For this we shift the entire area to draw so it fits
354  * within the left/right bounds and the side we do not truncate it on.
355  * Then we determine the truncation location, i.e. glyphs that fall
356  * outside of the range min_x - max_x will not be drawn; they are thus
357  * the truncated glyphs.
358  *
359  * At a later step we insert the dots.
360  */
361 
362  int max_w = right - left + 1; // The maximum width.
363 
364  int offset_x = 0; // The offset we need for positioning the glyphs
365  int min_x = left; // The minimum x position to draw normal glyphs on.
366  int max_x = right; // The maximum x position to draw normal glyphs on.
367 
368  truncation &= max_w < w; // Whether we need to do truncation.
369  int dot_width = 0; // Cache for the width of the dot.
370  const Sprite *dot_sprite = NULL; // Cache for the sprite of the dot.
371 
372  if (truncation) {
373  /*
374  * Assumption may be made that all fonts of a run are of the same size.
375  * In any case, we'll use these dots for the abbreviation, so even if
376  * another size would be chosen it won't have truncated too little for
377  * the truncation dots.
378  */
379  FontCache *fc = ((const Font*)line->GetVisualRun(0)->GetFont())->fc;
380  GlyphID dot_glyph = fc->MapCharToGlyph('.');
381  dot_width = fc->GetGlyphWidth(dot_glyph);
382  dot_sprite = fc->GetGlyph(dot_glyph);
383 
384  if (_current_text_dir == TD_RTL) {
385  min_x += 3 * dot_width;
386  offset_x = w - 3 * dot_width - max_w;
387  } else {
388  max_x -= 3 * dot_width;
389  }
390 
391  w = max_w;
392  }
393 
394  /* In case we have a RTL language we swap the alignment. */
395  if (!(align & SA_FORCE) && _current_text_dir == TD_RTL && (align & SA_HOR_MASK) != SA_HOR_CENTER) align ^= SA_RIGHT;
396 
397  /* right is the right most position to draw on. In this case we want to do
398  * calculations with the width of the string. In comparison right can be
399  * seen as lastof(todraw) and width as lengthof(todraw). They differ by 1.
400  * So most +1/-1 additions are to move from lengthof to 'indices'.
401  */
402  switch (align & SA_HOR_MASK) {
403  case SA_LEFT:
404  /* right + 1 = left + w */
405  right = left + w - 1;
406  break;
407 
408  case SA_HOR_CENTER:
409  left = RoundDivSU(right + 1 + left - w, 2);
410  /* right + 1 = left + w */
411  right = left + w - 1;
412  break;
413 
414  case SA_RIGHT:
415  left = right + 1 - w;
416  break;
417 
418  default:
419  NOT_REACHED();
420  }
421 
422  TextColour colour = TC_BLACK;
423  bool draw_shadow = false;
424  for (int run_index = 0; run_index < line->CountRuns(); run_index++) {
425  const ParagraphLayouter::VisualRun *run = line->GetVisualRun(run_index);
426  const Font *f = (const Font*)run->GetFont();
427 
428  FontCache *fc = f->fc;
429  colour = f->colour;
430  SetColourRemap(colour);
431 
432  DrawPixelInfo *dpi = _cur_dpi;
433  int dpi_left = dpi->left;
434  int dpi_right = dpi->left + dpi->width - 1;
435 
436  draw_shadow = fc->GetDrawGlyphShadow() && (colour & TC_NO_SHADE) == 0 && colour != TC_BLACK;
437 
438  for (int i = 0; i < run->GetGlyphCount(); i++) {
439  GlyphID glyph = run->GetGlyphs()[i];
440 
441  /* Not a valid glyph (empty) */
442  if (glyph == 0xFFFF) continue;
443 
444  int begin_x = (int)run->GetPositions()[i * 2] + left - offset_x;
445  int end_x = (int)run->GetPositions()[i * 2 + 2] + left - offset_x - 1;
446  int top = (int)run->GetPositions()[i * 2 + 1] + y;
447 
448  /* Truncated away. */
449  if (truncation && (begin_x < min_x || end_x > max_x)) continue;
450 
451  const Sprite *sprite = fc->GetGlyph(glyph);
452  /* Check clipping (the "+ 1" is for the shadow). */
453  if (begin_x + sprite->x_offs > dpi_right || begin_x + sprite->x_offs + sprite->width /* - 1 + 1 */ < dpi_left) continue;
454 
455  if (draw_shadow && (glyph & SPRITE_GLYPH) == 0) {
456  SetColourRemap(TC_BLACK);
457  GfxMainBlitter(sprite, begin_x + 1, top + 1, BM_COLOUR_REMAP);
458  SetColourRemap(colour);
459  }
460  GfxMainBlitter(sprite, begin_x, top, BM_COLOUR_REMAP);
461  }
462  }
463 
464  if (truncation) {
465  int x = (_current_text_dir == TD_RTL) ? left : (right - 3 * dot_width);
466  for (int i = 0; i < 3; i++, x += dot_width) {
467  if (draw_shadow) {
468  SetColourRemap(TC_BLACK);
469  GfxMainBlitter(dot_sprite, x + 1, y + 1, BM_COLOUR_REMAP);
470  SetColourRemap(colour);
471  }
472  GfxMainBlitter(dot_sprite, x, y, BM_COLOUR_REMAP);
473  }
474  }
475 
476  if (underline) {
477  GfxFillRect(left, y + h, right, y + h, _string_colourremap[1]);
478  }
479 
480  return (align & SA_HOR_MASK) == SA_RIGHT ? left : right;
481 }
482 
499 int DrawString(int left, int right, int top, const char *str, TextColour colour, StringAlignment align, bool underline, FontSize fontsize)
500 {
501  /* The string may contain control chars to change the font, just use the biggest font for clipping. */
503 
504  /* Funny glyphs may extent outside the usual bounds, so relax the clipping somewhat. */
505  int extra = max_height / 2;
506 
507  if (_cur_dpi->top + _cur_dpi->height + extra < top || _cur_dpi->top > top + max_height + extra ||
508  _cur_dpi->left + _cur_dpi->width + extra < left || _cur_dpi->left > right + extra) {
509  return 0;
510  }
511 
512  Layouter layout(str, INT32_MAX, colour, fontsize);
513  if (layout.Length() == 0) return 0;
514 
515  return DrawLayoutLine(*layout.Begin(), top, left, right, align, underline, true);
516 }
517 
534 int DrawString(int left, int right, int top, StringID str, TextColour colour, StringAlignment align, bool underline, FontSize fontsize)
535 {
536  char buffer[DRAW_STRING_BUFFER];
537  GetString(buffer, str, lastof(buffer));
538  return DrawString(left, right, top, buffer, colour, align, underline, fontsize);
539 }
540 
547 int GetStringHeight(const char *str, int maxw, FontSize fontsize)
548 {
549  Layouter layout(str, maxw, TC_FROMSTRING, fontsize);
550  return layout.GetBounds().height;
551 }
552 
559 int GetStringHeight(StringID str, int maxw)
560 {
561  char buffer[DRAW_STRING_BUFFER];
562  GetString(buffer, str, lastof(buffer));
563  return GetStringHeight(buffer, maxw);
564 }
565 
572 int GetStringLineCount(StringID str, int maxw)
573 {
574  char buffer[DRAW_STRING_BUFFER];
575  GetString(buffer, str, lastof(buffer));
576 
577  Layouter layout(buffer, maxw);
578  return layout.Length();
579 }
580 
588 {
589  Dimension box = {suggestion.width, (uint)GetStringHeight(str, suggestion.width)};
590  return box;
591 }
592 
599 Dimension GetStringMultiLineBoundingBox(const char *str, const Dimension &suggestion)
600 {
601  Dimension box = {suggestion.width, (uint)GetStringHeight(str, suggestion.width)};
602  return box;
603 }
604 
620 int DrawStringMultiLine(int left, int right, int top, int bottom, const char *str, TextColour colour, StringAlignment align, bool underline, FontSize fontsize)
621 {
622  int maxw = right - left + 1;
623  int maxh = bottom - top + 1;
624 
625  /* It makes no sense to even try if it can't be drawn anyway, or
626  * do we really want to support fonts of 0 or less pixels high? */
627  if (maxh <= 0) return top;
628 
629  Layouter layout(str, maxw, colour, fontsize);
630  int total_height = layout.GetBounds().height;
631  int y;
632  switch (align & SA_VERT_MASK) {
633  case SA_TOP:
634  y = top;
635  break;
636 
637  case SA_VERT_CENTER:
638  y = RoundDivSU(bottom + top - total_height, 2);
639  break;
640 
641  case SA_BOTTOM:
642  y = bottom - total_height;
643  break;
644 
645  default: NOT_REACHED();
646  }
647 
648  int last_line = top;
649  int first_line = bottom;
650 
651  for (const ParagraphLayouter::Line **iter = layout.Begin(); iter != layout.End(); iter++) {
652  const ParagraphLayouter::Line *line = *iter;
653 
654  int line_height = line->GetLeading();
655  if (y >= top && y < bottom) {
656  last_line = y + line_height;
657  if (first_line > y) first_line = y;
658 
659  DrawLayoutLine(line, y, left, right, align, underline, false);
660  }
661  y += line_height;
662  }
663 
664  return ((align & SA_VERT_MASK) == SA_BOTTOM) ? first_line : last_line;
665 }
666 
682 int DrawStringMultiLine(int left, int right, int top, int bottom, StringID str, TextColour colour, StringAlignment align, bool underline, FontSize fontsize)
683 {
684  char buffer[DRAW_STRING_BUFFER];
685  GetString(buffer, str, lastof(buffer));
686  return DrawStringMultiLine(left, right, top, bottom, buffer, colour, align, underline, fontsize);
687 }
688 
699 Dimension GetStringBoundingBox(const char *str, FontSize start_fontsize)
700 {
701  Layouter layout(str, INT32_MAX, TC_FROMSTRING, start_fontsize);
702  return layout.GetBounds();
703 }
704 
712 {
713  char buffer[DRAW_STRING_BUFFER];
714 
715  GetString(buffer, strid, lastof(buffer));
716  return GetStringBoundingBox(buffer);
717 }
718 
727 Point GetCharPosInString(const char *str, const char *ch, FontSize start_fontsize)
728 {
729  Layouter layout(str, INT32_MAX, TC_FROMSTRING, start_fontsize);
730  return layout.GetCharPosition(ch);
731 }
732 
740 const char *GetCharAtPosition(const char *str, int x, FontSize start_fontsize)
741 {
742  if (x < 0) return NULL;
743 
744  Layouter layout(str, INT32_MAX, TC_FROMSTRING, start_fontsize);
745  return layout.GetCharAtPosition(x);
746 }
747 
755 void DrawCharCentered(WChar c, int x, int y, TextColour colour)
756 {
757  SetColourRemap(colour);
758  GfxMainBlitter(GetGlyph(FS_NORMAL, c), x - GetCharacterWidth(FS_NORMAL, c) / 2, y, BM_COLOUR_REMAP);
759 }
760 
769 {
770  const Sprite *sprite = GetSprite(sprid, ST_NORMAL);
771 
772  if (offset != NULL) {
773  offset->x = UnScaleByZoom(sprite->x_offs, zoom);
774  offset->y = UnScaleByZoom(sprite->y_offs, zoom);
775  }
776 
777  Dimension d;
778  d.width = max<int>(0, UnScaleByZoom(sprite->x_offs + sprite->width, zoom));
779  d.height = max<int>(0, UnScaleByZoom(sprite->y_offs + sprite->height, zoom));
780  return d;
781 }
782 
789 {
790  switch (pal) {
791  case PAL_NONE: return BM_NORMAL;
792  case PALETTE_CRASH: return BM_CRASH_REMAP;
793  case PALETTE_ALL_BLACK: return BM_BLACK_REMAP;
794  default: return BM_COLOUR_REMAP;
795  }
796 }
797 
806 void DrawSpriteViewport(SpriteID img, PaletteID pal, int x, int y, const SubSprite *sub)
807 {
808  SpriteID real_sprite = GB(img, 0, SPRITE_WIDTH);
810  _colour_remap_ptr = GetNonSprite(GB(pal, 0, PALETTE_WIDTH), ST_RECOLOUR) + 1;
811  GfxMainBlitterViewport(GetSprite(real_sprite, ST_NORMAL), x, y, BM_TRANSPARENT, sub, real_sprite);
812  } else if (pal != PAL_NONE) {
813  if (HasBit(pal, PALETTE_TEXT_RECOLOUR)) {
815  } else {
816  _colour_remap_ptr = GetNonSprite(GB(pal, 0, PALETTE_WIDTH), ST_RECOLOUR) + 1;
817  }
818  GfxMainBlitterViewport(GetSprite(real_sprite, ST_NORMAL), x, y, GetBlitterMode(pal), sub, real_sprite);
819  } else {
820  GfxMainBlitterViewport(GetSprite(real_sprite, ST_NORMAL), x, y, BM_NORMAL, sub, real_sprite);
821  }
822 }
823 
833 void DrawSprite(SpriteID img, PaletteID pal, int x, int y, const SubSprite *sub, ZoomLevel zoom)
834 {
835  SpriteID real_sprite = GB(img, 0, SPRITE_WIDTH);
837  _colour_remap_ptr = GetNonSprite(GB(pal, 0, PALETTE_WIDTH), ST_RECOLOUR) + 1;
838  GfxMainBlitter(GetSprite(real_sprite, ST_NORMAL), x, y, BM_TRANSPARENT, sub, real_sprite, zoom);
839  } else if (pal != PAL_NONE) {
840  if (HasBit(pal, PALETTE_TEXT_RECOLOUR)) {
842  } else {
843  _colour_remap_ptr = GetNonSprite(GB(pal, 0, PALETTE_WIDTH), ST_RECOLOUR) + 1;
844  }
845  GfxMainBlitter(GetSprite(real_sprite, ST_NORMAL), x, y, GetBlitterMode(pal), sub, real_sprite, zoom);
846  } else {
847  GfxMainBlitter(GetSprite(real_sprite, ST_NORMAL), x, y, BM_NORMAL, sub, real_sprite, zoom);
848  }
849 }
850 
862 template <int ZOOM_BASE, bool SCALED_XY>
863 static void GfxBlitter(const Sprite * const sprite, int x, int y, BlitterMode mode, const SubSprite * const sub, SpriteID sprite_id, ZoomLevel zoom)
864 {
865  const DrawPixelInfo *dpi = _cur_dpi;
867 
868  if (SCALED_XY) {
869  /* Scale it */
870  x = ScaleByZoom(x, zoom);
871  y = ScaleByZoom(y, zoom);
872  }
873 
874  /* Move to the correct offset */
875  x += sprite->x_offs;
876  y += sprite->y_offs;
877 
878  if (sub == NULL) {
879  /* No clipping. */
880  bp.skip_left = 0;
881  bp.skip_top = 0;
882  bp.width = UnScaleByZoom(sprite->width, zoom);
883  bp.height = UnScaleByZoom(sprite->height, zoom);
884  } else {
885  /* Amount of pixels to clip from the source sprite */
886  int clip_left = max(0, -sprite->x_offs + sub->left * ZOOM_BASE );
887  int clip_top = max(0, -sprite->y_offs + sub->top * ZOOM_BASE );
888  int clip_right = max(0, sprite->width - (-sprite->x_offs + (sub->right + 1) * ZOOM_BASE));
889  int clip_bottom = max(0, sprite->height - (-sprite->y_offs + (sub->bottom + 1) * ZOOM_BASE));
890 
891  if (clip_left + clip_right >= sprite->width) return;
892  if (clip_top + clip_bottom >= sprite->height) return;
893 
894  bp.skip_left = UnScaleByZoomLower(clip_left, zoom);
895  bp.skip_top = UnScaleByZoomLower(clip_top, zoom);
896  bp.width = UnScaleByZoom(sprite->width - clip_left - clip_right, zoom);
897  bp.height = UnScaleByZoom(sprite->height - clip_top - clip_bottom, zoom);
898 
899  x += ScaleByZoom(bp.skip_left, zoom);
900  y += ScaleByZoom(bp.skip_top, zoom);
901  }
902 
903  /* Copy the main data directly from the sprite */
904  bp.sprite = sprite->data;
905  bp.sprite_width = sprite->width;
906  bp.sprite_height = sprite->height;
907  bp.top = 0;
908  bp.left = 0;
909 
910  bp.dst = dpi->dst_ptr;
911  bp.pitch = dpi->pitch;
912  bp.remap = _colour_remap_ptr;
913 
914  assert(sprite->width > 0);
915  assert(sprite->height > 0);
916 
917  if (bp.width <= 0) return;
918  if (bp.height <= 0) return;
919 
920  y -= SCALED_XY ? ScaleByZoom(dpi->top, zoom) : dpi->top;
921  int y_unscaled = UnScaleByZoom(y, zoom);
922  /* Check for top overflow */
923  if (y < 0) {
924  bp.height -= -y_unscaled;
925  if (bp.height <= 0) return;
926  bp.skip_top += -y_unscaled;
927  y = 0;
928  } else {
929  bp.top = y_unscaled;
930  }
931 
932  /* Check for bottom overflow */
933  y += SCALED_XY ? ScaleByZoom(bp.height - dpi->height, zoom) : ScaleByZoom(bp.height, zoom) - dpi->height;
934  if (y > 0) {
935  bp.height -= UnScaleByZoom(y, zoom);
936  if (bp.height <= 0) return;
937  }
938 
939  x -= SCALED_XY ? ScaleByZoom(dpi->left, zoom) : dpi->left;
940  int x_unscaled = UnScaleByZoom(x, zoom);
941  /* Check for left overflow */
942  if (x < 0) {
943  bp.width -= -x_unscaled;
944  if (bp.width <= 0) return;
945  bp.skip_left += -x_unscaled;
946  x = 0;
947  } else {
948  bp.left = x_unscaled;
949  }
950 
951  /* Check for right overflow */
952  x += SCALED_XY ? ScaleByZoom(bp.width - dpi->width, zoom) : ScaleByZoom(bp.width, zoom) - dpi->width;
953  if (x > 0) {
954  bp.width -= UnScaleByZoom(x, zoom);
955  if (bp.width <= 0) return;
956  }
957 
958  assert(bp.skip_left + bp.width <= UnScaleByZoom(sprite->width, zoom));
959  assert(bp.skip_top + bp.height <= UnScaleByZoom(sprite->height, zoom));
960 
961  /* We do not want to catch the mouse. However we also use that spritenumber for unknown (text) sprites. */
962  if (_newgrf_debug_sprite_picker.mode == SPM_REDRAW && sprite_id != SPR_CURSOR_MOUSE) {
964  void *topleft = blitter->MoveTo(bp.dst, bp.left, bp.top);
965  void *bottomright = blitter->MoveTo(topleft, bp.width - 1, bp.height - 1);
966 
968 
969  if (topleft <= clicked && clicked <= bottomright) {
970  uint offset = (((size_t)clicked - (size_t)topleft) / (blitter->GetScreenDepth() / 8)) % bp.pitch;
971  if (offset < (uint)bp.width) {
973  }
974  }
975  }
976 
977  BlitterFactory::GetCurrentBlitter()->Draw(&bp, mode, zoom);
978 }
979 
980 static void GfxMainBlitterViewport(const Sprite *sprite, int x, int y, BlitterMode mode, const SubSprite *sub, SpriteID sprite_id)
981 {
982  GfxBlitter<ZOOM_LVL_BASE, false>(sprite, x, y, mode, sub, sprite_id, _cur_dpi->zoom);
983 }
984 
985 static void GfxMainBlitter(const Sprite *sprite, int x, int y, BlitterMode mode, const SubSprite *sub, SpriteID sprite_id, ZoomLevel zoom)
986 {
987  GfxBlitter<1, true>(sprite, x, y, mode, sub, sprite_id, zoom);
988 }
989 
990 void DoPaletteAnimations();
991 
992 void GfxInitPalettes()
993 {
994  memcpy(&_cur_palette, &_palette, sizeof(_cur_palette));
995  DoPaletteAnimations();
996 }
997 
998 #define EXTR(p, q) (((uint16)(palette_animation_counter * (p)) * (q)) >> 16)
999 #define EXTR2(p, q) (((uint16)(~palette_animation_counter * (p)) * (q)) >> 16)
1000 
1001 void DoPaletteAnimations()
1002 {
1003  /* Animation counter for the palette animation. */
1004  static int palette_animation_counter = 0;
1005  palette_animation_counter += 8;
1006 
1008  const Colour *s;
1010  Colour old_val[PALETTE_ANIM_SIZE];
1011  const uint old_tc = palette_animation_counter;
1012  uint i;
1013  uint j;
1014 
1015  if (blitter != NULL && blitter->UsePaletteAnimation() == Blitter::PALETTE_ANIMATION_NONE) {
1016  palette_animation_counter = 0;
1017  }
1018 
1019  Colour *palette_pos = &_cur_palette.palette[PALETTE_ANIM_START]; // Points to where animations are taking place on the palette
1020  /* Makes a copy of the current animation palette in old_val,
1021  * so the work on the current palette could be compared, see if there has been any changes */
1022  memcpy(old_val, palette_pos, sizeof(old_val));
1023 
1024  /* Fizzy Drink bubbles animation */
1025  s = ev->fizzy_drink;
1026  j = EXTR2(512, EPV_CYCLES_FIZZY_DRINK);
1027  for (i = 0; i != EPV_CYCLES_FIZZY_DRINK; i++) {
1028  *palette_pos++ = s[j];
1029  j++;
1030  if (j == EPV_CYCLES_FIZZY_DRINK) j = 0;
1031  }
1032 
1033  /* Oil refinery fire animation */
1034  s = ev->oil_refinery;
1035  j = EXTR2(512, EPV_CYCLES_OIL_REFINERY);
1036  for (i = 0; i != EPV_CYCLES_OIL_REFINERY; i++) {
1037  *palette_pos++ = s[j];
1038  j++;
1039  if (j == EPV_CYCLES_OIL_REFINERY) j = 0;
1040  }
1041 
1042  /* Radio tower blinking */
1043  {
1044  byte i = (palette_animation_counter >> 1) & 0x7F;
1045  byte v;
1046 
1047  if (i < 0x3f) {
1048  v = 255;
1049  } else if (i < 0x4A || i >= 0x75) {
1050  v = 128;
1051  } else {
1052  v = 20;
1053  }
1054  palette_pos->r = v;
1055  palette_pos->g = 0;
1056  palette_pos->b = 0;
1057  palette_pos++;
1058 
1059  i ^= 0x40;
1060  if (i < 0x3f) {
1061  v = 255;
1062  } else if (i < 0x4A || i >= 0x75) {
1063  v = 128;
1064  } else {
1065  v = 20;
1066  }
1067  palette_pos->r = v;
1068  palette_pos->g = 0;
1069  palette_pos->b = 0;
1070  palette_pos++;
1071  }
1072 
1073  /* Handle lighthouse and stadium animation */
1074  s = ev->lighthouse;
1075  j = EXTR(256, EPV_CYCLES_LIGHTHOUSE);
1076  for (i = 0; i != EPV_CYCLES_LIGHTHOUSE; i++) {
1077  *palette_pos++ = s[j];
1078  j++;
1079  if (j == EPV_CYCLES_LIGHTHOUSE) j = 0;
1080  }
1081 
1082  /* Dark blue water */
1083  s = (_settings_game.game_creation.landscape == LT_TOYLAND) ? ev->dark_water_toyland : ev->dark_water;
1084  j = EXTR(320, EPV_CYCLES_DARK_WATER);
1085  for (i = 0; i != EPV_CYCLES_DARK_WATER; i++) {
1086  *palette_pos++ = s[j];
1087  j++;
1088  if (j == EPV_CYCLES_DARK_WATER) j = 0;
1089  }
1090 
1091  /* Glittery water */
1093  j = EXTR(128, EPV_CYCLES_GLITTER_WATER);
1094  for (i = 0; i != EPV_CYCLES_GLITTER_WATER / 3; i++) {
1095  *palette_pos++ = s[j];
1096  j += 3;
1098  }
1099 
1100  if (blitter != NULL && blitter->UsePaletteAnimation() == Blitter::PALETTE_ANIMATION_NONE) {
1101  palette_animation_counter = old_tc;
1102  } else {
1103  if (memcmp(old_val, &_cur_palette.palette[PALETTE_ANIM_START], sizeof(old_val)) != 0 && _cur_palette.count_dirty == 0) {
1104  /* Did we changed anything on the palette? Seems so. Mark it as dirty */
1105  _cur_palette.first_dirty = PALETTE_ANIM_START;
1106  _cur_palette.count_dirty = PALETTE_ANIM_SIZE;
1107  }
1108  }
1109 }
1110 
1117 {
1118  Colour c = _cur_palette.palette[background];
1119  /* Compute brightness according to http://www.w3.org/TR/AERT#color-contrast.
1120  * The following formula computes 1000 * brightness^2, with brightness being in range 0 to 255. */
1121  uint sq1000_brightness = c.r * c.r * 299 + c.g * c.g * 587 + c.b * c.b * 114;
1122  /* Compare with threshold brightness 128 (50%) */
1123  return sq1000_brightness < 128 * 128 * 1000 ? TC_WHITE : TC_BLACK;
1124 }
1125 
1130 void LoadStringWidthTable(bool monospace)
1131 {
1132  for (FontSize fs = monospace ? FS_MONO : FS_BEGIN; fs < (monospace ? FS_END : FS_MONO); fs++) {
1133  for (uint i = 0; i != 224; i++) {
1134  _stringwidth_table[fs][i] = GetGlyphWidth(fs, i + 32);
1135  }
1136  }
1137 
1138  ClearFontCache();
1139  ReInitAllWindows();
1140 }
1141 
1149 {
1150  /* Use _stringwidth_table cache if possible */
1151  if (key >= 32 && key < 256) return _stringwidth_table[size][key - 32];
1152 
1153  return GetGlyphWidth(size, key);
1154 }
1155 
1162 {
1163  byte width = 0;
1164  for (char c = '0'; c <= '9'; c++) {
1165  width = max(GetCharacterWidth(size, c), width);
1166  }
1167  return width;
1168 }
1169 
1176 void GetBroadestDigit(uint *front, uint *next, FontSize size)
1177 {
1178  int width = -1;
1179  for (char c = '9'; c >= '0'; c--) {
1180  int w = GetCharacterWidth(size, c);
1181  if (w > width) {
1182  width = w;
1183  *next = c - '0';
1184  if (c != '0') *front = c - '0';
1185  }
1186  }
1187 }
1188 
1189 void ScreenSizeChanged()
1190 {
1191  _dirty_bytes_per_line = CeilDiv(_screen.width, DIRTY_BLOCK_WIDTH);
1192  _dirty_blocks = ReallocT<byte>(_dirty_blocks, _dirty_bytes_per_line * CeilDiv(_screen.height, DIRTY_BLOCK_HEIGHT));
1193 
1194  /* check the dirty rect */
1195  if (_invalid_rect.right >= _screen.width) _invalid_rect.right = _screen.width;
1196  if (_invalid_rect.bottom >= _screen.height) _invalid_rect.bottom = _screen.height;
1197 
1198  /* screen size changed and the old bitmap is invalid now, so we don't want to undraw it */
1199  _cursor.visible = false;
1200 }
1201 
1202 void UndrawMouseCursor()
1203 {
1204  /* Don't undraw the mouse cursor if the screen is not ready */
1205  if (_screen.dst_ptr == NULL) return;
1206 
1207  if (_cursor.visible) {
1209  _cursor.visible = false;
1210  blitter->CopyFromBuffer(blitter->MoveTo(_screen.dst_ptr, _cursor.draw_pos.x, _cursor.draw_pos.y), _cursor_backup.GetBuffer(), _cursor.draw_size.x, _cursor.draw_size.y);
1211  VideoDriver::GetInstance()->MakeDirty(_cursor.draw_pos.x, _cursor.draw_pos.y, _cursor.draw_size.x, _cursor.draw_size.y);
1212  }
1213 }
1214 
1215 void DrawMouseCursor()
1216 {
1217 #if defined(WINCE)
1218  /* Don't ever draw the mouse for WinCE, as we work with a stylus */
1219  return;
1220 #endif
1221 
1222  /* Don't draw the mouse cursor if the screen is not ready */
1223  if (_screen.dst_ptr == NULL) return;
1224 
1226 
1227  /* Redraw mouse cursor but only when it's inside the window */
1228  if (!_cursor.in_window) return;
1229 
1230  /* Don't draw the mouse cursor if it's already drawn */
1231  if (_cursor.visible) {
1232  if (!_cursor.dirty) return;
1233  UndrawMouseCursor();
1234  }
1235 
1236  /* Determine visible area */
1237  int left = _cursor.pos.x + _cursor.total_offs.x;
1238  int width = _cursor.total_size.x;
1239  if (left < 0) {
1240  width += left;
1241  left = 0;
1242  }
1243  if (left + width > _screen.width) {
1244  width = _screen.width - left;
1245  }
1246  if (width <= 0) return;
1247 
1248  int top = _cursor.pos.y + _cursor.total_offs.y;
1249  int height = _cursor.total_size.y;
1250  if (top < 0) {
1251  height += top;
1252  top = 0;
1253  }
1254  if (top + height > _screen.height) {
1255  height = _screen.height - top;
1256  }
1257  if (height <= 0) return;
1258 
1259  _cursor.draw_pos.x = left;
1260  _cursor.draw_pos.y = top;
1261  _cursor.draw_size.x = width;
1262  _cursor.draw_size.y = height;
1263 
1264  uint8 *buffer = _cursor_backup.Allocate(blitter->BufferSize(_cursor.draw_size.x, _cursor.draw_size.y));
1265 
1266  /* Make backup of stuff below cursor */
1267  blitter->CopyToBuffer(blitter->MoveTo(_screen.dst_ptr, _cursor.draw_pos.x, _cursor.draw_pos.y), buffer, _cursor.draw_size.x, _cursor.draw_size.y);
1268 
1269  /* Draw cursor on screen */
1270  _cur_dpi = &_screen;
1271  for (uint i = 0; i < _cursor.sprite_count; ++i) {
1272  DrawSprite(_cursor.sprite_seq[i].sprite, _cursor.sprite_seq[i].pal, _cursor.pos.x + _cursor.sprite_pos[i].x, _cursor.pos.y + _cursor.sprite_pos[i].y);
1273  }
1274 
1275  VideoDriver::GetInstance()->MakeDirty(_cursor.draw_pos.x, _cursor.draw_pos.y, _cursor.draw_size.x, _cursor.draw_size.y);
1276 
1277  _cursor.visible = true;
1278  _cursor.dirty = false;
1279 }
1280 
1281 void RedrawScreenRect(int left, int top, int right, int bottom)
1282 {
1283  assert(right <= _screen.width && bottom <= _screen.height);
1284  if (_cursor.visible) {
1285  if (right > _cursor.draw_pos.x &&
1286  left < _cursor.draw_pos.x + _cursor.draw_size.x &&
1287  bottom > _cursor.draw_pos.y &&
1288  top < _cursor.draw_pos.y + _cursor.draw_size.y) {
1289  UndrawMouseCursor();
1290  }
1291  }
1292 
1293 #ifdef ENABLE_NETWORK
1295 #endif /* ENABLE_NETWORK */
1296 
1297  DrawOverlappedWindowForAll(left, top, right, bottom);
1298 
1299  VideoDriver::GetInstance()->MakeDirty(left, top, right - left, bottom - top);
1300 }
1301 
1308 {
1309  byte *b = _dirty_blocks;
1310  const int w = Align(_screen.width, DIRTY_BLOCK_WIDTH);
1311  const int h = Align(_screen.height, DIRTY_BLOCK_HEIGHT);
1312  int x;
1313  int y;
1314 
1315  if (HasModalProgress()) {
1316  /* We are generating the world, so release our rights to the map and
1317  * painting while we are waiting a bit. */
1320 
1321  /* Wait a while and update _realtime_tick so we are given the rights */
1326 
1327  /* When we ended with the modal progress, do not draw the blocks.
1328  * Simply let the next run do so, otherwise we would be loading
1329  * the new state (and possibly change the blitter) when we hold
1330  * the drawing lock, which we must not do. */
1331  if (_switch_mode != SM_NONE && !HasModalProgress()) return;
1332  }
1333 
1334  y = 0;
1335  do {
1336  x = 0;
1337  do {
1338  if (*b != 0) {
1339  int left;
1340  int top;
1341  int right = x + DIRTY_BLOCK_WIDTH;
1342  int bottom = y;
1343  byte *p = b;
1344  int h2;
1345 
1346  /* First try coalescing downwards */
1347  do {
1348  *p = 0;
1349  p += _dirty_bytes_per_line;
1350  bottom += DIRTY_BLOCK_HEIGHT;
1351  } while (bottom != h && *p != 0);
1352 
1353  /* Try coalescing to the right too. */
1354  h2 = (bottom - y) / DIRTY_BLOCK_HEIGHT;
1355  assert(h2 > 0);
1356  p = b;
1357 
1358  while (right != w) {
1359  byte *p2 = ++p;
1360  int h = h2;
1361  /* Check if a full line of dirty flags is set. */
1362  do {
1363  if (!*p2) goto no_more_coalesc;
1364  p2 += _dirty_bytes_per_line;
1365  } while (--h != 0);
1366 
1367  /* Wohoo, can combine it one step to the right!
1368  * Do that, and clear the bits. */
1369  right += DIRTY_BLOCK_WIDTH;
1370 
1371  h = h2;
1372  p2 = p;
1373  do {
1374  *p2 = 0;
1375  p2 += _dirty_bytes_per_line;
1376  } while (--h != 0);
1377  }
1378  no_more_coalesc:
1379 
1380  left = x;
1381  top = y;
1382 
1383  if (left < _invalid_rect.left ) left = _invalid_rect.left;
1384  if (top < _invalid_rect.top ) top = _invalid_rect.top;
1385  if (right > _invalid_rect.right ) right = _invalid_rect.right;
1386  if (bottom > _invalid_rect.bottom) bottom = _invalid_rect.bottom;
1387 
1388  if (left < right && top < bottom) {
1389  RedrawScreenRect(left, top, right, bottom);
1390  }
1391 
1392  }
1393  } while (b++, (x += DIRTY_BLOCK_WIDTH) != w);
1394  } while (b += -(int)(w / DIRTY_BLOCK_WIDTH) + _dirty_bytes_per_line, (y += DIRTY_BLOCK_HEIGHT) != h);
1395 
1396  ++_dirty_block_colour;
1397  _invalid_rect.left = w;
1398  _invalid_rect.top = h;
1399  _invalid_rect.right = 0;
1400  _invalid_rect.bottom = 0;
1401 }
1402 
1418 void SetDirtyBlocks(int left, int top, int right, int bottom)
1419 {
1420  byte *b;
1421  int width;
1422  int height;
1423 
1424  if (left < 0) left = 0;
1425  if (top < 0) top = 0;
1426  if (right > _screen.width) right = _screen.width;
1427  if (bottom > _screen.height) bottom = _screen.height;
1428 
1429  if (left >= right || top >= bottom) return;
1430 
1431  if (left < _invalid_rect.left ) _invalid_rect.left = left;
1432  if (top < _invalid_rect.top ) _invalid_rect.top = top;
1433  if (right > _invalid_rect.right ) _invalid_rect.right = right;
1434  if (bottom > _invalid_rect.bottom) _invalid_rect.bottom = bottom;
1435 
1436  left /= DIRTY_BLOCK_WIDTH;
1437  top /= DIRTY_BLOCK_HEIGHT;
1438 
1439  b = _dirty_blocks + top * _dirty_bytes_per_line + left;
1440 
1441  width = ((right - 1) / DIRTY_BLOCK_WIDTH) - left + 1;
1442  height = ((bottom - 1) / DIRTY_BLOCK_HEIGHT) - top + 1;
1443 
1444  assert(width > 0 && height > 0);
1445 
1446  do {
1447  int i = width;
1448 
1449  do b[--i] = 0xFF; while (i != 0);
1450 
1451  b += _dirty_bytes_per_line;
1452  } while (--height != 0);
1453 }
1454 
1462 {
1463  SetDirtyBlocks(0, 0, _screen.width, _screen.height);
1464 }
1465 
1480 bool FillDrawPixelInfo(DrawPixelInfo *n, int left, int top, int width, int height)
1481 {
1483  const DrawPixelInfo *o = _cur_dpi;
1484 
1485  n->zoom = ZOOM_LVL_NORMAL;
1486 
1487  assert(width > 0);
1488  assert(height > 0);
1489 
1490  if ((left -= o->left) < 0) {
1491  width += left;
1492  if (width <= 0) return false;
1493  n->left = -left;
1494  left = 0;
1495  } else {
1496  n->left = 0;
1497  }
1498 
1499  if (width > o->width - left) {
1500  width = o->width - left;
1501  if (width <= 0) return false;
1502  }
1503  n->width = width;
1504 
1505  if ((top -= o->top) < 0) {
1506  height += top;
1507  if (height <= 0) return false;
1508  n->top = -top;
1509  top = 0;
1510  } else {
1511  n->top = 0;
1512  }
1513 
1514  n->dst_ptr = blitter->MoveTo(o->dst_ptr, left, top);
1515  n->pitch = o->pitch;
1516 
1517  if (height > o->height - top) {
1518  height = o->height - top;
1519  if (height <= 0) return false;
1520  }
1521  n->height = height;
1522 
1523  return true;
1524 }
1525 
1531 {
1532  /* Ignore setting any cursor before the sprites are loaded. */
1533  if (GetMaxSpriteID() == 0) return;
1534 
1535  assert_compile(lengthof(_cursor.sprite_seq) == lengthof(_cursor.sprite_pos));
1536  assert(_cursor.sprite_count <= lengthof(_cursor.sprite_seq));
1537  for (uint i = 0; i < _cursor.sprite_count; ++i) {
1538  const Sprite *p = GetSprite(GB(_cursor.sprite_seq[i].sprite, 0, SPRITE_WIDTH), ST_NORMAL);
1539  Point offs, size;
1540  offs.x = UnScaleGUI(p->x_offs) + _cursor.sprite_pos[i].x;
1541  offs.y = UnScaleGUI(p->y_offs) + _cursor.sprite_pos[i].y;
1542  size.x = UnScaleGUI(p->width);
1543  size.y = UnScaleGUI(p->height);
1544 
1545  if (i == 0) {
1546  _cursor.total_offs = offs;
1547  _cursor.total_size = size;
1548  } else {
1549  int right = max(_cursor.total_offs.x + _cursor.total_size.x, offs.x + size.x);
1550  int bottom = max(_cursor.total_offs.y + _cursor.total_size.y, offs.y + size.y);
1551  if (offs.x < _cursor.total_offs.x) _cursor.total_offs.x = offs.x;
1552  if (offs.y < _cursor.total_offs.y) _cursor.total_offs.y = offs.y;
1553  _cursor.total_size.x = right - _cursor.total_offs.x;
1554  _cursor.total_size.y = bottom - _cursor.total_offs.y;
1555  }
1556  }
1557 
1558  _cursor.dirty = true;
1559 }
1560 
1566 static void SetCursorSprite(CursorID cursor, PaletteID pal)
1567 {
1568  if (_cursor.sprite_count == 1 && _cursor.sprite_seq[0].sprite == cursor && _cursor.sprite_seq[0].pal == pal) return;
1569 
1570  _cursor.sprite_count = 1;
1571  _cursor.sprite_seq[0].sprite = cursor;
1572  _cursor.sprite_seq[0].pal = pal;
1573  _cursor.sprite_pos[0].x = 0;
1574  _cursor.sprite_pos[0].y = 0;
1575 
1576  UpdateCursorSize();
1577 }
1578 
1579 static void SwitchAnimatedCursor()
1580 {
1581  const AnimCursor *cur = _cursor.animate_cur;
1582 
1583  if (cur == NULL || cur->sprite == AnimCursor::LAST) cur = _cursor.animate_list;
1584 
1585  SetCursorSprite(cur->sprite, _cursor.sprite_seq[0].pal);
1586 
1587  _cursor.animate_timeout = cur->display_time;
1588  _cursor.animate_cur = cur + 1;
1589 }
1590 
1591 void CursorTick()
1592 {
1593  if (_cursor.animate_timeout != 0 && --_cursor.animate_timeout == 0) {
1594  SwitchAnimatedCursor();
1595  }
1596 }
1597 
1602 void SetMouseCursorBusy(bool busy)
1603 {
1604  if (busy) {
1605  if (_cursor.sprite_seq[0].sprite == SPR_CURSOR_MOUSE) SetMouseCursor(SPR_CURSOR_ZZZ, PAL_NONE);
1606  } else {
1607  if (_cursor.sprite_seq[0].sprite == SPR_CURSOR_ZZZ) SetMouseCursor(SPR_CURSOR_MOUSE, PAL_NONE);
1608  }
1609 }
1610 
1618 {
1619  /* Turn off animation */
1620  _cursor.animate_timeout = 0;
1621  /* Set cursor */
1622  SetCursorSprite(sprite, pal);
1623 }
1624 
1631 {
1632  _cursor.animate_list = table;
1633  _cursor.animate_cur = NULL;
1634  _cursor.sprite_seq[0].pal = PAL_NONE;
1635  SwitchAnimatedCursor();
1636 }
1637 
1646 bool CursorVars::UpdateCursorPosition(int x, int y, bool queued_warp)
1647 {
1648  /* Detecting relative mouse movement is somewhat tricky.
1649  * - There may be multiple mouse move events in the video driver queue (esp. when OpenTTD lags a bit).
1650  * - When we request warping the mouse position (return true), a mouse move event is appended at the end of the queue.
1651  *
1652  * So, when this->fix_at is active, we use the following strategy:
1653  * - The first movement triggers the warp to reset the mouse position.
1654  * - Subsequent events have to compute movement relative to the previous event.
1655  * - The relative movement is finished, when we receive the event matching the warp.
1656  */
1657 
1658  if (x == this->pos.x && y == this->pos.y) {
1659  /* Warp finished. */
1660  this->queued_warp = false;
1661  }
1662 
1663  this->delta.x = x - (this->queued_warp ? this->last_position.x : this->pos.x);
1664  this->delta.y = y - (this->queued_warp ? this->last_position.y : this->pos.y);
1665 
1666  this->last_position.x = x;
1667  this->last_position.y = y;
1668 
1669  bool need_warp = false;
1670  if (this->fix_at) {
1671  if (this->delta.x != 0 || this->delta.y != 0) {
1672  /* Trigger warp.
1673  * Note: We also trigger warping again, if there is already a pending warp.
1674  * This makes it more tolerant about the OS or other software inbetween
1675  * botchering the warp. */
1676  this->queued_warp = queued_warp;
1677  need_warp = true;
1678  }
1679  } else if (this->pos.x != x || this->pos.y != y) {
1680  this->queued_warp = false; // Cancel warping, we are no longer confining the position.
1681  this->dirty = true;
1682  this->pos.x = x;
1683  this->pos.y = y;
1684  }
1685  return need_warp;
1686 }
1687 
1688 bool ChangeResInGame(int width, int height)
1689 {
1690  return (_screen.width == width && _screen.height == height) || VideoDriver::GetInstance()->ChangeResolution(width, height);
1691 }
1692 
1693 bool ToggleFullScreen(bool fs)
1694 {
1695  bool result = VideoDriver::GetInstance()->ToggleFullscreen(fs);
1696  if (_fullscreen != fs && _num_resolutions == 0) {
1697  DEBUG(driver, 0, "Could not find a suitable fullscreen resolution");
1698  }
1699  return result;
1700 }
1701 
1702 static int CDECL compare_res(const Dimension *pa, const Dimension *pb)
1703 {
1704  int x = pa->width - pb->width;
1705  if (x != 0) return x;
1706  return pa->height - pb->height;
1707 }
1708 
1709 void SortResolutions(int count)
1710 {
1711  QSortT(_resolutions, count, &compare_res);
1712 }
virtual void MakeDirty(int left, int top, int width, int height)=0
Mark a particular area dirty.
Functions related to OTTD&#39;s strings.
int left
The left offset in the &#39;dst&#39; in pixels to start drawing.
Definition: base.hpp:43
Functions/types related to NewGRF debugging.
uint32 PaletteID
The number of the palette.
Definition: gfx_type.h:20
GameSettings _settings_game
Game settings of a running game or the scenario editor.
Definition: settings.cpp:77
bool _networking
are we in networking mode?
Definition: network.cpp:56
Base of all video drivers.
bool dirty
the rect occupied by the mouse is dirty (redraw)
Definition: gfx_type.h:142
Data about how and where to blit pixels.
Definition: gfx_type.h:156
static const uint8 PC_WHITE
White palette colour.
Definition: gfx_func.h:210
Horizontally center the text.
Definition: gfx_func.h:99
uint32 _realtime_tick
The real time in the game.
Definition: debug.cpp:48
Control codes that are embedded in the translation strings.
void GfxFillRect(int left, int top, int right, int bottom, int colour, FillRectMode mode)
Applies a certain FillRectMode-operation to a rectangle [left, right] x [top, bottom] on the screen...
Definition: gfx.cpp:112
Point pos
logical mouse position
Definition: gfx_type.h:119
byte landscape
the landscape we&#39;re currently in
static void SetColourRemap(TextColour colour)
Set the colour remap to be for the given colour.
Definition: gfx.cpp:313
int sprite_width
Real width of the sprite.
Definition: base.hpp:41
static int UnScaleGUI(int value)
Short-hand to apply GUI zoom level.
Definition: zoom_func.h:72
Information about the currently used palette.
Definition: gfx_type.h:309
void SetMouseCursorBusy(bool busy)
Set or unset the ZZZ cursor.
Definition: gfx.cpp:1602
static const PaletteID PALETTE_ALL_BLACK
Exchange any color by black, needed for painting fictive tiles outside map.
Definition: sprites.h:1575
int height
The height in pixels that needs to be drawn to dst.
Definition: base.hpp:40
static byte _string_colourremap[3]
Recoloursprite for stringdrawing. The grf loader ensures that ST_FONT sprites only use colours 0 to 2...
Definition: gfx.cpp:71
bool _right_button_down
Is right mouse button pressed?
Definition: gfx.cpp:41
Point sprite_pos[16]
relative position of individual sprites
Definition: gfx_type.h:131
Perform transparency colour remapping.
Definition: base.hpp:22
static int UnScaleByZoomLower(int value, ZoomLevel zoom)
Scale by zoom level, usually shift right (when zoom > ZOOM_LVL_NORMAL)
Definition: zoom_func.h:61
Colour palette[256]
Current palette. Entry 0 has to be always fully transparent!
Definition: gfx_type.h:310
int skip_top
How much pixels of the source to skip on the top (based on zoom of dst)
Definition: base.hpp:38
Colour fizzy_drink[EPV_CYCLES_FIZZY_DRINK]
fizzy drinks
Definition: palettes.h:111
byte _colour_gradient[COLOUR_END][8]
All 16 colour gradients 8 colours per gradient from darkest (0) to lightest (7)
Definition: gfx.cpp:53
static int UnScaleByZoom(int value, ZoomLevel zoom)
Scale by zoom level, usually shift right (when zoom > ZOOM_LVL_NORMAL) When shifting right...
Definition: zoom_func.h:37
StringAlignment
How to align the to-be drawn text.
Definition: gfx_func.h:97
uint sprite_count
number of sprites to draw
Definition: gfx_type.h:132
#define FONT_HEIGHT_MONO
Height of characters in the large (FS_MONO) font.
Definition: gfx_func.h:186
Index of the monospaced font in the font tables.
Definition: gfx_type.h:207
Data structure describing a sprite.
Definition: spritecache.h:18
Mask for horizontal alignment.
Definition: gfx_func.h:101
int sprite_height
Real height of the sprite.
Definition: base.hpp:42
static const ExtraPaletteValues _extra_palette_values
Actual palette animation tables.
Definition: palettes.h:117
int width
The width in pixels that needs to be drawn to dst.
Definition: base.hpp:39
virtual void SetPixel(void *video, int x, int y, uint8 colour)=0
Draw a pixel with a given colour on the video-buffer.
static bool GfxPreprocessLine(DrawPixelInfo *dpi, int &x, int &y, int &x2, int &y2, int width)
Align parameters of a line to the given DPI and check simple clipping.
Definition: gfx.cpp:231
const AnimCursor * animate_list
in case of animated cursor, list of frames
Definition: gfx_type.h:137
static int ScaleByZoom(int value, ZoomLevel zoom)
Scale by zoom level, usually shift left (when zoom > ZOOM_LVL_NORMAL) When shifting right...
Definition: zoom_func.h:24
byte GetCharacterWidth(FontSize size, WChar key)
Return width of character glyph.
Definition: gfx.cpp:1148
const T * Begin() const
Get the pointer to the first item (const)
virtual bool ToggleFullscreen(bool fullscreen)=0
Change the full screen setting.
void * clicked_pixel
Clicked pixel (pointer to blitter buffer)
Definition: newgrf_debug.h:30
int GetStringHeight(const char *str, int maxw, FontSize fontsize)
Calculates height of string (in pixels).
Definition: gfx.cpp:547
static const int DRAW_STRING_BUFFER
Size of the buffer used for drawing strings.
Definition: gfx_func.h:87
const char * GetCharAtPosition(int x) const
Get the character that is at a position.
Definition: gfx_layout.cpp:754
int _num_resolutions
The number of resolutions.
Definition: driver.cpp:22
#define lastof(x)
Get the last element of an fixed size array.
Definition: depend.cpp:50
ZoomLevelByte _gui_zoom
GUI Zoom level.
Definition: gfx.cpp:60
No palette animation.
Definition: base.hpp:52
int skip_left
How much pixels of the source to skip on the left (based on zoom of dst)
Definition: base.hpp:37
Visual run contains data about the bit of text with the same font.
Definition: gfx_layout.h:108
byte GetDigitWidth(FontSize size)
Return the maximum width of single digit.
Definition: gfx.cpp:1161
The most basic (normal) sprite.
Definition: gfx_type.h:298
How all blitters should look like.
Definition: base.hpp:30
static const uint MODAL_PROGRESS_REDRAW_TIMEOUT
Timeout between redraws.
Definition: progress.h:17
static T max(const T a, const T b)
Returns the maximum of two values.
Definition: math_func.hpp:26
Functions related to laying out the texts.
virtual void EndCritical(bool allow_recursive=false)=0
End of the critical section.
static const uint EPV_CYCLES_OIL_REFINERY
length of the oil refinery&#39;s fire animation
Definition: palettes.h:101
bool visible
cursor is visible
Definition: gfx_type.h:141
const T * End() const
Get the pointer behind the last valid item (const)
NewGrfDebugSpritePicker _newgrf_debug_sprite_picker
The sprite picker.
static uint GetGlyphWidth(FontSize size, WChar key)
Get the width of a glyph.
Definition: fontcache.h:183
static int RoundDivSU(int a, uint b)
Computes round(a / b) for signed a and unsigned b.
Definition: math_func.hpp:338
FillRectMode
Define the operation GfxFillRect performs.
Definition: gfx_type.h:282
bool FillDrawPixelInfo(DrawPixelInfo *n, int left, int top, int width, int height)
Set up a clipping area for only drawing into a certain area.
Definition: gfx.cpp:1480
Point total_size
union of sprite properties
Definition: gfx_type.h:133
bool _left_button_clicked
Is left mouse button clicked?
Definition: gfx.cpp:40
Colour dark_water[EPV_CYCLES_DARK_WATER]
dark blue water
Definition: palettes.h:107
Force the alignment, i.e. don&#39;t swap for RTL languages.
Definition: gfx_func.h:110
ThreadMutex * _modal_progress_work_mutex
Rights for the performing work.
Definition: progress.cpp:21
bool _ctrl_pressed
Is Ctrl pressed?
Definition: gfx.cpp:36
Point draw_size
position and size bounding-box for drawing
Definition: gfx_type.h:135
Colour lighthouse[EPV_CYCLES_LIGHTHOUSE]
lighthouse & stadium
Definition: palettes.h:109
The colour translation of the GRF palettes.
CursorID sprite
Must be set to LAST_ANIM when it is the last sprite of the loop.
Definition: gfx_type.h:112
Collection of variables for cursor-display and -animation.
Definition: gfx_type.h:117
virtual bool ChangeResolution(int w, int h)=0
Change the resolution of the window.
bool IsFirstModalProgressLoop()
Check whether this is the first modal progress loop.
Definition: progress.cpp:41
Colour glitter_water[EPV_CYCLES_GLITTER_WATER]
glittery water
Definition: palettes.h:112
int16 y_offs
Number of pixels to shift the sprite downwards.
Definition: spritecache.h:22
#define FONT_HEIGHT_SMALL
Height of characters in the small (FS_SMALL) font.
Definition: gfx_func.h:177
A single line worth of VisualRuns.
Definition: gfx_layout.h:120
bool _right_button_clicked
Is right mouse button clicked?
Definition: gfx.cpp:42
static Rect _invalid_rect
The rect for repaint.
Definition: gfx.cpp:69
uint Length() const
Get the number of items in the list.
static T Align(const T x, uint n)
Return the smallest multiple of n equal or greater than x.
Definition: math_func.hpp:97
First font.
Definition: gfx_type.h:210
GameMode
Mode which defines the state of the game.
Definition: openttd.h:18
const T * GetBuffer() const
Get the currently allocated buffer.
Definition: alloc_type.hpp:140
virtual void DrawLine(void *video, int x, int y, int x2, int y2, int screen_width, int screen_height, uint8 colour, int width, int dash=0)
Draw a line with a given colour.
Definition: base.cpp:18
Parameters related to blitting.
Definition: base.hpp:33
void DrawSpriteViewport(SpriteID img, PaletteID pal, int x, int y, const SubSprite *sub)
Draw a sprite in a viewport.
Definition: gfx.cpp:806
bool _left_button_down
Is left mouse button pressed?
Definition: gfx.cpp:39
#define FONT_HEIGHT_NORMAL
Height of characters in the normal (FS_NORMAL) font.
Definition: gfx_func.h:180
virtual uint GetGlyphWidth(GlyphID key)=0
Get the width of the glyph with the given key.
Apply a recolour sprite to the screen content.
Definition: gfx_type.h:285
Types related to global configuration settings.
TextColour GetContrastColour(uint8 background)
Determine a contrasty text colour for a coloured background.
Definition: gfx.cpp:1116
Functions related to modal progress.
Definition of base types and functions in a cross-platform compatible way.
void LoadStringWidthTable(bool monospace)
Initialize _stringwidth_table cache.
Definition: gfx.cpp:1130
Description of tables for the palette animation.
Definition: palettes.h:106
Bottom align the text.
Definition: gfx_func.h:105
Top align the text.
Definition: gfx_func.h:103
A number of safeguards to prevent using unsafe methods.
int pitch
The pitch of the destination buffer.
Definition: base.hpp:47
TextColour
Colour of the strings, see _string_colourmap in table/string_colours.h or docs/ottd-colourtext-palett...
Definition: gfx_type.h:247
bool UpdateCursorPosition(int x, int y, bool queued_warp)
Update cursor position on mouse movement.
Definition: gfx.cpp:1646
static uint CeilDiv(uint a, uint b)
Computes ceil(a / b) for non-negative a and b.
Definition: math_func.hpp:316
virtual void Draw(Blitter::BlitterParams *bp, BlitterMode mode, ZoomLevel zoom)=0
Draw an image to the screen, given an amount of params defined above.
T * Allocate(size_t count)
Get buffer of at least count times T.
Definition: alloc_type.hpp:107
number of animated colours
Definition: gfx_type.h:277
byte _dirkeys
1 = left, 2 = up, 4 = right, 8 = down
Definition: gfx.cpp:32
Perform a crash remapping.
Definition: base.hpp:23
bool fix_at
mouse is moving, but cursor is not (used for scrolling)
Definition: gfx_type.h:122
void DrawCharCentered(WChar c, int x, int y, TextColour colour)
Draw single character horizontally centered around (x,y)
Definition: gfx.cpp:755
bool _screen_disable_anim
Disable palette animation (important for 32bpp-anim blitter during giant screenshot) ...
Definition: gfx.cpp:44
Point GetCharPosInString(const char *str, const char *ch, FontSize start_fontsize)
Get the leading corner of a character in a single-line string relative to the start of the string...
Definition: gfx.cpp:727
static const uint EPV_CYCLES_FIZZY_DRINK
length of the fizzy drinks animation
Definition: palettes.h:102
byte data[]
Sprite data.
Definition: spritecache.h:23
A reusable buffer that can be used for places that temporary allocate a bit of memory and do that ver...
Definition: alloc_type.hpp:89
int DrawString(int left, int right, int top, const char *str, TextColour colour, StringAlignment align, bool underline, FontSize fontsize)
Draw string, possibly truncated to make it fit in its allocated space.
Definition: gfx.cpp:499
Basic functions/variables used all over the place.
static const Palette _palette
Colour palette (DOS)
Definition: palettes.h:17
A single sprite of a list of animated cursors.
Definition: gfx_type.h:110
byte display_time
Amount of ticks this sprite will be shown.
Definition: gfx_type.h:113
Mask for vertical alignment.
Definition: gfx_func.h:106
void SetDirtyBlocks(int left, int top, int right, int bottom)
This function extends the internal _invalid_rect rectangle as it now contains the rectangle defined b...
Definition: gfx.cpp:1418
#define FONT_HEIGHT_LARGE
Height of characters in the large (FS_LARGE) font.
Definition: gfx_func.h:183
#define lengthof(x)
Return the length of an fixed size array.
Definition: depend.cpp:42
PauseModeByte _pause_mode
The current pause mode.
Definition: gfx.cpp:48
void DrawDirtyBlocks()
Repaints the rectangle blocks which are marked as &#39;dirty&#39;.
Definition: gfx.cpp:1307
static Blitter * GetCurrentBlitter()
Get the current active blitter (always set by calling SelectBlitter).
Definition: factory.hpp:147
number of bits for the sprite number
Definition: sprites.h:1494
int first_dirty
The first dirty element.
Definition: gfx_type.h:311
Perform remapping to a completely blackened sprite.
Definition: base.hpp:24
static const Sprite * GetGlyph(FontSize size, WChar key)
Get the Sprite for a glyph.
Definition: fontcache.h:176
ThreadMutex * _modal_progress_paint_mutex
Rights for the painting.
Definition: progress.cpp:23
uint32 StringID
Numeric value that represents a string, independent of the selected language.
Definition: strings_type.h:18
void DrawOverlappedWindowForAll(int left, int top, int right, int bottom)
From a rectangle that needs redrawing, find the windows that intersect with the rectangle.
Definition: window.cpp:937
virtual void CopyToBuffer(const void *video, void *dst, int width, int height)=0
Copy from the screen to a buffer.
virtual GlyphID MapCharToGlyph(WChar key)=0
Map a character into a glyph.
void DrawBox(int x, int y, int dx1, int dy1, int dx2, int dy2, int dx3, int dy3)
Draws the projection of a parallelepiped.
Definition: gfx.cpp:278
Font cache for basic fonts.
Definition: fontcache.h:23
Template of struct holding enum types (on most archs, enums are stored in an int32).
Definition: enum_type.hpp:139
Palette _cur_palette
Current palette.
Definition: gfx.cpp:49
uint16 height
Height of the sprite.
Definition: spritecache.h:19
Dimension GetBounds()
Get the boundaries of this paragraph.
Definition: gfx_layout.cpp:691
bool _shift_pressed
Is Shift pressed?
Definition: gfx.cpp:37
void NetworkUndrawChatMessage()
Hide the chatbox.
#define DEBUG(name, level,...)
Output a line of debugging information.
Definition: debug.h:39
Dimension _resolutions[32]
List of resolutions.
Definition: driver.cpp:23
Dimension GetStringBoundingBox(const char *str, FontSize start_fontsize)
Return the string dimension in pixels.
Definition: gfx.cpp:699
virtual Blitter::PaletteAnimation UsePaletteAnimation()=0
Check if the blitter uses palette animation at all.
void SetMouseCursor(CursorID sprite, PaletteID pal)
Assign a single non-animated sprite to the cursor.
Definition: gfx.cpp:1617
static const uint EPV_CYCLES_DARK_WATER
Description of the length of the palette cycle animations.
Definition: palettes.h:99
Dimension GetStringMultiLineBoundingBox(StringID str, const Dimension &suggestion)
Calculate string bounding box for multi-line strings.
Definition: gfx.cpp:587
Draw only every second pixel, used for greying-out.
Definition: gfx_type.h:284
PalSpriteID sprite_seq[16]
current image of cursor
Definition: gfx_type.h:130
uint GetMaxSpriteID()
Get a reasonable (upper bound) estimate of the maximum SpriteID used in OpenTTD; there will be no spr...
virtual int BufferSize(int width, int height)=0
Calculate how much memory there is needed for an image of this size in the video-buffer.
void SetAnimatedMouseCursor(const AnimCursor *table)
Assign an animation to the cursor.
Definition: gfx.cpp:1630
virtual void DrawRect(void *video, int width, int height, uint8 colour)=0
Make a single horizontal line in a single colour on the video-buffer.
ZoomLevel
All zoom levels we know.
Definition: zoom_type.h:21
uint16 width
Width of the sprite.
Definition: spritecache.h:20
static void GfxBlitter(const Sprite *const sprite, int x, int y, BlitterMode mode, const SubSprite *const sub, SpriteID sprite_id, ZoomLevel zoom)
The code for setting up the blitter mode and sprite information before finally drawing the sprite...
Definition: gfx.cpp:863
int top
The top offset in the &#39;dst&#39; in pixels to start drawing.
Definition: base.hpp:44
void ReInitAllWindows()
Re-initialize all windows.
Definition: window.cpp:3344
uint32 SpriteID
The number of a sprite, without mapping bits and colourtables.
Definition: gfx_type.h:19
void UpdateCursorSize()
Update cursor dimension.
Definition: gfx.cpp:1530
int GetStringLineCount(StringID str, int maxw)
Calculates number of lines of string.
Definition: gfx.cpp:572
static void GfxDoDrawLine(void *video, int x, int y, int x2, int y2, int screen_width, int screen_height, uint8 colour, int width, int dash=0)
Check line clipping by using a linear equation and draw the visible part of the line given by x/y and...
Definition: gfx.cpp:173
static const PaletteID PALETTE_CRASH
Recolour sprite greying of crashed vehicles.
Definition: sprites.h:1569
uint animate_timeout
in case of animated cursor, number of ticks to show the current cursor
Definition: gfx_type.h:139
static const byte _string_colourmap[17]
Colour mapping for TextColour.
const byte * remap
XXX – Temporary storage for remap array.
Definition: base.hpp:35
TextDirection _current_text_dir
Text direction of the currently selected language.
Definition: strings.cpp:52
static VideoDriver * GetInstance()
Get the currently active instance of the video driver.
virtual void CopyFromBuffer(void *video, const void *src, int width, int height)=0
Copy from a buffer to the screen.
const void * sprite
Pointer to the sprite how ever the encoder stored it.
Definition: base.hpp:34
static void SetCursorSprite(CursorID cursor, PaletteID pal)
Switch cursor to different sprite.
Definition: gfx.cpp:1566
void GetBroadestDigit(uint *front, uint *next, FontSize size)
Determine the broadest digits for guessing the maximum width of a n-digit number. ...
Definition: gfx.cpp:1176
when a sprite is to be displayed transparently, this bit needs to be set.
Definition: sprites.h:1508
static T abs(const T a)
Returns the absolute value of (scalar) variable.
Definition: math_func.hpp:83
static uint GB(const T x, const uint8 s, const uint8 n)
Fetch n bits from x, started at bit s.
Do not add shading to this text colour.
Definition: gfx_type.h:271
virtual const Sprite * GetGlyph(GlyphID key)=0
Get the glyph (sprite) of the given key.
Functions related to zooming.
FontSize
Available font sizes.
Definition: gfx_type.h:203
Perform a colour remapping.
Definition: base.hpp:21
bool Include(const T &item)
Tests whether a item is present in the vector, and appends it to the end if not.
Set if palette is actually a magic text recolour.
Definition: sprites.h:1491
Index of the normal font in the font tables.
Definition: gfx_type.h:204
bool in_window
mouse inside this window, determines drawing logic
Definition: gfx_type.h:143
SwitchMode _switch_mode
The next mainloop command.
Definition: gfx.cpp:47
int16 x_offs
Number of pixels to shift the sprite to the right.
Definition: spritecache.h:21
Used to only draw a part of the sprite.
Definition: gfx_type.h:219
virtual void * MoveTo(void *video, int x, int y)=0
Move the destination pointer the requested amount x and y, keeping in mind any pitch and bpp of the r...
void * dst
Destination buffer.
Definition: base.hpp:46
virtual bool GetDrawGlyphShadow()=0
Do we need to draw a glyph shadow?
Network functions used by other parts of OpenTTD.
uint32 CursorID
The number of the cursor (sprite)
Definition: gfx_type.h:21
Coordinates of a point in 2D.
Dimension GetSpriteSize(SpriteID sprid, Point *offset, ZoomLevel zoom)
Get the size of a sprite.
Definition: gfx.cpp:768
Structure to access the alpha, red, green, and blue channels from a 32 bit number.
Definition: gfx_type.h:164
Perform the simple blitting.
Definition: base.hpp:20
The colour translation of GRF&#39;s strings.
virtual uint8 GetScreenDepth()=0
Get the screen depth this blitter works for.
Colour value is already a real palette colour index, not an index of a StringColour.
Definition: gfx_type.h:270
BlitterMode
The modes of blitting we can do.
Definition: base.hpp:19
number of bits of the sprite containing the recolour palette
Definition: sprites.h:1493
Colour dark_water_toyland[EPV_CYCLES_DARK_WATER]
dark blue water Toyland
Definition: palettes.h:108
static bool HasBit(const T x, const uint8 y)
Checks if a bit in a value is set.
virtual void DrawColourMappingRect(void *dst, int width, int height, PaletteID pal)=0
Draw a colourtable to the screen.
The normal zoom level.
Definition: zoom_type.h:24
The layouter performs all the layout work.
Definition: gfx_layout.h:139
GameCreationSettings game_creation
settings used during the creation of a game (map)
virtual void ScrollBuffer(void *video, int &left, int &top, int &width, int &height, int scroll_x, int scroll_y)=0
Scroll the videobuffer some &#39;x&#39; and &#39;y&#39; value.
Specification of a rectangle with absolute coordinates of all edges.
Recolour sprite.
Definition: gfx_type.h:301
Text is written right-to-left by default.
Definition: strings_type.h:26
Right align the text (must be a single bit).
Definition: gfx_func.h:100
Left align the text.
Definition: gfx_func.h:98
virtual void BeginCritical(bool allow_recursive=false)=0
Begin the critical section.
const char * GetCharAtPosition(const char *str, int x, FontSize start_fontsize)
Get the character from a string that is drawn at a specific position.
Definition: gfx.cpp:740
Window functions not directly related to making/drawing windows.
Point delta
relative mouse movement in this tick
Definition: gfx_type.h:120
const AnimCursor * animate_cur
in case of animated cursor, current frame
Definition: gfx_type.h:138
uint32 GlyphID
Glyphs are characters from a font.
Definition: fontcache.h:19
Vertically center the text.
Definition: gfx_func.h:104
static byte _stringwidth_table[FS_END][224]
Cache containing width of often used characters.
Definition: gfx.cpp:51
SpriteID sprite
The &#39;real&#39; sprite.
Definition: gfx_type.h:25
int count_dirty
The number of dirty elements.
Definition: gfx_type.h:312
SmallVector< SpriteID, 256 > sprites
Sprites found.
Definition: newgrf_debug.h:32
Colour oil_refinery[EPV_CYCLES_OIL_REFINERY]
oil refinery
Definition: palettes.h:110
static const uint EPV_CYCLES_LIGHTHOUSE
length of the lighthouse/stadium animation
Definition: palettes.h:100
static const CursorID SPR_CURSOR_MOUSE
Cursor sprite numbers.
Definition: sprites.h:1349
Index in the _palettes array from which all animations are taking places (table/palettes.h)
Definition: gfx_type.h:278
static void QSortT(T *base, uint num, int(CDECL *comparator)(const T *, const T *), bool desc=false)
Type safe qsort()
Definition: sort_func.hpp:28
uint32 WChar
Type for wide characters, i.e.
Definition: string_type.h:35
static BlitterMode GetBlitterMode(PaletteID pal)
Helper function to get the blitter mode for different types of palettes.
Definition: gfx.cpp:788
Dimensions (a width and height) of a rectangle in 2D.
static int DrawLayoutLine(const ParagraphLayouter::Line *line, int y, int left, int right, StringAlignment align, bool underline, bool truncation)
Drawing routine for drawing a laid out line of text.
Definition: gfx.cpp:343
This file contains all sprite-related enums and defines.
NewGrfDebugSpritePickerMode mode
Current state.
Definition: newgrf_debug.h:29
Factory to &#39;query&#39; all available blitters.
Point GetCharPosition(const char *ch) const
Get the position of a character in the layout.
Definition: gfx_layout.cpp:707
static const uint EPV_CYCLES_GLITTER_WATER
length of the glittery water animation
Definition: palettes.h:103
void DrawSprite(SpriteID img, PaletteID pal, int x, int y, const SubSprite *sub, ZoomLevel zoom)
Draw a sprite, not in a viewport.
Definition: gfx.cpp:833
SwitchMode
Mode which defines what mode we&#39;re switching to.
Definition: openttd.h:26
Colour glitter_water_toyland[EPV_CYCLES_GLITTER_WATER]
glittery water Toyland
Definition: palettes.h:113
static bool HasModalProgress()
Check if we are currently in a modal progress state.
Definition: progress.h:23
void MarkWholeScreenDirty()
This function mark the whole screen as dirty.
Definition: gfx.cpp:1461
int DrawStringMultiLine(int left, int right, int top, int bottom, const char *str, TextColour colour, StringAlignment align, bool underline, FontSize fontsize)
Draw string, possibly over multiple lines.
Definition: gfx.cpp:620
PaletteID pal
The palette (use PAL_NONE) if not needed)
Definition: gfx_type.h:26