OpenTTD Source: src/gfx.cpp Source File

OpenTTD Source 14.0-beta1

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_gui.h"
21 #include "window_func.h"
22 #include "newgrf_debug.h"
23 #include "core/backup_type.hpp"
24 #include "core/container_func.hpp"
25 #include "viewport_func.h"
26
27 #include "table/string_colours.h"
28 #include "table/sprites.h"
29 #include "table/control_codes.h"
30
31 #include "safeguards.h"
32
33 byte _dirkeys;
34 bool _fullscreen;
35 byte _support8bpp;
36 CursorVars _cursor;
37 bool _ctrl_pressed;
38 bool _shift_pressed;
39 uint16_t _game_speed = 100;
40 bool _left_button_down;
41 bool _left_button_clicked;
42 bool _right_button_down;
43 bool _right_button_clicked;
44 DrawPixelInfo _screen;
45 bool _screen_disable_anim = false;
46 std::atomic<bool> _exit_game;
47 GameMode _game_mode;
48 SwitchMode _switch_mode;
49 std::chrono::steady_clock::time_point _switch_mode_time;
50 PauseMode _pause_mode;
51
52 static byte _stringwidth_table[FS_END][224];
53 DrawPixelInfo *_cur_dpi;
54
55 static void GfxMainBlitterViewport(const Sprite *sprite, int x, int y, BlitterMode mode, const SubSprite *sub = nullptr, SpriteID sprite_id = SPR_CURSOR_MOUSE);
56 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);
57
58 static ReusableBuffer<uint8_t> _cursor_backup;
59
60 ZoomLevel _gui_zoom = ZOOM_LVL_OUT_4X;
61 ZoomLevel _font_zoom = _gui_zoom;
62 int _gui_scale = MIN_INTERFACE_SCALE;
63 int _gui_scale_cfg;
64
72 static Rect _invalid_rect;
73 static const byte *_colour_remap_ptr;
74 static byte _string_colourremap[3];
75
76 static const uint DIRTY_BLOCK_HEIGHT = 8;
77 static const uint DIRTY_BLOCK_WIDTH = 64;
78
79 static uint _dirty_bytes_per_line = 0;
80 static byte *_dirty_blocks = nullptr;
81 extern uint _dirty_block_colour;
82
83 void GfxScroll(int left, int top, int width, int height, int xo, int yo)
84 {
85 Blitter *blitter = BlitterFactory::GetCurrentBlitter();
86
87 if (xo == 0 && yo == 0) return;
88
89 if (_cursor.visible) UndrawMouseCursor();
90
91 if (_networking) NetworkUndrawChatMessage();
92
93 blitter->ScrollBuffer(_screen.dst_ptr, left, top, width, height, xo, yo);
94 /* This part of the screen is now dirty. */
95 VideoDriver::GetInstance()->MakeDirty(left, top, width, height);
96 }
97
98
113 void GfxFillRect(int left, int top, int right, int bottom, int colour, FillRectMode mode)
114 {
115 Blitter *blitter = BlitterFactory::GetCurrentBlitter();
116 const DrawPixelInfo *dpi = _cur_dpi;
117 void *dst;
118 const int otop = top;
119 const int oleft = left;
120
121 if (dpi->zoom != ZOOM_LVL_NORMAL) return;
122 if (left > right || top > bottom) return;
123 if (right < dpi->left || left >= dpi->left + dpi->width) return;
124 if (bottom < dpi->top || top >= dpi->top + dpi->height) return;
125
126 if ( (left -= dpi->left) < 0) left = 0;
127 right = right - dpi->left + 1;
128 if (right > dpi->width) right = dpi->width;
129 right -= left;
130 assert(right > 0);
131
132 if ( (top -= dpi->top) < 0) top = 0;
133 bottom = bottom - dpi->top + 1;
134 if (bottom > dpi->height) bottom = dpi->height;
135 bottom -= top;
136 assert(bottom > 0);
137
138 dst = blitter->MoveTo(dpi->dst_ptr, left, top);
139
140 switch (mode) {
141 default: // FILLRECT_OPAQUE
142 blitter->DrawRect(dst, right, bottom, (uint8_t)colour);
143 break;
144
145 case FILLRECT_RECOLOUR:
146 blitter->DrawColourMappingRect(dst, right, bottom, GB(colour, 0, PALETTE_WIDTH));
147 break;
148
149 case FILLRECT_CHECKER: {
150 byte bo = (oleft - left + dpi->left + otop - top + dpi->top) & 1;
151 do {
152 for (int i = (bo ^= 1); i < right; i += 2) blitter->SetPixel(dst, i, 0, (uint8_t)colour);
153 dst = blitter->MoveTo(dst, 0, 1);
154 } while (--bottom > 0);
155 break;
156 }
157 }
158 }
159
160 typedef std::pair<Point, Point> LineSegment;
161
170 static std::vector<LineSegment> MakePolygonSegments(const std::vector<Point> &shape, Point offset)
171 {
172 std::vector<LineSegment> segments;
173 if (shape.size() < 3) return segments; // fewer than 3 will always result in an empty polygon
174 segments.reserve(shape.size());
175
176 /* Connect first and last point by having initial previous point be the last */
177 Point prev = shape.back();
178 prev.x -= offset.x;
179 prev.y -= offset.y;
180 for (Point pt : shape) {
181 pt.x -= offset.x;
182 pt.y -= offset.y;
183 /* Create segments for all non-horizontal lines in the polygon.
184 * The segments always have lowest Y coordinate first. */
185 if (prev.y > pt.y) {
186 segments.emplace_back(pt, prev);
187 } else if (prev.y < pt.y) {
188 segments.emplace_back(prev, pt);
189 }
190 prev = pt;
191 }
192
193 return segments;
194 }
195
209 void GfxFillPolygon(const std::vector<Point> &shape, int colour, FillRectMode mode)
210 {
211 Blitter *blitter = BlitterFactory::GetCurrentBlitter();
212 const DrawPixelInfo *dpi = _cur_dpi;
213 if (dpi->zoom != ZOOM_LVL_NORMAL) return;
214
215 std::vector<LineSegment> segments = MakePolygonSegments(shape, Point{ dpi->left, dpi->top });
216
217 /* Remove segments appearing entirely above or below the clipping area. */
218 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());
219
220 /* Check that this wasn't an empty shape (all points on a horizontal line or outside clipping.) */
221 if (segments.empty()) return;
222
223 /* Sort the segments by first point Y coordinate. */
224 std::sort(segments.begin(), segments.end(), [](const LineSegment &a, const LineSegment &b) { return a.first.y < b.first.y; });
225
226 /* Segments intersecting current scanline. */
227 std::vector<LineSegment> active;
228 /* Intersection points with a scanline.
229 * Kept outside loop to avoid repeated re-allocations. */
230 std::vector<int> intersections;
231 /* Normal, reasonable polygons don't have many intersections per scanline. */
232 active.reserve(4);
233 intersections.reserve(4);
234
235 /* Scan through the segments and paint each scanline. */
236 int y = segments.front().first.y;
237 std::vector<LineSegment>::iterator nextseg = segments.begin();
238 while (!active.empty() || nextseg != segments.end()) {
239 /* Clean up segments that have ended. */
240 active.erase(std::remove_if(active.begin(), active.end(), [y](const LineSegment &s) { return s.second.y == y; }), active.end());
241
242 /* Activate all segments starting on this scanline. */
243 while (nextseg != segments.end() && nextseg->first.y == y) {
244 active.push_back(*nextseg);
245 ++nextseg;
246 }
247
248 /* Check clipping. */
249 if (y < 0) {
250 ++y;
251 continue;
252 }
253 if (y >= dpi->height) return;
254
255 /* Intersect scanline with all active segments. */
256 intersections.clear();
257 for (const LineSegment &s : active) {
258 const int sdx = s.second.x - s.first.x;
259 const int sdy = s.second.y - s.first.y;
260 const int ldy = y - s.first.y;
261 const int x = s.first.x + sdx * ldy / sdy;
262 intersections.push_back(x);
263 }
264
265 /* Fill between pairs of intersections. */
266 std::sort(intersections.begin(), intersections.end());
267 for (size_t i = 1; i < intersections.size(); i += 2) {
268 /* Check clipping. */
269 const int x1 = std::max(0, intersections[i - 1]);
270 const int x2 = std::min(intersections[i], dpi->width);
271 if (x2 < 0) continue;
272 if (x1 >= dpi->width) continue;
273
274 /* Fill line y from x1 to x2. */
275 void *dst = blitter->MoveTo(dpi->dst_ptr, x1, y);
276 switch (mode) {
277 default: // FILLRECT_OPAQUE
278 blitter->DrawRect(dst, x2 - x1, 1, (uint8_t)colour);
279 break;
280 case FILLRECT_RECOLOUR:
281 blitter->DrawColourMappingRect(dst, x2 - x1, 1, GB(colour, 0, PALETTE_WIDTH));
282 break;
283 case FILLRECT_CHECKER:
284 /* Fill every other pixel, offset such that the sum of filled pixels' X and Y coordinates is odd.
285 * This creates a checkerboard effect. */
286 for (int x = (x1 + y) & 1; x < x2 - x1; x += 2) {
287 blitter->SetPixel(dst, x, 0, (uint8_t)colour);
288 }
289 break;
290 }
291 }
292
293 /* Next line */
294 ++y;
295 }
296 }
297
312 static inline void GfxDoDrawLine(void *video, int x, int y, int x2, int y2, int screen_width, int screen_height, uint8_t colour, int width, int dash = 0)
313 {
314 Blitter *blitter = BlitterFactory::GetCurrentBlitter();
315
316 assert(width > 0);
317
318 if (y2 == y || x2 == x) {
319 /* Special case: horizontal/vertical line. All checks already done in GfxPreprocessLine. */
320 blitter->DrawLine(video, x, y, x2, y2, screen_width, screen_height, colour, width, dash);
321 return;
322 }
323
324 int grade_y = y2 - y;
325 int grade_x = x2 - x;
326
327 /* Clipping rectangle. Slightly extended so we can ignore the width of the line. */
328 int extra = (int)CeilDiv(3 * width, 4); // not less then "width * sqrt(2) / 2"
329 Rect clip = { -extra, -extra, screen_width - 1 + extra, screen_height - 1 + extra };
330
331 /* prevent integer overflows. */
332 int margin = 1;
333 while (INT_MAX / abs(grade_y) < std::max(abs(clip.left - x), abs(clip.right - x))) {
334 grade_y /= 2;
335 grade_x /= 2;
336 margin *= 2; // account for rounding errors
337 }
338
339 /* Imagine that the line is infinitely long and it intersects with
340 * infinitely long left and right edges of the clipping rectangle.
341 * If both intersection points are outside the clipping rectangle
342 * and both on the same side of it, we don't need to draw anything. */
343 int left_isec_y = y + (clip.left - x) * grade_y / grade_x;
344 int right_isec_y = y + (clip.right - x) * grade_y / grade_x;
345 if ((left_isec_y > clip.bottom + margin && right_isec_y > clip.bottom + margin) ||
346 (left_isec_y < clip.top - margin && right_isec_y < clip.top - margin)) {
347 return;
348 }
349
350 /* It is possible to use the line equation to further reduce the amount of
351 * work the blitter has to do by shortening the effective line segment.
352 * However, in order to get that right and prevent the flickering effects
353 * of rounding errors so much additional code has to be run here that in
354 * the general case the effect is not noticeable. */
355
356 blitter->DrawLine(video, x, y, x2, y2, screen_width, screen_height, colour, width, dash);
357 }
358
370 static inline bool GfxPreprocessLine(DrawPixelInfo *dpi, int &x, int &y, int &x2, int &y2, int width)
371 {
372 x -= dpi->left;
373 x2 -= dpi->left;
374 y -= dpi->top;
375 y2 -= dpi->top;
376
377 /* Check simple clipping */
378 if (x + width / 2 < 0 && x2 + width / 2 < 0 ) return false;
379 if (y + width / 2 < 0 && y2 + width / 2 < 0 ) return false;
380 if (x - width / 2 > dpi->width && x2 - width / 2 > dpi->width ) return false;
381 if (y - width / 2 > dpi->height && y2 - width / 2 > dpi->height) return false;
382 return true;
383 }
384
385 void GfxDrawLine(int x, int y, int x2, int y2, int colour, int width, int dash)
386 {
387 DrawPixelInfo *dpi = _cur_dpi;
388 if (GfxPreprocessLine(dpi, x, y, x2, y2, width)) {
389 GfxDoDrawLine(dpi->dst_ptr, x, y, x2, y2, dpi->width, dpi->height, colour, width, dash);
390 }
391 }
392
393 void GfxDrawLineUnscaled(int x, int y, int x2, int y2, int colour)
394 {
395 DrawPixelInfo *dpi = _cur_dpi;
396 if (GfxPreprocessLine(dpi, x, y, x2, y2, 1)) {
397 GfxDoDrawLine(dpi->dst_ptr,
398 UnScaleByZoom(x, dpi->zoom), UnScaleByZoom(y, dpi->zoom),
399 UnScaleByZoom(x2, dpi->zoom), UnScaleByZoom(y2, dpi->zoom),
400 UnScaleByZoom(dpi->width, dpi->zoom), UnScaleByZoom(dpi->height, dpi->zoom), colour, 1);
401 }
402 }
403
417 void DrawBox(int x, int y, int dx1, int dy1, int dx2, int dy2, int dx3, int dy3)
418 {
419 /* ....
420 * .. ....
421 * .. ....
422 * .. ^
423 * <--__(dx1,dy1) /(dx2,dy2)
424 * : --__ / :
425 * : --__ / :
426 * : *(x,y) :
427 * : | :
428 * : | ..
429 * .... |(dx3,dy3)
430 * .... | ..
431 * ....V.
432 */
433
434 static const byte colour = PC_WHITE;
435
436 GfxDrawLineUnscaled(x, y, x + dx1, y + dy1, colour);
437 GfxDrawLineUnscaled(x, y, x + dx2, y + dy2, colour);
438 GfxDrawLineUnscaled(x, y, x + dx3, y + dy3, colour);
439
440 GfxDrawLineUnscaled(x + dx1, y + dy1, x + dx1 + dx2, y + dy1 + dy2, colour);
441 GfxDrawLineUnscaled(x + dx1, y + dy1, x + dx1 + dx3, y + dy1 + dy3, colour);
442 GfxDrawLineUnscaled(x + dx2, y + dy2, x + dx2 + dx1, y + dy2 + dy1, colour);
443 GfxDrawLineUnscaled(x + dx2, y + dy2, x + dx2 + dx3, y + dy2 + dy3, colour);
444 GfxDrawLineUnscaled(x + dx3, y + dy3, x + dx3 + dx1, y + dy3 + dy1, colour);
445 GfxDrawLineUnscaled(x + dx3, y + dy3, x + dx3 + dx2, y + dy3 + dy2, colour);
446 }
447
455 void DrawRectOutline(const Rect &r, int colour, int width, int dash)
456 {
457 GfxDrawLine(r.left, r.top, r.right, r.top, colour, width, dash);
458 GfxDrawLine(r.left, r.top, r.left, r.bottom, colour, width, dash);
459 GfxDrawLine(r.right, r.top, r.right, r.bottom, colour, width, dash);
460 GfxDrawLine(r.left, r.bottom, r.right, r.bottom, colour, width, dash);
461 }
462
467 static void SetColourRemap(TextColour colour)
468 {
469 if (colour == TC_INVALID) return;
470
471 /* Black strings have no shading ever; the shading is black, so it
472 * would be invisible at best, but it actually makes it illegible. */
473 bool no_shade = (colour & TC_NO_SHADE) != 0 || colour == TC_BLACK;
474 bool raw_colour = (colour & TC_IS_PALETTE_COLOUR) != 0;
475 colour &= ~(TC_NO_SHADE | TC_IS_PALETTE_COLOUR | TC_FORCED);
476
477 _string_colourremap[1] = raw_colour ? (byte)colour : _string_colourmap[colour];
478 _string_colourremap[2] = no_shade ? 0 : 1;
479 _colour_remap_ptr = _string_colourremap;
480 }
481
497 static int DrawLayoutLine(const ParagraphLayouter::Line &line, int y, int left, int right, StringAlignment align, bool underline, bool truncation)
498 {
499 if (line.CountRuns() == 0) return 0;
500
501 int w = line.GetWidth();
502 int h = line.GetLeading();
503
504 /*
505 * The following is needed for truncation.
506 * Depending on the text direction, we either remove bits at the rear
507 * or the front. For this we shift the entire area to draw so it fits
508 * within the left/right bounds and the side we do not truncate it on.
509 * Then we determine the truncation location, i.e. glyphs that fall
510 * outside of the range min_x - max_x will not be drawn; they are thus
511 * the truncated glyphs.
512 *
513 * At a later step we insert the dots.
514 */
515
516 int max_w = right - left + 1; // The maximum width.
517
518 int offset_x = 0; // The offset we need for positioning the glyphs
519 int min_x = left; // The minimum x position to draw normal glyphs on.
520 int max_x = right; // The maximum x position to draw normal glyphs on.
521
522 truncation &= max_w < w; // Whether we need to do truncation.
523 int dot_width = 0; // Cache for the width of the dot.
524 const Sprite *dot_sprite = nullptr; // Cache for the sprite of the dot.
525
526 if (truncation) {
527 /*
528 * Assumption may be made that all fonts of a run are of the same size.
529 * In any case, we'll use these dots for the abbreviation, so even if
530 * another size would be chosen it won't have truncated too little for
531 * the truncation dots.
532 */
533 FontCache *fc = line.GetVisualRun(0).GetFont()->fc;
534 GlyphID dot_glyph = fc->MapCharToGlyph('.');
535 dot_width = fc->GetGlyphWidth(dot_glyph);
536 dot_sprite = fc->GetGlyph(dot_glyph);
537
538 if (_current_text_dir == TD_RTL) {
539 min_x += 3 * dot_width;
540 offset_x = w - 3 * dot_width - max_w;
541 } else {
542 max_x -= 3 * dot_width;
543 }
544
545 w = max_w;
546 }
547
548 /* In case we have a RTL language we swap the alignment. */
549 if (!(align & SA_FORCE) && _current_text_dir == TD_RTL && (align & SA_HOR_MASK) != SA_HOR_CENTER) align ^= SA_RIGHT;
550
551 /* right is the right most position to draw on. In this case we want to do
552 * calculations with the width of the string. In comparison right can be
553 * seen as lastof(todraw) and width as lengthof(todraw). They differ by 1.
554 * So most +1/-1 additions are to move from lengthof to 'indices'.
555 */
556 switch (align & SA_HOR_MASK) {
557 case SA_LEFT:
558 /* right + 1 = left + w */
559 right = left + w - 1;
560 break;
561
562 case SA_HOR_CENTER:
563 left = RoundDivSU(right + 1 + left - w, 2);
564 /* right + 1 = left + w */
565 right = left + w - 1;
566 break;
567
568 case SA_RIGHT:
569 left = right + 1 - w;
570 break;
571
572 default:
573 NOT_REACHED();
574 }
575
576 const uint shadow_offset = ScaleGUITrad(1);
577
578 TextColour colour = TC_BLACK;
579 bool draw_shadow = false;
580 for (int run_index = 0; run_index < line.CountRuns(); run_index++) {
581 const ParagraphLayouter::VisualRun &run = line.GetVisualRun(run_index);
582 const auto &glyphs = run.GetGlyphs();
583 const auto &positions = run.GetPositions();
584 const Font *f = run.GetFont();
585
586 FontCache *fc = f->fc;
587 colour = f->colour;
588 SetColourRemap(colour);
589
590 DrawPixelInfo *dpi = _cur_dpi;
591 int dpi_left = dpi->left;
592 int dpi_right = dpi->left + dpi->width - 1;
593
594 draw_shadow = fc->GetDrawGlyphShadow() && (colour & TC_NO_SHADE) == 0 && colour != TC_BLACK;
595
596 for (int i = 0; i < run.GetGlyphCount(); i++) {
597 GlyphID glyph = glyphs[i];
598
599 /* Not a valid glyph (empty) */
600 if (glyph == 0xFFFF) continue;
601
602 int begin_x = positions[i].x + left - offset_x;
603 int end_x = positions[i + 1].x + left - offset_x - 1;
604 int top = positions[i].y + y;
605
606 /* Truncated away. */
607 if (truncation && (begin_x < min_x || end_x > max_x)) continue;
608
609 const Sprite *sprite = fc->GetGlyph(glyph);
610 /* Check clipping (the "+ 1" is for the shadow). */
611 if (begin_x + sprite->x_offs > dpi_right || begin_x + sprite->x_offs + sprite->width /* - 1 + 1 */ < dpi_left) continue;
612
613 if (draw_shadow && (glyph & SPRITE_GLYPH) == 0) {
614 SetColourRemap(TC_BLACK);
615 GfxMainBlitter(sprite, begin_x + shadow_offset, top + shadow_offset, BM_COLOUR_REMAP);
616 SetColourRemap(colour);
617 }
618 GfxMainBlitter(sprite, begin_x, top, BM_COLOUR_REMAP);
619 }
620 }
621
622 if (truncation) {
623 int x = (_current_text_dir == TD_RTL) ? left : (right - 3 * dot_width);
624 for (int i = 0; i < 3; i++, x += dot_width) {
625 if (draw_shadow) {
626 SetColourRemap(TC_BLACK);
627 GfxMainBlitter(dot_sprite, x + shadow_offset, y + shadow_offset, BM_COLOUR_REMAP);
628 SetColourRemap(colour);
629 }
630 GfxMainBlitter(dot_sprite, x, y, BM_COLOUR_REMAP);
631 }
632 }
633
634 if (underline) {
635 GfxFillRect(left, y + h, right, y + h + WidgetDimensions::scaled.bevel.top - 1, _string_colourremap[1]);
636 }
637
638 return (align & SA_HOR_MASK) == SA_RIGHT ? left : right;
639 }
640
658 int DrawString(int left, int right, int top, std::string_view str, TextColour colour, StringAlignment align, bool underline, FontSize fontsize)
659 {
660 /* The string may contain control chars to change the font, just use the biggest font for clipping. */
661 int max_height = std::max({GetCharacterHeight(FS_SMALL), GetCharacterHeight(FS_NORMAL), GetCharacterHeight(FS_LARGE), GetCharacterHeight(FS_MONO)});
662
663 /* Funny glyphs may extent outside the usual bounds, so relax the clipping somewhat. */
664 int extra = max_height / 2;
665
666 if (_cur_dpi->top + _cur_dpi->height + extra < top || _cur_dpi->top > top + max_height + extra ||
667 _cur_dpi->left + _cur_dpi->width + extra < left || _cur_dpi->left > right + extra) {
668 return 0;
669 }
670
671 Layouter layout(str, INT32_MAX, colour, fontsize);
672 if (layout.empty()) return 0;
673
674 return DrawLayoutLine(*layout.front(), top, left, right, align, underline, true);
675 }
676
694 int DrawString(int left, int right, int top, StringID str, TextColour colour, StringAlignment align, bool underline, FontSize fontsize)
695 {
696 return DrawString(left, right, top, GetString(str), colour, align, underline, fontsize);
697 }
698
705 int GetStringHeight(std::string_view str, int maxw, FontSize fontsize)
706 {
707 assert(maxw > 0);
708 Layouter layout(str, maxw, TC_FROMSTRING, fontsize);
709 return layout.GetBounds().height;
710 }
711
718 int GetStringHeight(StringID str, int maxw)
719 {
720 return GetStringHeight(GetString(str), maxw);
721 }
722
729 int GetStringLineCount(StringID str, int maxw)
730 {
731 Layouter layout(GetString(str), maxw);
732 return (uint)layout.size();
733 }
734
741 Dimension GetStringMultiLineBoundingBox(StringID str, const Dimension &suggestion)
742 {
743 Dimension box = {suggestion.width, (uint)GetStringHeight(str, suggestion.width)};
744 return box;
745 }
746
753 Dimension GetStringMultiLineBoundingBox(std::string_view str, const Dimension &suggestion)
754 {
755 Dimension box = {suggestion.width, (uint)GetStringHeight(str, suggestion.width)};
756 return box;
757 }
758
775 int DrawStringMultiLine(int left, int right, int top, int bottom, std::string_view str, TextColour colour, StringAlignment align, bool underline, FontSize fontsize)
776 {
777 int maxw = right - left + 1;
778 int maxh = bottom - top + 1;
779
780 /* It makes no sense to even try if it can't be drawn anyway, or
781 * do we really want to support fonts of 0 or less pixels high? */
782 if (maxh <= 0) return top;
783
784 Layouter layout(str, maxw, colour, fontsize);
785 int total_height = layout.GetBounds().height;
786 int y;
787 switch (align & SA_VERT_MASK) {
788 case SA_TOP:
789 y = top;
790 break;
791
792 case SA_VERT_CENTER:
793 y = RoundDivSU(bottom + top - total_height, 2);
794 break;
795
796 case SA_BOTTOM:
797 y = bottom - total_height;
798 break;
799
800 default: NOT_REACHED();
801 }
802
803 int last_line = top;
804 int first_line = bottom;
805
806 for (const auto &line : layout) {
807
808 int line_height = line->GetLeading();
809 if (y >= top && y + line_height - 1 <= bottom) {
810 last_line = y + line_height;
811 if (first_line > y) first_line = y;
812
813 DrawLayoutLine(*line, y, left, right, align, underline, false);
814 }
815 y += line_height;
816 }
817
818 return ((align & SA_VERT_MASK) == SA_BOTTOM) ? first_line : last_line;
819 }
820
837 int DrawStringMultiLine(int left, int right, int top, int bottom, StringID str, TextColour colour, StringAlignment align, bool underline, FontSize fontsize)
838 {
839 return DrawStringMultiLine(left, right, top, bottom, GetString(str), colour, align, underline, fontsize);
840 }
841
852 Dimension GetStringBoundingBox(std::string_view str, FontSize start_fontsize)
853 {
854 Layouter layout(str, INT32_MAX, TC_FROMSTRING, start_fontsize);
855 return layout.GetBounds();
856 }
857
864 Dimension GetStringBoundingBox(StringID strid, FontSize start_fontsize)
865 {
866 return GetStringBoundingBox(GetString(strid), start_fontsize);
867 }
868
875 uint GetStringListWidth(const StringID *list, FontSize fontsize)
876 {
877 uint width = 0;
878 for (const StringID *str = list; *str != INVALID_STRING_ID; str++) {
879 width = std::max(width, GetStringBoundingBox(*str, fontsize).width);
880 }
881 return width;
882 }
883
892 Point GetCharPosInString(std::string_view str, const char *ch, FontSize start_fontsize)
893 {
894 /* Ensure "ch" is inside "str" or at the exact end. */
895 assert(ch >= str.data() && (ch - str.data()) <= static_cast<ptrdiff_t>(str.size()));
896 auto it_ch = str.begin() + (ch - str.data());
897
898 Layouter layout(str, INT32_MAX, TC_FROMSTRING, start_fontsize);
899 return layout.GetCharPosition(it_ch);
900 }
901
909 ptrdiff_t GetCharAtPosition(std::string_view str, int x, FontSize start_fontsize)
910 {
911 if (x < 0) return -1;
912
913 Layouter layout(str, INT32_MAX, TC_FROMSTRING, start_fontsize);
914 return layout.GetCharAtPosition(x, 0);
915 }
916
924 void DrawCharCentered(char32_t c, const Rect &r, TextColour colour)
925 {
926 SetColourRemap(colour);
927 GfxMainBlitter(GetGlyph(FS_NORMAL, c),
928 CenterBounds(r.left, r.right, GetCharacterWidth(FS_NORMAL, c)),
929 CenterBounds(r.top, r.bottom, GetCharacterHeight(FS_NORMAL)),
930 BM_COLOUR_REMAP);
931 }
932
941 Dimension GetSpriteSize(SpriteID sprid, Point *offset, ZoomLevel zoom)
942 {
943 const Sprite *sprite = GetSprite(sprid, SpriteType::Normal);
944
945 if (offset != nullptr) {
946 offset->x = UnScaleByZoom(sprite->x_offs, zoom);
947 offset->y = UnScaleByZoom(sprite->y_offs, zoom);
948 }
949
950 Dimension d;
951 d.width = std::max<int>(0, UnScaleByZoom(sprite->x_offs + sprite->width, zoom));
952 d.height = std::max<int>(0, UnScaleByZoom(sprite->y_offs + sprite->height, zoom));
953 return d;
954 }
955
961 static BlitterMode GetBlitterMode(PaletteID pal)
962 {
963 switch (pal) {
964 case PAL_NONE: return BM_NORMAL;
965 case PALETTE_CRASH: return BM_CRASH_REMAP;
966 case PALETTE_ALL_BLACK: return BM_BLACK_REMAP;
967 default: return BM_COLOUR_REMAP;
968 }
969 }
970
979 void DrawSpriteViewport(SpriteID img, PaletteID pal, int x, int y, const SubSprite *sub)
980 {
981 SpriteID real_sprite = GB(img, 0, SPRITE_WIDTH);
982 if (HasBit(img, PALETTE_MODIFIER_TRANSPARENT)) {
983 pal = GB(pal, 0, PALETTE_WIDTH);
984 _colour_remap_ptr = GetNonSprite(pal, SpriteType::Recolour) + 1;
985 GfxMainBlitterViewport(GetSprite(real_sprite, SpriteType::Normal), x, y, pal == PALETTE_TO_TRANSPARENT ? BM_TRANSPARENT : BM_TRANSPARENT_REMAP, sub, real_sprite);
986 } else if (pal != PAL_NONE) {
987 if (HasBit(pal, PALETTE_TEXT_RECOLOUR)) {
988 SetColourRemap((TextColour)GB(pal, 0, PALETTE_WIDTH));
989 } else {
990 _colour_remap_ptr = GetNonSprite(GB(pal, 0, PALETTE_WIDTH), SpriteType::Recolour) + 1;
991 }
992 GfxMainBlitterViewport(GetSprite(real_sprite, SpriteType::Normal), x, y, GetBlitterMode(pal), sub, real_sprite);
993 } else {
994 GfxMainBlitterViewport(GetSprite(real_sprite, SpriteType::Normal), x, y, BM_NORMAL, sub, real_sprite);
995 }
996 }
997
1007 void DrawSprite(SpriteID img, PaletteID pal, int x, int y, const SubSprite *sub, ZoomLevel zoom)
1008 {
1009 SpriteID real_sprite = GB(img, 0, SPRITE_WIDTH);
1010 if (HasBit(img, PALETTE_MODIFIER_TRANSPARENT)) {
1011 pal = GB(pal, 0, PALETTE_WIDTH);
1012 _colour_remap_ptr = GetNonSprite(pal, SpriteType::Recolour) + 1;
1013 GfxMainBlitter(GetSprite(real_sprite, SpriteType::Normal), x, y, pal == PALETTE_TO_TRANSPARENT ? BM_TRANSPARENT : BM_TRANSPARENT_REMAP, sub, real_sprite, zoom);
1014 } else if (pal != PAL_NONE) {
1015 if (HasBit(pal, PALETTE_TEXT_RECOLOUR)) {
1016 SetColourRemap((TextColour)GB(pal, 0, PALETTE_WIDTH));
1017 } else {
1018 _colour_remap_ptr = GetNonSprite(GB(pal, 0, PALETTE_WIDTH), SpriteType::Recolour) + 1;
1019 }
1020 GfxMainBlitter(GetSprite(real_sprite, SpriteType::Normal), x, y, GetBlitterMode(pal), sub, real_sprite, zoom);
1021 } else {
1022 GfxMainBlitter(GetSprite(real_sprite, SpriteType::Normal), x, y, BM_NORMAL, sub, real_sprite, zoom);
1023 }
1024 }
1025
1038 template <int ZOOM_BASE, bool SCALED_XY>
1039 static void GfxBlitter(const Sprite * const sprite, int x, int y, BlitterMode mode, const SubSprite * const sub, SpriteID sprite_id, ZoomLevel zoom, const DrawPixelInfo *dst = nullptr)
1040 {
1041 const DrawPixelInfo *dpi = (dst != nullptr) ? dst : _cur_dpi;
1042 Blitter::BlitterParams bp;
1043
1044 if (SCALED_XY) {
1045 /* Scale it */
1046 x = ScaleByZoom(x, zoom);
1047 y = ScaleByZoom(y, zoom);
1048 }
1049
1050 /* Move to the correct offset */
1051 x += sprite->x_offs;
1052 y += sprite->y_offs;
1053
1054 if (sub == nullptr) {
1055 /* No clipping. */
1056 bp.skip_left = 0;
1057 bp.skip_top = 0;
1058 bp.width = UnScaleByZoom(sprite->width, zoom);
1059 bp.height = UnScaleByZoom(sprite->height, zoom);
1060 } else {
1061 /* Amount of pixels to clip from the source sprite */
1062 int clip_left = std::max(0, -sprite->x_offs + sub->left * ZOOM_BASE );
1063 int clip_top = std::max(0, -sprite->y_offs + sub->top * ZOOM_BASE );
1064 int clip_right = std::max(0, sprite->width - (-sprite->x_offs + (sub->right + 1) * ZOOM_BASE));
1065 int clip_bottom = std::max(0, sprite->height - (-sprite->y_offs + (sub->bottom + 1) * ZOOM_BASE));
1066
1067 if (clip_left + clip_right >= sprite->width) return;
1068 if (clip_top + clip_bottom >= sprite->height) return;
1069
1070 bp.skip_left = UnScaleByZoomLower(clip_left, zoom);
1071 bp.skip_top = UnScaleByZoomLower(clip_top, zoom);
1072 bp.width = UnScaleByZoom(sprite->width - clip_left - clip_right, zoom);
1073 bp.height = UnScaleByZoom(sprite->height - clip_top - clip_bottom, zoom);
1074
1075 x += ScaleByZoom(bp.skip_left, zoom);
1076 y += ScaleByZoom(bp.skip_top, zoom);
1077 }
1078
1079 /* Copy the main data directly from the sprite */
1080 bp.sprite = sprite->data;
1081 bp.sprite_width = sprite->width;
1082 bp.sprite_height = sprite->height;
1083 bp.top = 0;
1084 bp.left = 0;
1085
1086 bp.dst = dpi->dst_ptr;
1087 bp.pitch = dpi->pitch;
1088 bp.remap = _colour_remap_ptr;
1089
1090 assert(sprite->width > 0);
1091 assert(sprite->height > 0);
1092
1093 if (bp.width <= 0) return;
1094 if (bp.height <= 0) return;
1095
1096 y -= SCALED_XY ? ScaleByZoom(dpi->top, zoom) : dpi->top;
1097 int y_unscaled = UnScaleByZoom(y, zoom);
1098 /* Check for top overflow */
1099 if (y < 0) {
1100 bp.height -= -y_unscaled;
1101 if (bp.height <= 0) return;
1102 bp.skip_top += -y_unscaled;
1103 y = 0;
1104 } else {
1105 bp.top = y_unscaled;
1106 }
1107
1108 /* Check for bottom overflow */
1109 y += SCALED_XY ? ScaleByZoom(bp.height - dpi->height, zoom) : ScaleByZoom(bp.height, zoom) - dpi->height;
1110 if (y > 0) {
1111 bp.height -= UnScaleByZoom(y, zoom);
1112 if (bp.height <= 0) return;
1113 }
1114
1115 x -= SCALED_XY ? ScaleByZoom(dpi->left, zoom) : dpi->left;
1116 int x_unscaled = UnScaleByZoom(x, zoom);
1117 /* Check for left overflow */
1118 if (x < 0) {
1119 bp.width -= -x_unscaled;
1120 if (bp.width <= 0) return;
1121 bp.skip_left += -x_unscaled;
1122 x = 0;
1123 } else {
1124 bp.left = x_unscaled;
1125 }
1126
1127 /* Check for right overflow */
1128 x += SCALED_XY ? ScaleByZoom(bp.width - dpi->width, zoom) : ScaleByZoom(bp.width, zoom) - dpi->width;
1129 if (x > 0) {
1130 bp.width -= UnScaleByZoom(x, zoom);
1131 if (bp.width <= 0) return;
1132 }
1133
1134 assert(bp.skip_left + bp.width <= UnScaleByZoom(sprite->width, zoom));
1135 assert(bp.skip_top + bp.height <= UnScaleByZoom(sprite->height, zoom));
1136
1137 /* We do not want to catch the mouse. However we also use that spritenumber for unknown (text) sprites. */
1138 if (_newgrf_debug_sprite_picker.mode == SPM_REDRAW && sprite_id != SPR_CURSOR_MOUSE) {
1139 Blitter *blitter = BlitterFactory::GetCurrentBlitter();
1140 void *topleft = blitter->MoveTo(bp.dst, bp.left, bp.top);
1141 void *bottomright = blitter->MoveTo(topleft, bp.width - 1, bp.height - 1);
1142
1143 void *clicked = _newgrf_debug_sprite_picker.clicked_pixel;
1144
1145 if (topleft <= clicked && clicked <= bottomright) {
1146 uint offset = (((size_t)clicked - (size_t)topleft) / (blitter->GetScreenDepth() / 8)) % bp.pitch;
1147 if (offset < (uint)bp.width) {
1148 include(_newgrf_debug_sprite_picker.sprites, sprite_id);
1149 }
1150 }
1151 }
1152
1153 BlitterFactory::GetCurrentBlitter()->Draw(&bp, mode, zoom);
1154 }
1155
1163 std::unique_ptr<uint32_t[]> DrawSpriteToRgbaBuffer(SpriteID spriteId, ZoomLevel zoom)
1164 {
1165 /* Invalid zoom level requested? */
1166 if (zoom < _settings_client.gui.zoom_min || zoom > _settings_client.gui.zoom_max) return nullptr;
1167
1168 Blitter *blitter = BlitterFactory::GetCurrentBlitter();
1169 if (blitter->GetScreenDepth() != 8 && blitter->GetScreenDepth() != 32) return nullptr;
1170
1171 /* Gather information about the sprite to write, reserve memory */
1172 const SpriteID real_sprite = GB(spriteId, 0, SPRITE_WIDTH);
1173 const Sprite *sprite = GetSprite(real_sprite, SpriteType::Normal);
1174 Dimension dim = GetSpriteSize(real_sprite, nullptr, zoom);
1175 size_t dim_size = static_cast<size_t>(dim.width) * dim.height;
1176 std::unique_ptr<uint32_t[]> result(new uint32_t[dim_size]);
1177 /* Set buffer to fully transparent. */
1178 MemSetT(result.get(), 0, dim_size);
1179
1180 /* Prepare new DrawPixelInfo - Normally this would be the screen but we want to draw to another buffer here.
1181 * Normally, pitch would be scaled screen width, but in our case our "screen" is only the sprite width wide. */
1182 DrawPixelInfo dpi;
1183 dpi.dst_ptr = result.get();
1184 dpi.pitch = dim.width;
1185 dpi.left = 0;
1186 dpi.top = 0;
1187 dpi.width = dim.width;
1188 dpi.height = dim.height;
1189 dpi.zoom = zoom;
1190
1191 dim_size = static_cast<size_t>(dim.width) * dim.height;
1192
1193 /* If the current blitter is a paletted blitter, we have to render to an extra buffer and resolve the palette later. */
1194 std::unique_ptr<byte[]> pal_buffer{};
1195 if (blitter->GetScreenDepth() == 8) {
1196 pal_buffer.reset(new byte[dim_size]);
1197 MemSetT(pal_buffer.get(), 0, dim_size);
1198
1199 dpi.dst_ptr = pal_buffer.get();
1200 }
1201
1202 /* Temporarily disable screen animations while blitting - This prevents 40bpp_anim from writing to the animation buffer. */
1203 Backup<bool> disable_anim(_screen_disable_anim, true, FILE_LINE);
1204 GfxBlitter<1, true>(sprite, 0, 0, BM_NORMAL, nullptr, real_sprite, zoom, &dpi);
1205 disable_anim.Restore();
1206
1207 if (blitter->GetScreenDepth() == 8) {
1208 /* Resolve palette. */
1209 uint32_t *dst = result.get();
1210 const byte *src = pal_buffer.get();
1211 for (size_t i = 0; i < dim_size; ++i) {
1212 *dst++ = _cur_palette.palette[*src++].data;
1213 }
1214 }
1215
1216 return result;
1217 }
1218
1219 static void GfxMainBlitterViewport(const Sprite *sprite, int x, int y, BlitterMode mode, const SubSprite *sub, SpriteID sprite_id)
1220 {
1221 GfxBlitter<ZOOM_LVL_BASE, false>(sprite, x, y, mode, sub, sprite_id, _cur_dpi->zoom);
1222 }
1223
1224 static void GfxMainBlitter(const Sprite *sprite, int x, int y, BlitterMode mode, const SubSprite *sub, SpriteID sprite_id, ZoomLevel zoom)
1225 {
1226 GfxBlitter<1, true>(sprite, x, y, mode, sub, sprite_id, zoom);
1227 }
1228
1233 void LoadStringWidthTable(bool monospace)
1234 {
1235 ClearFontCache();
1236
1237 for (FontSize fs = monospace ? FS_MONO : FS_BEGIN; fs < (monospace ? FS_END : FS_MONO); fs++) {
1238 for (uint i = 0; i != 224; i++) {
1239 _stringwidth_table[fs][i] = GetGlyphWidth(fs, i + 32);
1240 }
1241 }
1242 }
1243
1250 byte GetCharacterWidth(FontSize size, char32_t key)
1251 {
1252 /* Use _stringwidth_table cache if possible */
1253 if (key >= 32 && key < 256) return _stringwidth_table[size][key - 32];
1254
1255 return GetGlyphWidth(size, key);
1256 }
1257
1263 byte GetDigitWidth(FontSize size)
1264 {
1265 byte width = 0;
1266 for (char c = '0'; c <= '9'; c++) {
1267 width = std::max(GetCharacterWidth(size, c), width);
1268 }
1269 return width;
1270 }
1271
1278 void GetBroadestDigit(uint *front, uint *next, FontSize size)
1279 {
1280 int width = -1;
1281 for (char c = '9'; c >= '0'; c--) {
1282 int w = GetCharacterWidth(size, c);
1283 if (w > width) {
1284 width = w;
1285 *next = c - '0';
1286 if (c != '0') *front = c - '0';
1287 }
1288 }
1289 }
1290
1291 void ScreenSizeChanged()
1292 {
1293 _dirty_bytes_per_line = CeilDiv(_screen.width, DIRTY_BLOCK_WIDTH);
1294 _dirty_blocks = ReallocT<byte>(_dirty_blocks, static_cast<size_t>(_dirty_bytes_per_line) * CeilDiv(_screen.height, DIRTY_BLOCK_HEIGHT));
1295
1296 /* check the dirty rect */
1297 if (_invalid_rect.right >= _screen.width) _invalid_rect.right = _screen.width;
1298 if (_invalid_rect.bottom >= _screen.height) _invalid_rect.bottom = _screen.height;
1299
1300 /* screen size changed and the old bitmap is invalid now, so we don't want to undraw it */
1301 _cursor.visible = false;
1302 }
1303
1304 void UndrawMouseCursor()
1305 {
1306 /* Don't undraw mouse cursor if it is handled by the video driver. */
1307 if (VideoDriver::GetInstance()->UseSystemCursor()) return;
1308
1309 /* Don't undraw the mouse cursor if the screen is not ready */
1310 if (_screen.dst_ptr == nullptr) return;
1311
1312 if (_cursor.visible) {
1313 Blitter *blitter = BlitterFactory::GetCurrentBlitter();
1314 _cursor.visible = false;
1315 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);
1316 VideoDriver::GetInstance()->MakeDirty(_cursor.draw_pos.x, _cursor.draw_pos.y, _cursor.draw_size.x, _cursor.draw_size.y);
1317 }
1318 }
1319
1320 void DrawMouseCursor()
1321 {
1322 /* Don't draw mouse cursor if it is handled by the video driver. */
1323 if (VideoDriver::GetInstance()->UseSystemCursor()) return;
1324
1325 /* Don't draw the mouse cursor if the screen is not ready */
1326 if (_screen.dst_ptr == nullptr) return;
1327
1328 Blitter *blitter = BlitterFactory::GetCurrentBlitter();
1329
1330 /* Redraw mouse cursor but only when it's inside the window */
1331 if (!_cursor.in_window) return;
1332
1333 /* Don't draw the mouse cursor if it's already drawn */
1334 if (_cursor.visible) {
1335 if (!_cursor.dirty) return;
1336 UndrawMouseCursor();
1337 }
1338
1339 /* Determine visible area */
1340 int left = _cursor.pos.x + _cursor.total_offs.x;
1341 int width = _cursor.total_size.x;
1342 if (left < 0) {
1343 width += left;
1344 left = 0;
1345 }
1346 if (left + width > _screen.width) {
1347 width = _screen.width - left;
1348 }
1349 if (width <= 0) return;
1350
1351 int top = _cursor.pos.y + _cursor.total_offs.y;
1352 int height = _cursor.total_size.y;
1353 if (top < 0) {
1354 height += top;
1355 top = 0;
1356 }
1357 if (top + height > _screen.height) {
1358 height = _screen.height - top;
1359 }
1360 if (height <= 0) return;
1361
1362 _cursor.draw_pos.x = left;
1363 _cursor.draw_pos.y = top;
1364 _cursor.draw_size.x = width;
1365 _cursor.draw_size.y = height;
1366
1367 uint8_t *buffer = _cursor_backup.Allocate(blitter->BufferSize(_cursor.draw_size.x, _cursor.draw_size.y));
1368
1369 /* Make backup of stuff below cursor */
1370 blitter->CopyToBuffer(blitter->MoveTo(_screen.dst_ptr, _cursor.draw_pos.x, _cursor.draw_pos.y), buffer, _cursor.draw_size.x, _cursor.draw_size.y);
1371
1372 /* Draw cursor on screen */
1373 _cur_dpi = &_screen;
1374 for (uint i = 0; i < _cursor.sprite_count; ++i) {
1375 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);
1376 }
1377
1378 VideoDriver::GetInstance()->MakeDirty(_cursor.draw_pos.x, _cursor.draw_pos.y, _cursor.draw_size.x, _cursor.draw_size.y);
1379
1380 _cursor.visible = true;
1381 _cursor.dirty = false;
1382 }
1383
1394 void RedrawScreenRect(int left, int top, int right, int bottom)
1395 {
1396 assert(right <= _screen.width && bottom <= _screen.height);
1397 if (_cursor.visible) {
1398 if (right > _cursor.draw_pos.x &&
1399 left < _cursor.draw_pos.x + _cursor.draw_size.x &&
1400 bottom > _cursor.draw_pos.y &&
1401 top < _cursor.draw_pos.y + _cursor.draw_size.y) {
1402 UndrawMouseCursor();
1403 }
1404 }
1405
1406 if (_networking) NetworkUndrawChatMessage();
1407
1408 DrawOverlappedWindowForAll(left, top, right, bottom);
1409
1410 VideoDriver::GetInstance()->MakeDirty(left, top, right - left, bottom - top);
1411 }
1412
1420 void DrawDirtyBlocks()
1421 {
1422 byte *b = _dirty_blocks;
1423 const int w = Align(_screen.width, DIRTY_BLOCK_WIDTH);
1424 const int h = Align(_screen.height, DIRTY_BLOCK_HEIGHT);
1425 int x;
1426 int y;
1427
1428 y = 0;
1429 do {
1430 x = 0;
1431 do {
1432 if (*b != 0) {
1433 int left;
1434 int top;
1435 int right = x + DIRTY_BLOCK_WIDTH;
1436 int bottom = y;
1437 byte *p = b;
1438 int h2;
1439
1440 /* First try coalescing downwards */
1441 do {
1442 *p = 0;
1443 p += _dirty_bytes_per_line;
1444 bottom += DIRTY_BLOCK_HEIGHT;
1445 } while (bottom != h && *p != 0);
1446
1447 /* Try coalescing to the right too. */
1448 h2 = (bottom - y) / DIRTY_BLOCK_HEIGHT;
1449 assert(h2 > 0);
1450 p = b;
1451
1452 while (right != w) {
1453 byte *p2 = ++p;
1454 int i = h2;
1455 /* Check if a full line of dirty flags is set. */
1456 do {
1457 if (!*p2) goto no_more_coalesc;
1458 p2 += _dirty_bytes_per_line;
1459 } while (--i != 0);
1460
1461 /* Wohoo, can combine it one step to the right!
1462 * Do that, and clear the bits. */
1463 right += DIRTY_BLOCK_WIDTH;
1464
1465 i = h2;
1466 p2 = p;
1467 do {
1468 *p2 = 0;
1469 p2 += _dirty_bytes_per_line;
1470 } while (--i != 0);
1471 }
1472 no_more_coalesc:
1473
1474 left = x;
1475 top = y;
1476
1477 if (left < _invalid_rect.left ) left = _invalid_rect.left;
1478 if (top < _invalid_rect.top ) top = _invalid_rect.top;
1479 if (right > _invalid_rect.right ) right = _invalid_rect.right;
1480 if (bottom > _invalid_rect.bottom) bottom = _invalid_rect.bottom;
1481
1482 if (left < right && top < bottom) {
1483 RedrawScreenRect(left, top, right, bottom);
1484 }
1485
1486 }
1487 } while (b++, (x += DIRTY_BLOCK_WIDTH) != w);
1488 } while (b += -(int)(w / DIRTY_BLOCK_WIDTH) + _dirty_bytes_per_line, (y += DIRTY_BLOCK_HEIGHT) != h);
1489
1490 ++_dirty_block_colour;
1491 _invalid_rect.left = w;
1492 _invalid_rect.top = h;
1493 _invalid_rect.right = 0;
1494 _invalid_rect.bottom = 0;
1495 }
1496
1509 void AddDirtyBlock(int left, int top, int right, int bottom)
1510 {
1511 byte *b;
1512 int width;
1513 int height;
1514
1515 if (left < 0) left = 0;
1516 if (top < 0) top = 0;
1517 if (right > _screen.width) right = _screen.width;
1518 if (bottom > _screen.height) bottom = _screen.height;
1519
1520 if (left >= right || top >= bottom) return;
1521
1522 if (left < _invalid_rect.left ) _invalid_rect.left = left;
1523 if (top < _invalid_rect.top ) _invalid_rect.top = top;
1524 if (right > _invalid_rect.right ) _invalid_rect.right = right;
1525 if (bottom > _invalid_rect.bottom) _invalid_rect.bottom = bottom;
1526
1527 left /= DIRTY_BLOCK_WIDTH;
1528 top /= DIRTY_BLOCK_HEIGHT;
1529
1530 b = _dirty_blocks + top * _dirty_bytes_per_line + left;
1531
1532 width = ((right - 1) / DIRTY_BLOCK_WIDTH) - left + 1;
1533 height = ((bottom - 1) / DIRTY_BLOCK_HEIGHT) - top + 1;
1534
1535 assert(width > 0 && height > 0);
1536
1537 do {
1538 int i = width;
1539
1540 do b[--i] = 0xFF; while (i != 0);
1541
1542 b += _dirty_bytes_per_line;
1543 } while (--height != 0);
1544 }
1545
1552 void MarkWholeScreenDirty()
1553 {
1554 AddDirtyBlock(0, 0, _screen.width, _screen.height);
1555 }
1556
1571 bool FillDrawPixelInfo(DrawPixelInfo *n, int left, int top, int width, int height)
1572 {
1573 Blitter *blitter = BlitterFactory::GetCurrentBlitter();
1574 const DrawPixelInfo *o = _cur_dpi;
1575
1576 n->zoom = ZOOM_LVL_NORMAL;
1577
1578 assert(width > 0);
1579 assert(height > 0);
1580
1581 if ((left -= o->left) < 0) {
1582 width += left;
1583 if (width <= 0) return false;
1584 n->left = -left;
1585 left = 0;
1586 } else {
1587 n->left = 0;
1588 }
1589
1590 if (width > o->width - left) {
1591 width = o->width - left;
1592 if (width <= 0) return false;
1593 }
1594 n->width = width;
1595
1596 if ((top -= o->top) < 0) {
1597 height += top;
1598 if (height <= 0) return false;
1599 n->top = -top;
1600 top = 0;
1601 } else {
1602 n->top = 0;
1603 }
1604
1605 n->dst_ptr = blitter->MoveTo(o->dst_ptr, left, top);
1606 n->pitch = o->pitch;
1607
1608 if (height > o->height - top) {
1609 height = o->height - top;
1610 if (height <= 0) return false;
1611 }
1612 n->height = height;
1613
1614 return true;
1615 }
1616
1621 void UpdateCursorSize()
1622 {
1623 /* Ignore setting any cursor before the sprites are loaded. */
1624 if (GetMaxSpriteID() == 0) return;
1625
1626 static_assert(lengthof(_cursor.sprite_seq) == lengthof(_cursor.sprite_pos));
1627 assert(_cursor.sprite_count <= lengthof(_cursor.sprite_seq));
1628 for (uint i = 0; i < _cursor.sprite_count; ++i) {
1629 const Sprite *p = GetSprite(GB(_cursor.sprite_seq[i].sprite, 0, SPRITE_WIDTH), SpriteType::Normal);
1630 Point offs, size;
1631 offs.x = UnScaleGUI(p->x_offs) + _cursor.sprite_pos[i].x;
1632 offs.y = UnScaleGUI(p->y_offs) + _cursor.sprite_pos[i].y;
1633 size.x = UnScaleGUI(p->width);
1634 size.y = UnScaleGUI(p->height);
1635
1636 if (i == 0) {
1637 _cursor.total_offs = offs;
1638 _cursor.total_size = size;
1639 } else {
1640 int right = std::max(_cursor.total_offs.x + _cursor.total_size.x, offs.x + size.x);
1641 int bottom = std::max(_cursor.total_offs.y + _cursor.total_size.y, offs.y + size.y);
1642 if (offs.x < _cursor.total_offs.x) _cursor.total_offs.x = offs.x;
1643 if (offs.y < _cursor.total_offs.y) _cursor.total_offs.y = offs.y;
1644 _cursor.total_size.x = right - _cursor.total_offs.x;
1645 _cursor.total_size.y = bottom - _cursor.total_offs.y;
1646 }
1647 }
1648
1649 _cursor.dirty = true;
1650 }
1651
1657 static void SetCursorSprite(CursorID cursor, PaletteID pal)
1658 {
1659 if (_cursor.sprite_count == 1 && _cursor.sprite_seq[0].sprite == cursor && _cursor.sprite_seq[0].pal == pal) return;
1660
1661 _cursor.sprite_count = 1;
1662 _cursor.sprite_seq[0].sprite = cursor;
1663 _cursor.sprite_seq[0].pal = pal;
1664 _cursor.sprite_pos[0].x = 0;
1665 _cursor.sprite_pos[0].y = 0;
1666
1667 UpdateCursorSize();
1668 }
1669
1670 static void SwitchAnimatedCursor()
1671 {
1672 const AnimCursor *cur = _cursor.animate_cur;
1673
1674 if (cur == nullptr || cur->sprite == AnimCursor::LAST) cur = _cursor.animate_list;
1675
1676 SetCursorSprite(cur->sprite, _cursor.sprite_seq[0].pal);
1677
1678 _cursor.animate_timeout = cur->display_time;
1679 _cursor.animate_cur = cur + 1;
1680 }
1681
1682 void CursorTick()
1683 {
1684 if (_cursor.animate_timeout != 0 && --_cursor.animate_timeout == 0) {
1685 SwitchAnimatedCursor();
1686 }
1687 }
1688
1693 void SetMouseCursorBusy(bool busy)
1694 {
1695 if (busy) {
1696 if (_cursor.sprite_seq[0].sprite == SPR_CURSOR_MOUSE) SetMouseCursor(SPR_CURSOR_ZZZ, PAL_NONE);
1697 } else {
1698 if (_cursor.sprite_seq[0].sprite == SPR_CURSOR_ZZZ) SetMouseCursor(SPR_CURSOR_MOUSE, PAL_NONE);
1699 }
1700 }
1701
1708 void SetMouseCursor(CursorID sprite, PaletteID pal)
1709 {
1710 /* Turn off animation */
1711 _cursor.animate_timeout = 0;
1712 /* Set cursor */
1713 SetCursorSprite(sprite, pal);
1714 }
1715
1721 void SetAnimatedMouseCursor(const AnimCursor *table)
1722 {
1723 _cursor.animate_list = table;
1724 _cursor.animate_cur = nullptr;
1725 _cursor.sprite_seq[0].pal = PAL_NONE;
1726 SwitchAnimatedCursor();
1727 }
1728
1735 void CursorVars::UpdateCursorPositionRelative(int delta_x, int delta_y)
1736 {
1737 assert(this->fix_at);
1738
1739 this->delta.x = delta_x;
1740 this->delta.y = delta_y;
1741 }
1742
1749 bool CursorVars::UpdateCursorPosition(int x, int y)
1750 {
1751 this->delta.x = x - this->pos.x;
1752 this->delta.y = y - this->pos.y;
1753
1754 if (this->fix_at) {
1755 return this->delta.x != 0 || this->delta.y != 0;
1756 } else if (this->pos.x != x || this->pos.y != y) {
1757 this->dirty = true;
1758 this->pos.x = x;
1759 this->pos.y = y;
1760 }
1761
1762 return false;
1763 }
1764
1765 bool ChangeResInGame(int width, int height)
1766 {
1767 return (_screen.width == width && _screen.height == height) || VideoDriver::GetInstance()->ChangeResolution(width, height);
1768 }
1769
1770 bool ToggleFullScreen(bool fs)
1771 {
1772 bool result = VideoDriver::GetInstance()->ToggleFullscreen(fs);
1773 if (_fullscreen != fs && _resolutions.empty()) {
1774 Debug(driver, 0, "Could not find a suitable fullscreen resolution");
1775 }
1776 return result;
1777 }
1778
1779 void SortResolutions()
1780 {
1781 std::sort(_resolutions.begin(), _resolutions.end());
1782
1783 /* Remove any duplicates from the list. */
1784 auto last = std::unique(_resolutions.begin(), _resolutions.end());
1785 _resolutions.erase(last, _resolutions.end());
1786 }
1787
1791 void UpdateGUIZoom()
1792 {
1793 /* Determine real GUI zoom to use. */
1794 if (_gui_scale_cfg == -1) {
1795 _gui_scale = VideoDriver::GetInstance()->GetSuggestedUIScale();
1796 } else {
1797 _gui_scale = Clamp(_gui_scale_cfg, MIN_INTERFACE_SCALE, MAX_INTERFACE_SCALE);
1798 }
1799
1800 int8_t new_zoom = ScaleGUITrad(1) <= 1 ? ZOOM_LVL_OUT_4X : ScaleGUITrad(1) >= 4 ? ZOOM_LVL_MIN : ZOOM_LVL_OUT_2X;
1801 /* Font glyphs should not be clamped to min/max zoom. */
1802 _font_zoom = static_cast<ZoomLevel>(new_zoom);
1803 /* Ensure the gui_zoom is clamped between min/max. */
1804 new_zoom = Clamp(new_zoom, _settings_client.gui.zoom_min, _settings_client.gui.zoom_max);
1805 _gui_zoom = static_cast<ZoomLevel>(new_zoom);
1806 }
1807
1814 bool AdjustGUIZoom(bool automatic)
1815 {
1816 ZoomLevel old_gui_zoom = _gui_zoom;
1817 ZoomLevel old_font_zoom = _font_zoom;
1818 int old_scale = _gui_scale;
1819 UpdateGUIZoom();
1820 if (old_scale == _gui_scale && old_gui_zoom == _gui_zoom) return false;
1821
1822 /* Update cursors if sprite zoom level has changed. */
1823 if (old_gui_zoom != _gui_zoom) {
1824 VideoDriver::GetInstance()->ClearSystemSprites();
1825 UpdateCursorSize();
1826 }
1827 if (old_font_zoom != _font_zoom) {
1828 GfxClearFontSpriteCache();
1829 }
1830 ClearFontCache();
1831 LoadStringWidthTable();
1832
1833 SetupWidgetDimensions();
1834 UpdateAllVirtCoords();
1835
1836 /* Adjust all window sizes to match the new zoom level, so that they don't appear
1837 to move around when the application is moved to a screen with different DPI. */
1838 auto zoom_shift = old_gui_zoom - _gui_zoom;
1839 for (Window *w : Window::Iterate()) {
1840 if (automatic) {
1841 w->left = (w->left * _gui_scale) / old_scale;
1842 w->top = (w->top * _gui_scale) / old_scale;
1843 }
1844 if (w->viewport != nullptr) {
1845 w->viewport->zoom = static_cast<ZoomLevel>(Clamp(w->viewport->zoom - zoom_shift, _settings_client.gui.zoom_min, _settings_client.gui.zoom_max));
1846 }
1847 }
1848
1849 return true;
1850 }
1851
1852 void ChangeGameSpeed(bool enable_fast_forward)
1853 {
1854 if (enable_fast_forward) {
1855 _game_speed = _settings_client.gui.fast_forward_speed_limit;
1856 } else {
1857 _game_speed = 100;
1858 }
1859 }
_cur_palette
Palette _cur_palette
Current palette.
Definition: palette.cpp:24
Sprite::height
uint16_t height
Height of the sprite.
Definition: spritecache.h:18
_dirkeys
byte _dirkeys
1 = left, 2 = up, 4 = right, 8 = down
Definition: gfx.cpp:33
NewGrfDebugSpritePicker::clicked_pixel
void * clicked_pixel
Clicked pixel (pointer to blitter buffer)
Definition: newgrf_debug.h:27
LoadStringWidthTable
void LoadStringWidthTable(bool monospace)
Initialize _stringwidth_table cache.
Definition: gfx.cpp:1233
TC_FORCED
@ TC_FORCED
Ignore colour changes from strings.
Definition: gfx_type.h:278
SetMouseCursorBusy
void SetMouseCursorBusy(bool busy)
Set or unset the ZZZ cursor.
Definition: gfx.cpp:1693
CursorVars::UpdateCursorPosition
bool UpdateCursorPosition(int x, int y)
Update cursor position on mouse movement.
Definition: gfx.cpp:1749
SwitchMode
SwitchMode
Mode which defines what mode we're switching to.
Definition: openttd.h:26
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:417
SA_HOR_MASK
@ SA_HOR_MASK
Mask for horizontal alignment.
Definition: gfx_type.h:341
CursorVars
Collection of variables for cursor-display and -animation.
Definition: gfx_type.h:115
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:1509
ZOOM_LVL_OUT_2X
@ ZOOM_LVL_OUT_2X
Zoomed 2 times out.
Definition: zoom_type.h:23
_string_colourremap
static byte _string_colourremap[3]
Recoloursprite for stringdrawing. The grf loader ensures that SpriteType::Font sprites only use colou...
Definition: gfx.cpp:74
Sprite::x_offs
int16_t x_offs
Number of pixels to shift the sprite to the right.
Definition: spritecache.h:20
PALETTE_TEXT_RECOLOUR
@ PALETTE_TEXT_RECOLOUR
Set if palette is actually a magic text recolour.
Definition: sprites.h:1524
CursorVars::animate_cur
const AnimCursor * animate_cur
in case of animated cursor, current frame
Definition: gfx_type.h:136
GetGlyph
const Sprite * GetGlyph(FontSize size, char32_t key)
Get the Sprite for a glyph.
Definition: fontcache.h:188
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:30
Blitter::BlitterParams::top
int top
The top offset in the 'dst' in pixels to start drawing.
Definition: base.hpp:43
WidgetDimensions::scaled
static WidgetDimensions scaled
Widget dimensions scaled for current zoom level.
Definition: window_gui.h:68
BM_TRANSPARENT
@ BM_TRANSPARENT
Perform transparency darkening 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.
Font::fc
FontCache * fc
The font we are using.
Definition: gfx_layout.h:77
CursorVars::sprite_count
uint sprite_count
number of sprites to draw
Definition: gfx_type.h:130
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:36
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:40
Blitter::BlitterParams::width
int width
The width in pixels that needs to be drawn to dst.
Definition: base.hpp:38
SPRITE_WIDTH
@ SPRITE_WIDTH
number of bits for the sprite number
Definition: sprites.h:1527
Backup
Class to backup a specific variable and restore it later.
Definition: backup_type.hpp:21
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:209
FS_BEGIN
@ FS_BEGIN
First font.
Definition: gfx_type.h:209
Blitter
How all blitters should look like.
Definition: base.hpp:29
Blitter::BlitterParams::sprite_height
int sprite_height
Real height of the sprite.
Definition: base.hpp:41
CursorVars::visible
bool visible
cursor is visible
Definition: gfx_type.h:139
StringID
uint32_t StringID
Numeric value that represents a string, independent of the selected language.
Definition: strings_type.h:16
PC_WHITE
static const uint8_t PC_WHITE
White palette colour.
Definition: palette_func.h:58
_newgrf_debug_sprite_picker
NewGrfDebugSpritePicker _newgrf_debug_sprite_picker
The sprite picker.
Definition: newgrf_debug_gui.cpp:49
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:295
GB
constexpr static debug_inline uint GB(const T x, const uint8_t s, const uint8_t n)
Fetch n bits from x, started at bit s.
Definition: bitmath_func.hpp:32
Blitter::GetScreenDepth
virtual uint8_t GetScreenDepth()=0
Get the screen depth this blitter works for.
NewGrfDebugSpritePicker::sprites
std::vector< SpriteID > sprites
Sprites found.
Definition: newgrf_debug.h:28
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:26
CursorVars::animate_list
const AnimCursor * animate_list
in case of animated cursor, list of frames
Definition: gfx_type.h:135
Blitter::SetPixel
virtual void SetPixel(void *video, int x, int y, uint8_t colour)=0
Draw a pixel with a given colour on the video-buffer.
PalSpriteID::sprite
SpriteID sprite
The 'real' sprite.
Definition: gfx_type.h:23
Blitter::BlitterParams::dst
void * dst
Destination buffer.
Definition: base.hpp:45
PALETTE_TO_TRANSPARENT
static const PaletteID PALETTE_TO_TRANSPARENT
This sets the sprite to transparent.
Definition: sprites.h:1599
GetCharacterWidth
byte GetCharacterWidth(FontSize size, char32_t key)
Return width of character glyph.
Definition: gfx.cpp:1250
FS_LARGE
@ FS_LARGE
Index of the large font in the font tables.
Definition: gfx_type.h:205
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.
_ctrl_pressed
bool _ctrl_pressed
Is Ctrl pressed?
Definition: gfx.cpp:37
FILLRECT_CHECKER
@ FILLRECT_CHECKER
Draw only every second pixel, used for greying-out.
Definition: gfx_type.h:294
GetStringListWidth
uint GetStringListWidth(const StringID *list, FontSize fontsize)
Get maximum width of a list of strings.
Definition: gfx.cpp:875
TextColour
TextColour
Colour of the strings, see _string_colourmap in table/string_colours.h or docs/ottd-colourtext-palett...
Definition: gfx_type.h:253
zoom_func.h
Blitter::BlitterParams::sprite_width
int sprite_width
Real width of the sprite.
Definition: base.hpp:40
DrawSpriteToRgbaBuffer
std::unique_ptr< uint32_t[]> DrawSpriteToRgbaBuffer(SpriteID spriteId, ZoomLevel zoom)
Draws a sprite to a new RGBA buffer (see Colour union) instead of drawing to the screen.
Definition: gfx.cpp:1163
ZoomLevel
ZoomLevel
All zoom levels we know.
Definition: zoom_type.h:19
CeilDiv
constexpr uint CeilDiv(uint a, uint b)
Computes ceil(a / b) for non-negative a and b.
Definition: math_func.hpp:320
SA_BOTTOM
@ SA_BOTTOM
Bottom align the text.
Definition: gfx_type.h:345
Blitter::BlitterParams::pitch
int pitch
The pitch of the destination buffer.
Definition: base.hpp:46
StringAlignment
StringAlignment
How to align the to-be drawn text.
Definition: gfx_type.h:337
_settings_client
ClientSettings _settings_client
The current settings for this game.
Definition: settings.cpp:54
SetColourRemap
static void SetColourRemap(TextColour colour)
Set the colour remap to be for the given colour.
Definition: gfx.cpp:467
newgrf_debug.h
FillRectMode
FillRectMode
Define the operation GfxFillRect performs.
Definition: gfx_type.h:292
CursorVars::UpdateCursorPositionRelative
void UpdateCursorPositionRelative(int delta_x, int delta_y)
Update cursor position based on a relative change.
Definition: gfx.cpp:1735
SA_RIGHT
@ SA_RIGHT
Right align the text (must be a single bit).
Definition: gfx_type.h:340
SA_VERT_CENTER
@ SA_VERT_CENTER
Vertically center the text.
Definition: gfx_type.h:344
_gui_zoom
ZoomLevel _gui_zoom
GUI Zoom level.
Definition: gfx.cpp:60
CursorVars::draw_size
Point draw_size
position and size bounding-box for drawing
Definition: gfx_type.h:133
VideoDriver::ClearSystemSprites
virtual void ClearSystemSprites()
Clear all cached sprites.
Definition: video_driver.hpp:106
SubSprite
Used to only draw a part of the sprite.
Definition: gfx_type.h:225
PaletteID
uint32_t PaletteID
The number of the palette.
Definition: gfx_type.h:18
GUISettings::zoom_max
ZoomLevel zoom_max
maximum zoom out level
Definition: settings_type.h:158
CursorVars::sprite_pos
Point sprite_pos[16]
relative position of individual sprites
Definition: gfx_type.h:129
Debug
#define Debug(category, level, format_string,...)
Ouptut a line of debugging information.
Definition: debug.h:37
_gui_scale
int _gui_scale
GUI scale, 100 is 100%.
Definition: gfx.cpp:62
GetStringLineCount
int GetStringLineCount(StringID str, int maxw)
Calculates number of lines of string.
Definition: gfx.cpp:729
FontCache::GetDrawGlyphShadow
virtual bool GetDrawGlyphShadow()=0
Do we need to draw a glyph shadow?
control_codes.h
SpriteType::Recolour
@ Recolour
Recolour sprite.
GfxDoDrawLine
static void GfxDoDrawLine(void *video, int x, int y, int x2, int y2, int screen_width, int screen_height, uint8_t 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:312
UpdateCursorSize
void UpdateCursorSize()
Update cursor dimension.
Definition: gfx.cpp:1621
BM_NORMAL
@ BM_NORMAL
Perform the simple blitting.
Definition: base.hpp:18
ParagraphLayouter::Line
A single line worth of VisualRuns.
Definition: gfx_layout.h:106
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:497
RoundDivSU
constexpr int RoundDivSU(int a, uint b)
Computes round(a / b) for signed a and unsigned b.
Definition: math_func.hpp:342
AdjustGUIZoom
bool AdjustGUIZoom(bool automatic)
Resolve GUI zoom level and adjust GUI to new zoom, if auto-suggestion is requested.
Definition: gfx.cpp:1814
include
bool include(Container &container, typename Container::const_reference &item)
Helper function to append an item to a container if it is not already contained.
Definition: container_func.hpp:24
ScaleGUITrad
int ScaleGUITrad(int value)
Scale traditional pixel dimensions to GUI zoom level.
Definition: zoom_func.h:117
Blitter::BlitterParams::sprite
const void * sprite
Pointer to the sprite how ever the encoder stored it.
Definition: base.hpp:33
window_gui.h
_gui_scale_cfg
int _gui_scale_cfg
GUI scale in config.
Definition: gfx.cpp:63
ZOOM_LVL_MIN
@ ZOOM_LVL_MIN
Minimum zoom level.
Definition: zoom_type.h:43
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:920
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.
GUISettings::fast_forward_speed_limit
uint16_t fast_forward_speed_limit
Game speed to use when fast-forward is enabled.
Definition: settings_type.h:202
Blitter::DrawLine
virtual void DrawLine(void *video, int x, int y, int x2, int y2, int screen_width, int screen_height, uint8_t colour, int width, int dash=0)=0
Draw a line with a given colour.
FS_NORMAL
@ FS_NORMAL
Index of the normal font in the font tables.
Definition: gfx_type.h:203
SA_TOP
@ SA_TOP
Top align the text.
Definition: gfx_type.h:343
SetMouseCursor
void SetMouseCursor(CursorID sprite, PaletteID pal)
Assign a single non-animated sprite to the cursor.
Definition: gfx.cpp:1708
PALETTE_WIDTH
@ PALETTE_WIDTH
number of bits of the sprite containing the recolour palette
Definition: sprites.h:1526
_screen_disable_anim
bool _screen_disable_anim
Disable palette animation (important for 32bpp-anim blitter during giant screenshot)
Definition: gfx.cpp:45
Blitter::BufferSize
virtual size_t BufferSize(uint width, uint height)=0
Calculate how much memory there is needed for an image of this size in the video-buffer.
Palette::palette
Colour palette[256]
Current palette. Entry 0 has to be always fully transparent!
Definition: gfx_type.h:324
FS_SMALL
@ FS_SMALL
Index of the small font in the font tables.
Definition: gfx_type.h:204
Layouter::GetBounds
Dimension GetBounds()
Get the boundaries of this paragraph.
Definition: gfx_layout.cpp:199
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:125
Sprite::width
uint16_t width
Width of the sprite.
Definition: spritecache.h:19
GetGlyphWidth
uint GetGlyphWidth(FontSize size, char32_t key)
Get the width of a glyph.
Definition: fontcache.h:195
_pause_mode
PauseMode _pause_mode
The current pause mode.
Definition: gfx.cpp:50
_string_colourmap
static const byte _string_colourmap[17]
Colour mapping for TextColour.
Definition: string_colours.h:11
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:276
BlitterFactory::GetCurrentBlitter
static Blitter * GetCurrentBlitter()
Get the current active blitter (always set by calling SelectBlitter).
Definition: factory.hpp:138
SA_FORCE
@ SA_FORCE
Force the alignment, i.e. don't swap for RTL languages.
Definition: gfx_type.h:350
CursorVars::total_size
Point total_size
union of sprite properties
Definition: gfx_type.h:131
BM_CRASH_REMAP
@ BM_CRASH_REMAP
Perform a crash remapping.
Definition: base.hpp:22
safeguards.h
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:31
CursorID
uint32_t CursorID
The number of the cursor (sprite)
Definition: gfx_type.h:19
CursorVars::fix_at
bool fix_at
mouse is moving, but cursor is not (used for scrolling)
Definition: gfx_type.h:120
_switch_mode_time
std::chrono::steady_clock::time_point _switch_mode_time
The time when the switch mode was requested.
Definition: gfx.cpp:49
GetStringHeight
int GetStringHeight(std::string_view str, int maxw, FontSize fontsize)
Calculates height of string (in pixels).
Definition: gfx.cpp:705
RedrawScreenRect
void RedrawScreenRect(int left, int top, int right, int bottom)
Repaints a specific rectangle of the screen.
Definition: gfx.cpp:1394
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:277
_networking
bool _networking
are we in networking mode?
Definition: network.cpp:59
_shift_pressed
bool _shift_pressed
Is Shift pressed?
Definition: gfx.cpp:38
DrawDirtyBlocks
void DrawDirtyBlocks()
Repaints the rectangle blocks which are marked as 'dirty'.
Definition: gfx.cpp:1420
GlyphID
uint32_t GlyphID
Glyphs are characters from a font.
Definition: fontcache.h:17
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:1007
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:741
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:121
CenterBounds
int CenterBounds(int min, int max, int size)
Determine where to draw a centred object inside a widget.
Definition: gfx_func.h:166
PauseMode
PauseMode
Modes of pausing we've got.
Definition: openttd.h:62
BM_BLACK_REMAP
@ BM_BLACK_REMAP
Perform remapping to a completely blackened sprite.
Definition: base.hpp:23
SetAnimatedMouseCursor
void SetAnimatedMouseCursor(const AnimCursor *table)
Assign an animation to the cursor.
Definition: gfx.cpp:1721
_game_speed
uint16_t _game_speed
Current game-speed; 100 is 1x, 0 is infinite.
Definition: gfx.cpp:39
stdafx.h
GameMode
GameMode
Mode which defines the state of the game.
Definition: openttd.h:18
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:113
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:72
SpriteID
uint32_t SpriteID
The number of a sprite, without mapping bits and colourtables.
Definition: gfx_type.h:17
PALETTE_MODIFIER_TRANSPARENT
@ PALETTE_MODIFIER_TRANSPARENT
when a sprite is to be displayed transparently, this bit needs to be set.
Definition: sprites.h:1541
VideoDriver::GetInstance
static VideoDriver * GetInstance()
Get the currently active instance of the video driver.
Definition: video_driver.hpp:200
viewport_func.h
SA_HOR_CENTER
@ SA_HOR_CENTER
Horizontally center the text.
Definition: gfx_type.h:339
Window::AllWindows
Iterable ensemble of all valid Windows.
Definition: window_gui.h:906
Font
Container with information about a font.
Definition: gfx_layout.h:75
GetDigitWidth
byte GetDigitWidth(FontSize size)
Return the maximum width of single digit.
Definition: gfx.cpp:1263
UnScaleByZoomLower
int UnScaleByZoomLower(int value, ZoomLevel zoom)
Scale by zoom level, usually shift right (when zoom > ZOOM_LVL_NORMAL)
Definition: zoom_func.h:67
Colour::data
uint32_t data
Conversion of the channel information to a 32 bit number.
Definition: gfx_type.h:160
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:1278
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:1571
ParagraphLayouter::VisualRun
Visual run contains data about the bit of text with the same font.
Definition: gfx_layout.h:94
GetSpriteSize
Dimension GetSpriteSize(SpriteID sprid, Point *offset, ZoomLevel zoom)
Get the size of a sprite.
Definition: gfx.cpp:941
GUISettings::zoom_min
ZoomLevel zoom_min
minimum zoom out level
Definition: settings_type.h:157
Font::colour
TextColour colour
The colour this font has to be.
Definition: gfx_layout.h:78
_switch_mode
SwitchMode _switch_mode
The next mainloop command.
Definition: gfx.cpp:48
_font_zoom
ZoomLevel _font_zoom
Sprite font Zoom level (not clamped)
Definition: gfx.cpp:61
FontCache::MapCharToGlyph
virtual GlyphID MapCharToGlyph(char32_t key, bool fallback=true)=0
Map a character into a glyph.
DrawStringMultiLine
int DrawStringMultiLine(int left, int right, int top, int bottom, std::string_view str, TextColour colour, StringAlignment align, bool underline, FontSize fontsize)
Draw string, possibly over multiple lines.
Definition: gfx.cpp:775
GfxBlitter
static void GfxBlitter(const Sprite *const sprite, int x, int y, BlitterMode mode, const SubSprite *const sub, SpriteID sprite_id, ZoomLevel zoom, const DrawPixelInfo *dst=nullptr)
The code for setting up the blitter mode and sprite information before finally drawing the sprite.
Definition: gfx.cpp:1039
PALETTE_CRASH
static const PaletteID PALETTE_CRASH
Recolour sprite greying of crashed vehicles.
Definition: sprites.h:1602
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
UnScaleByZoom
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
SA_VERT_MASK
@ SA_VERT_MASK
Mask for vertical alignment.
Definition: gfx_type.h:346
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...
abs
constexpr T abs(const T a)
Returns the absolute value of (scalar) variable.
Definition: math_func.hpp:23
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:211
Blitter::DrawRect
virtual void DrawRect(void *video, int width, int height, uint8_t colour)=0
Make a single horizontal line in a single colour on the video-buffer.
Sprite::y_offs
int16_t y_offs
Number of pixels to shift the sprite downwards.
Definition: spritecache.h:21
UpdateAllVirtCoords
void UpdateAllVirtCoords()
Update the viewport coordinates of all signs.
Definition: afterload.cpp:222
_stringwidth_table
static byte _stringwidth_table[FS_END][224]
Cache containing width of often used characters.
Definition: gfx.cpp:52
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:42
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:961
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:170
GetString
std::string GetString(StringID string)
Resolve the given StringID into a std::string with all the associated DParam lookups and formatting.
Definition: strings.cpp:327
GfxClearFontSpriteCache
void GfxClearFontSpriteCache()
Remove all encoded font sprites from the sprite cache without discarding sprite location information.
Definition: spritecache.cpp:1051
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:370
SetCursorSprite
static void SetCursorSprite(CursorID cursor, PaletteID pal)
Switch cursor to different sprite.
Definition: gfx.cpp:1657
container_func.hpp
AnimCursor
A single sprite of a list of animated cursors.
Definition: gfx_type.h:108
VideoDriver::GetSuggestedUIScale
virtual int GetSuggestedUIScale()
Get a suggested default GUI scale taking screen DPI into account.
Definition: video_driver.hpp:170
DrawCharCentered
void DrawCharCentered(char32_t c, const Rect &r, TextColour colour)
Draw single character horizontally centered around (x,y)
Definition: gfx.cpp:924
SA_LEFT
@ SA_LEFT
Left align the text.
Definition: gfx_type.h:338
network.h
UnScaleGUI
int UnScaleGUI(int value)
Short-hand to apply GUI zoom level.
Definition: zoom_func.h:77
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
CursorVars::sprite_seq
PalSpriteID sprite_seq[16]
current image of cursor
Definition: gfx_type.h:128
GetCharacterHeight
int GetCharacterHeight(FontSize size)
Get height of a character for a given font size.
Definition: fontcache.cpp:78
lengthof
#define lengthof(x)
Return the length of an fixed size array.
Definition: stdafx.h:300
MarkWholeScreenDirty
void MarkWholeScreenDirty()
This function mark the whole screen as dirty.
Definition: gfx.cpp:1552
MemSetT
void MemSetT(T *ptr, byte value, size_t num=1)
Type-safe version of memset().
Definition: mem_func.hpp:49
DrawRectOutline
void DrawRectOutline(const Rect &r, int colour, int width, int dash)
Draw the outline of a Rect.
Definition: gfx.cpp:455
Blitter::BlitterParams
Parameters related to blitting.
Definition: base.hpp:32
FS_MONO
@ FS_MONO
Index of the monospaced font in the font tables.
Definition: gfx_type.h:206
DrawString
int DrawString(int left, int right, int top, std::string_view str, TextColour colour, StringAlignment align, bool underline, FontSize fontsize)
Draw string, possibly truncated to make it fit in its allocated space.
Definition: gfx.cpp:658
ZOOM_LVL_NORMAL
@ ZOOM_LVL_NORMAL
The normal zoom level.
Definition: zoom_type.h:22
SPR_CURSOR_MOUSE
static const CursorID SPR_CURSOR_MOUSE
Cursor sprite numbers.
Definition: sprites.h:1382
GetCharPosInString
Point GetCharPosInString(std::string_view 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:892
PalSpriteID::pal
PaletteID pal
The palette (use PAL_NONE) if not needed)
Definition: gfx_type.h:24
Layouter::GetCharPosition
Point GetCharPosition(std::string_view::const_iterator ch) const
Get the position of a character in the layout.
Definition: gfx_layout.cpp:228
Blitter::BlitterParams::height
int height
The height in pixels that needs to be drawn to dst.
Definition: base.hpp:39
FontSize
FontSize
Available font sizes.
Definition: gfx_type.h:202
GetCharAtPosition
ptrdiff_t GetCharAtPosition(std::string_view str, int x, FontSize start_fontsize)
Get the character from a string that is drawn at a specific position.
Definition: gfx.cpp:909
Window
Data structure for an opened window.
Definition: window_gui.h:267
Clamp
constexpr T Clamp(const T a, const T min, const T max)
Clamp a value between an interval.
Definition: math_func.hpp:79
ZOOM_LVL_OUT_4X
@ ZOOM_LVL_OUT_4X
Zoomed 4 times out.
Definition: zoom_type.h:24
Rect
Specification of a rectangle with absolute coordinates of all edges.
Definition: geometry_type.hpp:75
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:37
_right_button_clicked
bool _right_button_clicked
Is right mouse button clicked?
Definition: gfx.cpp:43
ScaleByZoom
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
Sprite
Data structure describing a sprite.
Definition: spritecache.h:17
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:34
BM_TRANSPARENT_REMAP
@ BM_TRANSPARENT_REMAP
Perform transparency colour remapping.
Definition: base.hpp:21
UpdateGUIZoom
void UpdateGUIZoom()
Resolve GUI zoom level, if auto-suggestion is requested.
Definition: gfx.cpp:1791
Align
constexpr T Align(const T x, uint n)
Return the smallest multiple of n equal or greater than x.
Definition: math_func.hpp:37
_left_button_clicked
bool _left_button_clicked
Is left mouse button clicked?
Definition: gfx.cpp:41
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:56
SetupWidgetDimensions
void SetupWidgetDimensions()
Set up pre-scaled versions of Widget Dimensions.
Definition: widget.cpp:66
GetStringBoundingBox
Dimension GetStringBoundingBox(std::string_view str, FontSize start_fontsize)
Return the string dimension in pixels.
Definition: gfx.cpp:852
SpriteType::Normal
@ Normal
The most basic (normal) sprite.
_right_button_down
bool _right_button_down
Is right mouse button pressed?
Definition: gfx.cpp:42
PALETTE_ALL_BLACK
static const PaletteID PALETTE_ALL_BLACK
Exchange any color by black, needed for painting fictive tiles outside map.
Definition: sprites.h:1608
INVALID_STRING_ID
static const StringID INVALID_STRING_ID
Constant representing an invalid string (16bit in case it is used in savegames)
Definition: strings_type.h:17
ClientSettings::gui
GUISettings gui
settings related to the GUI
Definition: settings_type.h:636
DrawPixelInfo
Data about how and where to blit pixels.
Definition: gfx_type.h:151
Layouter::GetCharAtPosition
ptrdiff_t GetCharAtPosition(int x, size_t line_index) const
Get the character that is at a pixel position in the first line of the layouted text.
Definition: gfx_layout.cpp:288
backup_type.hpp
DrawSpriteViewport
void DrawSpriteViewport(SpriteID img, PaletteID pal, int x, int y, const SubSprite *sub)
Draw a sprite in a viewport.
Definition: gfx.cpp:979
HasBit
constexpr debug_inline bool HasBit(const T x, const uint8_t y)
Checks if a bit in a value is set.
Definition: bitmath_func.hpp:103