Kiwano Engine v1.2.x
Renderer.h
1// Copyright (c) 2016-2018 Kiwano - Nomango
2//
3// Permission is hereby granted, free of charge, to any person obtaining a copy
4// of this software and associated documentation files (the "Software"), to deal
5// in the Software without restriction, including without limitation the rights
6// to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
7// copies of the Software, and to permit persons to whom the Software is
8// furnished to do so, subject to the following conditions:
9//
10// The above copyright notice and this permission notice shall be included in
11// all copies or substantial portions of the Software.
12//
13// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
14// IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
15// FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
16// AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
17// LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
18// OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
19// THE SOFTWARE.
20
21#pragma once
22#include <kiwano/base/Module.h>
23#include <kiwano/render/Font.h>
24#include <kiwano/render/GifImage.h>
25#include <kiwano/render/TextStyle.h>
26#include <kiwano/render/RenderContext.h>
27#include <kiwano/platform/Window.h>
28
29namespace kiwano
30{
31
47class KGE_API Renderer : public Module
48{
49public:
52 static Renderer& GetInstance();
53
56 virtual Color GetClearColor() const;
57
60 Size GetOutputSize() const;
61
64 RenderContext& GetContext();
65
68 virtual void Resize(uint32_t width, uint32_t height) = 0;
69
72 void SetClearColor(const Color& clear_color);
73
76 void SetVSyncEnabled(bool enabled);
77
80 void ResetResolutionWhenWindowResized(bool enabled);
81
86 virtual void CreateTexture(Texture& texture, const String& file_path) = 0;
87
92 virtual void CreateTexture(Texture& texture, const BinaryData& data) = 0;
93
100 virtual void CreateTexture(Texture& texture, const PixelSize& size, const BinaryData& data, PixelFormat format) = 0;
101
106 virtual void CreateGifImage(GifImage& gif, const String& file_path) = 0;
107
112 virtual void CreateGifImage(GifImage& gif, const BinaryData& data) = 0;
113
119 virtual void CreateGifImageFrame(GifImage::Frame& frame, const GifImage& gif, size_t frame_index) = 0;
120
126 virtual void CreateFontCollection(Font& font, Vector<String>& family_names, const String& file_path) = 0;
127
133 virtual void CreateFontCollection(Font& font, Vector<String>& family_names, const BinaryData& data) = 0;
134
140 virtual void CreateTextLayout(TextLayout& layout, const String& content, const TextStyle& style) = 0;
141
147 virtual void CreateLineShape(Shape& shape, const Point& begin_pos, const Point& end_pos) = 0;
148
153 virtual void CreateRectShape(Shape& shape, const Rect& rect) = 0;
154
160 virtual void CreateRoundedRectShape(Shape& shape, const Rect& rect, const Vec2& radius) = 0;
161
167 virtual void CreateEllipseShape(Shape& shape, const Point& center, const Vec2& radius) = 0;
168
172 virtual void CreateShapeSink(ShapeMaker& maker) = 0;
173
178 virtual void CreateBrush(Brush& brush, const Color& color) = 0;
179
184 virtual void CreateBrush(Brush& brush, const LinearGradientStyle& style) = 0;
185
190 virtual void CreateBrush(Brush& brush, const RadialGradientStyle& style) = 0;
191
196 virtual void CreateBrush(Brush& brush, TexturePtr texture) = 0;
197
206 virtual void CreateStrokeStyle(StrokeStyle& stroke_style) = 0;
207
213 virtual RenderContextPtr CreateTextureRenderContext(TexturePtr texture, const PixelSize& desired_size) = 0;
214
215public:
218 virtual void Clear() = 0;
219
223 virtual void Present() = 0;
224
228 virtual void MakeContextForWindow(WindowPtr window) = 0;
229
232 virtual void Destroy();
233
236 void HandleEvent(EventModuleContext& ctx) override;
237
238protected:
239 Renderer();
240
241protected:
242 bool vsync_;
243 bool auto_reset_resolution_;
244 Color clear_color_;
245 Size output_size_;
246 RenderContextPtr render_ctx_;
247};
248
252{
253 return *render_ctx_;
254}
255
257{
258 return output_size_;
259}
260
262{
263 return clear_color_;
264}
265
266} // namespace kiwano
画刷
Definition: Brush.h:94
Definition: Color.h:41
时间模块上下文
Definition: Module.h:96
字体
Definition: Font.h:90
GIF图像
Definition: GifImage.h:39
基础模块
Definition: Module.h:111
渲染上下文
Definition: RenderContext.h:64
渲染器
Definition: Renderer.h:48
virtual RenderContextPtr CreateTextureRenderContext(TexturePtr texture, const PixelSize &desired_size)=0
创建纹理渲染上下文,将上下文的渲染输出到纹理中
virtual void CreateTexture(Texture &texture, const String &file_path)=0
创建纹理内部资源
virtual void CreateRoundedRectShape(Shape &shape, const Rect &rect, const Vec2 &radius)=0
创建圆角矩形形状内部资源
RenderContext & GetContext()
获取渲染上下文
Definition: Renderer.h:251
virtual void CreateLineShape(Shape &shape, const Point &begin_pos, const Point &end_pos)=0
创建线段形状内部资源
virtual void CreateRectShape(Shape &shape, const Rect &rect)=0
创建矩形形状内部资源
virtual void CreateShapeSink(ShapeMaker &maker)=0
创建几何图形生成器内部资源
virtual void CreateFontCollection(Font &font, Vector< String > &family_names, const BinaryData &data)=0
创建字体集内部资源
virtual void MakeContextForWindow(WindowPtr window)=0
为窗口创建渲染上下文
virtual void CreateTexture(Texture &texture, const BinaryData &data)=0
创建纹理内部资源
virtual void CreateBrush(Brush &brush, const RadialGradientStyle &style)=0
创建径向渐变画刷内部资源
Size GetOutputSize() const
获取渲染输出大小
Definition: Renderer.h:256
virtual void CreateFontCollection(Font &font, Vector< String > &family_names, const String &file_path)=0
创建字体集内部资源
virtual void CreateGifImageFrame(GifImage::Frame &frame, const GifImage &gif, size_t frame_index)=0
创建GIF关键帧内部资源
virtual Color GetClearColor() const
获取清屏颜色
Definition: Renderer.h:261
virtual void CreateTextLayout(TextLayout &layout, const String &content, const TextStyle &style)=0
创建文字布局内部资源
virtual void Present()=0
将绘制内容呈现至窗口
virtual void CreateBrush(Brush &brush, const LinearGradientStyle &style)=0
创建线性渐变画刷内部资源
virtual void CreateStrokeStyle(StrokeStyle &stroke_style)=0
创建线条样式内部资源
virtual void Resize(uint32_t width, uint32_t height)=0
重设渲染输出大小
virtual void CreateBrush(Brush &brush, const Color &color)=0
创建纯色画刷内部资源
virtual void Clear()=0
清除绘制内容
virtual void CreateTexture(Texture &texture, const PixelSize &size, const BinaryData &data, PixelFormat format)=0
从内存加载位图纹理资源
virtual void CreateBrush(Brush &brush, TexturePtr texture)=0
创建纹理画刷内部资源
virtual void CreateEllipseShape(Shape &shape, const Point &center, const Vec2 &radius)=0
创建椭圆形状内部资源
virtual void CreateGifImage(GifImage &gif, const BinaryData &data)=0
创建GIF图像内部资源
virtual void CreateGifImage(GifImage &gif, const String &file_path)=0
创建GIF图像内部资源
形状生成器
Definition: ShapeMaker.h:47
形状
Definition: Shape.h:40
线条样式
Definition: StrokeStyle.h:70
文本布局
Definition: TextLayout.h:39
文本样式
Definition: TextStyle.h:51
纹理
Definition: Texture.h:66
PixelFormat
像素格式
Definition: Texture.h:56
二进制数据
Definition: BinaryData.h:30
GIF帧
Definition: GifImage.h:89
线性渐变样式
Definition: Brush.h:61
径向渐变样式
Definition: Brush.h:76