1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
|
/*
* Canvas.h, part of VCMI engine
*
* Authors: listed in file AUTHORS in main folder
*
* License: GNU General Public License v2.0 or later
* Full text of license available in license.txt file, in main folder
*
*/
#pragma once
#include "../gui/TextAlignment.h"
#include "../../lib/Rect.h"
#include "../../lib/Color.h"
struct SDL_Surface;
class IImage;
class IVideoInstance;
enum EFonts : int8_t;
enum class CanvasScalingPolicy
{
AUTO, // automatically scale canvas operations by global scaling factor
IGNORE // disable any scaling processing. Scaling factor will be set to 1
};
/// Class that represents surface for drawing on
class Canvas
{
friend class CanvasClipRectGuard;
/// Upscaler awareness. Must be first member for initialization
CanvasScalingPolicy scalingPolicy;
/// Target surface
SDL_Surface * surface;
/// Current rendering area, all rendering operations will be moved into selected area
Rect renderArea;
/// constructs canvas using existing surface. Caller maintains ownership on the surface
explicit Canvas(SDL_Surface * surface, CanvasScalingPolicy scalingPolicy);
/// copy constructor
Canvas(const Canvas & other);
Point transformPos(const Point & input);
Point transformSize(const Point & input);
public:
Canvas & operator = (const Canvas & other) = delete;
Canvas & operator = (Canvas && other) = delete;
/// move constructor
Canvas(Canvas && other);
/// creates canvas that only covers specified subsection of a surface
Canvas(const Canvas & other, const Rect & clipRect);
/// constructs canvas of specified size
explicit Canvas(const Point & size, CanvasScalingPolicy scalingPolicy);
/// constructs canvas using existing surface. Caller maintains ownership on the surface
/// Compatibility method. AVOID USAGE. To be removed once SDL abstraction layer is finished.
static Canvas createFromSurface(SDL_Surface * surface, CanvasScalingPolicy scalingPolicy);
~Canvas();
/// if set to true, drawing this canvas onto another canvas will use alpha channel information
void applyTransparency(bool on);
/// applies grayscale filter onto current image
void applyGrayscale();
/// renders image onto this canvas at specified position
void draw(const std::shared_ptr<IImage>& image, const Point & pos);
void draw(const IImage& image, const Point & pos);
void draw(IVideoInstance & video, const Point & pos);
/// renders section of image bounded by sourceRect at specified position
void draw(const std::shared_ptr<IImage>& image, const Point & pos, const Rect & sourceRect);
/// renders another canvas onto this canvas
void draw(const Canvas &image, const Point & pos);
/// renders another canvas onto this canvas with transparency
void drawTransparent(const Canvas & image, const Point & pos, double transparency);
/// renders another canvas onto this canvas with scaling
void drawScaled(const Canvas &image, const Point & pos, const Point & targetSize);
/// renders single pixels with specified color
void drawPoint(const Point & dest, const ColorRGBA & color);
/// renders continuous, 1-pixel wide line with color gradient
void drawLine(const Point & from, const Point & dest, const ColorRGBA & colorFrom, const ColorRGBA & colorDest);
/// renders rectangular, solid-color border in specified location
void drawBorder(const Rect & target, const ColorRGBA & color, int width = 1);
/// renders rectangular, dashed border in specified location
void drawBorderDashed(const Rect & target, const ColorRGBA & color);
/// renders single line of text with specified parameters
void drawText(const Point & position, const EFonts & font, const ColorRGBA & colorDest, ETextAlignment alignment, const std::string & text );
/// renders multiple lines of text with specified parameters
void drawText(const Point & position, const EFonts & font, const ColorRGBA & colorDest, ETextAlignment alignment, const std::vector<std::string> & text );
/// fills selected area with solid color
void drawColor(const Rect & target, const ColorRGBA & color);
/// fills selected area with blended color
void drawColorBlended(const Rect & target, const ColorRGBA & color);
/// fills canvas with texture
void fillTexture(const std::shared_ptr<IImage>& image);
int getScalingFactor() const;
/// get the render area
Rect getRenderArea() const;
};
class CanvasClipRectGuard : boost::noncopyable
{
SDL_Surface * surf;
Rect oldRect;
public:
CanvasClipRectGuard(Canvas & canvas, const Rect & rect);
~CanvasClipRectGuard();
};
|
