Kiwano Engine v1.3.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/Shader.h>
27#include <kiwano/render/RenderContext.h>
28#include <kiwano/platform/Window.h>
29
30namespace kiwano
31{
32
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 CreateBitmap(Bitmap& bitmap, StringView file_path) = 0;
87
92 virtual void CreateBitmap(Bitmap& bitmap, const BinaryData& data) = 0;
93
100 virtual void CreateBitmap(Bitmap& bitmap, const PixelSize& size, const BinaryData& data, PixelFormat format) = 0;
101
106 virtual void CreateGifImage(GifImage& gif, StringView 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(FontCollection& collection, Vector<String>& family_names,
127 const Vector<String>& file_paths) = 0;
128
134 virtual void CreateFontCollection(FontCollection& collection, Vector<String>& family_names,
135 const Vector<BinaryData>& datas) = 0;
136
142 virtual void CreateTextLayout(TextLayout& layout, StringView content, const TextStyle& style) = 0;
143
149 virtual void CreateLineShape(Shape& shape, const Point& begin_pos, const Point& end_pos) = 0;
150
155 virtual void CreateRectShape(Shape& shape, const Rect& rect) = 0;
156
162 virtual void CreateRoundedRectShape(Shape& shape, const Rect& rect, const Vec2& radius) = 0;
163
169 virtual void CreateEllipseShape(Shape& shape, const Point& center, const Vec2& radius) = 0;
170
174 virtual void CreateShapeSink(ShapeMaker& maker) = 0;
175
180 virtual void CreateBrush(Brush& brush, const Color& color) = 0;
181
186 virtual void CreateBrush(Brush& brush, const LinearGradientStyle& style) = 0;
187
192 virtual void CreateBrush(Brush& brush, const RadialGradientStyle& style) = 0;
193
198 virtual void CreateBrush(Brush& brush, RefPtr<Image> image, const Rect& src_rect) = 0;
199
208 virtual void CreateStrokeStyle(StrokeStyle& stroke_style) = 0;
209
214 virtual void CreatePixelShader(PixelShader& shader, const BinaryData& cso_data) = 0;
215
221 virtual RefPtr<RenderContext> CreateContextForBitmap(RefPtr<Bitmap> bitmap, const Size& desired_size) = 0;
222
229
235
236public:
239 virtual void Clear() = 0;
240
244 virtual void Present() = 0;
245
249 virtual void MakeContextForWindow(RefPtr<Window> window) = 0;
250
253 virtual void Destroy();
254
257 void HandleEvent(EventModuleContext& ctx) override;
258
259protected:
260 Renderer();
261
262protected:
263 bool vsync_;
264 bool auto_reset_resolution_;
265 Color clear_color_;
266 Size dip_size_;
267 RefPtr<RenderContext> render_ctx_;
268};
269
273{
274 return *render_ctx_;
275}
276
278{
279 return dip_size_;
280}
281
283{
284 return clear_color_;
285}
286
287} // namespace kiwano
位图
Definition: Bitmap.h:95
画刷
Definition: Brush.h:92
Definition: Color.h:41
时间模块上下文
Definition: Module.h:96
字体集合
Definition: Font.h:89
GIF图像
Definition: GifImage.h:38
基础模块
Definition: Module.h:111
像素着色器
Definition: Shader.h:53
引用计数智能指针
Definition: RefBasePtr.hpp:35
渲染上下文
Definition: RenderContext.h:62
渲染器
Definition: Renderer.h:48
virtual RefPtr< RenderContext > CreateContextForBitmapInPixels(RefPtr< Bitmap > bitmap, const PixelSize &desired_size)=0
创建渲染上下文,将上下文的渲染输出到位图中
virtual void CreateRoundedRectShape(Shape &shape, const Rect &rect, const Vec2 &radius)=0
创建圆角矩形形状
virtual void CreateBrush(Brush &brush, RefPtr< Image > image, const Rect &src_rect)=0
创建图像画刷
virtual void CreateBitmap(Bitmap &bitmap, const PixelSize &size, const BinaryData &data, PixelFormat format)=0
从内存加载位图位图资源
virtual void CreateBitmap(Bitmap &bitmap, const BinaryData &data)=0
创建位图
RenderContext & GetContext()
获取渲染上下文
Definition: Renderer.h:272
virtual void CreateFontCollection(FontCollection &collection, Vector< String > &family_names, const Vector< String > &file_paths)=0
创建字体集合
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 RefPtr< RenderContext > CreateContextForBitmap(RefPtr< Bitmap > bitmap, const Size &desired_size)=0
创建渲染上下文,将上下文的渲染输出到位图中
virtual void CreateBitmap(Bitmap &bitmap, StringView file_path)=0
创建位图
virtual void CreateFontCollection(FontCollection &collection, Vector< String > &family_names, const Vector< BinaryData > &datas)=0
创建字体集合
virtual void CreateBrush(Brush &brush, const RadialGradientStyle &style)=0
创建径向渐变画刷
Size GetOutputSize() const
获取渲染输出大小
Definition: Renderer.h:277
virtual void CreateGifImageFrame(GifImage::Frame &frame, const GifImage &gif, size_t frame_index)=0
创建GIF关键帧
virtual Color GetClearColor() const
获取清屏颜色
Definition: Renderer.h:282
virtual void CreateTextLayout(TextLayout &layout, StringView content, const TextStyle &style)=0
创建文字布局
virtual void CreatePixelShader(PixelShader &shader, const BinaryData &cso_data)=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 RefPtr< RenderContext > CreateContextForCommandList(RefPtr< Image > cmd_list)=0
创建渲染上下文,将上下文的渲染输出到命令集中
virtual void CreateBrush(Brush &brush, const Color &color)=0
创建纯色画刷
virtual void CreateGifImage(GifImage &gif, StringView file_path)=0
创建GIF图像
virtual void Clear()=0
清除绘制内容
virtual void MakeContextForWindow(RefPtr< Window > window)=0
为窗口创建渲染上下文
virtual void CreateEllipseShape(Shape &shape, const Point &center, const Vec2 &radius)=0
创建椭圆形状
virtual void CreateGifImage(GifImage &gif, const BinaryData &data)=0
创建GIF图像
形状生成器
Definition: ShapeMaker.h:45
形状
Definition: Shape.h:38
线条样式
Definition: StrokeStyle.h:68
文本布局
Definition: TextLayout.h:37
文本样式
Definition: TextStyle.h:64
PixelFormat
像素格式
Definition: Bitmap.h:54
二进制数据
Definition: BinaryData.h:30
GIF帧
Definition: GifImage.h:88
线性渐变样式
Definition: Brush.h:59
径向渐变样式
Definition: Brush.h:74