OpenTTD Source  1.10.0-RC1
gfx.cpp
Go to the documentation of this file.
1 /*
2  * This file is part of OpenTTD.
3  * 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.
4  * 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.
5  * 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/>.
6  */
7 
10 #include "stdafx.h"
11 #include "gfx_layout.h"
12 #include "progress.h"
13 #include "zoom_func.h"
14 #include "blitter/factory.hpp"
15 #include "video/video_driver.hpp"
16 #include "strings_func.h"
17 #include "settings_type.h"
18 #include "network/network.h"
19 #include "network/network_func.h"
20 #include "window_func.h"
21 #include "newgrf_debug.h"
22 #include "thread.h"
23 
24 #include "table/palettes.h"
25 #include "table/string_colours.h"
26 #include "table/sprites.h"
27 #include "table/control_codes.h"
28 
29 #include "safeguards.h"
30 
31 byte _dirkeys;
32 bool _fullscreen;
33 byte _support8bpp;
34 CursorVars _cursor;
37 byte _fast_forward;
42 DrawPixelInfo _screen;
43 bool _screen_disable_anim = false;
44 bool _exit_game;
45 GameMode _game_mode;
49 
50 static byte _stringwidth_table[FS_END][224];
51 DrawPixelInfo *_cur_dpi;
52 byte _colour_gradient[COLOUR_END][8];
53 
54 static void GfxMainBlitterViewport(const Sprite *sprite, int x, int y, BlitterMode mode, const SubSprite *sub = nullptr, SpriteID sprite_id = SPR_CURSOR_MOUSE);
55 static void GfxMainBlitter(const Sprite *sprite, int x, int y, BlitterMode mode, const SubSprite *sub = nullptr, SpriteID sprite_id = SPR_CURSOR_MOUSE, ZoomLevel zoom = ZOOM_LVL_NORMAL);
56 
57 static ReusableBuffer<uint8> _cursor_backup;
58 
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 = nullptr;
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 
89 
90  blitter->ScrollBuffer(_screen.dst_ptr, left, top, width, height, xo, yo);
91  /* This part of the screen is now dirty. */
92  VideoDriver::GetInstance()->MakeDirty(left, top, width, height);
93 }
94 
95 
110 void GfxFillRect(int left, int top, int right, int bottom, int colour, FillRectMode mode)
111 {
113  const DrawPixelInfo *dpi = _cur_dpi;
114  void *dst;
115  const int otop = top;
116  const int oleft = left;
117 
118  if (dpi->zoom != ZOOM_LVL_NORMAL) return;
119  if (left > right || top > bottom) return;
120  if (right < dpi->left || left >= dpi->left + dpi->width) return;
121  if (bottom < dpi->top || top >= dpi->top + dpi->height) return;
122 
123  if ( (left -= dpi->left) < 0) left = 0;
124  right = right - dpi->left + 1;
125  if (right > dpi->width) right = dpi->width;
126  right -= left;
127  assert(right > 0);
128 
129  if ( (top -= dpi->top) < 0) top = 0;
130  bottom = bottom - dpi->top + 1;
131  if (bottom > dpi->height) bottom = dpi->height;
132  bottom -= top;
133  assert(bottom > 0);
134 
135  dst = blitter->MoveTo(dpi->dst_ptr, left, top);
136 
137  switch (mode) {
138  default: // FILLRECT_OPAQUE
139  blitter->DrawRect(dst, right, bottom, (uint8)colour);
140  break;
141 
142  case FILLRECT_RECOLOUR:
143  blitter->DrawColourMappingRect(dst, right, bottom, GB(colour, 0, PALETTE_WIDTH));
144  break;
145 
146  case FILLRECT_CHECKER: {
147  byte bo = (oleft - left + dpi->left + otop - top + dpi->top) & 1;
148  do {
149  for (int i = (bo ^= 1); i < right; i += 2) blitter->SetPixel(dst, i, 0, (uint8)colour);
150  dst = blitter->MoveTo(dst, 0, 1);
151  } while (--bottom > 0);
152  break;
153  }
154  }
155 }
156 
157 typedef std::pair<Point, Point> LineSegment;
158 
167 static std::vector<LineSegment> MakePolygonSegments(const std::vector<Point> &shape, Point offset)
168 {
169  std::vector<LineSegment> segments;
170  if (shape.size() < 3) return segments; // fewer than 3 will always result in an empty polygon
171  segments.reserve(shape.size());
172 
173  /* Connect first and last point by having initial previous point be the last */
174  Point prev = shape.back();
175  prev.x -= offset.x;
176  prev.y -= offset.y;
177  for (Point pt : shape) {
178  pt.x -= offset.x;
179  pt.y -= offset.y;
180  /* Create segments for all non-horizontal lines in the polygon.
181  * The segments always have lowest Y coordinate first. */
182  if (prev.y > pt.y) {
183  segments.emplace_back(pt, prev);
184  } else if (prev.y < pt.y) {
185  segments.emplace_back(prev, pt);
186  }
187  prev = pt;
188  }
189 
190  return segments;
191 }
192 
206 void GfxFillPolygon(const std::vector<Point> &shape, int colour, FillRectMode mode)
207 {
209  const DrawPixelInfo *dpi = _cur_dpi;
210  if (dpi->zoom != ZOOM_LVL_NORMAL) return;
211 
212  std::vector<LineSegment> segments = MakePolygonSegments(shape, Point{ dpi->left, dpi->top });
213 
214  /* Remove segments appearing entirely above or below the clipping area. */
215  segments.erase(std::remove_if(segments.begin(), segments.end(), [dpi](const LineSegment &s) { return s.second.y <= 0 || s.first.y >= dpi->height; }), segments.end());
216 
217  /* Check that this wasn't an empty shape (all points on a horizontal line or outside clipping.) */
218  if (segments.empty()) return;
219 
220  /* Sort the segments by first point Y coordinate. */
221  std::sort(segments.begin(), segments.end(), [](const LineSegment &a, const LineSegment &b) { return a.first.y < b.first.y; });
222 
223  /* Segments intersecting current scanline. */
224  std::vector<LineSegment> active;
225  /* Intersection points with a scanline.
226  * Kept outside loop to avoid repeated re-allocations. */
227  std::vector<int> intersections;
228  /* Normal, reasonable polygons don't have many intersections per scanline. */
229  active.reserve(4);
230  intersections.reserve(4);
231 
232  /* Scan through the segments and paint each scanline. */
233  int y = segments.front().first.y;
234  std::vector<LineSegment>::iterator nextseg = segments.begin();
235  while (!active.empty() || nextseg != segments.end()) {
236  /* Clean up segments that have ended. */
237  active.erase(std::remove_if(active.begin(), active.end(), [y](const LineSegment &s) { return s.second.y == y; }), active.end());
238 
239  /* Activate all segments starting on this scanline. */
240  while (nextseg != segments.end() && nextseg->first.y == y) {
241  active.push_back(*nextseg);
242  ++nextseg;
243  }
244 
245  /* Check clipping. */
246  if (y < 0) {
247  ++y;
248  continue;
249  }
250  if (y >= dpi->height) return;
251 
252  /* Intersect scanline with all active segments. */
253  intersections.clear();
254  for (const LineSegment &s : active) {
255  const int sdx = s.second.x - s.first.x;
256  const int sdy = s.second.y - s.first.y;
257  const int ldy = y - s.first.y;
258  const int x = s.first.x + sdx * ldy / sdy;
259  intersections.push_back(x);
260  }
261 
262  /* Fill between pairs of intersections. */
263  std::sort(intersections.begin(), intersections.end());
264  for (size_t i = 1; i < intersections.size(); i += 2) {
265  /* Check clipping. */
266  const int x1 = max(0, intersections[i - 1]);
267  const int x2 = min(intersections[i], dpi->width);
268  if (x2 < 0) continue;
269  if (x1 >= dpi->width) continue;
270 
271  /* Fill line y from x1 to x2. */
272  void *dst = blitter->MoveTo(dpi->dst_ptr, x1, y);
273  switch (mode) {
274  default: // FILLRECT_OPAQUE
275  blitter->DrawRect(dst, x2 - x1, 1, (uint8)colour);
276  break;
277  case FILLRECT_RECOLOUR:
278  blitter->DrawColourMappingRect(dst, x2 - x1, 1, GB(colour, 0, PALETTE_WIDTH));
279  break;
280  case FILLRECT_CHECKER:
281  /* Fill every other pixel, offset such that the sum of filled pixels' X and Y coordinates is odd.
282  * This creates a checkerboard effect. */
283  for (int x = (x1 + y) & 1; x < x2 - x1; x += 2) {
284  blitter->SetPixel(dst, x, 0, (uint8)colour);
285  }
286  break;
287  }
288  }
289 
290  /* Next line */
291  ++y;
292  }
293 }
294 
309 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)
310 {
312 
313  assert(width > 0);
314 
315  if (y2 == y || x2 == x) {
316  /* Special case: horizontal/vertical line. All checks already done in GfxPreprocessLine. */
317  blitter->DrawLine(video, x, y, x2, y2, screen_width, screen_height, colour, width, dash);
318  return;
319  }
320 
321  int grade_y = y2 - y;
322  int grade_x = x2 - x;
323 
324  /* Clipping rectangle. Slightly extended so we can ignore the width of the line. */
325  int extra = (int)CeilDiv(3 * width, 4); // not less then "width * sqrt(2) / 2"
326  Rect clip = { -extra, -extra, screen_width - 1 + extra, screen_height - 1 + extra };
327 
328  /* prevent integer overflows. */
329  int margin = 1;
330  while (INT_MAX / abs(grade_y) < max(abs(clip.left - x), abs(clip.right - x))) {
331  grade_y /= 2;
332  grade_x /= 2;
333  margin *= 2; // account for rounding errors
334  }
335 
336  /* Imagine that the line is infinitely long and it intersects with
337  * infinitely long left and right edges of the clipping rectangle.
338  * If both intersection points are outside the clipping rectangle
339  * and both on the same side of it, we don't need to draw anything. */
340  int left_isec_y = y + (clip.left - x) * grade_y / grade_x;
341  int right_isec_y = y + (clip.right - x) * grade_y / grade_x;
342  if ((left_isec_y > clip.bottom + margin && right_isec_y > clip.bottom + margin) ||
343  (left_isec_y < clip.top - margin && right_isec_y < clip.top - margin)) {
344  return;
345  }
346 
347  /* It is possible to use the line equation to further reduce the amount of
348  * work the blitter has to do by shortening the effective line segment.
349  * However, in order to get that right and prevent the flickering effects
350  * of rounding errors so much additional code has to be run here that in
351  * the general case the effect is not noticeable. */
352 
353  blitter->DrawLine(video, x, y, x2, y2, screen_width, screen_height, colour, width, dash);
354 }
355 
367 static inline bool GfxPreprocessLine(DrawPixelInfo *dpi, int &x, int &y, int &x2, int &y2, int width)
368 {
369  x -= dpi->left;
370  x2 -= dpi->left;
371  y -= dpi->top;
372  y2 -= dpi->top;
373 
374  /* Check simple clipping */
375  if (x + width / 2 < 0 && x2 + width / 2 < 0 ) return false;
376  if (y + width / 2 < 0 && y2 + width / 2 < 0 ) return false;
377  if (x - width / 2 > dpi->width && x2 - width / 2 > dpi->width ) return false;
378  if (y - width / 2 > dpi->height && y2 - width / 2 > dpi->height) return false;
379  return true;
380 }
381 
382 void GfxDrawLine(int x, int y, int x2, int y2, int colour, int width, int dash)
383 {
384  DrawPixelInfo *dpi = _cur_dpi;
385  if (GfxPreprocessLine(dpi, x, y, x2, y2, width)) {
386  GfxDoDrawLine(dpi->dst_ptr, x, y, x2, y2, dpi->width, dpi->height, colour, width, dash);
387  }
388 }
389 
390 void GfxDrawLineUnscaled(int x, int y, int x2, int y2, int colour)
391 {
392  DrawPixelInfo *dpi = _cur_dpi;
393  if (GfxPreprocessLine(dpi, x, y, x2, y2, 1)) {
394  GfxDoDrawLine(dpi->dst_ptr,
395  UnScaleByZoom(x, dpi->zoom), UnScaleByZoom(y, dpi->zoom),
396  UnScaleByZoom(x2, dpi->zoom), UnScaleByZoom(y2, dpi->zoom),
397  UnScaleByZoom(dpi->width, dpi->zoom), UnScaleByZoom(dpi->height, dpi->zoom), colour, 1);
398  }
399 }
400 
414 void DrawBox(int x, int y, int dx1, int dy1, int dx2, int dy2, int dx3, int dy3)
415 {
416  /* ....
417  * .. ....
418  * .. ....
419  * .. ^
420  * <--__(dx1,dy1) /(dx2,dy2)
421  * : --__ / :
422  * : --__ / :
423  * : *(x,y) :
424  * : | :
425  * : | ..
426  * .... |(dx3,dy3)
427  * .... | ..
428  * ....V.
429  */
430 
431  static const byte colour = PC_WHITE;
432 
433  GfxDrawLineUnscaled(x, y, x + dx1, y + dy1, colour);
434  GfxDrawLineUnscaled(x, y, x + dx2, y + dy2, colour);
435  GfxDrawLineUnscaled(x, y, x + dx3, y + dy3, colour);
436 
437  GfxDrawLineUnscaled(x + dx1, y + dy1, x + dx1 + dx2, y + dy1 + dy2, colour);
438  GfxDrawLineUnscaled(x + dx1, y + dy1, x + dx1 + dx3, y + dy1 + dy3, colour);
439  GfxDrawLineUnscaled(x + dx2, y + dy2, x + dx2 + dx1, y + dy2 + dy1, colour);
440  GfxDrawLineUnscaled(x + dx2, y + dy2, x + dx2 + dx3, y + dy2 + dy3, colour);
441  GfxDrawLineUnscaled(x + dx3, y + dy3, x + dx3 + dx1, y + dy3 + dy1, colour);
442  GfxDrawLineUnscaled(x + dx3, y + dy3, x + dx3 + dx2, y + dy3 + dy2, colour);
443 }
444 
449 static void SetColourRemap(TextColour colour)
450 {
451  if (colour == TC_INVALID) return;
452 
453  /* Black strings have no shading ever; the shading is black, so it
454  * would be invisible at best, but it actually makes it illegible. */
455  bool no_shade = (colour & TC_NO_SHADE) != 0 || colour == TC_BLACK;
456  bool raw_colour = (colour & TC_IS_PALETTE_COLOUR) != 0;
457  colour &= ~(TC_NO_SHADE | TC_IS_PALETTE_COLOUR | TC_FORCED);
458 
459  _string_colourremap[1] = raw_colour ? (byte)colour : _string_colourmap[colour];
460  _string_colourremap[2] = no_shade ? 0 : 1;
461  _colour_remap_ptr = _string_colourremap;
462 }
463 
479 static int DrawLayoutLine(const ParagraphLayouter::Line &line, int y, int left, int right, StringAlignment align, bool underline, bool truncation)
480 {
481  if (line.CountRuns() == 0) return 0;
482 
483  int w = line.GetWidth();
484  int h = line.GetLeading();
485 
486  /*
487  * The following is needed for truncation.
488  * Depending on the text direction, we either remove bits at the rear
489  * or the front. For this we shift the entire area to draw so it fits
490  * within the left/right bounds and the side we do not truncate it on.
491  * Then we determine the truncation location, i.e. glyphs that fall
492  * outside of the range min_x - max_x will not be drawn; they are thus
493  * the truncated glyphs.
494  *
495  * At a later step we insert the dots.
496  */
497 
498  int max_w = right - left + 1; // The maximum width.
499 
500  int offset_x = 0; // The offset we need for positioning the glyphs
501  int min_x = left; // The minimum x position to draw normal glyphs on.
502  int max_x = right; // The maximum x position to draw normal glyphs on.
503 
504  truncation &= max_w < w; // Whether we need to do truncation.
505  int dot_width = 0; // Cache for the width of the dot.
506  const Sprite *dot_sprite = nullptr; // Cache for the sprite of the dot.
507 
508  if (truncation) {
509  /*
510  * Assumption may be made that all fonts of a run are of the same size.
511  * In any case, we'll use these dots for the abbreviation, so even if
512  * another size would be chosen it won't have truncated too little for
513  * the truncation dots.
514  */
515  FontCache *fc = ((const Font*)line.GetVisualRun(0).GetFont())->fc;
516  GlyphID dot_glyph = fc->MapCharToGlyph('.');
517  dot_width = fc->GetGlyphWidth(dot_glyph);
518  dot_sprite = fc->GetGlyph(dot_glyph);
519 
520  if (_current_text_dir == TD_RTL) {
521  min_x += 3 * dot_width;
522  offset_x = w - 3 * dot_width - max_w;
523  } else {
524  max_x -= 3 * dot_width;
525  }
526 
527  w = max_w;
528  }
529 
530  /* In case we have a RTL language we swap the alignment. */
531  if (!(align & SA_FORCE) && _current_text_dir == TD_RTL && (align & SA_HOR_MASK) != SA_HOR_CENTER) align ^= SA_RIGHT;
532 
533  /* right is the right most position to draw on. In this case we want to do
534  * calculations with the width of the string. In comparison right can be
535  * seen as lastof(todraw) and width as lengthof(todraw). They differ by 1.
536  * So most +1/-1 additions are to move from lengthof to 'indices'.
537  */
538  switch (align & SA_HOR_MASK) {
539  case SA_LEFT:
540  /* right + 1 = left + w */
541  right = left + w - 1;
542  break;
543 
544  case SA_HOR_CENTER:
545  left = RoundDivSU(right + 1 + left - w, 2);
546  /* right + 1 = left + w */
547  right = left + w - 1;
548  break;
549 
550  case SA_RIGHT:
551  left = right + 1 - w;
552  break;
553 
554  default:
555  NOT_REACHED();
556  }
557 
558  TextColour colour = TC_BLACK;
559  bool draw_shadow = false;
560  for (int run_index = 0; run_index < line.CountRuns(); run_index++) {
561  const ParagraphLayouter::VisualRun &run = line.GetVisualRun(run_index);
562  const Font *f = (const Font*)run.GetFont();
563 
564  FontCache *fc = f->fc;
565  colour = f->colour;
566  SetColourRemap(colour);
567 
568  DrawPixelInfo *dpi = _cur_dpi;
569  int dpi_left = dpi->left;
570  int dpi_right = dpi->left + dpi->width - 1;
571 
572  draw_shadow = fc->GetDrawGlyphShadow() && (colour & TC_NO_SHADE) == 0 && colour != TC_BLACK;
573 
574  for (int i = 0; i < run.GetGlyphCount(); i++) {
575  GlyphID glyph = run.GetGlyphs()[i];
576 
577  /* Not a valid glyph (empty) */
578  if (glyph == 0xFFFF) continue;
579 
580  int begin_x = (int)run.GetPositions()[i * 2] + left - offset_x;
581  int end_x = (int)run.GetPositions()[i * 2 + 2] + left - offset_x - 1;
582  int top = (int)run.GetPositions()[i * 2 + 1] + y;
583 
584  /* Truncated away. */
585  if (truncation && (begin_x < min_x || end_x > max_x)) continue;
586 
587  const Sprite *sprite = fc->GetGlyph(glyph);
588  /* Check clipping (the "+ 1" is for the shadow). */
589  if (begin_x + sprite->x_offs > dpi_right || begin_x + sprite->x_offs + sprite->width /* - 1 + 1 */ < dpi_left) continue;
590 
591  if (draw_shadow && (glyph & SPRITE_GLYPH) == 0) {
592  SetColourRemap(TC_BLACK);
593  GfxMainBlitter(sprite, begin_x + 1, top + 1, BM_COLOUR_REMAP);
594  SetColourRemap(colour);
595  }
596  GfxMainBlitter(sprite, begin_x, top, BM_COLOUR_REMAP);
597  }
598  }
599 
600  if (truncation) {
601  int x = (_current_text_dir == TD_RTL) ? left : (right - 3 * dot_width);
602  for (int i = 0; i < 3; i++, x += dot_width) {
603  if (draw_shadow) {
604  SetColourRemap(TC_BLACK);
605  GfxMainBlitter(dot_sprite, x + 1, y + 1, BM_COLOUR_REMAP);
606  SetColourRemap(colour);
607  }
608  GfxMainBlitter(dot_sprite, x, y, BM_COLOUR_REMAP);
609  }
610  }
611 
612  if (underline) {
613  GfxFillRect(left, y + h, right, y + h, _string_colourremap[1]);
614  }
615 
616  return (align & SA_HOR_MASK) == SA_RIGHT ? left : right;
617 }
618 
636 int DrawString(int left, int right, int top, const char *str, TextColour colour, StringAlignment align, bool underline, FontSize fontsize)
637 {
638  /* The string may contain control chars to change the font, just use the biggest font for clipping. */
640 
641  /* Funny glyphs may extent outside the usual bounds, so relax the clipping somewhat. */
642  int extra = max_height / 2;
643 
644  if (_cur_dpi->top + _cur_dpi->height + extra < top || _cur_dpi->top > top + max_height + extra ||
645  _cur_dpi->left + _cur_dpi->width + extra < left || _cur_dpi->left > right + extra) {
646  return 0;
647  }
648 
649  Layouter layout(str, INT32_MAX, colour, fontsize);
650  if (layout.size() == 0) return 0;
651 
652  return DrawLayoutLine(*layout.front(), top, left, right, align, underline, true);
653 }
654 
672 int DrawString(int left, int right, int top, StringID str, TextColour colour, StringAlignment align, bool underline, FontSize fontsize)
673 {
674  char buffer[DRAW_STRING_BUFFER];
675  GetString(buffer, str, lastof(buffer));
676  return DrawString(left, right, top, buffer, colour, align, underline, fontsize);
677 }
678 
685 int GetStringHeight(const char *str, int maxw, FontSize fontsize)
686 {
687  Layouter layout(str, maxw, TC_FROMSTRING, fontsize);
688  return layout.GetBounds().height;
689 }
690 
697 int GetStringHeight(StringID str, int maxw)
698 {
699  char buffer[DRAW_STRING_BUFFER];
700  GetString(buffer, str, lastof(buffer));
701  return GetStringHeight(buffer, maxw);
702 }
703 
710 int GetStringLineCount(StringID str, int maxw)
711 {
712  char buffer[DRAW_STRING_BUFFER];
713  GetString(buffer, str, lastof(buffer));
714 
715  Layouter layout(buffer, maxw);
716  return (uint)layout.size();
717 }
718 
726 {
727  Dimension box = {suggestion.width, (uint)GetStringHeight(str, suggestion.width)};
728  return box;
729 }
730 
737 Dimension GetStringMultiLineBoundingBox(const char *str, const Dimension &suggestion)
738 {
739  Dimension box = {suggestion.width, (uint)GetStringHeight(str, suggestion.width)};
740  return box;
741 }
742 
759 int DrawStringMultiLine(int left, int right, int top, int bottom, const char *str, TextColour colour, StringAlignment align, bool underline, FontSize fontsize)
760 {
761  int maxw = right - left + 1;
762  int maxh = bottom - top + 1;
763 
764  /* It makes no sense to even try if it can't be drawn anyway, or
765  * do we really want to support fonts of 0 or less pixels high? */
766  if (maxh <= 0) return top;
767 
768  Layouter layout(str, maxw, colour, fontsize);
769  int total_height = layout.GetBounds().height;
770  int y;
771  switch (align & SA_VERT_MASK) {
772  case SA_TOP:
773  y = top;
774  break;
775 
776  case SA_VERT_CENTER:
777  y = RoundDivSU(bottom + top - total_height, 2);
778  break;
779 
780  case SA_BOTTOM:
781  y = bottom - total_height;
782  break;
783 
784  default: NOT_REACHED();
785  }
786 
787  int last_line = top;
788  int first_line = bottom;
789 
790  for (const auto &line : layout) {
791 
792  int line_height = line->GetLeading();
793  if (y >= top && y < bottom) {
794  last_line = y + line_height;
795  if (first_line > y) first_line = y;
796 
797  DrawLayoutLine(*line, y, left, right, align, underline, false);
798  }
799  y += line_height;
800  }
801 
802  return ((align & SA_VERT_MASK) == SA_BOTTOM) ? first_line : last_line;
803 }
804 
821 int DrawStringMultiLine(int left, int right, int top, int bottom, StringID str, TextColour colour, StringAlignment align, bool underline, FontSize fontsize)
822 {
823  char buffer[DRAW_STRING_BUFFER];
824  GetString(buffer, str, lastof(buffer));
825  return DrawStringMultiLine(left, right, top, bottom, buffer, colour, align, underline, fontsize);
826 }
827 
838 Dimension GetStringBoundingBox(const char *str, FontSize start_fontsize)
839 {
840  Layouter layout(str, INT32_MAX, TC_FROMSTRING, start_fontsize);
841  return layout.GetBounds();
842 }
843 
851 {
852  char buffer[DRAW_STRING_BUFFER];
853 
854  GetString(buffer, strid, lastof(buffer));
855  return GetStringBoundingBox(buffer);
856 }
857 
866 Point GetCharPosInString(const char *str, const char *ch, FontSize start_fontsize)
867 {
868  Layouter layout(str, INT32_MAX, TC_FROMSTRING, start_fontsize);
869  return layout.GetCharPosition(ch);
870 }
871 
879 const char *GetCharAtPosition(const char *str, int x, FontSize start_fontsize)
880 {
881  if (x < 0) return nullptr;
882 
883  Layouter layout(str, INT32_MAX, TC_FROMSTRING, start_fontsize);
884  return layout.GetCharAtPosition(x);
885 }
886 
895 void DrawCharCentered(WChar c, int x, int y, TextColour colour)
896 {
897  SetColourRemap(colour);
898  GfxMainBlitter(GetGlyph(FS_NORMAL, c), x - GetCharacterWidth(FS_NORMAL, c) / 2, y, BM_COLOUR_REMAP);
899 }
900 
909 {
910  const Sprite *sprite = GetSprite(sprid, ST_NORMAL);
911 
912  if (offset != nullptr) {
913  offset->x = UnScaleByZoom(sprite->x_offs, zoom);
914  offset->y = UnScaleByZoom(sprite->y_offs, zoom);
915  }
916 
917  Dimension d;
918  d.width = max<int>(0, UnScaleByZoom(sprite->x_offs + sprite->width, zoom));
919  d.height = max<int>(0, UnScaleByZoom(sprite->y_offs + sprite->height, zoom));
920  return d;
921 }
922 
929 {
930  switch (pal) {
931  case PAL_NONE: return BM_NORMAL;
932  case PALETTE_CRASH: return BM_CRASH_REMAP;
933  case PALETTE_ALL_BLACK: return BM_BLACK_REMAP;
934  default: return BM_COLOUR_REMAP;
935  }
936 }
937 
946 void DrawSpriteViewport(SpriteID img, PaletteID pal, int x, int y, const SubSprite *sub)
947 {
948  SpriteID real_sprite = GB(img, 0, SPRITE_WIDTH);
950  _colour_remap_ptr = GetNonSprite(GB(pal, 0, PALETTE_WIDTH), ST_RECOLOUR) + 1;
951  GfxMainBlitterViewport(GetSprite(real_sprite, ST_NORMAL), x, y, BM_TRANSPARENT, sub, real_sprite);
952  } else if (pal != PAL_NONE) {
953  if (HasBit(pal, PALETTE_TEXT_RECOLOUR)) {
955  } else {
956  _colour_remap_ptr = GetNonSprite(GB(pal, 0, PALETTE_WIDTH), ST_RECOLOUR) + 1;
957  }
958  GfxMainBlitterViewport(GetSprite(real_sprite, ST_NORMAL), x, y, GetBlitterMode(pal), sub, real_sprite);
959  } else {
960  GfxMainBlitterViewport(GetSprite(real_sprite, ST_NORMAL), x, y, BM_NORMAL, sub, real_sprite);
961  }
962 }
963 
973 void DrawSprite(SpriteID img, PaletteID pal, int x, int y, const SubSprite *sub, ZoomLevel zoom)
974 {
975  SpriteID real_sprite = GB(img, 0, SPRITE_WIDTH);
977  _colour_remap_ptr = GetNonSprite(GB(pal, 0, PALETTE_WIDTH), ST_RECOLOUR) + 1;
978  GfxMainBlitter(GetSprite(real_sprite, ST_NORMAL), x, y, BM_TRANSPARENT, sub, real_sprite, zoom);
979  } else if (pal != PAL_NONE) {
980  if (HasBit(pal, PALETTE_TEXT_RECOLOUR)) {
982  } else {
983  _colour_remap_ptr = GetNonSprite(GB(pal, 0, PALETTE_WIDTH), ST_RECOLOUR) + 1;
984  }
985  GfxMainBlitter(GetSprite(real_sprite, ST_NORMAL), x, y, GetBlitterMode(pal), sub, real_sprite, zoom);
986  } else {
987  GfxMainBlitter(GetSprite(real_sprite, ST_NORMAL), x, y, BM_NORMAL, sub, real_sprite, zoom);
988  }
989 }
990 
1002 template <int ZOOM_BASE, bool SCALED_XY>
1003 static void GfxBlitter(const Sprite * const sprite, int x, int y, BlitterMode mode, const SubSprite * const sub, SpriteID sprite_id, ZoomLevel zoom)
1004 {
1005  const DrawPixelInfo *dpi = _cur_dpi;
1007 
1008  if (SCALED_XY) {
1009  /* Scale it */
1010  x = ScaleByZoom(x, zoom);
1011  y = ScaleByZoom(y, zoom);
1012  }
1013 
1014  /* Move to the correct offset */
1015  x += sprite->x_offs;
1016  y += sprite->y_offs;
1017 
1018  if (sub == nullptr) {
1019  /* No clipping. */
1020  bp.skip_left = 0;
1021  bp.skip_top = 0;
1022  bp.width = UnScaleByZoom(sprite->width, zoom);
1023  bp.height = UnScaleByZoom(sprite->height, zoom);
1024  } else {
1025  /* Amount of pixels to clip from the source sprite */
1026  int clip_left = max(0, -sprite->x_offs + sub->left * ZOOM_BASE );
1027  int clip_top = max(0, -sprite->y_offs + sub->top * ZOOM_BASE );
1028  int clip_right = max(0, sprite->width - (-sprite->x_offs + (sub->right + 1) * ZOOM_BASE));
1029  int clip_bottom = max(0, sprite->height - (-sprite->y_offs + (sub->bottom + 1) * ZOOM_BASE));
1030 
1031  if (clip_left + clip_right >= sprite->width) return;
1032  if (clip_top + clip_bottom >= sprite->height) return;
1033 
1034  bp.skip_left = UnScaleByZoomLower(clip_left, zoom);
1035  bp.skip_top = UnScaleByZoomLower(clip_top, zoom);
1036  bp.width = UnScaleByZoom(sprite->width - clip_left - clip_right, zoom);
1037  bp.height = UnScaleByZoom(sprite->height - clip_top - clip_bottom, zoom);
1038 
1039  x += ScaleByZoom(bp.skip_left, zoom);
1040  y += ScaleByZoom(bp.skip_top, zoom);
1041  }
1042 
1043  /* Copy the main data directly from the sprite */
1044  bp.sprite = sprite->data;
1045  bp.sprite_width = sprite->width;
1046  bp.sprite_height = sprite->height;
1047  bp.top = 0;
1048  bp.left = 0;
1049 
1050  bp.dst = dpi->dst_ptr;
1051  bp.pitch = dpi->pitch;
1052  bp.remap = _colour_remap_ptr;
1053 
1054  assert(sprite->width > 0);
1055  assert(sprite->height > 0);
1056 
1057  if (bp.width <= 0) return;
1058  if (bp.height <= 0) return;
1059 
1060  y -= SCALED_XY ? ScaleByZoom(dpi->top, zoom) : dpi->top;
1061  int y_unscaled = UnScaleByZoom(y, zoom);
1062  /* Check for top overflow */
1063  if (y < 0) {
1064  bp.height -= -y_unscaled;
1065  if (bp.height <= 0) return;
1066  bp.skip_top += -y_unscaled;
1067  y = 0;
1068  } else {
1069  bp.top = y_unscaled;
1070  }
1071 
1072  /* Check for bottom overflow */
1073  y += SCALED_XY ? ScaleByZoom(bp.height - dpi->height, zoom) : ScaleByZoom(bp.height, zoom) - dpi->height;
1074  if (y > 0) {
1075  bp.height -= UnScaleByZoom(y, zoom);
1076  if (bp.height <= 0) return;
1077  }
1078 
1079  x -= SCALED_XY ? ScaleByZoom(dpi->left, zoom) : dpi->left;
1080  int x_unscaled = UnScaleByZoom(x, zoom);
1081  /* Check for left overflow */
1082  if (x < 0) {
1083  bp.width -= -x_unscaled;
1084  if (bp.width <= 0) return;
1085  bp.skip_left += -x_unscaled;
1086  x = 0;
1087  } else {
1088  bp.left = x_unscaled;
1089  }
1090 
1091  /* Check for right overflow */
1092  x += SCALED_XY ? ScaleByZoom(bp.width - dpi->width, zoom) : ScaleByZoom(bp.width, zoom) - dpi->width;
1093  if (x > 0) {
1094  bp.width -= UnScaleByZoom(x, zoom);
1095  if (bp.width <= 0) return;
1096  }
1097 
1098  assert(bp.skip_left + bp.width <= UnScaleByZoom(sprite->width, zoom));
1099  assert(bp.skip_top + bp.height <= UnScaleByZoom(sprite->height, zoom));
1100 
1101  /* We do not want to catch the mouse. However we also use that spritenumber for unknown (text) sprites. */
1102  if (_newgrf_debug_sprite_picker.mode == SPM_REDRAW && sprite_id != SPR_CURSOR_MOUSE) {
1104  void *topleft = blitter->MoveTo(bp.dst, bp.left, bp.top);
1105  void *bottomright = blitter->MoveTo(topleft, bp.width - 1, bp.height - 1);
1106 
1108 
1109  if (topleft <= clicked && clicked <= bottomright) {
1110  uint offset = (((size_t)clicked - (size_t)topleft) / (blitter->GetScreenDepth() / 8)) % bp.pitch;
1111  if (offset < (uint)bp.width) {
1113  }
1114  }
1115  }
1116 
1117  BlitterFactory::GetCurrentBlitter()->Draw(&bp, mode, zoom);
1118 }
1119 
1120 static void GfxMainBlitterViewport(const Sprite *sprite, int x, int y, BlitterMode mode, const SubSprite *sub, SpriteID sprite_id)
1121 {
1122  GfxBlitter<ZOOM_LVL_BASE, false>(sprite, x, y, mode, sub, sprite_id, _cur_dpi->zoom);
1123 }
1124 
1125 static void GfxMainBlitter(const Sprite *sprite, int x, int y, BlitterMode mode, const SubSprite *sub, SpriteID sprite_id, ZoomLevel zoom)
1126 {
1127  GfxBlitter<1, true>(sprite, x, y, mode, sub, sprite_id, zoom);
1128 }
1129 
1130 void DoPaletteAnimations();
1131 
1132 void GfxInitPalettes()
1133 {
1134  memcpy(&_cur_palette, &_palette, sizeof(_cur_palette));
1135  DoPaletteAnimations();
1136 }
1137 
1138 #define EXTR(p, q) (((uint16)(palette_animation_counter * (p)) * (q)) >> 16)
1139 #define EXTR2(p, q) (((uint16)(~palette_animation_counter * (p)) * (q)) >> 16)
1140 
1141 void DoPaletteAnimations()
1142 {
1143  /* Animation counter for the palette animation. */
1144  static int palette_animation_counter = 0;
1145  palette_animation_counter += 8;
1146 
1148  const Colour *s;
1150  Colour old_val[PALETTE_ANIM_SIZE];
1151  const uint old_tc = palette_animation_counter;
1152  uint i;
1153  uint j;
1154 
1155  if (blitter != nullptr && blitter->UsePaletteAnimation() == Blitter::PALETTE_ANIMATION_NONE) {
1156  palette_animation_counter = 0;
1157  }
1158 
1159  Colour *palette_pos = &_cur_palette.palette[PALETTE_ANIM_START]; // Points to where animations are taking place on the palette
1160  /* Makes a copy of the current animation palette in old_val,
1161  * so the work on the current palette could be compared, see if there has been any changes */
1162  memcpy(old_val, palette_pos, sizeof(old_val));
1163 
1164  /* Fizzy Drink bubbles animation */
1165  s = ev->fizzy_drink;
1166  j = EXTR2(512, EPV_CYCLES_FIZZY_DRINK);
1167  for (i = 0; i != EPV_CYCLES_FIZZY_DRINK; i++) {
1168  *palette_pos++ = s[j];
1169  j++;
1170  if (j == EPV_CYCLES_FIZZY_DRINK) j = 0;
1171  }
1172 
1173  /* Oil refinery fire animation */
1174  s = ev->oil_refinery;
1175  j = EXTR2(512, EPV_CYCLES_OIL_REFINERY);
1176  for (i = 0; i != EPV_CYCLES_OIL_REFINERY; i++) {
1177  *palette_pos++ = s[j];
1178  j++;
1179  if (j == EPV_CYCLES_OIL_REFINERY) j = 0;
1180  }
1181 
1182  /* Radio tower blinking */
1183  {
1184  byte i = (palette_animation_counter >> 1) & 0x7F;
1185  byte v;
1186 
1187  if (i < 0x3f) {
1188  v = 255;
1189  } else if (i < 0x4A || i >= 0x75) {
1190  v = 128;
1191  } else {
1192  v = 20;
1193  }
1194  palette_pos->r = v;
1195  palette_pos->g = 0;
1196  palette_pos->b = 0;
1197  palette_pos++;
1198 
1199  i ^= 0x40;
1200  if (i < 0x3f) {
1201  v = 255;
1202  } else if (i < 0x4A || i >= 0x75) {
1203  v = 128;
1204  } else {
1205  v = 20;
1206  }
1207  palette_pos->r = v;
1208  palette_pos->g = 0;
1209  palette_pos->b = 0;
1210  palette_pos++;
1211  }
1212 
1213  /* Handle lighthouse and stadium animation */
1214  s = ev->lighthouse;
1215  j = EXTR(256, EPV_CYCLES_LIGHTHOUSE);
1216  for (i = 0; i != EPV_CYCLES_LIGHTHOUSE; i++) {
1217  *palette_pos++ = s[j];
1218  j++;
1219  if (j == EPV_CYCLES_LIGHTHOUSE) j = 0;
1220  }
1221 
1222  /* Dark blue water */
1223  s = (_settings_game.game_creation.landscape == LT_TOYLAND) ? ev->dark_water_toyland : ev->dark_water;
1224  j = EXTR(320, EPV_CYCLES_DARK_WATER);
1225  for (i = 0; i != EPV_CYCLES_DARK_WATER; i++) {
1226  *palette_pos++ = s[j];
1227  j++;
1228  if (j == EPV_CYCLES_DARK_WATER) j = 0;
1229  }
1230 
1231  /* Glittery water */
1233  j = EXTR(128, EPV_CYCLES_GLITTER_WATER);
1234  for (i = 0; i != EPV_CYCLES_GLITTER_WATER / 3; i++) {
1235  *palette_pos++ = s[j];
1236  j += 3;
1238  }
1239 
1240  if (blitter != nullptr && blitter->UsePaletteAnimation() == Blitter::PALETTE_ANIMATION_NONE) {
1241  palette_animation_counter = old_tc;
1242  } else {
1243  if (memcmp(old_val, &_cur_palette.palette[PALETTE_ANIM_START], sizeof(old_val)) != 0 && _cur_palette.count_dirty == 0) {
1244  /* Did we changed anything on the palette? Seems so. Mark it as dirty */
1245  _cur_palette.first_dirty = PALETTE_ANIM_START;
1246  _cur_palette.count_dirty = PALETTE_ANIM_SIZE;
1247  }
1248  }
1249 }
1250 
1257 TextColour GetContrastColour(uint8 background, uint8 threshold)
1258 {
1259  Colour c = _cur_palette.palette[background];
1260  /* Compute brightness according to http://www.w3.org/TR/AERT#color-contrast.
1261  * The following formula computes 1000 * brightness^2, with brightness being in range 0 to 255. */
1262  uint sq1000_brightness = c.r * c.r * 299 + c.g * c.g * 587 + c.b * c.b * 114;
1263  /* Compare with threshold brightness which defaults to 128 (50%) */
1264  return sq1000_brightness < ((uint) threshold) * ((uint) threshold) * 1000 ? TC_WHITE : TC_BLACK;
1265 }
1266 
1271 void LoadStringWidthTable(bool monospace)
1272 {
1273  ClearFontCache();
1274 
1275  for (FontSize fs = monospace ? FS_MONO : FS_BEGIN; fs < (monospace ? FS_END : FS_MONO); fs++) {
1276  for (uint i = 0; i != 224; i++) {
1277  _stringwidth_table[fs][i] = GetGlyphWidth(fs, i + 32);
1278  }
1279  }
1280 
1281  ReInitAllWindows();
1282 }
1283 
1291 {
1292  /* Use _stringwidth_table cache if possible */
1293  if (key >= 32 && key < 256) return _stringwidth_table[size][key - 32];
1294 
1295  return GetGlyphWidth(size, key);
1296 }
1297 
1304 {
1305  byte width = 0;
1306  for (char c = '0'; c <= '9'; c++) {
1307  width = max(GetCharacterWidth(size, c), width);
1308  }
1309  return width;
1310 }
1311 
1318 void GetBroadestDigit(uint *front, uint *next, FontSize size)
1319 {
1320  int width = -1;
1321  for (char c = '9'; c >= '0'; c--) {
1322  int w = GetCharacterWidth(size, c);
1323  if (w > width) {
1324  width = w;
1325  *next = c - '0';
1326  if (c != '0') *front = c - '0';
1327  }
1328  }
1329 }
1330 
1331 void ScreenSizeChanged()
1332 {
1333  _dirty_bytes_per_line = CeilDiv(_screen.width, DIRTY_BLOCK_WIDTH);
1334  _dirty_blocks = ReallocT<byte>(_dirty_blocks, _dirty_bytes_per_line * CeilDiv(_screen.height, DIRTY_BLOCK_HEIGHT));
1335 
1336  /* check the dirty rect */
1337  if (_invalid_rect.right >= _screen.width) _invalid_rect.right = _screen.width;
1338  if (_invalid_rect.bottom >= _screen.height) _invalid_rect.bottom = _screen.height;
1339 
1340  /* screen size changed and the old bitmap is invalid now, so we don't want to undraw it */
1341  _cursor.visible = false;
1342 }
1343 
1344 void UndrawMouseCursor()
1345 {
1346  /* Don't undraw the mouse cursor if the screen is not ready */
1347  if (_screen.dst_ptr == nullptr) return;
1348 
1349  if (_cursor.visible) {
1351  _cursor.visible = false;
1352  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);
1353  VideoDriver::GetInstance()->MakeDirty(_cursor.draw_pos.x, _cursor.draw_pos.y, _cursor.draw_size.x, _cursor.draw_size.y);
1354  }
1355 }
1356 
1357 void DrawMouseCursor()
1358 {
1359  /* Don't draw the mouse cursor if the screen is not ready */
1360  if (_screen.dst_ptr == nullptr) return;
1361 
1363 
1364  /* Redraw mouse cursor but only when it's inside the window */
1365  if (!_cursor.in_window) return;
1366 
1367  /* Don't draw the mouse cursor if it's already drawn */
1368  if (_cursor.visible) {
1369  if (!_cursor.dirty) return;
1370  UndrawMouseCursor();
1371  }
1372 
1373  /* Determine visible area */
1374  int left = _cursor.pos.x + _cursor.total_offs.x;
1375  int width = _cursor.total_size.x;
1376  if (left < 0) {
1377  width += left;
1378  left = 0;
1379  }
1380  if (left + width > _screen.width) {
1381  width = _screen.width - left;
1382  }
1383  if (width <= 0) return;
1384 
1385  int top = _cursor.pos.y + _cursor.total_offs.y;
1386  int height = _cursor.total_size.y;
1387  if (top < 0) {
1388  height += top;
1389  top = 0;
1390  }
1391  if (top + height > _screen.height) {
1392  height = _screen.height - top;
1393  }
1394  if (height <= 0) return;
1395 
1396  _cursor.draw_pos.x = left;
1397  _cursor.draw_pos.y = top;
1398  _cursor.draw_size.x = width;
1399  _cursor.draw_size.y = height;
1400 
1401  uint8 *buffer = _cursor_backup.Allocate(blitter->BufferSize(_cursor.draw_size.x, _cursor.draw_size.y));
1402 
1403  /* Make backup of stuff below cursor */
1404  blitter->CopyToBuffer(blitter->MoveTo(_screen.dst_ptr, _cursor.draw_pos.x, _cursor.draw_pos.y), buffer, _cursor.draw_size.x, _cursor.draw_size.y);
1405 
1406  /* Draw cursor on screen */
1407  _cur_dpi = &_screen;
1408  for (uint i = 0; i < _cursor.sprite_count; ++i) {
1409  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);
1410  }
1411 
1412  VideoDriver::GetInstance()->MakeDirty(_cursor.draw_pos.x, _cursor.draw_pos.y, _cursor.draw_size.x, _cursor.draw_size.y);
1413 
1414  _cursor.visible = true;
1415  _cursor.dirty = false;
1416 }
1417 
1418 void RedrawScreenRect(int left, int top, int right, int bottom)
1419 {
1420  assert(right <= _screen.width && bottom <= _screen.height);
1421  if (_cursor.visible) {
1422  if (right > _cursor.draw_pos.x &&
1423  left < _cursor.draw_pos.x + _cursor.draw_size.x &&
1424  bottom > _cursor.draw_pos.y &&
1425  top < _cursor.draw_pos.y + _cursor.draw_size.y) {
1426  UndrawMouseCursor();
1427  }
1428  }
1429 
1431 
1432  DrawOverlappedWindowForAll(left, top, right, bottom);
1433 
1434  VideoDriver::GetInstance()->MakeDirty(left, top, right - left, bottom - top);
1435 }
1436 
1443 {
1444  byte *b = _dirty_blocks;
1445  const int w = Align(_screen.width, DIRTY_BLOCK_WIDTH);
1446  const int h = Align(_screen.height, DIRTY_BLOCK_HEIGHT);
1447  int x;
1448  int y;
1449 
1450  if (HasModalProgress()) {
1451  /* We are generating the world, so release our rights to the map and
1452  * painting while we are waiting a bit. */
1453  _modal_progress_paint_mutex.unlock();
1454  _modal_progress_work_mutex.unlock();
1455 
1456  /* Wait a while and update _realtime_tick so we are given the rights */
1459 
1460  /* Modal progress thread may need blitter access while we are waiting for it. */
1465 
1466  /* When we ended with the modal progress, do not draw the blocks.
1467  * Simply let the next run do so, otherwise we would be loading
1468  * the new state (and possibly change the blitter) when we hold
1469  * the drawing lock, which we must not do. */
1470  if (_switch_mode != SM_NONE && !HasModalProgress()) return;
1471  }
1472 
1473  y = 0;
1474  do {
1475  x = 0;
1476  do {
1477  if (*b != 0) {
1478  int left;
1479  int top;
1480  int right = x + DIRTY_BLOCK_WIDTH;
1481  int bottom = y;
1482  byte *p = b;
1483  int h2;
1484 
1485  /* First try coalescing downwards */
1486  do {
1487  *p = 0;
1488  p += _dirty_bytes_per_line;
1489  bottom += DIRTY_BLOCK_HEIGHT;
1490  } while (bottom != h && *p != 0);
1491 
1492  /* Try coalescing to the right too. */
1493  h2 = (bottom - y) / DIRTY_BLOCK_HEIGHT;
1494  assert(h2 > 0);
1495  p = b;
1496 
1497  while (right != w) {
1498  byte *p2 = ++p;
1499  int h = h2;
1500  /* Check if a full line of dirty flags is set. */
1501  do {
1502  if (!*p2) goto no_more_coalesc;
1503  p2 += _dirty_bytes_per_line;
1504  } while (--h != 0);
1505 
1506  /* Wohoo, can combine it one step to the right!
1507  * Do that, and clear the bits. */
1508  right += DIRTY_BLOCK_WIDTH;
1509 
1510  h = h2;
1511  p2 = p;
1512  do {
1513  *p2 = 0;
1514  p2 += _dirty_bytes_per_line;
1515  } while (--h != 0);
1516  }
1517  no_more_coalesc:
1518 
1519  left = x;
1520  top = y;
1521 
1522  if (left < _invalid_rect.left ) left = _invalid_rect.left;
1523  if (top < _invalid_rect.top ) top = _invalid_rect.top;
1524  if (right > _invalid_rect.right ) right = _invalid_rect.right;
1525  if (bottom > _invalid_rect.bottom) bottom = _invalid_rect.bottom;
1526 
1527  if (left < right && top < bottom) {
1528  RedrawScreenRect(left, top, right, bottom);
1529  }
1530 
1531  }
1532  } while (b++, (x += DIRTY_BLOCK_WIDTH) != w);
1533  } while (b += -(int)(w / DIRTY_BLOCK_WIDTH) + _dirty_bytes_per_line, (y += DIRTY_BLOCK_HEIGHT) != h);
1534 
1535  ++_dirty_block_colour;
1536  _invalid_rect.left = w;
1537  _invalid_rect.top = h;
1538  _invalid_rect.right = 0;
1539  _invalid_rect.bottom = 0;
1540 }
1541 
1557 void SetDirtyBlocks(int left, int top, int right, int bottom)
1558 {
1559  byte *b;
1560  int width;
1561  int height;
1562 
1563  if (left < 0) left = 0;
1564  if (top < 0) top = 0;
1565  if (right > _screen.width) right = _screen.width;
1566  if (bottom > _screen.height) bottom = _screen.height;
1567 
1568  if (left >= right || top >= bottom) return;
1569 
1570  if (left < _invalid_rect.left ) _invalid_rect.left = left;
1571  if (top < _invalid_rect.top ) _invalid_rect.top = top;
1572  if (right > _invalid_rect.right ) _invalid_rect.right = right;
1573  if (bottom > _invalid_rect.bottom) _invalid_rect.bottom = bottom;
1574 
1575  left /= DIRTY_BLOCK_WIDTH;
1576  top /= DIRTY_BLOCK_HEIGHT;
1577 
1578  b = _dirty_blocks + top * _dirty_bytes_per_line + left;
1579 
1580  width = ((right - 1) / DIRTY_BLOCK_WIDTH) - left + 1;
1581  height = ((bottom - 1) / DIRTY_BLOCK_HEIGHT) - top + 1;
1582 
1583  assert(width > 0 && height > 0);
1584 
1585  do {
1586  int i = width;
1587 
1588  do b[--i] = 0xFF; while (i != 0);
1589 
1590  b += _dirty_bytes_per_line;
1591  } while (--height != 0);
1592 }
1593 
1601 {
1602  SetDirtyBlocks(0, 0, _screen.width, _screen.height);
1603 }
1604 
1619 bool FillDrawPixelInfo(DrawPixelInfo *n, int left, int top, int width, int height)
1620 {
1622  const DrawPixelInfo *o = _cur_dpi;
1623 
1624  n->zoom = ZOOM_LVL_NORMAL;
1625 
1626  assert(width > 0);
1627  assert(height > 0);
1628 
1629  if ((left -= o->left) < 0) {
1630  width += left;
1631  if (width <= 0) return false;
1632  n->left = -left;
1633  left = 0;
1634  } else {
1635  n->left = 0;
1636  }
1637 
1638  if (width > o->width - left) {
1639  width = o->width - left;
1640  if (width <= 0) return false;
1641  }
1642  n->width = width;
1643 
1644  if ((top -= o->top) < 0) {
1645  height += top;
1646  if (height <= 0) return false;
1647  n->top = -top;
1648  top = 0;
1649  } else {
1650  n->top = 0;
1651  }
1652 
1653  n->dst_ptr = blitter->MoveTo(o->dst_ptr, left, top);
1654  n->pitch = o->pitch;
1655 
1656  if (height > o->height - top) {
1657  height = o->height - top;
1658  if (height <= 0) return false;
1659  }
1660  n->height = height;
1661 
1662  return true;
1663 }
1664 
1670 {
1671  /* Ignore setting any cursor before the sprites are loaded. */
1672  if (GetMaxSpriteID() == 0) return;
1673 
1674  assert_compile(lengthof(_cursor.sprite_seq) == lengthof(_cursor.sprite_pos));
1675  assert(_cursor.sprite_count <= lengthof(_cursor.sprite_seq));
1676  for (uint i = 0; i < _cursor.sprite_count; ++i) {
1677  const Sprite *p = GetSprite(GB(_cursor.sprite_seq[i].sprite, 0, SPRITE_WIDTH), ST_NORMAL);
1678  Point offs, size;
1679  offs.x = UnScaleGUI(p->x_offs) + _cursor.sprite_pos[i].x;
1680  offs.y = UnScaleGUI(p->y_offs) + _cursor.sprite_pos[i].y;
1681  size.x = UnScaleGUI(p->width);
1682  size.y = UnScaleGUI(p->height);
1683 
1684  if (i == 0) {
1685  _cursor.total_offs = offs;
1686  _cursor.total_size = size;
1687  } else {
1688  int right = max(_cursor.total_offs.x + _cursor.total_size.x, offs.x + size.x);
1689  int bottom = max(_cursor.total_offs.y + _cursor.total_size.y, offs.y + size.y);
1690  if (offs.x < _cursor.total_offs.x) _cursor.total_offs.x = offs.x;
1691  if (offs.y < _cursor.total_offs.y) _cursor.total_offs.y = offs.y;
1692  _cursor.total_size.x = right - _cursor.total_offs.x;
1693  _cursor.total_size.y = bottom - _cursor.total_offs.y;
1694  }
1695  }
1696 
1697  _cursor.dirty = true;
1698 }
1699 
1705 static void SetCursorSprite(CursorID cursor, PaletteID pal)
1706 {
1707  if (_cursor.sprite_count == 1 && _cursor.sprite_seq[0].sprite == cursor && _cursor.sprite_seq[0].pal == pal) return;
1708 
1709  _cursor.sprite_count = 1;
1710  _cursor.sprite_seq[0].sprite = cursor;
1711  _cursor.sprite_seq[0].pal = pal;
1712  _cursor.sprite_pos[0].x = 0;
1713  _cursor.sprite_pos[0].y = 0;
1714 
1715  UpdateCursorSize();
1716 }
1717 
1718 static void SwitchAnimatedCursor()
1719 {
1720  const AnimCursor *cur = _cursor.animate_cur;
1721 
1722  if (cur == nullptr || cur->sprite == AnimCursor::LAST) cur = _cursor.animate_list;
1723 
1724  SetCursorSprite(cur->sprite, _cursor.sprite_seq[0].pal);
1725 
1726  _cursor.animate_timeout = cur->display_time;
1727  _cursor.animate_cur = cur + 1;
1728 }
1729 
1730 void CursorTick()
1731 {
1732  if (_cursor.animate_timeout != 0 && --_cursor.animate_timeout == 0) {
1733  SwitchAnimatedCursor();
1734  }
1735 }
1736 
1741 void SetMouseCursorBusy(bool busy)
1742 {
1743  if (busy) {
1744  if (_cursor.sprite_seq[0].sprite == SPR_CURSOR_MOUSE) SetMouseCursor(SPR_CURSOR_ZZZ, PAL_NONE);
1745  } else {
1746  if (_cursor.sprite_seq[0].sprite == SPR_CURSOR_ZZZ) SetMouseCursor(SPR_CURSOR_MOUSE, PAL_NONE);
1747  }
1748 }
1749 
1757 {
1758  /* Turn off animation */
1759  _cursor.animate_timeout = 0;
1760  /* Set cursor */
1761  SetCursorSprite(sprite, pal);
1762 }
1763 
1770 {
1771  _cursor.animate_list = table;
1772  _cursor.animate_cur = nullptr;
1773  _cursor.sprite_seq[0].pal = PAL_NONE;
1774  SwitchAnimatedCursor();
1775 }
1776 
1785 bool CursorVars::UpdateCursorPosition(int x, int y, bool queued_warp)
1786 {
1787  /* Detecting relative mouse movement is somewhat tricky.
1788  * - There may be multiple mouse move events in the video driver queue (esp. when OpenTTD lags a bit).
1789  * - When we request warping the mouse position (return true), a mouse move event is appended at the end of the queue.
1790  *
1791  * So, when this->fix_at is active, we use the following strategy:
1792  * - The first movement triggers the warp to reset the mouse position.
1793  * - Subsequent events have to compute movement relative to the previous event.
1794  * - The relative movement is finished, when we receive the event matching the warp.
1795  */
1796 
1797  if (x == this->pos.x && y == this->pos.y) {
1798  /* Warp finished. */
1799  this->queued_warp = false;
1800  }
1801 
1802  this->delta.x = x - (this->queued_warp ? this->last_position.x : this->pos.x);
1803  this->delta.y = y - (this->queued_warp ? this->last_position.y : this->pos.y);
1804 
1805  this->last_position.x = x;
1806  this->last_position.y = y;
1807 
1808  bool need_warp = false;
1809  if (this->fix_at) {
1810  if (this->delta.x != 0 || this->delta.y != 0) {
1811  /* Trigger warp.
1812  * Note: We also trigger warping again, if there is already a pending warp.
1813  * This makes it more tolerant about the OS or other software in between
1814  * botchering the warp. */
1815  this->queued_warp = queued_warp;
1816  need_warp = true;
1817  }
1818  } else if (this->pos.x != x || this->pos.y != y) {
1819  this->queued_warp = false; // Cancel warping, we are no longer confining the position.
1820  this->dirty = true;
1821  this->pos.x = x;
1822  this->pos.y = y;
1823  }
1824  return need_warp;
1825 }
1826 
1827 bool ChangeResInGame(int width, int height)
1828 {
1829  return (_screen.width == width && _screen.height == height) || VideoDriver::GetInstance()->ChangeResolution(width, height);
1830 }
1831 
1832 bool ToggleFullScreen(bool fs)
1833 {
1834  bool result = VideoDriver::GetInstance()->ToggleFullscreen(fs);
1835  if (_fullscreen != fs && _resolutions.empty()) {
1836  DEBUG(driver, 0, "Could not find a suitable fullscreen resolution");
1837  }
1838  return result;
1839 }
1840 
1841 void SortResolutions()
1842 {
1843  std::sort(_resolutions.begin(), _resolutions.end());
1844 }
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:41
Functions/types related to NewGRF debugging.
static std::vector< LineSegment > MakePolygonSegments(const std::vector< Point > &shape, Point offset)
Make line segments from a polygon defined by points, translated by an offset.
Definition: gfx.cpp:167
uint32 PaletteID
The number of the palette.
Definition: gfx_type.h:18
GameSettings _settings_game
Game settings of a running game or the scenario editor.
Definition: settings.cpp:80
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:479
bool _networking
are we in networking mode?
Definition: network.cpp:52
Base of all video drivers.
bool dirty
the rect occupied by the mouse is dirty (redraw)
Definition: gfx_type.h:140
Data about how and where to blit pixels.
Definition: gfx_type.h:154
static const uint8 PC_WHITE
White palette colour.
Definition: gfx_func.h:207
Horizontally center the text.
Definition: gfx_func.h:95
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:110
Point pos
logical mouse position
Definition: gfx_type.h:117
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:449
int sprite_width
Real width of the sprite.
Definition: base.hpp:39
static int UnScaleGUI(int value)
Short-hand to apply GUI zoom level.
Definition: zoom_func.h:66
Information about the currently used palette.
Definition: gfx_type.h:308
void SetMouseCursorBusy(bool busy)
Set or unset the ZZZ cursor.
Definition: gfx.cpp:1741
virtual void ReleaseBlitterLock()
Release any lock(s) required to be held when changing blitters.
static const PaletteID PALETTE_ALL_BLACK
Exchange any color by black, needed for painting fictive tiles outside map.
Definition: sprites.h:1593
int height
The height in pixels that needs to be drawn to dst.
Definition: base.hpp:38
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:40
Point sprite_pos[16]
relative position of individual sprites
Definition: gfx_type.h:129
Perform transparency colour remapping.
Definition: base.hpp:20
static int UnScaleByZoomLower(int value, ZoomLevel zoom)
Scale by zoom level, usually shift right (when zoom > ZOOM_LVL_NORMAL)
Definition: zoom_func.h:56
Colour palette[256]
Current palette. Entry 0 has to be always fully transparent!
Definition: gfx_type.h:309
int skip_top
How much pixels of the source to skip on the top (based on zoom of dst)
Definition: base.hpp:36
Colour fizzy_drink[EPV_CYCLES_FIZZY_DRINK]
fizzy drinks
Definition: palettes.h:109
byte _colour_gradient[COLOUR_END][8]
All 16 colour gradients 8 colours per gradient from darkest (0) to lightest (7)
Definition: gfx.cpp:52
std::vector< SpriteID > sprites
Sprites found.
Definition: newgrf_debug.h:30
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:34
StringAlignment
How to align the to-be drawn text.
Definition: gfx_func.h:93
uint sprite_count
number of sprites to draw
Definition: gfx_type.h:130
#define FONT_HEIGHT_MONO
Height of characters in the large (FS_MONO) font.
Definition: gfx_func.h:183
Index of the monospaced font in the font tables.
Definition: gfx_type.h:205
Data structure describing a sprite.
Definition: spritecache.h:16
Mask for horizontal alignment.
Definition: gfx_func.h:97
int sprite_height
Real height of the sprite.
Definition: base.hpp:40
static const ExtraPaletteValues _extra_palette_values
Actual palette animation tables.
Definition: palettes.h:115
int width
The width in pixels that needs to be drawn to dst.
Definition: base.hpp:37
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:367
const AnimCursor * animate_list
in case of animated cursor, list of frames
Definition: gfx_type.h:135
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:22
byte GetCharacterWidth(FontSize size, WChar key)
Return width of character glyph.
Definition: gfx.cpp:1290
virtual bool ToggleFullscreen(bool fullscreen)=0
Change the full screen setting.
void * clicked_pixel
Clicked pixel (pointer to blitter buffer)
Definition: newgrf_debug.h:28
int GetStringHeight(const char *str, int maxw, FontSize fontsize)
Calculates height of string (in pixels).
Definition: gfx.cpp:685
void CSleep(int milliseconds)
Sleep on the current thread for a defined time.
Definition: thread.h:25
static const int DRAW_STRING_BUFFER
Size of the buffer used for drawing strings.
Definition: gfx_func.h:83
const char * GetCharAtPosition(int x) const
Get the character that is at a position.
Definition: gfx_layout.cpp:807
#define lastof(x)
Get the last element of an fixed size array.
Definition: depend.cpp:48
No palette animation.
Definition: base.hpp:50
int skip_left
How much pixels of the source to skip on the left (based on zoom of dst)
Definition: base.hpp:35
Visual run contains data about the bit of text with the same font.
Definition: gfx_layout.h:120
byte GetDigitWidth(FontSize size)
Return the maximum width of single digit.
Definition: gfx.cpp:1303
How all blitters should look like.
Definition: base.hpp:28
static const uint MODAL_PROGRESS_REDRAW_TIMEOUT
Timeout between redraws.
Definition: progress.h:15
static T max(const T a, const T b)
Returns the maximum of two values.
Definition: math_func.hpp:24
Functions related to laying out the texts.
static const uint EPV_CYCLES_OIL_REFINERY
length of the oil refinery&#39;s fire animation
Definition: palettes.h:99
bool visible
cursor is visible
Definition: gfx_type.h:139
NewGrfDebugSpritePicker _newgrf_debug_sprite_picker
The sprite picker.
static uint GetGlyphWidth(FontSize size, WChar key)
Get the width of a glyph.
Definition: fontcache.h:201
static int RoundDivSU(int a, uint b)
Computes round(a / b) for signed a and unsigned b.
Definition: math_func.hpp:336
FillRectMode
Define the operation GfxFillRect performs.
Definition: gfx_type.h:281
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:1619
Point total_size
union of sprite properties
Definition: gfx_type.h:131
bool _left_button_clicked
Is left mouse button clicked?
Definition: gfx.cpp:39
Colour dark_water[EPV_CYCLES_DARK_WATER]
dark blue water
Definition: palettes.h:105
std::vector< Dimension > _resolutions
List of resolutions.
Definition: driver.cpp:20
Force the alignment, i.e. don&#39;t swap for RTL languages.
Definition: gfx_func.h:106
std::mutex _modal_progress_work_mutex
Rights for the performing work.
Definition: progress.cpp:21
bool _ctrl_pressed
Is Ctrl pressed?
Definition: gfx.cpp:35
Point draw_size
position and size bounding-box for drawing
Definition: gfx_type.h:133
Colour lighthouse[EPV_CYCLES_LIGHTHOUSE]
lighthouse & stadium
Definition: palettes.h:107
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:110
Collection of variables for cursor-display and -animation.
Definition: gfx_type.h:115
virtual bool ChangeResolution(int w, int h)=0
Change the resolution of the window.
void GfxFillPolygon(const std::vector< Point > &shape, int colour, FillRectMode mode)
Fill a polygon with colour.
Definition: gfx.cpp:206
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:110
int16 y_offs
Number of pixels to shift the sprite downwards.
Definition: spritecache.h:20
#define FONT_HEIGHT_SMALL
Height of characters in the small (FS_SMALL) font.
Definition: gfx_func.h:174
A single line worth of VisualRuns.
Definition: gfx_layout.h:132
bool _right_button_clicked
Is right mouse button clicked?
Definition: gfx.cpp:41
static Rect _invalid_rect
The rect for repaint.
Definition: gfx.cpp:69
Base of all threads.
static T Align(const T x, uint n)
Return the smallest multiple of n equal or greater than x.
Definition: math_func.hpp:95
First font.
Definition: gfx_type.h:208
GameMode
Mode which defines the state of the game.
Definition: openttd.h:16
const T * GetBuffer() const
Get the currently allocated buffer.
Definition: alloc_type.hpp:75
Parameters related to blitting.
Definition: base.hpp:31
void DrawSpriteViewport(SpriteID img, PaletteID pal, int x, int y, const SubSprite *sub)
Draw a sprite in a viewport.
Definition: gfx.cpp:946
bool _left_button_down
Is left mouse button pressed?
Definition: gfx.cpp:38
#define FONT_HEIGHT_NORMAL
Height of characters in the normal (FS_NORMAL) font.
Definition: gfx_func.h:177
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:284
Types related to global configuration settings.
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:1271
Description of tables for the palette animation.
Definition: palettes.h:104
Bottom align the text.
Definition: gfx_func.h:101
Top align the text.
Definition: gfx_func.h:99
A number of safeguards to prevent using unsafe methods.
int pitch
The pitch of the destination buffer.
Definition: base.hpp:45
TextColour
Colour of the strings, see _string_colourmap in table/string_colours.h or docs/ottd-colourtext-palett...
Definition: gfx_type.h:245
bool UpdateCursorPosition(int x, int y, bool queued_warp)
Update cursor position on mouse movement.
Definition: gfx.cpp:1785
static uint CeilDiv(uint a, uint b)
Computes ceil(a / b) for non-negative a and b.
Definition: math_func.hpp:314
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:42
number of animated colours
Definition: gfx_type.h:276
byte _dirkeys
1 = left, 2 = up, 4 = right, 8 = down
Definition: gfx.cpp:31
Perform a crash remapping.
Definition: base.hpp:21
bool fix_at
mouse is moving, but cursor is not (used for scrolling)
Definition: gfx_type.h:120
void DrawCharCentered(WChar c, int x, int y, TextColour colour)
Draw single character horizontally centered around (x,y)
Definition: gfx.cpp:895
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)=0
Draw a line with a given colour.
bool _screen_disable_anim
Disable palette animation (important for 32bpp-anim blitter during giant screenshot) ...
Definition: gfx.cpp:43
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:866
static const uint EPV_CYCLES_FIZZY_DRINK
length of the fizzy drinks animation
Definition: palettes.h:100
byte data[]
Sprite data.
Definition: spritecache.h:21
A reusable buffer that can be used for places that temporary allocate a bit of memory and do that ver...
Definition: alloc_type.hpp:24
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:636
Basic functions/variables used all over the place.
static const Palette _palette
Colour palette (DOS)
Definition: palettes.h:15
A single sprite of a list of animated cursors.
Definition: gfx_type.h:108
byte display_time
Amount of ticks this sprite will be shown.
Definition: gfx_type.h:111
Mask for vertical alignment.
Definition: gfx_func.h:102
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:1557
#define FONT_HEIGHT_LARGE
Height of characters in the large (FS_LARGE) font.
Definition: gfx_func.h:180
virtual void AcquireBlitterLock()
Acquire any lock(s) required to be held when changing blitters.
#define lengthof(x)
Return the length of an fixed size array.
Definition: depend.cpp:40
void DrawDirtyBlocks()
Repaints the rectangle blocks which are marked as &#39;dirty&#39;.
Definition: gfx.cpp:1442
static Blitter * GetCurrentBlitter()
Get the current active blitter (always set by calling SelectBlitter).
Definition: factory.hpp:145
static T min(const T a, const T b)
Returns the minimum of two values.
Definition: math_func.hpp:40
number of bits for the sprite number
Definition: sprites.h:1512
int first_dirty
The first dirty element.
Definition: gfx_type.h:310
PauseMode _pause_mode
The current pause mode.
Definition: gfx.cpp:47
Perform remapping to a completely blackened sprite.
Definition: base.hpp:22
static const Sprite * GetGlyph(FontSize size, WChar key)
Get the Sprite for a glyph.
Definition: fontcache.h:194
uint32 StringID
Numeric value that represents a string, independent of the selected language.
Definition: strings_type.h:16
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:959
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:414
PauseMode
Modes of pausing we&#39;ve got.
Definition: openttd.h:55
Font cache for basic fonts.
Definition: fontcache.h:21
Palette _cur_palette
Current palette.
Definition: gfx.cpp:48
uint16 height
Height of the sprite.
Definition: spritecache.h:17
The most basic (normal) sprite.
Definition: gfx_type.h:297
Dimension GetBounds()
Get the boundaries of this paragraph.
Definition: gfx_layout.cpp:744
bool _shift_pressed
Is Shift pressed?
Definition: gfx.cpp:36
void NetworkUndrawChatMessage()
Hide the chatbox.
#define DEBUG(name, level,...)
Output a line of debugging information.
Definition: debug.h:35
Dimension GetStringBoundingBox(const char *str, FontSize start_fontsize)
Return the string dimension in pixels.
Definition: gfx.cpp:838
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:1756
static const uint EPV_CYCLES_DARK_WATER
Description of the length of the palette cycle animations.
Definition: palettes.h:97
Dimension GetStringMultiLineBoundingBox(StringID str, const Dimension &suggestion)
Calculate string bounding box for multi-line strings.
Definition: gfx.cpp:725
Draw only every second pixel, used for greying-out.
Definition: gfx_type.h:283
PalSpriteID sprite_seq[16]
current image of cursor
Definition: gfx_type.h:128
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:1769
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.
uint16 width
Width of the sprite.
Definition: spritecache.h:18
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:1003
int top
The top offset in the &#39;dst&#39; in pixels to start drawing.
Definition: base.hpp:42
void ReInitAllWindows()
Re-initialize all windows.
Definition: window.cpp:3454
Recolour sprite.
Definition: gfx_type.h:300
uint32 SpriteID
The number of a sprite, without mapping bits and colourtables.
Definition: gfx_type.h:17
void UpdateCursorSize()
Update cursor dimension.
Definition: gfx.cpp:1669
int GetStringLineCount(StringID str, int maxw)
Calculates number of lines of string.
Definition: gfx.cpp:710
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:309
TextColour GetContrastColour(uint8 background, uint8 threshold)
Determine a contrasty text colour for a coloured background.
Definition: gfx.cpp:1257
static const PaletteID PALETTE_CRASH
Recolour sprite greying of crashed vehicles.
Definition: sprites.h:1587
uint animate_timeout
in case of animated cursor, number of ticks to show the current cursor
Definition: gfx_type.h:137
static const byte _string_colourmap[17]
Colour mapping for TextColour.
const byte * remap
XXX – Temporary storage for remap array.
Definition: base.hpp:33
bool include(std::vector< T > &vec, const T &item)
Helper function to append an item to a vector if it is not already contained Consider using std::set...
TextDirection _current_text_dir
Text direction of the currently selected language.
Definition: strings.cpp:48
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.
Ignore colour changes from strings.
Definition: gfx_type.h:270
const void * sprite
Pointer to the sprite how ever the encoder stored it.
Definition: base.hpp:32
static void SetCursorSprite(CursorID cursor, PaletteID pal)
Switch cursor to different sprite.
Definition: gfx.cpp:1705
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:1318
when a sprite is to be displayed transparently, this bit needs to be set.
Definition: sprites.h:1526
static T abs(const T a)
Returns the absolute value of (scalar) variable.
Definition: math_func.hpp:81
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:269
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:201
Perform a colour remapping.
Definition: base.hpp:19
ZoomLevel _font_zoom
Font Zoom level.
Definition: gfx.cpp:60
Set if palette is actually a magic text recolour.
Definition: sprites.h:1509
Index of the normal font in the font tables.
Definition: gfx_type.h:202
bool in_window
mouse inside this window, determines drawing logic
Definition: gfx_type.h:141
ZoomLevel _gui_zoom
GUI Zoom level.
Definition: gfx.cpp:59
SwitchMode _switch_mode
The next mainloop command.
Definition: gfx.cpp:46
int16 x_offs
Number of pixels to shift the sprite to the right.
Definition: spritecache.h:19
Used to only draw a part of the sprite.
Definition: gfx_type.h:217
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...
The normal zoom level.
Definition: zoom_type.h:22
void * dst
Destination buffer.
Definition: base.hpp:44
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:19
Coordinates of a point in 2D.
Dimension GetSpriteSize(SpriteID sprid, Point *offset, ZoomLevel zoom)
Get the size of a sprite.
Definition: gfx.cpp:908
Structure to access the alpha, red, green, and blue channels from a 32 bit number.
Definition: gfx_type.h:162
Perform the simple blitting.
Definition: base.hpp:18
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:268
BlitterMode
The modes of blitting we can do.
Definition: base.hpp:17
number of bits of the sprite containing the recolour palette
Definition: sprites.h:1511
Colour dark_water_toyland[EPV_CYCLES_DARK_WATER]
dark blue water Toyland
Definition: palettes.h:106
static bool HasBit(const T x, const uint8 y)
Checks if a bit in a value is set.
ZoomLevel
All zoom levels we know.
Definition: zoom_type.h:19
virtual void DrawColourMappingRect(void *dst, int width, int height, PaletteID pal)=0
Draw a colourtable to the screen.
std::mutex _modal_progress_paint_mutex
Rights for the painting.
Definition: progress.cpp:23
The layouter performs all the layout work.
Definition: gfx_layout.h:151
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.
Text is written right-to-left by default.
Definition: strings_type.h:24
Right align the text (must be a single bit).
Definition: gfx_func.h:96
Left align the text.
Definition: gfx_func.h:94
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:879
Window functions not directly related to making/drawing windows.
Point delta
relative mouse movement in this tick
Definition: gfx_type.h:118
const AnimCursor * animate_cur
in case of animated cursor, current frame
Definition: gfx_type.h:136
uint32 GlyphID
Glyphs are characters from a font.
Definition: fontcache.h:17
Vertically center the text.
Definition: gfx_func.h:100
static byte _stringwidth_table[FS_END][224]
Cache containing width of often used characters.
Definition: gfx.cpp:50
SpriteID sprite
The &#39;real&#39; sprite.
Definition: gfx_type.h:23
int count_dirty
The number of dirty elements.
Definition: gfx_type.h:311
Colour oil_refinery[EPV_CYCLES_OIL_REFINERY]
oil refinery
Definition: palettes.h:108
static const uint EPV_CYCLES_LIGHTHOUSE
length of the lighthouse/stadium animation
Definition: palettes.h:98
static const CursorID SPR_CURSOR_MOUSE
Cursor sprite numbers.
Definition: sprites.h:1367
Index in the _palettes array from which all animations are taking places (table/palettes.h)
Definition: gfx_type.h:277
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:928
Dimensions (a width and height) of a rectangle in 2D.
This file contains all sprite-related enums and defines.
NewGrfDebugSpritePickerMode mode
Current state.
Definition: newgrf_debug.h:27
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:760
static const uint EPV_CYCLES_GLITTER_WATER
length of the glittery water animation
Definition: palettes.h:101
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:973
SwitchMode
Mode which defines what mode we&#39;re switching to.
Definition: openttd.h:24
Colour glitter_water_toyland[EPV_CYCLES_GLITTER_WATER]
glittery water Toyland
Definition: palettes.h:111
static bool HasModalProgress()
Check if we are currently in a modal progress state.
Definition: progress.h:21
void MarkWholeScreenDirty()
This function mark the whole screen as dirty.
Definition: gfx.cpp:1600
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:759
PaletteID pal
The palette (use PAL_NONE) if not needed)
Definition: gfx_type.h:24