OpenTTD Source  12.0-beta2
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 uint16 _game_speed = 100;
42 DrawPixelInfo _screen;
43 bool _screen_disable_anim = false;
44 std::atomic<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 std::recursive_mutex _palette_mutex;
55 
56 static void GfxMainBlitterViewport(const Sprite *sprite, int x, int y, BlitterMode mode, const SubSprite *sub = nullptr, SpriteID sprite_id = SPR_CURSOR_MOUSE);
57 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);
58 
59 static ReusableBuffer<uint8> _cursor_backup;
60 
63 
66 
67 
76 static const byte *_colour_remap_ptr;
77 static byte _string_colourremap[3];
78 
79 static const uint DIRTY_BLOCK_HEIGHT = 8;
80 static const uint DIRTY_BLOCK_WIDTH = 64;
81 
82 static uint _dirty_bytes_per_line = 0;
83 static byte *_dirty_blocks = nullptr;
84 extern uint _dirty_block_colour;
85 
86 void GfxScroll(int left, int top, int width, int height, int xo, int yo)
87 {
89 
90  if (xo == 0 && yo == 0) return;
91 
92  if (_cursor.visible) UndrawMouseCursor();
93 
95 
96  blitter->ScrollBuffer(_screen.dst_ptr, left, top, width, height, xo, yo);
97  /* This part of the screen is now dirty. */
98  VideoDriver::GetInstance()->MakeDirty(left, top, width, height);
99 }
100 
101 
116 void GfxFillRect(int left, int top, int right, int bottom, int colour, FillRectMode mode)
117 {
119  const DrawPixelInfo *dpi = _cur_dpi;
120  void *dst;
121  const int otop = top;
122  const int oleft = left;
123 
124  if (dpi->zoom != ZOOM_LVL_NORMAL) return;
125  if (left > right || top > bottom) return;
126  if (right < dpi->left || left >= dpi->left + dpi->width) return;
127  if (bottom < dpi->top || top >= dpi->top + dpi->height) return;
128 
129  if ( (left -= dpi->left) < 0) left = 0;
130  right = right - dpi->left + 1;
131  if (right > dpi->width) right = dpi->width;
132  right -= left;
133  assert(right > 0);
134 
135  if ( (top -= dpi->top) < 0) top = 0;
136  bottom = bottom - dpi->top + 1;
137  if (bottom > dpi->height) bottom = dpi->height;
138  bottom -= top;
139  assert(bottom > 0);
140 
141  dst = blitter->MoveTo(dpi->dst_ptr, left, top);
142 
143  switch (mode) {
144  default: // FILLRECT_OPAQUE
145  blitter->DrawRect(dst, right, bottom, (uint8)colour);
146  break;
147 
148  case FILLRECT_RECOLOUR:
149  blitter->DrawColourMappingRect(dst, right, bottom, GB(colour, 0, PALETTE_WIDTH));
150  break;
151 
152  case FILLRECT_CHECKER: {
153  byte bo = (oleft - left + dpi->left + otop - top + dpi->top) & 1;
154  do {
155  for (int i = (bo ^= 1); i < right; i += 2) blitter->SetPixel(dst, i, 0, (uint8)colour);
156  dst = blitter->MoveTo(dst, 0, 1);
157  } while (--bottom > 0);
158  break;
159  }
160  }
161 }
162 
163 typedef std::pair<Point, Point> LineSegment;
164 
173 static std::vector<LineSegment> MakePolygonSegments(const std::vector<Point> &shape, Point offset)
174 {
175  std::vector<LineSegment> segments;
176  if (shape.size() < 3) return segments; // fewer than 3 will always result in an empty polygon
177  segments.reserve(shape.size());
178 
179  /* Connect first and last point by having initial previous point be the last */
180  Point prev = shape.back();
181  prev.x -= offset.x;
182  prev.y -= offset.y;
183  for (Point pt : shape) {
184  pt.x -= offset.x;
185  pt.y -= offset.y;
186  /* Create segments for all non-horizontal lines in the polygon.
187  * The segments always have lowest Y coordinate first. */
188  if (prev.y > pt.y) {
189  segments.emplace_back(pt, prev);
190  } else if (prev.y < pt.y) {
191  segments.emplace_back(prev, pt);
192  }
193  prev = pt;
194  }
195 
196  return segments;
197 }
198 
212 void GfxFillPolygon(const std::vector<Point> &shape, int colour, FillRectMode mode)
213 {
215  const DrawPixelInfo *dpi = _cur_dpi;
216  if (dpi->zoom != ZOOM_LVL_NORMAL) return;
217 
218  std::vector<LineSegment> segments = MakePolygonSegments(shape, Point{ dpi->left, dpi->top });
219 
220  /* Remove segments appearing entirely above or below the clipping area. */
221  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());
222 
223  /* Check that this wasn't an empty shape (all points on a horizontal line or outside clipping.) */
224  if (segments.empty()) return;
225 
226  /* Sort the segments by first point Y coordinate. */
227  std::sort(segments.begin(), segments.end(), [](const LineSegment &a, const LineSegment &b) { return a.first.y < b.first.y; });
228 
229  /* Segments intersecting current scanline. */
230  std::vector<LineSegment> active;
231  /* Intersection points with a scanline.
232  * Kept outside loop to avoid repeated re-allocations. */
233  std::vector<int> intersections;
234  /* Normal, reasonable polygons don't have many intersections per scanline. */
235  active.reserve(4);
236  intersections.reserve(4);
237 
238  /* Scan through the segments and paint each scanline. */
239  int y = segments.front().first.y;
240  std::vector<LineSegment>::iterator nextseg = segments.begin();
241  while (!active.empty() || nextseg != segments.end()) {
242  /* Clean up segments that have ended. */
243  active.erase(std::remove_if(active.begin(), active.end(), [y](const LineSegment &s) { return s.second.y == y; }), active.end());
244 
245  /* Activate all segments starting on this scanline. */
246  while (nextseg != segments.end() && nextseg->first.y == y) {
247  active.push_back(*nextseg);
248  ++nextseg;
249  }
250 
251  /* Check clipping. */
252  if (y < 0) {
253  ++y;
254  continue;
255  }
256  if (y >= dpi->height) return;
257 
258  /* Intersect scanline with all active segments. */
259  intersections.clear();
260  for (const LineSegment &s : active) {
261  const int sdx = s.second.x - s.first.x;
262  const int sdy = s.second.y - s.first.y;
263  const int ldy = y - s.first.y;
264  const int x = s.first.x + sdx * ldy / sdy;
265  intersections.push_back(x);
266  }
267 
268  /* Fill between pairs of intersections. */
269  std::sort(intersections.begin(), intersections.end());
270  for (size_t i = 1; i < intersections.size(); i += 2) {
271  /* Check clipping. */
272  const int x1 = std::max(0, intersections[i - 1]);
273  const int x2 = std::min(intersections[i], dpi->width);
274  if (x2 < 0) continue;
275  if (x1 >= dpi->width) continue;
276 
277  /* Fill line y from x1 to x2. */
278  void *dst = blitter->MoveTo(dpi->dst_ptr, x1, y);
279  switch (mode) {
280  default: // FILLRECT_OPAQUE
281  blitter->DrawRect(dst, x2 - x1, 1, (uint8)colour);
282  break;
283  case FILLRECT_RECOLOUR:
284  blitter->DrawColourMappingRect(dst, x2 - x1, 1, GB(colour, 0, PALETTE_WIDTH));
285  break;
286  case FILLRECT_CHECKER:
287  /* Fill every other pixel, offset such that the sum of filled pixels' X and Y coordinates is odd.
288  * This creates a checkerboard effect. */
289  for (int x = (x1 + y) & 1; x < x2 - x1; x += 2) {
290  blitter->SetPixel(dst, x, 0, (uint8)colour);
291  }
292  break;
293  }
294  }
295 
296  /* Next line */
297  ++y;
298  }
299 }
300 
315 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)
316 {
318 
319  assert(width > 0);
320 
321  if (y2 == y || x2 == x) {
322  /* Special case: horizontal/vertical line. All checks already done in GfxPreprocessLine. */
323  blitter->DrawLine(video, x, y, x2, y2, screen_width, screen_height, colour, width, dash);
324  return;
325  }
326 
327  int grade_y = y2 - y;
328  int grade_x = x2 - x;
329 
330  /* Clipping rectangle. Slightly extended so we can ignore the width of the line. */
331  int extra = (int)CeilDiv(3 * width, 4); // not less then "width * sqrt(2) / 2"
332  Rect clip = { -extra, -extra, screen_width - 1 + extra, screen_height - 1 + extra };
333 
334  /* prevent integer overflows. */
335  int margin = 1;
336  while (INT_MAX / abs(grade_y) < std::max(abs(clip.left - x), abs(clip.right - x))) {
337  grade_y /= 2;
338  grade_x /= 2;
339  margin *= 2; // account for rounding errors
340  }
341 
342  /* Imagine that the line is infinitely long and it intersects with
343  * infinitely long left and right edges of the clipping rectangle.
344  * If both intersection points are outside the clipping rectangle
345  * and both on the same side of it, we don't need to draw anything. */
346  int left_isec_y = y + (clip.left - x) * grade_y / grade_x;
347  int right_isec_y = y + (clip.right - x) * grade_y / grade_x;
348  if ((left_isec_y > clip.bottom + margin && right_isec_y > clip.bottom + margin) ||
349  (left_isec_y < clip.top - margin && right_isec_y < clip.top - margin)) {
350  return;
351  }
352 
353  /* It is possible to use the line equation to further reduce the amount of
354  * work the blitter has to do by shortening the effective line segment.
355  * However, in order to get that right and prevent the flickering effects
356  * of rounding errors so much additional code has to be run here that in
357  * the general case the effect is not noticeable. */
358 
359  blitter->DrawLine(video, x, y, x2, y2, screen_width, screen_height, colour, width, dash);
360 }
361 
373 static inline bool GfxPreprocessLine(DrawPixelInfo *dpi, int &x, int &y, int &x2, int &y2, int width)
374 {
375  x -= dpi->left;
376  x2 -= dpi->left;
377  y -= dpi->top;
378  y2 -= dpi->top;
379 
380  /* Check simple clipping */
381  if (x + width / 2 < 0 && x2 + width / 2 < 0 ) return false;
382  if (y + width / 2 < 0 && y2 + width / 2 < 0 ) return false;
383  if (x - width / 2 > dpi->width && x2 - width / 2 > dpi->width ) return false;
384  if (y - width / 2 > dpi->height && y2 - width / 2 > dpi->height) return false;
385  return true;
386 }
387 
388 void GfxDrawLine(int x, int y, int x2, int y2, int colour, int width, int dash)
389 {
390  DrawPixelInfo *dpi = _cur_dpi;
391  if (GfxPreprocessLine(dpi, x, y, x2, y2, width)) {
392  GfxDoDrawLine(dpi->dst_ptr, x, y, x2, y2, dpi->width, dpi->height, colour, width, dash);
393  }
394 }
395 
396 void GfxDrawLineUnscaled(int x, int y, int x2, int y2, int colour)
397 {
398  DrawPixelInfo *dpi = _cur_dpi;
399  if (GfxPreprocessLine(dpi, x, y, x2, y2, 1)) {
400  GfxDoDrawLine(dpi->dst_ptr,
401  UnScaleByZoom(x, dpi->zoom), UnScaleByZoom(y, dpi->zoom),
402  UnScaleByZoom(x2, dpi->zoom), UnScaleByZoom(y2, dpi->zoom),
403  UnScaleByZoom(dpi->width, dpi->zoom), UnScaleByZoom(dpi->height, dpi->zoom), colour, 1);
404  }
405 }
406 
420 void DrawBox(int x, int y, int dx1, int dy1, int dx2, int dy2, int dx3, int dy3)
421 {
422  /* ....
423  * .. ....
424  * .. ....
425  * .. ^
426  * <--__(dx1,dy1) /(dx2,dy2)
427  * : --__ / :
428  * : --__ / :
429  * : *(x,y) :
430  * : | :
431  * : | ..
432  * .... |(dx3,dy3)
433  * .... | ..
434  * ....V.
435  */
436 
437  static const byte colour = PC_WHITE;
438 
439  GfxDrawLineUnscaled(x, y, x + dx1, y + dy1, colour);
440  GfxDrawLineUnscaled(x, y, x + dx2, y + dy2, colour);
441  GfxDrawLineUnscaled(x, y, x + dx3, y + dy3, colour);
442 
443  GfxDrawLineUnscaled(x + dx1, y + dy1, x + dx1 + dx2, y + dy1 + dy2, colour);
444  GfxDrawLineUnscaled(x + dx1, y + dy1, x + dx1 + dx3, y + dy1 + dy3, colour);
445  GfxDrawLineUnscaled(x + dx2, y + dy2, x + dx2 + dx1, y + dy2 + dy1, colour);
446  GfxDrawLineUnscaled(x + dx2, y + dy2, x + dx2 + dx3, y + dy2 + dy3, colour);
447  GfxDrawLineUnscaled(x + dx3, y + dy3, x + dx3 + dx1, y + dy3 + dy1, colour);
448  GfxDrawLineUnscaled(x + dx3, y + dy3, x + dx3 + dx2, y + dy3 + dy2, colour);
449 }
450 
455 static void SetColourRemap(TextColour colour)
456 {
457  if (colour == TC_INVALID) return;
458 
459  /* Black strings have no shading ever; the shading is black, so it
460  * would be invisible at best, but it actually makes it illegible. */
461  bool no_shade = (colour & TC_NO_SHADE) != 0 || colour == TC_BLACK;
462  bool raw_colour = (colour & TC_IS_PALETTE_COLOUR) != 0;
463  colour &= ~(TC_NO_SHADE | TC_IS_PALETTE_COLOUR | TC_FORCED);
464 
465  _string_colourremap[1] = raw_colour ? (byte)colour : _string_colourmap[colour];
466  _string_colourremap[2] = no_shade ? 0 : 1;
467  _colour_remap_ptr = _string_colourremap;
468 }
469 
485 static int DrawLayoutLine(const ParagraphLayouter::Line &line, int y, int left, int right, StringAlignment align, bool underline, bool truncation)
486 {
487  if (line.CountRuns() == 0) return 0;
488 
489  int w = line.GetWidth();
490  int h = line.GetLeading();
491 
492  /*
493  * The following is needed for truncation.
494  * Depending on the text direction, we either remove bits at the rear
495  * or the front. For this we shift the entire area to draw so it fits
496  * within the left/right bounds and the side we do not truncate it on.
497  * Then we determine the truncation location, i.e. glyphs that fall
498  * outside of the range min_x - max_x will not be drawn; they are thus
499  * the truncated glyphs.
500  *
501  * At a later step we insert the dots.
502  */
503 
504  int max_w = right - left + 1; // The maximum width.
505 
506  int offset_x = 0; // The offset we need for positioning the glyphs
507  int min_x = left; // The minimum x position to draw normal glyphs on.
508  int max_x = right; // The maximum x position to draw normal glyphs on.
509 
510  truncation &= max_w < w; // Whether we need to do truncation.
511  int dot_width = 0; // Cache for the width of the dot.
512  const Sprite *dot_sprite = nullptr; // Cache for the sprite of the dot.
513 
514  if (truncation) {
515  /*
516  * Assumption may be made that all fonts of a run are of the same size.
517  * In any case, we'll use these dots for the abbreviation, so even if
518  * another size would be chosen it won't have truncated too little for
519  * the truncation dots.
520  */
521  FontCache *fc = ((const Font*)line.GetVisualRun(0).GetFont())->fc;
522  GlyphID dot_glyph = fc->MapCharToGlyph('.');
523  dot_width = fc->GetGlyphWidth(dot_glyph);
524  dot_sprite = fc->GetGlyph(dot_glyph);
525 
526  if (_current_text_dir == TD_RTL) {
527  min_x += 3 * dot_width;
528  offset_x = w - 3 * dot_width - max_w;
529  } else {
530  max_x -= 3 * dot_width;
531  }
532 
533  w = max_w;
534  }
535 
536  /* In case we have a RTL language we swap the alignment. */
537  if (!(align & SA_FORCE) && _current_text_dir == TD_RTL && (align & SA_HOR_MASK) != SA_HOR_CENTER) align ^= SA_RIGHT;
538 
539  /* right is the right most position to draw on. In this case we want to do
540  * calculations with the width of the string. In comparison right can be
541  * seen as lastof(todraw) and width as lengthof(todraw). They differ by 1.
542  * So most +1/-1 additions are to move from lengthof to 'indices'.
543  */
544  switch (align & SA_HOR_MASK) {
545  case SA_LEFT:
546  /* right + 1 = left + w */
547  right = left + w - 1;
548  break;
549 
550  case SA_HOR_CENTER:
551  left = RoundDivSU(right + 1 + left - w, 2);
552  /* right + 1 = left + w */
553  right = left + w - 1;
554  break;
555 
556  case SA_RIGHT:
557  left = right + 1 - w;
558  break;
559 
560  default:
561  NOT_REACHED();
562  }
563 
564  TextColour colour = TC_BLACK;
565  bool draw_shadow = false;
566  for (int run_index = 0; run_index < line.CountRuns(); run_index++) {
567  const ParagraphLayouter::VisualRun &run = line.GetVisualRun(run_index);
568  const Font *f = (const Font*)run.GetFont();
569 
570  FontCache *fc = f->fc;
571  colour = f->colour;
572  SetColourRemap(colour);
573 
574  DrawPixelInfo *dpi = _cur_dpi;
575  int dpi_left = dpi->left;
576  int dpi_right = dpi->left + dpi->width - 1;
577 
578  draw_shadow = fc->GetDrawGlyphShadow() && (colour & TC_NO_SHADE) == 0 && colour != TC_BLACK;
579 
580  for (int i = 0; i < run.GetGlyphCount(); i++) {
581  GlyphID glyph = run.GetGlyphs()[i];
582 
583  /* Not a valid glyph (empty) */
584  if (glyph == 0xFFFF) continue;
585 
586  int begin_x = (int)run.GetPositions()[i * 2] + left - offset_x;
587  int end_x = (int)run.GetPositions()[i * 2 + 2] + left - offset_x - 1;
588  int top = (int)run.GetPositions()[i * 2 + 1] + y;
589 
590  /* Truncated away. */
591  if (truncation && (begin_x < min_x || end_x > max_x)) continue;
592 
593  const Sprite *sprite = fc->GetGlyph(glyph);
594  /* Check clipping (the "+ 1" is for the shadow). */
595  if (begin_x + sprite->x_offs > dpi_right || begin_x + sprite->x_offs + sprite->width /* - 1 + 1 */ < dpi_left) continue;
596 
597  if (draw_shadow && (glyph & SPRITE_GLYPH) == 0) {
598  SetColourRemap(TC_BLACK);
599  GfxMainBlitter(sprite, begin_x + 1, top + 1, BM_COLOUR_REMAP);
600  SetColourRemap(colour);
601  }
602  GfxMainBlitter(sprite, begin_x, top, BM_COLOUR_REMAP);
603  }
604  }
605 
606  if (truncation) {
607  int x = (_current_text_dir == TD_RTL) ? left : (right - 3 * dot_width);
608  for (int i = 0; i < 3; i++, x += dot_width) {
609  if (draw_shadow) {
610  SetColourRemap(TC_BLACK);
611  GfxMainBlitter(dot_sprite, x + 1, y + 1, BM_COLOUR_REMAP);
612  SetColourRemap(colour);
613  }
614  GfxMainBlitter(dot_sprite, x, y, BM_COLOUR_REMAP);
615  }
616  }
617 
618  if (underline) {
619  GfxFillRect(left, y + h, right, y + h, _string_colourremap[1]);
620  }
621 
622  return (align & SA_HOR_MASK) == SA_RIGHT ? left : right;
623 }
624 
642 int DrawString(int left, int right, int top, const char *str, TextColour colour, StringAlignment align, bool underline, FontSize fontsize)
643 {
644  /* The string may contain control chars to change the font, just use the biggest font for clipping. */
646 
647  /* Funny glyphs may extent outside the usual bounds, so relax the clipping somewhat. */
648  int extra = max_height / 2;
649 
650  if (_cur_dpi->top + _cur_dpi->height + extra < top || _cur_dpi->top > top + max_height + extra ||
651  _cur_dpi->left + _cur_dpi->width + extra < left || _cur_dpi->left > right + extra) {
652  return 0;
653  }
654 
655  Layouter layout(str, INT32_MAX, colour, fontsize);
656  if (layout.size() == 0) return 0;
657 
658  return DrawLayoutLine(*layout.front(), top, left, right, align, underline, true);
659 }
660 
678 int DrawString(int left, int right, int top, const std::string &str, TextColour colour, StringAlignment align, bool underline, FontSize fontsize)
679 {
680  return DrawString(left, right, top, str.c_str(), colour, align, underline, fontsize);
681 }
682 
700 int DrawString(int left, int right, int top, StringID str, TextColour colour, StringAlignment align, bool underline, FontSize fontsize)
701 {
702  char buffer[DRAW_STRING_BUFFER];
703  GetString(buffer, str, lastof(buffer));
704  return DrawString(left, right, top, buffer, colour, align, underline, fontsize);
705 }
706 
713 int GetStringHeight(const char *str, int maxw, FontSize fontsize)
714 {
715  Layouter layout(str, maxw, TC_FROMSTRING, fontsize);
716  return layout.GetBounds().height;
717 }
718 
725 int GetStringHeight(StringID str, int maxw)
726 {
727  char buffer[DRAW_STRING_BUFFER];
728  GetString(buffer, str, lastof(buffer));
729  return GetStringHeight(buffer, maxw);
730 }
731 
738 int GetStringLineCount(StringID str, int maxw)
739 {
740  char buffer[DRAW_STRING_BUFFER];
741  GetString(buffer, str, lastof(buffer));
742 
743  Layouter layout(buffer, maxw);
744  return (uint)layout.size();
745 }
746 
754 {
755  Dimension box = {suggestion.width, (uint)GetStringHeight(str, suggestion.width)};
756  return box;
757 }
758 
765 Dimension GetStringMultiLineBoundingBox(const char *str, const Dimension &suggestion)
766 {
767  Dimension box = {suggestion.width, (uint)GetStringHeight(str, suggestion.width)};
768  return box;
769 }
770 
787 int DrawStringMultiLine(int left, int right, int top, int bottom, const char *str, TextColour colour, StringAlignment align, bool underline, FontSize fontsize)
788 {
789  int maxw = right - left + 1;
790  int maxh = bottom - top + 1;
791 
792  /* It makes no sense to even try if it can't be drawn anyway, or
793  * do we really want to support fonts of 0 or less pixels high? */
794  if (maxh <= 0) return top;
795 
796  Layouter layout(str, maxw, colour, fontsize);
797  int total_height = layout.GetBounds().height;
798  int y;
799  switch (align & SA_VERT_MASK) {
800  case SA_TOP:
801  y = top;
802  break;
803 
804  case SA_VERT_CENTER:
805  y = RoundDivSU(bottom + top - total_height, 2);
806  break;
807 
808  case SA_BOTTOM:
809  y = bottom - total_height;
810  break;
811 
812  default: NOT_REACHED();
813  }
814 
815  int last_line = top;
816  int first_line = bottom;
817 
818  for (const auto &line : layout) {
819 
820  int line_height = line->GetLeading();
821  if (y >= top && y < bottom) {
822  last_line = y + line_height;
823  if (first_line > y) first_line = y;
824 
825  DrawLayoutLine(*line, y, left, right, align, underline, false);
826  }
827  y += line_height;
828  }
829 
830  return ((align & SA_VERT_MASK) == SA_BOTTOM) ? first_line : last_line;
831 }
832 
833 
850 int DrawStringMultiLine(int left, int right, int top, int bottom, const std::string &str, TextColour colour, StringAlignment align, bool underline, FontSize fontsize)
851 {
852  return DrawStringMultiLine(left, right, top, bottom, str.c_str(), colour, align, underline, fontsize);
853 }
854 
871 int DrawStringMultiLine(int left, int right, int top, int bottom, StringID str, TextColour colour, StringAlignment align, bool underline, FontSize fontsize)
872 {
873  char buffer[DRAW_STRING_BUFFER];
874  GetString(buffer, str, lastof(buffer));
875  return DrawStringMultiLine(left, right, top, bottom, buffer, colour, align, underline, fontsize);
876 }
877 
888 Dimension GetStringBoundingBox(const char *str, FontSize start_fontsize)
889 {
890  Layouter layout(str, INT32_MAX, TC_FROMSTRING, start_fontsize);
891  return layout.GetBounds();
892 }
893 
904 Dimension GetStringBoundingBox(const std::string &str, FontSize start_fontsize)
905 {
906  return GetStringBoundingBox(str.c_str(), start_fontsize);
907 }
908 
916 {
917  char buffer[DRAW_STRING_BUFFER];
918 
919  GetString(buffer, strid, lastof(buffer));
920  return GetStringBoundingBox(buffer);
921 }
922 
931 Point GetCharPosInString(const char *str, const char *ch, FontSize start_fontsize)
932 {
933  Layouter layout(str, INT32_MAX, TC_FROMSTRING, start_fontsize);
934  return layout.GetCharPosition(ch);
935 }
936 
944 const char *GetCharAtPosition(const char *str, int x, FontSize start_fontsize)
945 {
946  if (x < 0) return nullptr;
947 
948  Layouter layout(str, INT32_MAX, TC_FROMSTRING, start_fontsize);
949  return layout.GetCharAtPosition(x);
950 }
951 
959 void DrawCharCentered(WChar c, const Rect &r, TextColour colour)
960 {
961  SetColourRemap(colour);
962  GfxMainBlitter(GetGlyph(FS_NORMAL, c),
963  CenterBounds(r.left, r.right, GetCharacterWidth(FS_NORMAL, c)),
964  CenterBounds(r.top, r.bottom, FONT_HEIGHT_NORMAL),
966 }
967 
977 {
978  const Sprite *sprite = GetSprite(sprid, ST_NORMAL);
979 
980  if (offset != nullptr) {
981  offset->x = UnScaleByZoom(sprite->x_offs, zoom);
982  offset->y = UnScaleByZoom(sprite->y_offs, zoom);
983  }
984 
985  Dimension d;
986  d.width = std::max<int>(0, UnScaleByZoom(sprite->x_offs + sprite->width, zoom));
987  d.height = std::max<int>(0, UnScaleByZoom(sprite->y_offs + sprite->height, zoom));
988  return d;
989 }
990 
997 {
998  switch (pal) {
999  case PAL_NONE: return BM_NORMAL;
1000  case PALETTE_CRASH: return BM_CRASH_REMAP;
1001  case PALETTE_ALL_BLACK: return BM_BLACK_REMAP;
1002  default: return BM_COLOUR_REMAP;
1003  }
1004 }
1005 
1014 void DrawSpriteViewport(SpriteID img, PaletteID pal, int x, int y, const SubSprite *sub)
1015 {
1016  SpriteID real_sprite = GB(img, 0, SPRITE_WIDTH);
1018  _colour_remap_ptr = GetNonSprite(GB(pal, 0, PALETTE_WIDTH), ST_RECOLOUR) + 1;
1019  GfxMainBlitterViewport(GetSprite(real_sprite, ST_NORMAL), x, y, BM_TRANSPARENT, sub, real_sprite);
1020  } else if (pal != PAL_NONE) {
1021  if (HasBit(pal, PALETTE_TEXT_RECOLOUR)) {
1023  } else {
1024  _colour_remap_ptr = GetNonSprite(GB(pal, 0, PALETTE_WIDTH), ST_RECOLOUR) + 1;
1025  }
1026  GfxMainBlitterViewport(GetSprite(real_sprite, ST_NORMAL), x, y, GetBlitterMode(pal), sub, real_sprite);
1027  } else {
1028  GfxMainBlitterViewport(GetSprite(real_sprite, ST_NORMAL), x, y, BM_NORMAL, sub, real_sprite);
1029  }
1030 }
1031 
1041 void DrawSprite(SpriteID img, PaletteID pal, int x, int y, const SubSprite *sub, ZoomLevel zoom)
1042 {
1043  SpriteID real_sprite = GB(img, 0, SPRITE_WIDTH);
1045  _colour_remap_ptr = GetNonSprite(GB(pal, 0, PALETTE_WIDTH), ST_RECOLOUR) + 1;
1046  GfxMainBlitter(GetSprite(real_sprite, ST_NORMAL), x, y, BM_TRANSPARENT, sub, real_sprite, zoom);
1047  } else if (pal != PAL_NONE) {
1048  if (HasBit(pal, PALETTE_TEXT_RECOLOUR)) {
1050  } else {
1051  _colour_remap_ptr = GetNonSprite(GB(pal, 0, PALETTE_WIDTH), ST_RECOLOUR) + 1;
1052  }
1053  GfxMainBlitter(GetSprite(real_sprite, ST_NORMAL), x, y, GetBlitterMode(pal), sub, real_sprite, zoom);
1054  } else {
1055  GfxMainBlitter(GetSprite(real_sprite, ST_NORMAL), x, y, BM_NORMAL, sub, real_sprite, zoom);
1056  }
1057 }
1058 
1070 template <int ZOOM_BASE, bool SCALED_XY>
1071 static void GfxBlitter(const Sprite * const sprite, int x, int y, BlitterMode mode, const SubSprite * const sub, SpriteID sprite_id, ZoomLevel zoom)
1072 {
1073  const DrawPixelInfo *dpi = _cur_dpi;
1075 
1076  if (SCALED_XY) {
1077  /* Scale it */
1078  x = ScaleByZoom(x, zoom);
1079  y = ScaleByZoom(y, zoom);
1080  }
1081 
1082  /* Move to the correct offset */
1083  x += sprite->x_offs;
1084  y += sprite->y_offs;
1085 
1086  if (sub == nullptr) {
1087  /* No clipping. */
1088  bp.skip_left = 0;
1089  bp.skip_top = 0;
1090  bp.width = UnScaleByZoom(sprite->width, zoom);
1091  bp.height = UnScaleByZoom(sprite->height, zoom);
1092  } else {
1093  /* Amount of pixels to clip from the source sprite */
1094  int clip_left = std::max(0, -sprite->x_offs + sub->left * ZOOM_BASE );
1095  int clip_top = std::max(0, -sprite->y_offs + sub->top * ZOOM_BASE );
1096  int clip_right = std::max(0, sprite->width - (-sprite->x_offs + (sub->right + 1) * ZOOM_BASE));
1097  int clip_bottom = std::max(0, sprite->height - (-sprite->y_offs + (sub->bottom + 1) * ZOOM_BASE));
1098 
1099  if (clip_left + clip_right >= sprite->width) return;
1100  if (clip_top + clip_bottom >= sprite->height) return;
1101 
1102  bp.skip_left = UnScaleByZoomLower(clip_left, zoom);
1103  bp.skip_top = UnScaleByZoomLower(clip_top, zoom);
1104  bp.width = UnScaleByZoom(sprite->width - clip_left - clip_right, zoom);
1105  bp.height = UnScaleByZoom(sprite->height - clip_top - clip_bottom, zoom);
1106 
1107  x += ScaleByZoom(bp.skip_left, zoom);
1108  y += ScaleByZoom(bp.skip_top, zoom);
1109  }
1110 
1111  /* Copy the main data directly from the sprite */
1112  bp.sprite = sprite->data;
1113  bp.sprite_width = sprite->width;
1114  bp.sprite_height = sprite->height;
1115  bp.top = 0;
1116  bp.left = 0;
1117 
1118  bp.dst = dpi->dst_ptr;
1119  bp.pitch = dpi->pitch;
1120  bp.remap = _colour_remap_ptr;
1121 
1122  assert(sprite->width > 0);
1123  assert(sprite->height > 0);
1124 
1125  if (bp.width <= 0) return;
1126  if (bp.height <= 0) return;
1127 
1128  y -= SCALED_XY ? ScaleByZoom(dpi->top, zoom) : dpi->top;
1129  int y_unscaled = UnScaleByZoom(y, zoom);
1130  /* Check for top overflow */
1131  if (y < 0) {
1132  bp.height -= -y_unscaled;
1133  if (bp.height <= 0) return;
1134  bp.skip_top += -y_unscaled;
1135  y = 0;
1136  } else {
1137  bp.top = y_unscaled;
1138  }
1139 
1140  /* Check for bottom overflow */
1141  y += SCALED_XY ? ScaleByZoom(bp.height - dpi->height, zoom) : ScaleByZoom(bp.height, zoom) - dpi->height;
1142  if (y > 0) {
1143  bp.height -= UnScaleByZoom(y, zoom);
1144  if (bp.height <= 0) return;
1145  }
1146 
1147  x -= SCALED_XY ? ScaleByZoom(dpi->left, zoom) : dpi->left;
1148  int x_unscaled = UnScaleByZoom(x, zoom);
1149  /* Check for left overflow */
1150  if (x < 0) {
1151  bp.width -= -x_unscaled;
1152  if (bp.width <= 0) return;
1153  bp.skip_left += -x_unscaled;
1154  x = 0;
1155  } else {
1156  bp.left = x_unscaled;
1157  }
1158 
1159  /* Check for right overflow */
1160  x += SCALED_XY ? ScaleByZoom(bp.width - dpi->width, zoom) : ScaleByZoom(bp.width, zoom) - dpi->width;
1161  if (x > 0) {
1162  bp.width -= UnScaleByZoom(x, zoom);
1163  if (bp.width <= 0) return;
1164  }
1165 
1166  assert(bp.skip_left + bp.width <= UnScaleByZoom(sprite->width, zoom));
1167  assert(bp.skip_top + bp.height <= UnScaleByZoom(sprite->height, zoom));
1168 
1169  /* We do not want to catch the mouse. However we also use that spritenumber for unknown (text) sprites. */
1170  if (_newgrf_debug_sprite_picker.mode == SPM_REDRAW && sprite_id != SPR_CURSOR_MOUSE) {
1172  void *topleft = blitter->MoveTo(bp.dst, bp.left, bp.top);
1173  void *bottomright = blitter->MoveTo(topleft, bp.width - 1, bp.height - 1);
1174 
1176 
1177  if (topleft <= clicked && clicked <= bottomright) {
1178  uint offset = (((size_t)clicked - (size_t)topleft) / (blitter->GetScreenDepth() / 8)) % bp.pitch;
1179  if (offset < (uint)bp.width) {
1181  }
1182  }
1183  }
1184 
1185  BlitterFactory::GetCurrentBlitter()->Draw(&bp, mode, zoom);
1186 }
1187 
1188 static void GfxMainBlitterViewport(const Sprite *sprite, int x, int y, BlitterMode mode, const SubSprite *sub, SpriteID sprite_id)
1189 {
1190  GfxBlitter<ZOOM_LVL_BASE, false>(sprite, x, y, mode, sub, sprite_id, _cur_dpi->zoom);
1191 }
1192 
1193 static void GfxMainBlitter(const Sprite *sprite, int x, int y, BlitterMode mode, const SubSprite *sub, SpriteID sprite_id, ZoomLevel zoom)
1194 {
1195  GfxBlitter<1, true>(sprite, x, y, mode, sub, sprite_id, zoom);
1196 }
1197 
1198 void DoPaletteAnimations();
1199 
1200 void GfxInitPalettes()
1201 {
1202  std::lock_guard<std::recursive_mutex> lock(_palette_mutex);
1203  memcpy(&_cur_palette, &_palette, sizeof(_cur_palette));
1204  DoPaletteAnimations();
1205 }
1206 
1216 bool CopyPalette(Palette &local_palette, bool force_copy)
1217 {
1218  std::lock_guard<std::recursive_mutex> lock(_palette_mutex);
1219 
1220  if (!force_copy && _cur_palette.count_dirty == 0) return false;
1221 
1222  local_palette = _cur_palette;
1224 
1225  if (force_copy) {
1226  local_palette.first_dirty = 0;
1227  local_palette.count_dirty = 256;
1228  }
1229 
1230  return true;
1231 }
1232 
1233 #define EXTR(p, q) (((uint16)(palette_animation_counter * (p)) * (q)) >> 16)
1234 #define EXTR2(p, q) (((uint16)(~palette_animation_counter * (p)) * (q)) >> 16)
1235 
1236 void DoPaletteAnimations()
1237 {
1238  std::lock_guard<std::recursive_mutex> lock(_palette_mutex);
1239 
1240  /* Animation counter for the palette animation. */
1241  static int palette_animation_counter = 0;
1242  palette_animation_counter += 8;
1243 
1245  const Colour *s;
1247  Colour old_val[PALETTE_ANIM_SIZE];
1248  const uint old_tc = palette_animation_counter;
1249  uint i;
1250  uint j;
1251 
1252  if (blitter != nullptr && blitter->UsePaletteAnimation() == Blitter::PALETTE_ANIMATION_NONE) {
1253  palette_animation_counter = 0;
1254  }
1255 
1256  Colour *palette_pos = &_cur_palette.palette[PALETTE_ANIM_START]; // Points to where animations are taking place on the palette
1257  /* Makes a copy of the current animation palette in old_val,
1258  * so the work on the current palette could be compared, see if there has been any changes */
1259  memcpy(old_val, palette_pos, sizeof(old_val));
1260 
1261  /* Fizzy Drink bubbles animation */
1262  s = ev->fizzy_drink;
1263  j = EXTR2(512, EPV_CYCLES_FIZZY_DRINK);
1264  for (i = 0; i != EPV_CYCLES_FIZZY_DRINK; i++) {
1265  *palette_pos++ = s[j];
1266  j++;
1267  if (j == EPV_CYCLES_FIZZY_DRINK) j = 0;
1268  }
1269 
1270  /* Oil refinery fire animation */
1271  s = ev->oil_refinery;
1272  j = EXTR2(512, EPV_CYCLES_OIL_REFINERY);
1273  for (i = 0; i != EPV_CYCLES_OIL_REFINERY; i++) {
1274  *palette_pos++ = s[j];
1275  j++;
1276  if (j == EPV_CYCLES_OIL_REFINERY) j = 0;
1277  }
1278 
1279  /* Radio tower blinking */
1280  {
1281  byte i = (palette_animation_counter >> 1) & 0x7F;
1282  byte v;
1283 
1284  if (i < 0x3f) {
1285  v = 255;
1286  } else if (i < 0x4A || i >= 0x75) {
1287  v = 128;
1288  } else {
1289  v = 20;
1290  }
1291  palette_pos->r = v;
1292  palette_pos->g = 0;
1293  palette_pos->b = 0;
1294  palette_pos++;
1295 
1296  i ^= 0x40;
1297  if (i < 0x3f) {
1298  v = 255;
1299  } else if (i < 0x4A || i >= 0x75) {
1300  v = 128;
1301  } else {
1302  v = 20;
1303  }
1304  palette_pos->r = v;
1305  palette_pos->g = 0;
1306  palette_pos->b = 0;
1307  palette_pos++;
1308  }
1309 
1310  /* Handle lighthouse and stadium animation */
1311  s = ev->lighthouse;
1312  j = EXTR(256, EPV_CYCLES_LIGHTHOUSE);
1313  for (i = 0; i != EPV_CYCLES_LIGHTHOUSE; i++) {
1314  *palette_pos++ = s[j];
1315  j++;
1316  if (j == EPV_CYCLES_LIGHTHOUSE) j = 0;
1317  }
1318 
1319  /* Dark blue water */
1320  s = (_settings_game.game_creation.landscape == LT_TOYLAND) ? ev->dark_water_toyland : ev->dark_water;
1321  j = EXTR(320, EPV_CYCLES_DARK_WATER);
1322  for (i = 0; i != EPV_CYCLES_DARK_WATER; i++) {
1323  *palette_pos++ = s[j];
1324  j++;
1325  if (j == EPV_CYCLES_DARK_WATER) j = 0;
1326  }
1327 
1328  /* Glittery water */
1330  j = EXTR(128, EPV_CYCLES_GLITTER_WATER);
1331  for (i = 0; i != EPV_CYCLES_GLITTER_WATER / 3; i++) {
1332  *palette_pos++ = s[j];
1333  j += 3;
1335  }
1336 
1337  if (blitter != nullptr && blitter->UsePaletteAnimation() == Blitter::PALETTE_ANIMATION_NONE) {
1338  palette_animation_counter = old_tc;
1339  } else {
1340  if (memcmp(old_val, &_cur_palette.palette[PALETTE_ANIM_START], sizeof(old_val)) != 0 && _cur_palette.count_dirty == 0) {
1341  /* Did we changed anything on the palette? Seems so. Mark it as dirty */
1344  }
1345  }
1346 }
1347 
1354 TextColour GetContrastColour(uint8 background, uint8 threshold)
1355 {
1356  Colour c = _cur_palette.palette[background];
1357  /* Compute brightness according to http://www.w3.org/TR/AERT#color-contrast.
1358  * The following formula computes 1000 * brightness^2, with brightness being in range 0 to 255. */
1359  uint sq1000_brightness = c.r * c.r * 299 + c.g * c.g * 587 + c.b * c.b * 114;
1360  /* Compare with threshold brightness which defaults to 128 (50%) */
1361  return sq1000_brightness < ((uint) threshold) * ((uint) threshold) * 1000 ? TC_WHITE : TC_BLACK;
1362 }
1363 
1368 void LoadStringWidthTable(bool monospace)
1369 {
1370  ClearFontCache();
1371 
1372  for (FontSize fs = monospace ? FS_MONO : FS_BEGIN; fs < (monospace ? FS_END : FS_MONO); fs++) {
1373  for (uint i = 0; i != 224; i++) {
1374  _stringwidth_table[fs][i] = GetGlyphWidth(fs, i + 32);
1375  }
1376  }
1377 
1378  ReInitAllWindows(false);
1379 }
1380 
1388 {
1389  /* Use _stringwidth_table cache if possible */
1390  if (key >= 32 && key < 256) return _stringwidth_table[size][key - 32];
1391 
1392  return GetGlyphWidth(size, key);
1393 }
1394 
1401 {
1402  byte width = 0;
1403  for (char c = '0'; c <= '9'; c++) {
1404  width = std::max(GetCharacterWidth(size, c), width);
1405  }
1406  return width;
1407 }
1408 
1415 void GetBroadestDigit(uint *front, uint *next, FontSize size)
1416 {
1417  int width = -1;
1418  for (char c = '9'; c >= '0'; c--) {
1419  int w = GetCharacterWidth(size, c);
1420  if (w > width) {
1421  width = w;
1422  *next = c - '0';
1423  if (c != '0') *front = c - '0';
1424  }
1425  }
1426 }
1427 
1428 void ScreenSizeChanged()
1429 {
1430  _dirty_bytes_per_line = CeilDiv(_screen.width, DIRTY_BLOCK_WIDTH);
1431  _dirty_blocks = ReallocT<byte>(_dirty_blocks, _dirty_bytes_per_line * CeilDiv(_screen.height, DIRTY_BLOCK_HEIGHT));
1432 
1433  /* check the dirty rect */
1434  if (_invalid_rect.right >= _screen.width) _invalid_rect.right = _screen.width;
1435  if (_invalid_rect.bottom >= _screen.height) _invalid_rect.bottom = _screen.height;
1436 
1437  /* screen size changed and the old bitmap is invalid now, so we don't want to undraw it */
1438  _cursor.visible = false;
1439 }
1440 
1441 void UndrawMouseCursor()
1442 {
1443  /* Don't undraw mouse cursor if it is handled by the video driver. */
1444  if (VideoDriver::GetInstance()->UseSystemCursor()) return;
1445 
1446  /* Don't undraw the mouse cursor if the screen is not ready */
1447  if (_screen.dst_ptr == nullptr) return;
1448 
1449  if (_cursor.visible) {
1451  _cursor.visible = false;
1452  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);
1453  VideoDriver::GetInstance()->MakeDirty(_cursor.draw_pos.x, _cursor.draw_pos.y, _cursor.draw_size.x, _cursor.draw_size.y);
1454  }
1455 }
1456 
1457 void DrawMouseCursor()
1458 {
1459  /* Don't draw mouse cursor if it is handled by the video driver. */
1460  if (VideoDriver::GetInstance()->UseSystemCursor()) return;
1461 
1462  /* Don't draw the mouse cursor if the screen is not ready */
1463  if (_screen.dst_ptr == nullptr) return;
1464 
1466 
1467  /* Redraw mouse cursor but only when it's inside the window */
1468  if (!_cursor.in_window) return;
1469 
1470  /* Don't draw the mouse cursor if it's already drawn */
1471  if (_cursor.visible) {
1472  if (!_cursor.dirty) return;
1473  UndrawMouseCursor();
1474  }
1475 
1476  /* Determine visible area */
1477  int left = _cursor.pos.x + _cursor.total_offs.x;
1478  int width = _cursor.total_size.x;
1479  if (left < 0) {
1480  width += left;
1481  left = 0;
1482  }
1483  if (left + width > _screen.width) {
1484  width = _screen.width - left;
1485  }
1486  if (width <= 0) return;
1487 
1488  int top = _cursor.pos.y + _cursor.total_offs.y;
1489  int height = _cursor.total_size.y;
1490  if (top < 0) {
1491  height += top;
1492  top = 0;
1493  }
1494  if (top + height > _screen.height) {
1495  height = _screen.height - top;
1496  }
1497  if (height <= 0) return;
1498 
1499  _cursor.draw_pos.x = left;
1500  _cursor.draw_pos.y = top;
1501  _cursor.draw_size.x = width;
1502  _cursor.draw_size.y = height;
1503 
1504  uint8 *buffer = _cursor_backup.Allocate(blitter->BufferSize(_cursor.draw_size.x, _cursor.draw_size.y));
1505 
1506  /* Make backup of stuff below cursor */
1507  blitter->CopyToBuffer(blitter->MoveTo(_screen.dst_ptr, _cursor.draw_pos.x, _cursor.draw_pos.y), buffer, _cursor.draw_size.x, _cursor.draw_size.y);
1508 
1509  /* Draw cursor on screen */
1510  _cur_dpi = &_screen;
1511  for (uint i = 0; i < _cursor.sprite_count; ++i) {
1512  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);
1513  }
1514 
1515  VideoDriver::GetInstance()->MakeDirty(_cursor.draw_pos.x, _cursor.draw_pos.y, _cursor.draw_size.x, _cursor.draw_size.y);
1516 
1517  _cursor.visible = true;
1518  _cursor.dirty = false;
1519 }
1520 
1531 void RedrawScreenRect(int left, int top, int right, int bottom)
1532 {
1533  assert(right <= _screen.width && bottom <= _screen.height);
1534  if (_cursor.visible) {
1535  if (right > _cursor.draw_pos.x &&
1536  left < _cursor.draw_pos.x + _cursor.draw_size.x &&
1537  bottom > _cursor.draw_pos.y &&
1538  top < _cursor.draw_pos.y + _cursor.draw_size.y) {
1539  UndrawMouseCursor();
1540  }
1541  }
1542 
1544 
1545  DrawOverlappedWindowForAll(left, top, right, bottom);
1546 
1547  VideoDriver::GetInstance()->MakeDirty(left, top, right - left, bottom - top);
1548 }
1549 
1558 {
1559  byte *b = _dirty_blocks;
1560  const int w = Align(_screen.width, DIRTY_BLOCK_WIDTH);
1561  const int h = Align(_screen.height, DIRTY_BLOCK_HEIGHT);
1562  int x;
1563  int y;
1564 
1565  y = 0;
1566  do {
1567  x = 0;
1568  do {
1569  if (*b != 0) {
1570  int left;
1571  int top;
1572  int right = x + DIRTY_BLOCK_WIDTH;
1573  int bottom = y;
1574  byte *p = b;
1575  int h2;
1576 
1577  /* First try coalescing downwards */
1578  do {
1579  *p = 0;
1580  p += _dirty_bytes_per_line;
1581  bottom += DIRTY_BLOCK_HEIGHT;
1582  } while (bottom != h && *p != 0);
1583 
1584  /* Try coalescing to the right too. */
1585  h2 = (bottom - y) / DIRTY_BLOCK_HEIGHT;
1586  assert(h2 > 0);
1587  p = b;
1588 
1589  while (right != w) {
1590  byte *p2 = ++p;
1591  int h = h2;
1592  /* Check if a full line of dirty flags is set. */
1593  do {
1594  if (!*p2) goto no_more_coalesc;
1595  p2 += _dirty_bytes_per_line;
1596  } while (--h != 0);
1597 
1598  /* Wohoo, can combine it one step to the right!
1599  * Do that, and clear the bits. */
1600  right += DIRTY_BLOCK_WIDTH;
1601 
1602  h = h2;
1603  p2 = p;
1604  do {
1605  *p2 = 0;
1606  p2 += _dirty_bytes_per_line;
1607  } while (--h != 0);
1608  }
1609  no_more_coalesc:
1610 
1611  left = x;
1612  top = y;
1613 
1614  if (left < _invalid_rect.left ) left = _invalid_rect.left;
1615  if (top < _invalid_rect.top ) top = _invalid_rect.top;
1616  if (right > _invalid_rect.right ) right = _invalid_rect.right;
1617  if (bottom > _invalid_rect.bottom) bottom = _invalid_rect.bottom;
1618 
1619  if (left < right && top < bottom) {
1620  RedrawScreenRect(left, top, right, bottom);
1621  }
1622 
1623  }
1624  } while (b++, (x += DIRTY_BLOCK_WIDTH) != w);
1625  } while (b += -(int)(w / DIRTY_BLOCK_WIDTH) + _dirty_bytes_per_line, (y += DIRTY_BLOCK_HEIGHT) != h);
1626 
1627  ++_dirty_block_colour;
1628  _invalid_rect.left = w;
1629  _invalid_rect.top = h;
1630  _invalid_rect.right = 0;
1631  _invalid_rect.bottom = 0;
1632 }
1633 
1646 void AddDirtyBlock(int left, int top, int right, int bottom)
1647 {
1648  byte *b;
1649  int width;
1650  int height;
1651 
1652  if (left < 0) left = 0;
1653  if (top < 0) top = 0;
1654  if (right > _screen.width) right = _screen.width;
1655  if (bottom > _screen.height) bottom = _screen.height;
1656 
1657  if (left >= right || top >= bottom) return;
1658 
1659  if (left < _invalid_rect.left ) _invalid_rect.left = left;
1660  if (top < _invalid_rect.top ) _invalid_rect.top = top;
1661  if (right > _invalid_rect.right ) _invalid_rect.right = right;
1662  if (bottom > _invalid_rect.bottom) _invalid_rect.bottom = bottom;
1663 
1664  left /= DIRTY_BLOCK_WIDTH;
1665  top /= DIRTY_BLOCK_HEIGHT;
1666 
1667  b = _dirty_blocks + top * _dirty_bytes_per_line + left;
1668 
1669  width = ((right - 1) / DIRTY_BLOCK_WIDTH) - left + 1;
1670  height = ((bottom - 1) / DIRTY_BLOCK_HEIGHT) - top + 1;
1671 
1672  assert(width > 0 && height > 0);
1673 
1674  do {
1675  int i = width;
1676 
1677  do b[--i] = 0xFF; while (i != 0);
1678 
1679  b += _dirty_bytes_per_line;
1680  } while (--height != 0);
1681 }
1682 
1690 {
1691  AddDirtyBlock(0, 0, _screen.width, _screen.height);
1692 }
1693 
1708 bool FillDrawPixelInfo(DrawPixelInfo *n, int left, int top, int width, int height)
1709 {
1711  const DrawPixelInfo *o = _cur_dpi;
1712 
1713  n->zoom = ZOOM_LVL_NORMAL;
1714 
1715  assert(width > 0);
1716  assert(height > 0);
1717 
1718  if ((left -= o->left) < 0) {
1719  width += left;
1720  if (width <= 0) return false;
1721  n->left = -left;
1722  left = 0;
1723  } else {
1724  n->left = 0;
1725  }
1726 
1727  if (width > o->width - left) {
1728  width = o->width - left;
1729  if (width <= 0) return false;
1730  }
1731  n->width = width;
1732 
1733  if ((top -= o->top) < 0) {
1734  height += top;
1735  if (height <= 0) return false;
1736  n->top = -top;
1737  top = 0;
1738  } else {
1739  n->top = 0;
1740  }
1741 
1742  n->dst_ptr = blitter->MoveTo(o->dst_ptr, left, top);
1743  n->pitch = o->pitch;
1744 
1745  if (height > o->height - top) {
1746  height = o->height - top;
1747  if (height <= 0) return false;
1748  }
1749  n->height = height;
1750 
1751  return true;
1752 }
1753 
1759 {
1760  /* Ignore setting any cursor before the sprites are loaded. */
1761  if (GetMaxSpriteID() == 0) return;
1762 
1763  static_assert(lengthof(_cursor.sprite_seq) == lengthof(_cursor.sprite_pos));
1764  assert(_cursor.sprite_count <= lengthof(_cursor.sprite_seq));
1765  for (uint i = 0; i < _cursor.sprite_count; ++i) {
1766  const Sprite *p = GetSprite(GB(_cursor.sprite_seq[i].sprite, 0, SPRITE_WIDTH), ST_NORMAL);
1767  Point offs, size;
1768  offs.x = UnScaleGUI(p->x_offs) + _cursor.sprite_pos[i].x;
1769  offs.y = UnScaleGUI(p->y_offs) + _cursor.sprite_pos[i].y;
1770  size.x = UnScaleGUI(p->width);
1771  size.y = UnScaleGUI(p->height);
1772 
1773  if (i == 0) {
1774  _cursor.total_offs = offs;
1775  _cursor.total_size = size;
1776  } else {
1777  int right = std::max(_cursor.total_offs.x + _cursor.total_size.x, offs.x + size.x);
1778  int bottom = std::max(_cursor.total_offs.y + _cursor.total_size.y, offs.y + size.y);
1779  if (offs.x < _cursor.total_offs.x) _cursor.total_offs.x = offs.x;
1780  if (offs.y < _cursor.total_offs.y) _cursor.total_offs.y = offs.y;
1781  _cursor.total_size.x = right - _cursor.total_offs.x;
1782  _cursor.total_size.y = bottom - _cursor.total_offs.y;
1783  }
1784  }
1785 
1786  _cursor.dirty = true;
1787 }
1788 
1794 static void SetCursorSprite(CursorID cursor, PaletteID pal)
1795 {
1796  if (_cursor.sprite_count == 1 && _cursor.sprite_seq[0].sprite == cursor && _cursor.sprite_seq[0].pal == pal) return;
1797 
1798  _cursor.sprite_count = 1;
1799  _cursor.sprite_seq[0].sprite = cursor;
1800  _cursor.sprite_seq[0].pal = pal;
1801  _cursor.sprite_pos[0].x = 0;
1802  _cursor.sprite_pos[0].y = 0;
1803 
1804  UpdateCursorSize();
1805 }
1806 
1807 static void SwitchAnimatedCursor()
1808 {
1809  const AnimCursor *cur = _cursor.animate_cur;
1810 
1811  if (cur == nullptr || cur->sprite == AnimCursor::LAST) cur = _cursor.animate_list;
1812 
1813  SetCursorSprite(cur->sprite, _cursor.sprite_seq[0].pal);
1814 
1815  _cursor.animate_timeout = cur->display_time;
1816  _cursor.animate_cur = cur + 1;
1817 }
1818 
1819 void CursorTick()
1820 {
1821  if (_cursor.animate_timeout != 0 && --_cursor.animate_timeout == 0) {
1822  SwitchAnimatedCursor();
1823  }
1824 }
1825 
1830 void SetMouseCursorBusy(bool busy)
1831 {
1832  if (busy) {
1833  if (_cursor.sprite_seq[0].sprite == SPR_CURSOR_MOUSE) SetMouseCursor(SPR_CURSOR_ZZZ, PAL_NONE);
1834  } else {
1835  if (_cursor.sprite_seq[0].sprite == SPR_CURSOR_ZZZ) SetMouseCursor(SPR_CURSOR_MOUSE, PAL_NONE);
1836  }
1837 }
1838 
1846 {
1847  /* Turn off animation */
1848  _cursor.animate_timeout = 0;
1849  /* Set cursor */
1850  SetCursorSprite(sprite, pal);
1851 }
1852 
1859 {
1860  _cursor.animate_list = table;
1861  _cursor.animate_cur = nullptr;
1862  _cursor.sprite_seq[0].pal = PAL_NONE;
1863  SwitchAnimatedCursor();
1864 }
1865 
1871 void CursorVars::UpdateCursorPositionRelative(int delta_x, int delta_y)
1872 {
1873  if (this->fix_at) {
1874  this->delta.x = delta_x;
1875  this->delta.y = delta_y;
1876  } else {
1877  int last_position_x = this->pos.x;
1878  int last_position_y = this->pos.y;
1879 
1880  this->pos.x = Clamp(this->pos.x + delta_x, 0, _cur_resolution.width - 1);
1881  this->pos.y = Clamp(this->pos.y + delta_y, 0, _cur_resolution.height - 1);
1882 
1883  this->delta.x = last_position_x - this->pos.x;
1884  this->delta.y = last_position_y - this->pos.y;
1885 
1886  this->dirty = true;
1887  }
1888 }
1889 
1898 bool CursorVars::UpdateCursorPosition(int x, int y, bool queued_warp)
1899 {
1900  /* Detecting relative mouse movement is somewhat tricky.
1901  * - There may be multiple mouse move events in the video driver queue (esp. when OpenTTD lags a bit).
1902  * - When we request warping the mouse position (return true), a mouse move event is appended at the end of the queue.
1903  *
1904  * So, when this->fix_at is active, we use the following strategy:
1905  * - The first movement triggers the warp to reset the mouse position.
1906  * - Subsequent events have to compute movement relative to the previous event.
1907  * - The relative movement is finished, when we receive the event matching the warp.
1908  */
1909 
1910  if (x == this->pos.x && y == this->pos.y) {
1911  /* Warp finished. */
1912  this->queued_warp = false;
1913  }
1914 
1915  this->delta.x = x - (this->queued_warp ? this->last_position.x : this->pos.x);
1916  this->delta.y = y - (this->queued_warp ? this->last_position.y : this->pos.y);
1917 
1918  this->last_position.x = x;
1919  this->last_position.y = y;
1920 
1921  bool need_warp = false;
1922  if (this->fix_at) {
1923  if (this->delta.x != 0 || this->delta.y != 0) {
1924  /* Trigger warp.
1925  * Note: We also trigger warping again, if there is already a pending warp.
1926  * This makes it more tolerant about the OS or other software in between
1927  * botchering the warp. */
1928  this->queued_warp = queued_warp;
1929  need_warp = true;
1930  }
1931  } else if (this->pos.x != x || this->pos.y != y) {
1932  this->queued_warp = false; // Cancel warping, we are no longer confining the position.
1933  this->dirty = true;
1934  this->pos.x = x;
1935  this->pos.y = y;
1936  }
1937  return need_warp;
1938 }
1939 
1940 bool ChangeResInGame(int width, int height)
1941 {
1942  return (_screen.width == width && _screen.height == height) || VideoDriver::GetInstance()->ChangeResolution(width, height);
1943 }
1944 
1945 bool ToggleFullScreen(bool fs)
1946 {
1947  bool result = VideoDriver::GetInstance()->ToggleFullscreen(fs);
1948  if (_fullscreen != fs && _resolutions.empty()) {
1949  Debug(driver, 0, "Could not find a suitable fullscreen resolution");
1950  }
1951  return result;
1952 }
1953 
1954 void SortResolutions()
1955 {
1956  std::sort(_resolutions.begin(), _resolutions.end());
1957 }
1958 
1963 {
1964  /* Determine real GUI zoom to use. */
1965  if (_gui_zoom_cfg == ZOOM_LVL_CFG_AUTO) {
1967  } else {
1968  /* Ensure the gui_zoom is clamped between min/max. Change the
1969  * _gui_zoom_cfg if it isn't, as this is used to visually show the
1970  * selection in the Game Options. */
1972  _gui_zoom = static_cast<ZoomLevel>(_gui_zoom_cfg);
1973  }
1974 
1975  /* Determine real font zoom to use. */
1976  if (_font_zoom_cfg == ZOOM_LVL_CFG_AUTO) {
1978  } else {
1979  _font_zoom = static_cast<ZoomLevel>(_font_zoom_cfg);
1980  }
1981 }
1982 
1983 void ChangeGameSpeed(bool enable_fast_forward)
1984 {
1985  if (enable_fast_forward) {
1987  } else {
1988  _game_speed = 100;
1989  }
1990 }
_dirkeys
byte _dirkeys
1 = left, 2 = up, 4 = right, 8 = down
Definition: gfx.cpp:31
NewGrfDebugSpritePicker::clicked_pixel
void * clicked_pixel
Clicked pixel (pointer to blitter buffer)
Definition: newgrf_debug.h:28
LoadStringWidthTable
void LoadStringWidthTable(bool monospace)
Initialize _stringwidth_table cache.
Definition: gfx.cpp:1368
PC_WHITE
static const uint8 PC_WHITE
White palette colour.
Definition: gfx_func.h:193
TC_FORCED
@ TC_FORCED
Ignore colour changes from strings.
Definition: gfx_type.h:275
GlyphID
uint32 GlyphID
Glyphs are characters from a font.
Definition: fontcache.h:17
SetMouseCursorBusy
void SetMouseCursorBusy(bool busy)
Set or unset the ZZZ cursor.
Definition: gfx.cpp:1830
SwitchMode
SwitchMode
Mode which defines what mode we're switching to.
Definition: openttd.h:25
factory.hpp
DrawBox
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:420
Palette::first_dirty
int first_dirty
The first dirty element.
Definition: gfx_type.h:315
Blitter::SetPixel
virtual void SetPixel(void *video, int x, int y, uint8 colour)=0
Draw a pixel with a given colour on the video-buffer.
SA_HOR_MASK
@ SA_HOR_MASK
Mask for horizontal alignment.
Definition: gfx_type.h:331
CursorVars
Collection of variables for cursor-display and -animation.
Definition: gfx_type.h:115
WChar
char32_t WChar
Type for wide characters, i.e.
Definition: string_type.h:35
AddDirtyBlock
void AddDirtyBlock(int left, int top, int right, int bottom)
Extend the internal _invalid_rect rectangle to contain the rectangle defined by the given parameters.
Definition: gfx.cpp:1646
UnScaleByZoomLower
static int UnScaleByZoomLower(int value, ZoomLevel zoom)
Scale by zoom level, usually shift right (when zoom > ZOOM_LVL_NORMAL)
Definition: zoom_func.h:56
_string_colourremap
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:77
ExtraPaletteValues
Description of tables for the palette animation.
Definition: palettes.h:104
PALETTE_TEXT_RECOLOUR
@ PALETTE_TEXT_RECOLOUR
Set if palette is actually a magic text recolour.
Definition: sprites.h:1522
GB
static uint GB(const T x, const uint8 s, const uint8 n)
Fetch n bits from x, started at bit s.
Definition: bitmath_func.hpp:32
CursorVars::animate_cur
const AnimCursor * animate_cur
in case of animated cursor, current frame
Definition: gfx_type.h:136
ReusableBuffer
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
Dimension
Dimensions (a width and height) of a rectangle in 2D.
Definition: geometry_type.hpp:27
Blitter::BlitterParams::top
int top
The top offset in the 'dst' in pixels to start drawing.
Definition: base.hpp:42
BM_TRANSPARENT
@ BM_TRANSPARENT
Perform transparency colour remapping.
Definition: base.hpp:20
Blitter::DrawColourMappingRect
virtual void DrawColourMappingRect(void *dst, int width, int height, PaletteID pal)=0
Draw a colourtable to the screen.
CursorVars::sprite_count
uint sprite_count
number of sprites to draw
Definition: gfx_type.h:130
palettes.h
Blitter::BlitterParams::skip_left
int skip_left
How much pixels of the source to skip on the left (based on zoom of dst)
Definition: base.hpp:35
CursorVars::dirty
bool dirty
the rect occupied by the mouse is dirty (redraw)
Definition: gfx_type.h:140
BlitterMode
BlitterMode
The modes of blitting we can do.
Definition: base.hpp:17
_left_button_down
bool _left_button_down
Is left mouse button pressed?
Definition: gfx.cpp:38
Blitter::BlitterParams::width
int width
The width in pixels that needs to be drawn to dst.
Definition: base.hpp:37
SPRITE_WIDTH
@ SPRITE_WIDTH
number of bits for the sprite number
Definition: sprites.h:1525
GameCreationSettings::landscape
byte landscape
the landscape we're currently in
Definition: settings_type.h:320
PALETTE_ANIM_SIZE
@ PALETTE_ANIM_SIZE
number of animated colours
Definition: gfx_type.h:281
Blitter::UsePaletteAnimation
virtual Blitter::PaletteAnimation UsePaletteAnimation()=0
Check if the blitter uses palette animation at all.
Sprite::data
byte data[]
Sprite data.
Definition: spritecache.h:22
GfxFillPolygon
void GfxFillPolygon(const std::vector< Point > &shape, int colour, FillRectMode mode)
Fill a polygon with colour.
Definition: gfx.cpp:212
lock
std::mutex lock
synchronization for playback status fields
Definition: win32_m.cpp:34
FS_BEGIN
@ FS_BEGIN
First font.
Definition: gfx_type.h:213
GetContrastColour
TextColour GetContrastColour(uint8 background, uint8 threshold)
Determine a contrasty text colour for a coloured background.
Definition: gfx.cpp:1354
Blitter
How all blitters should look like.
Definition: base.hpp:28
ExtraPaletteValues::lighthouse
Colour lighthouse[EPV_CYCLES_LIGHTHOUSE]
lighthouse & stadium
Definition: palettes.h:107
_palette
static const Palette _palette
Colour palette (DOS)
Definition: palettes.h:15
Blitter::BlitterParams::sprite_height
int sprite_height
Real height of the sprite.
Definition: base.hpp:40
CursorVars::visible
bool visible
cursor is visible
Definition: gfx_type.h:139
_newgrf_debug_sprite_picker
NewGrfDebugSpritePicker _newgrf_debug_sprite_picker
The sprite picker.
Definition: newgrf_debug_gui.cpp:48
Blitter::GetScreenDepth
virtual uint8 GetScreenDepth()=0
Get the screen depth this blitter works for.
Blitter::CopyToBuffer
virtual void CopyToBuffer(const void *video, void *dst, int width, int height)=0
Copy from the screen to a buffer.
FILLRECT_RECOLOUR
@ FILLRECT_RECOLOUR
Apply a recolour sprite to the screen content.
Definition: gfx_type.h:289
NewGrfDebugSpritePicker::sprites
std::vector< SpriteID > sprites
Sprites found.
Definition: newgrf_debug.h:29
VideoDriver::MakeDirty
virtual void MakeDirty(int left, int top, int width, int height)=0
Mark a particular area dirty.
VideoDriver::ToggleFullscreen
virtual bool ToggleFullscreen(bool fullscreen)=0
Change the full screen setting.
NewGrfDebugSpritePicker::mode
NewGrfDebugSpritePickerMode mode
Current state.
Definition: newgrf_debug.h:27
CursorVars::animate_list
const AnimCursor * animate_list
in case of animated cursor, list of frames
Definition: gfx_type.h:135
PalSpriteID::sprite
SpriteID sprite
The 'real' sprite.
Definition: gfx_type.h:23
HasBit
static bool HasBit(const T x, const uint8 y)
Checks if a bit in a value is set.
Definition: bitmath_func.hpp:103
Blitter::BlitterParams::dst
void * dst
Destination buffer.
Definition: base.hpp:44
UnScaleGUI
static int UnScaleGUI(int value)
Short-hand to apply GUI zoom level.
Definition: zoom_func.h:66
include
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,...
Definition: smallvec_type.hpp:27
Blitter::ScrollBuffer
virtual void ScrollBuffer(void *video, int &left, int &top, int &width, int &height, int scroll_x, int scroll_y)=0
Scroll the videobuffer some 'x' and 'y' value.
Sprite::height
uint16 height
Height of the sprite.
Definition: spritecache.h:18
_ctrl_pressed
bool _ctrl_pressed
Is Ctrl pressed?
Definition: gfx.cpp:35
FILLRECT_CHECKER
@ FILLRECT_CHECKER
Draw only every second pixel, used for greying-out.
Definition: gfx_type.h:288
_font_zoom_cfg
int8 _font_zoom_cfg
Font zoom level in config.
Definition: gfx.cpp:65
TextColour
TextColour
Colour of the strings, see _string_colourmap in table/string_colours.h or docs/ottd-colourtext-palett...
Definition: gfx_type.h:250
zoom_func.h
Sprite::x_offs
int16 x_offs
Number of pixels to shift the sprite to the right.
Definition: spritecache.h:20
Blitter::BlitterParams::sprite_width
int sprite_width
Real width of the sprite.
Definition: base.hpp:39
ZoomLevel
ZoomLevel
All zoom levels we know.
Definition: zoom_type.h:21
SA_BOTTOM
@ SA_BOTTOM
Bottom align the text.
Definition: gfx_type.h:335
Layouter::GetCharPosition
Point GetCharPosition(const char *ch) const
Get the position of a character in the layout.
Definition: gfx_layout.cpp:762
Blitter::BlitterParams::pitch
int pitch
The pitch of the destination buffer.
Definition: base.hpp:45
StringAlignment
StringAlignment
How to align the to-be drawn text.
Definition: gfx_type.h:327
_settings_client
ClientSettings _settings_client
The current settings for this game.
Definition: settings.cpp:52
DrawString
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:642
SetColourRemap
static void SetColourRemap(TextColour colour)
Set the colour remap to be for the given colour.
Definition: gfx.cpp:455
newgrf_debug.h
FillRectMode
FillRectMode
Define the operation GfxFillRect performs.
Definition: gfx_type.h:286
ST_NORMAL
@ ST_NORMAL
The most basic (normal) sprite.
Definition: gfx_type.h:302
CursorVars::UpdateCursorPositionRelative
void UpdateCursorPositionRelative(int delta_x, int delta_y)
Update cursor position on mouse movement for relative modes.
Definition: gfx.cpp:1871
SA_RIGHT
@ SA_RIGHT
Right align the text (must be a single bit).
Definition: gfx_type.h:330
SA_VERT_CENTER
@ SA_VERT_CENTER
Vertically center the text.
Definition: gfx_type.h:334
EPV_CYCLES_FIZZY_DRINK
static const uint EPV_CYCLES_FIZZY_DRINK
length of the fizzy drinks animation
Definition: palettes.h:100
_gui_zoom
ZoomLevel _gui_zoom
GUI Zoom level.
Definition: gfx.cpp:61
GfxDoDrawLine
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:315
VideoDriver::GetSuggestedUIZoom
virtual ZoomLevel GetSuggestedUIZoom()
Get a suggested default GUI zoom taking screen DPI into account.
Definition: video_driver.hpp:172
CursorVars::draw_size
Point draw_size
position and size bounding-box for drawing
Definition: gfx_type.h:133
SubSprite
Used to only draw a part of the sprite.
Definition: gfx_type.h:222
GUISettings::zoom_max
ZoomLevel zoom_max
maximum zoom out level
Definition: settings_type.h:130
_colour_gradient
byte _colour_gradient[COLOUR_END][8]
All 16 colour gradients 8 colours per gradient from darkest (0) to lightest (7)
Definition: gfx.cpp:52
CursorVars::sprite_pos
Point sprite_pos[16]
relative position of individual sprites
Definition: gfx_type.h:129
Blitter::DrawRect
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.
GetStringBoundingBox
Dimension GetStringBoundingBox(const char *str, FontSize start_fontsize)
Return the string dimension in pixels.
Definition: gfx.cpp:888
GetStringLineCount
int GetStringLineCount(StringID str, int maxw)
Calculates number of lines of string.
Definition: gfx.cpp:738
DrawStringMultiLine
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:787
_palette_mutex
static std::recursive_mutex _palette_mutex
To coordinate access to _cur_palette.
Definition: gfx.cpp:54
FontCache::GetDrawGlyphShadow
virtual bool GetDrawGlyphShadow()=0
Do we need to draw a glyph shadow?
GameSettings::game_creation
GameCreationSettings game_creation
settings used during the creation of a game (map)
Definition: settings_type.h:576
control_codes.h
UpdateCursorSize
void UpdateCursorSize()
Update cursor dimension.
Definition: gfx.cpp:1758
SpriteID
uint32 SpriteID
The number of a sprite, without mapping bits and colourtables.
Definition: gfx_type.h:17
BM_NORMAL
@ BM_NORMAL
Perform the simple blitting.
Definition: base.hpp:18
ParagraphLayouter::Line
A single line worth of VisualRuns.
Definition: gfx_layout.h:134
DrawLayoutLine
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:485
_extra_palette_values
static const ExtraPaletteValues _extra_palette_values
Actual palette animation tables.
Definition: palettes.h:115
ExtraPaletteValues::oil_refinery
Colour oil_refinery[EPV_CYCLES_OIL_REFINERY]
oil refinery
Definition: palettes.h:108
GfxBlitter
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:1071
Blitter::BlitterParams::sprite
const void * sprite
Pointer to the sprite how ever the encoder stored it.
Definition: base.hpp:32
DrawOverlappedWindowForAll
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:970
Blitter::Draw
virtual void Draw(Blitter::BlitterParams *bp, BlitterMode mode, ZoomLevel zoom)=0
Draw an image to the screen, given an amount of params defined above.
DRAW_STRING_BUFFER
static const int DRAW_STRING_BUFFER
Size of the buffer used for drawing strings.
Definition: gfx_func.h:85
Blitter::DrawLine
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.
GUISettings::fast_forward_speed_limit
uint16 fast_forward_speed_limit
Game speed to use when fast-forward is enabled.
Definition: settings_type.h:172
Align
static T Align(const T x, uint n)
Return the smallest multiple of n equal or greater than x.
Definition: math_func.hpp:35
CursorID
uint32 CursorID
The number of the cursor (sprite)
Definition: gfx_type.h:19
ExtraPaletteValues::glitter_water_toyland
Colour glitter_water_toyland[EPV_CYCLES_GLITTER_WATER]
glittery water Toyland
Definition: palettes.h:111
FS_NORMAL
@ FS_NORMAL
Index of the normal font in the font tables.
Definition: gfx_type.h:207
SA_TOP
@ SA_TOP
Top align the text.
Definition: gfx_type.h:333
SetMouseCursor
void SetMouseCursor(CursorID sprite, PaletteID pal)
Assign a single non-animated sprite to the cursor.
Definition: gfx.cpp:1845
PALETTE_WIDTH
@ PALETTE_WIDTH
number of bits of the sprite containing the recolour palette
Definition: sprites.h:1524
ReInitAllWindows
void ReInitAllWindows(bool zoom_changed)
Re-initialize all windows.
Definition: window.cpp:3331
CursorVars::UpdateCursorPosition
bool UpdateCursorPosition(int x, int y, bool queued_warp)
Update cursor position on mouse movement.
Definition: gfx.cpp:1898
_screen_disable_anim
bool _screen_disable_anim
Disable palette animation (important for 32bpp-anim blitter during giant screenshot)
Definition: gfx.cpp:43
Palette::palette
Colour palette[256]
Current palette. Entry 0 has to be always fully transparent!
Definition: gfx_type.h:314
Layouter::GetBounds
Dimension GetBounds()
Get the boundaries of this paragraph.
Definition: gfx_layout.cpp:746
BM_COLOUR_REMAP
@ BM_COLOUR_REMAP
Perform a colour remapping.
Definition: base.hpp:19
Layouter
The layouter performs all the layout work.
Definition: gfx_layout.h:153
_pause_mode
PauseMode _pause_mode
The current pause mode.
Definition: gfx.cpp:47
FONT_HEIGHT_MONO
#define FONT_HEIGHT_MONO
Height of characters in the large (FS_MONO) font.
Definition: gfx_func.h:171
_string_colourmap
static const byte _string_colourmap[17]
Colour mapping for TextColour.
Definition: string_colours.h:11
_settings_game
GameSettings _settings_game
Game settings of a running game or the scenario editor.
Definition: settings.cpp:53
TC_IS_PALETTE_COLOUR
@ TC_IS_PALETTE_COLOUR
Colour value is already a real palette colour index, not an index of a StringColour.
Definition: gfx_type.h:273
BlitterFactory::GetCurrentBlitter
static Blitter * GetCurrentBlitter()
Get the current active blitter (always set by calling SelectBlitter).
Definition: factory.hpp:141
SA_FORCE
@ SA_FORCE
Force the alignment, i.e. don't swap for RTL languages.
Definition: gfx_type.h:340
CursorVars::total_size
Point total_size
union of sprite properties
Definition: gfx_type.h:131
GetCharAtPosition
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:944
BM_CRASH_REMAP
@ BM_CRASH_REMAP
Perform a crash remapping.
Definition: base.hpp:21
EPV_CYCLES_OIL_REFINERY
static const uint EPV_CYCLES_OIL_REFINERY
length of the oil refinery's fire animation
Definition: palettes.h:99
safeguards.h
Sprite::width
uint16 width
Width of the sprite.
Definition: spritecache.h:19
AnimCursor::sprite
CursorID sprite
Must be set to LAST_ANIM when it is the last sprite of the loop.
Definition: gfx_type.h:110
_resolutions
std::vector< Dimension > _resolutions
List of resolutions.
Definition: driver.cpp:24
CursorVars::fix_at
bool fix_at
mouse is moving, but cursor is not (used for scrolling)
Definition: gfx_type.h:120
RedrawScreenRect
void RedrawScreenRect(int left, int top, int right, int bottom)
Repaints a specific rectangle of the screen.
Definition: gfx.cpp:1531
VideoDriver::ChangeResolution
virtual bool ChangeResolution(int w, int h)=0
Change the resolution of the window.
TC_NO_SHADE
@ TC_NO_SHADE
Do not add shading to this text colour.
Definition: gfx_type.h:274
_networking
bool _networking
are we in networking mode?
Definition: network.cpp:56
_shift_pressed
bool _shift_pressed
Is Shift pressed?
Definition: gfx.cpp:36
DrawDirtyBlocks
void DrawDirtyBlocks()
Repaints the rectangle blocks which are marked as 'dirty'.
Definition: gfx.cpp:1557
FONT_HEIGHT_LARGE
#define FONT_HEIGHT_LARGE
Height of characters in the large (FS_LARGE) font.
Definition: gfx_func.h:168
DrawSprite
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:1041
gfx_layout.h
settings_type.h
GetStringMultiLineBoundingBox
Dimension GetStringMultiLineBoundingBox(StringID str, const Dimension &suggestion)
Calculate string bounding box for multi-line strings.
Definition: gfx.cpp:753
sprites.h
Point
Coordinates of a point in 2D.
Definition: geometry_type.hpp:21
NetworkUndrawChatMessage
void NetworkUndrawChatMessage()
Hide the chatbox.
Definition: network_chat_gui.cpp:126
DrawCharCentered
void DrawCharCentered(WChar c, const Rect &r, TextColour colour)
Draw single character horizontally centered around (x,y)
Definition: gfx.cpp:959
PauseMode
PauseMode
Modes of pausing we've got.
Definition: openttd.h:60
BM_BLACK_REMAP
@ BM_BLACK_REMAP
Perform remapping to a completely blackened sprite.
Definition: base.hpp:22
UnScaleByZoom
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
SetAnimatedMouseCursor
void SetAnimatedMouseCursor(const AnimCursor *table)
Assign an animation to the cursor.
Definition: gfx.cpp:1858
stdafx.h
GameMode
GameMode
Mode which defines the state of the game.
Definition: openttd.h:17
RoundDivSU
static int RoundDivSU(int a, uint b)
Computes round(a / b) for signed a and unsigned b.
Definition: math_func.hpp:276
GfxFillRect
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:116
FontCache::GetGlyphWidth
virtual uint GetGlyphWidth(GlyphID key)=0
Get the width of the glyph with the given key.
_invalid_rect
static Rect _invalid_rect
The rect for repaint.
Definition: gfx.cpp:75
Palette::count_dirty
int count_dirty
The number of dirty elements.
Definition: gfx_type.h:316
PALETTE_MODIFIER_TRANSPARENT
@ PALETTE_MODIFIER_TRANSPARENT
when a sprite is to be displayed transparently, this bit needs to be set.
Definition: sprites.h:1539
VideoDriver::GetInstance
static VideoDriver * GetInstance()
Get the currently active instance of the video driver.
Definition: video_driver.hpp:199
SA_HOR_CENTER
@ SA_HOR_CENTER
Horizontally center the text.
Definition: gfx_type.h:329
PALETTE_ANIM_START
@ PALETTE_ANIM_START
Index in the _palettes array from which all animations are taking places (table/palettes....
Definition: gfx_type.h:282
GetDigitWidth
byte GetDigitWidth(FontSize size)
Return the maximum width of single digit.
Definition: gfx.cpp:1400
string_colours.h
GetBroadestDigit
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:1415
FillDrawPixelInfo
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:1708
FONT_HEIGHT_SMALL
#define FONT_HEIGHT_SMALL
Height of characters in the small (FS_SMALL) font.
Definition: gfx_func.h:162
ParagraphLayouter::VisualRun
Visual run contains data about the bit of text with the same font.
Definition: gfx_layout.h:122
Colour
Structure to access the alpha, red, green, and blue channels from a 32 bit number.
Definition: gfx_type.h:163
GetGlyphWidth
static uint GetGlyphWidth(FontSize size, WChar key)
Get the width of a glyph.
Definition: fontcache.h:204
GetStringHeight
int GetStringHeight(const char *str, int maxw, FontSize fontsize)
Calculates height of string (in pixels).
Definition: gfx.cpp:713
GetSpriteSize
Dimension GetSpriteSize(SpriteID sprid, Point *offset, ZoomLevel zoom)
Get the size of a sprite.
Definition: gfx.cpp:976
GUISettings::zoom_min
ZoomLevel zoom_min
minimum zoom out level
Definition: settings_type.h:129
_gui_zoom_cfg
int8 _gui_zoom_cfg
GUI zoom level in config.
Definition: gfx.cpp:64
_switch_mode
SwitchMode _switch_mode
The next mainloop command.
Definition: gfx.cpp:46
_font_zoom
ZoomLevel _font_zoom
Font Zoom level.
Definition: gfx.cpp:62
StringID
uint32 StringID
Numeric value that represents a string, independent of the selected language.
Definition: strings_type.h:16
Clamp
static T Clamp(const T a, const T min, const T max)
Clamp a value between an interval.
Definition: math_func.hpp:77
PALETTE_CRASH
static const PaletteID PALETTE_CRASH
Recolour sprite greying of crashed vehicles.
Definition: sprites.h:1600
strings_func.h
CursorVars::animate_timeout
uint animate_timeout
in case of animated cursor, number of ticks to show the current cursor
Definition: gfx_type.h:137
ScaleByZoom
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
SA_VERT_MASK
@ SA_VERT_MASK
Mask for vertical alignment.
Definition: gfx_type.h:336
FontCache
Font cache for basic fonts.
Definition: fontcache.h:21
Blitter::MoveTo
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...
FONT_HEIGHT_NORMAL
#define FONT_HEIGHT_NORMAL
Height of characters in the normal (FS_NORMAL) font.
Definition: gfx_func.h:165
video_driver.hpp
FontCache::GetGlyph
virtual const Sprite * GetGlyph(GlyphID key)=0
Get the glyph (sprite) of the given key.
GetMaxSpriteID
uint GetMaxSpriteID()
Get a reasonable (upper bound) estimate of the maximum SpriteID used in OpenTTD; there will be no spr...
Definition: spritecache.cpp:220
Layouter::GetCharAtPosition
const char * GetCharAtPosition(int x) const
Get the character that is at a position.
Definition: gfx_layout.cpp:809
PaletteID
uint32 PaletteID
The number of the palette.
Definition: gfx_type.h:18
_stringwidth_table
static byte _stringwidth_table[FS_END][224]
Cache containing width of often used characters.
Definition: gfx.cpp:50
GetGlyph
static const Sprite * GetGlyph(FontSize size, WChar key)
Get the Sprite for a glyph.
Definition: fontcache.h:197
EPV_CYCLES_LIGHTHOUSE
static const uint EPV_CYCLES_LIGHTHOUSE
length of the lighthouse/stadium animation
Definition: palettes.h:98
CopyPalette
bool CopyPalette(Palette &local_palette, bool force_copy)
Copy the current palette if the palette was updated.
Definition: gfx.cpp:1216
AnimCursor::display_time
byte display_time
Amount of ticks this sprite will be shown.
Definition: gfx_type.h:111
Blitter::BlitterParams::left
int left
The left offset in the 'dst' in pixels to start drawing.
Definition: base.hpp:41
CursorVars::delta
Point delta
relative mouse movement in this tick
Definition: gfx_type.h:118
GetBlitterMode
static BlitterMode GetBlitterMode(PaletteID pal)
Helper function to get the blitter mode for different types of palettes.
Definition: gfx.cpp:996
ExtraPaletteValues::dark_water
Colour dark_water[EPV_CYCLES_DARK_WATER]
dark blue water
Definition: palettes.h:105
MakePolygonSegments
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:173
progress.h
GfxPreprocessLine
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:373
SetCursorSprite
static void SetCursorSprite(CursorID cursor, PaletteID pal)
Switch cursor to different sprite.
Definition: gfx.cpp:1794
Sprite::y_offs
int16 y_offs
Number of pixels to shift the sprite downwards.
Definition: spritecache.h:21
Blitter::PALETTE_ANIMATION_NONE
@ PALETTE_ANIMATION_NONE
No palette animation.
Definition: base.hpp:50
AnimCursor
A single sprite of a list of animated cursors.
Definition: gfx_type.h:108
abs
static T abs(const T a)
Returns the absolute value of (scalar) variable.
Definition: math_func.hpp:21
_cur_palette
Palette _cur_palette
Current palette.
Definition: gfx.cpp:48
SA_LEFT
@ SA_LEFT
Left align the text.
Definition: gfx_type.h:328
network.h
GetCharacterWidth
byte GetCharacterWidth(FontSize size, WChar key)
Return width of character glyph.
Definition: gfx.cpp:1387
Blitter::CopyFromBuffer
virtual void CopyFromBuffer(void *video, const void *src, int width, int height)=0
Copy from a buffer to the screen.
window_func.h
CenterBounds
static int CenterBounds(int min, int max, int size)
Determine where to draw a centred object inside a widget.
Definition: gfx_func.h:137
Debug
#define Debug(name, level, format_string,...)
Ouptut a line of debugging information.
Definition: debug.h:37
CursorVars::sprite_seq
PalSpriteID sprite_seq[16]
current image of cursor
Definition: gfx_type.h:128
EPV_CYCLES_DARK_WATER
static const uint EPV_CYCLES_DARK_WATER
Description of the length of the palette cycle animations.
Definition: palettes.h:97
lengthof
#define lengthof(x)
Return the length of an fixed size array.
Definition: stdafx.h:378
MarkWholeScreenDirty
void MarkWholeScreenDirty()
This function mark the whole screen as dirty.
Definition: gfx.cpp:1689
Blitter::BlitterParams
Parameters related to blitting.
Definition: base.hpp:31
FS_MONO
@ FS_MONO
Index of the monospaced font in the font tables.
Definition: gfx_type.h:210
ZOOM_LVL_NORMAL
@ ZOOM_LVL_NORMAL
The normal zoom level.
Definition: zoom_type.h:24
SPR_CURSOR_MOUSE
static const CursorID SPR_CURSOR_MOUSE
Cursor sprite numbers.
Definition: sprites.h:1380
CeilDiv
static uint CeilDiv(uint a, uint b)
Computes ceil(a / b) for non-negative a and b.
Definition: math_func.hpp:254
PalSpriteID::pal
PaletteID pal
The palette (use PAL_NONE) if not needed)
Definition: gfx_type.h:24
Blitter::BlitterParams::height
int height
The height in pixels that needs to be drawn to dst.
Definition: base.hpp:38
FontSize
FontSize
Available font sizes.
Definition: gfx_type.h:206
ST_RECOLOUR
@ ST_RECOLOUR
Recolour sprite.
Definition: gfx_type.h:305
ExtraPaletteValues::dark_water_toyland
Colour dark_water_toyland[EPV_CYCLES_DARK_WATER]
dark blue water Toyland
Definition: palettes.h:106
ExtraPaletteValues::fizzy_drink
Colour fizzy_drink[EPV_CYCLES_FIZZY_DRINK]
fizzy drinks
Definition: palettes.h:109
Rect
Specification of a rectangle with absolute coordinates of all edges.
Definition: geometry_type.hpp:47
CursorVars::pos
Point pos
logical mouse position
Definition: gfx_type.h:117
Blitter::BlitterParams::skip_top
int skip_top
How much pixels of the source to skip on the top (based on zoom of dst)
Definition: base.hpp:36
FontCache::MapCharToGlyph
virtual GlyphID MapCharToGlyph(WChar key)=0
Map a character into a glyph.
_right_button_clicked
bool _right_button_clicked
Is right mouse button clicked?
Definition: gfx.cpp:41
Palette
Information about the currently used palette.
Definition: gfx_type.h:313
EPV_CYCLES_GLITTER_WATER
static const uint EPV_CYCLES_GLITTER_WATER
length of the glittery water animation
Definition: palettes.h:101
Sprite
Data structure describing a sprite.
Definition: spritecache.h:17
GetCharPosInString
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:931
thread.h
CursorVars::in_window
bool in_window
mouse inside this window, determines drawing logic
Definition: gfx_type.h:141
Blitter::BlitterParams::remap
const byte * remap
XXX – Temporary storage for remap array.
Definition: base.hpp:33
lastof
#define lastof(x)
Get the last element of an fixed size array.
Definition: stdafx.h:394
UpdateGUIZoom
void UpdateGUIZoom()
Resolve GUI zoom level, if auto-suggestion is requested.
Definition: gfx.cpp:1962
_left_button_clicked
bool _left_button_clicked
Is left mouse button clicked?
Definition: gfx.cpp:39
_cur_resolution
Dimension _cur_resolution
The current resolution.
Definition: driver.cpp:25
TD_RTL
@ TD_RTL
Text is written right-to-left by default.
Definition: strings_type.h:24
network_func.h
_current_text_dir
TextDirection _current_text_dir
Text direction of the currently selected language.
Definition: strings.cpp:48
ExtraPaletteValues::glitter_water
Colour glitter_water[EPV_CYCLES_GLITTER_WATER]
glittery water
Definition: palettes.h:110
_game_speed
uint16 _game_speed
Current game-speed; 100 is 1x, 0 is infinite.
Definition: gfx.cpp:37
_right_button_down
bool _right_button_down
Is right mouse button pressed?
Definition: gfx.cpp:40
PALETTE_ALL_BLACK
static const PaletteID PALETTE_ALL_BLACK
Exchange any color by black, needed for painting fictive tiles outside map.
Definition: sprites.h:1606
ClientSettings::gui
GUISettings gui
settings related to the GUI
Definition: settings_type.h:593
DrawPixelInfo
Data about how and where to blit pixels.
Definition: gfx_type.h:155
Blitter::BufferSize
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.
DrawSpriteViewport
void DrawSpriteViewport(SpriteID img, PaletteID pal, int x, int y, const SubSprite *sub)
Draw a sprite in a viewport.
Definition: gfx.cpp:1014