-
Notifications
You must be signed in to change notification settings - Fork 3
/
RenderLoop.cpp
290 lines (271 loc) · 9.68 KB
/
RenderLoop.cpp
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
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
/*
* Copyright (c) 2016-2024 WangBin <wbsecg1 at gmail.com>
* This file is part of UGS (Universal Graphics Surface)
* Source code: https://github.com/wang-bin/ugs
*
* This Source Code Form is subject to the terms of the Mozilla Public
* License, v. 2.0. If a copy of the MPL was not distributed with this
* file, You can obtain one at http://mozilla.org/MPL/2.0/.
*/
#include "ugs/RenderLoop.h"
#include "ugs/PlatformSurface.h"
#include "base/BlockingQueue.h"
#include <cassert>
#include <list>
#include <mutex>
#include <thread>
#include <iostream>
//// TODO: frame rendering can be driven by frame push, master clock, vsync, subtitle(hi fps sub, but must < vsync fps), any of above conditions triggered, post update event in render loop
UGS_NS_BEGIN
using namespace std;
class RenderLoop::SurfaceContext {
public:
shared_ptr<PlatformSurface> surface;
RenderContext ctx; // TODO: if use the same context, use shared_ptr, deleter is destroyRenderContext
int width = 0;
int height = 0;
};
class RenderLoop::Private
{
public:
~Private() {
assert(!render_thread.joinable() && "rendering thread can not be joinable in dtor. MUST call stop() & waitForStopped() first");
}
void schedule(std::function<void()>&& task) {
tasks.push(std::move(task));
}
void run() {
running = true;
std::clog << this << " start RenderLoop" << std::endl;
while (true) { // TODO: lock free? semaphore?
function<void()> task;
tasks.pop(task);
if (task)
task();
if (stop_requested && surfaces.empty())
break;
}
running = false;
}
bool use_thread = true;
bool stop_requested = false;
bool running = false;
bool stop_on_last_close = true;
mutex mtx;
thread render_thread;
list<RenderLoop::SurfaceContext*> surfaces;
function<void(PlatformSurface*,int,int, RenderContext)> resize_cb = nullptr;
function<bool(PlatformSurface*, RenderContext)> draw_cb = nullptr;
function<void(PlatformSurface*)> close_cb = nullptr;
function<void(PlatformSurface*, RenderContext)> ctx_created_cb = nullptr;
function<void(PlatformSurface*, RenderContext)> ctx_destroy_cb = nullptr;
private:
BlockingQueue<function<void()>> tasks; // TODO: unbounded_blocking_fifo w/ or w/o semaphore (depending on on draw call cost(profile))
};
RenderLoop::RenderLoop()
: d(new Private())
{
}
RenderLoop::~RenderLoop()
{
// can not stop and waitForStopped() in dtor to avoid calling virtual functions. user MUST manually cal them
delete d;
}
bool RenderLoop::start(bool stop_on_last_surface_closed)
{
if (d->running)
return true;
d->running = true;
d->stop_on_last_close = stop_on_last_surface_closed;
if (d->use_thread) { // check joinable?
d->render_thread = std::thread([this]{
std::clog << "Rendering thread @" << std::this_thread::get_id() << std::endl;
d->run();
});
}
return true;
}
void RenderLoop::stop()
{
if (!isRunning())
return;
d->stop_requested = true;
// call once per loop, so no lock
const unique_lock lock(d->mtx);
for (auto sp : d->surfaces) {
sp->surface->close();
}
}
void RenderLoop::waitForStopped()
{
if (!d->use_thread) {
d->run();
return;
}
while (d->running) {
{
const unique_lock lock(d->mtx);
// surfaces.erase() on close.
// TODO: lock free, schedule a task so in the same thread as ease(still has mutext in task queue)? main thread?
// cow?
for (auto sp : d->surfaces) {
sp->surface->processEvents(); // MPSC
}
}
this_thread::sleep_for(chrono::milliseconds(10)); // TODO: poll native events?
}
if (d->render_thread.joinable())
d->render_thread.join();
}
bool RenderLoop::isRunning() const
{
return d->running;
}
void RenderLoop::update()
{
d->schedule([this]{
// TODO: lock? what if add(surface) now?
for (auto sp : d->surfaces) {
if (!process(sp)) {
clog << "surface removed, skip current update" << endl;
break;
}
}
});
}
RenderLoop& RenderLoop::onResize(const function<void(PlatformSurface*,int,int,RenderContext)>& cb)
{
d->resize_cb = cb;
return *this;
}
RenderLoop& RenderLoop::onDraw(const function<bool(PlatformSurface*, RenderContext)>& cb)
{
d->draw_cb = cb;
return *this;
}
RenderLoop& RenderLoop::onContextCreated(const function<void(PlatformSurface*,void*)>& cb)
{
d->ctx_created_cb = cb;
return *this;
}
RenderLoop& RenderLoop::onDestroyContext(const function<void(PlatformSurface*,void*)>& cb)
{
d->ctx_destroy_cb = cb;
return *this;
}
RenderLoop& RenderLoop::onClose(const function<void(PlatformSurface*)>& cb)
{
d->close_cb = cb;
return *this;
}
weak_ptr<PlatformSurface> RenderLoop::add(PlatformSurface *surface)
{
const shared_ptr<PlatformSurface> ss(surface);
auto sp = new SurfaceContext{ss, nullptr};
// TODO: lock?
const unique_lock lock(d->mtx);
d->surfaces.push_back(sp);
surface->setEventCallback([=]{ // TODO: void(Event e)
d->schedule([=]{
if (!process(sp)) {
clog << "surface removed by event callback..." << endl;
}
});
});
d->schedule([=]{
if (!process(sp)) { // create=>resize=>close event in 1 process()
clog << "deleting surface scheduled by surface add callback..." << endl;
const unique_lock lock(d->mtx);
auto it = find(d->surfaces.begin(), d->surfaces.end(), sp);
delete *it;
d->surfaces.erase(it); // gcc4.8 can not erase a const_iterator
}
});
return ss;
}
PlatformSurface* RenderLoop::process(SurfaceContext *sp)
{
PlatformSurface* surface = sp->surface.get();
void* ctx = sp->ctx;
if (!surface->acquire())
return surface;
activateRenderContext(surface, ctx);
PlatformSurface::Event e{};
while (surface->popEvent(e)) {
if (e.type == PlatformSurface::Event::Close) {
std::clog << surface << "->PlatformSurface::Event::Close" << std::endl;
if (ctx) {
if (d->ctx_destroy_cb)
d->ctx_destroy_cb(surface, ctx);
destroyRenderContext(surface, ctx);
}
if (d->close_cb)
d->close_cb(surface);
surface->release();
auto it = find(d->surfaces.begin(), d->surfaces.end(), sp);
const unique_lock lock(d->mtx);
clog << "removing closed surface..." << endl;
d->surfaces.erase(it);
delete sp;
if (d->stop_on_last_close && d->surfaces.empty())
d->stop_requested = true;
return nullptr; // FIXME
} else if (e.type == PlatformSurface::Event::Resize) {
sp->width = e.size.width;
sp->height = e.size.height;
std::clog << "PlatformSurface::Event::Resize " << e.size.width << "x" << e.size.height << std::endl;
if (d->resize_cb)
d->resize_cb(surface, e.size.width, e.size.height, ctx);
#if defined(__ANDROID__) || defined(ANDROID)
submitRenderContext(surface, ctx);
surface->submit();
// workaround for android wrong display rect. also force iOS resize rbo because makeCurrent is not always called in current implementation
// if (d->draw_cb && d->draw_cb(surface, ctx)) // for all platforms? // for iOS, render in a correct viewport before swapBuffers
#endif
} else if (e.type == PlatformSurface::Event::NativeHandle) {
std::clog << surface << "->PlatformSurface::Event::NativeHandle: " << e.handle.before << ">>>" << e.handle.after << std::endl;
if (e.handle.before && ctx) {
if (d->ctx_destroy_cb)
d->ctx_destroy_cb(surface, ctx);
destroyRenderContext(surface, ctx);
}
sp->ctx = nullptr;
surface->release(); // assume createRenderContext() will not call any gl command, so surface->acquire() is not required.
if (!e.handle.after)
return surface;
ctx = createRenderContext(surface);
if (!ctx) { // ss will be destroyed if not pushed to list
std::clog << "ERROR! Failed to create rendering context! platform surface handle: " << surface->nativeHandle() << std::endl;
return surface; // already release(). FIXME
}
if (d->ctx_created_cb)
d->ctx_created_cb(surface, ctx);
sp->ctx = ctx;
surface->setEventCallback([=]{ // TODO: void(Event e)
d->schedule([=]{
if (!process(sp)) {
clog << "surface removed by event callback..." << endl;
}
});
});
if (!surface->acquire())
return surface;
activateRenderContext(surface, ctx);
}
}
if (!ctx) {
std::clog << "no gfx context. skip rendering..." << std::endl;
surface->release();
return surface;
}
if (d->draw_cb && d->draw_cb(surface, ctx)) { // not onDraw(surface) with surface is ok, because context is current
int changes = 0;
submitRenderContext(surface, ctx, &changes); // TODO: recreate context if false(device lost)?
surface->submit();
if (changes && sp->width > 0 && sp->height > 0) // surface->size() in thread may be not allowed
surface->PlatformSurface::resize(sp->width, sp->height);
}
surface->release();
return surface;
}
UGS_NS_END