Skip to content
This repository was archived by the owner on Feb 25, 2025. It is now read-only.

Commit ff730be

Browse files
loic-sharmaloic-sharma
committed
Polish
1 parent d024d5e commit ff730be

File tree

9 files changed

+176
-60
lines changed

9 files changed

+176
-60
lines changed

‎shell/platform/windows/angle_surface_manager.cc‎

Lines changed: 20 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -209,7 +209,8 @@ void AngleSurfaceManager::CleanUp() {
209209

210210
bool AngleSurfaceManager::CreateSurface(WindowsRenderTarget* render_target,
211211
EGLint width,
212-
EGLint height) {
212+
EGLint height,
213+
bool vsync_enabled) {
213214
if (!render_target || !initialize_succeeded_) {
214215
return false;
215216
}
@@ -232,12 +233,15 @@ bool AngleSurfaceManager::CreateSurface(WindowsRenderTarget* render_target,
232233
surface_width_ = width;
233234
surface_height_ = height;
234235
render_surface_ = surface;
236+
237+
SetVSyncEnabled(vsync_enabled);
235238
return true;
236239
}
237240

238241
void AngleSurfaceManager::ResizeSurface(WindowsRenderTarget* render_target,
239242
EGLint width,
240-
EGLint height) {
243+
EGLint height,
244+
bool vsync_enabled) {
241245
EGLint existing_width, existing_height;
242246
GetSurfaceDimensions(&existing_width, &existing_height);
243247
if (width != existing_width || height != existing_height) {
@@ -246,7 +250,7 @@ void AngleSurfaceManager::ResizeSurface(WindowsRenderTarget* render_target,
246250

247251
ClearContext();
248252
DestroySurface();
249-
if (!CreateSurface(render_target, width, height)) {
253+
if (!CreateSurface(render_target, width, height, vsync_enabled)) {
250254
FML_LOG(ERROR)
251255
<< "AngleSurfaceManager::ResizeSurface failed to create surface";
252256
}
@@ -302,8 +306,20 @@ EGLSurface AngleSurfaceManager::CreateSurfaceFromHandle(
302306
}
303307

304308
void AngleSurfaceManager::SetVSyncEnabled(bool enabled) {
309+
if (eglMakeCurrent(egl_display_, render_surface_, render_surface_,
310+
egl_context_) == EGL_TRUE) {
311+
LogEglError("Unable to make surface current to update the swap interval");
312+
return;
313+
}
314+
315+
// OpenGL swap intervals can be used to prevent screen tearing.
316+
// If enabled, the raster thread blocks until the v-blank.
317+
// This is unnecessary if DWM composition is enabled.
318+
// See: https://www.khronos.org/opengl/wiki/Swap_Interval
319+
// See: https://learn.microsoft.com/windows/win32/dwm/composition-ovw
305320
if (eglSwapInterval(egl_display_, enabled ? 1 : 0) != EGL_TRUE) {
306-
LogEglError("Updating swap interval failed");
321+
LogEglError("Unable to update the swap interval");
322+
return;
307323
}
308324
}
309325

‎shell/platform/windows/angle_surface_manager.h‎

Lines changed: 13 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,7 @@
2323

2424
namespace flutter {
2525

26-
// A manager for inializing ANGLE correctly and using it to create and
26+
// A manager for initializing ANGLE correctly and using it to create and
2727
// destroy surfaces
2828
class AngleSurfaceManager {
2929
public:
@@ -34,17 +34,19 @@ class AngleSurfaceManager {
3434
// associated with window, in the appropriate format for display.
3535
// Target represents the visual entity to bind to. Width and
3636
// height represent dimensions surface is created at.
37-
bool CreateSurface(WindowsRenderTarget* render_target,
38-
EGLint width,
39-
EGLint height);
37+
virtual bool CreateSurface(WindowsRenderTarget* render_target,
38+
EGLint width,
39+
EGLint height,
40+
bool enable_vsync);
4041

4142
// Resizes backing surface from current size to newly requested size
4243
// based on width and height for the specific case when width and height do
4344
// not match current surface dimensions. Target represents the visual entity
4445
// to bind to.
45-
void ResizeSurface(WindowsRenderTarget* render_target,
46-
EGLint width,
47-
EGLint height);
46+
virtual void ResizeSurface(WindowsRenderTarget* render_target,
47+
EGLint width,
48+
EGLint height,
49+
bool enable_vsync);
4850

4951
// queries EGL for the dimensions of surface in physical
5052
// pixels returning width and height as out params.
@@ -73,13 +75,13 @@ class AngleSurfaceManager {
7375
EGLClientBuffer handle,
7476
const EGLint* attributes) const;
7577

76-
// If true, sets the swap interval to 1 and swapping blocks until the vsync.
77-
// This is enabled by default.
78-
void SetVSyncEnabled(bool enabled);
79-
8078
// Gets the |EGLDisplay|.
8179
EGLDisplay egl_display() const { return egl_display_; };
8280

81+
// If enabled, makes the current surface's buffer swaps block until the
82+
// v-blank.
83+
virtual void SetVSyncEnabled(bool enabled);
84+
8385
// Gets the |ID3D11Device| chosen by ANGLE.
8486
bool GetDevice(ID3D11Device** device);
8587

‎shell/platform/windows/flutter_window.cc‎

Lines changed: 8 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -312,13 +312,16 @@ ui::AXPlatformNodeWin* FlutterWindow::GetAlert() {
312312
return alert_node_.get();
313313
}
314314

315-
bool FlutterWindow::DwmIsCompositionEnabled() {
316-
BOOL enabled;
317-
if (SUCCEEDED(::DwmIsCompositionEnabled(&enabled))) {
318-
return enabled;
315+
bool FlutterWindow::NeedsVSync() {
316+
// If the Desktop Window Manager composition is enabled,
317+
// the system itself synchronizes with v-sync.
318+
// See: https://learn.microsoft.com/windows/win32/dwm/composition-ovw
319+
BOOL composition_enabled;
320+
if (SUCCEEDED(::DwmIsCompositionEnabled(&composition_enabled))) {
321+
return !composition_enabled;
319322
}
320323

321-
return false;
324+
return true;
322325
}
323326

324327
} // namespace flutter

‎shell/platform/windows/flutter_window.h‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -154,10 +154,10 @@ class FlutterWindow : public Window, public WindowBindingHandler {
154154
AlertPlatformNodeDelegate* GetAlertDelegate() override;
155155

156156
// |WindowBindingHandler|
157-
bool DwmIsCompositionEnabled() override;
157+
ui::AXPlatformNodeWin* GetAlert() override;
158158

159159
// |WindowBindingHandler|
160-
ui::AXPlatformNodeWin* GetAlert() override;
160+
bool NeedsVSync() override;
161161

162162
// |Window|
163163
ui::AXFragmentRootDelegateWin* GetAxFragmentRootDelegate() override;

‎shell/platform/windows/flutter_windows_view.cc‎

Lines changed: 5 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -81,9 +81,8 @@ uint32_t FlutterWindowsView::GetFrameBufferId(size_t width, size_t height) {
8181
if (resize_target_width_ == width && resize_target_height_ == height) {
8282
// Platform thread is blocked for the entire duration until the
8383
// resize_status_ is set to kDone.
84-
engine_->surface_manager()->ResizeSurface(GetRenderTarget(), width, height);
85-
UpdateSurfaceVsync();
86-
84+
engine_->surface_manager()->ResizeSurface(GetRenderTarget(), width, height,
85+
binding_handler_->NeedsVSync());
8786
resize_status_ = ResizeState::kFrameGenerated;
8887
}
8988

@@ -587,30 +586,15 @@ bool FlutterWindowsView::PresentSoftwareBitmap(const void* allocation,
587586
void FlutterWindowsView::CreateRenderSurface() {
588587
if (engine_ && engine_->surface_manager()) {
589588
PhysicalWindowBounds bounds = binding_handler_->GetPhysicalWindowBounds();
589+
bool enable_vsync = binding_handler_->NeedsVSync();
590590
engine_->surface_manager()->CreateSurface(GetRenderTarget(), bounds.width,
591-
bounds.height);
592-
UpdateSurfaceVsync();
591+
bounds.height, enable_vsync);
593592

594593
resize_target_width_ = bounds.width;
595594
resize_target_height_ = bounds.height;
596595
}
597596
}
598597

599-
void FlutterWindowsView::UpdateSurfaceVsync() {
600-
BASE_DCHECK(engine_);
601-
BASE_DCHECK(engine_->surface_manager());
602-
603-
// OpenGL swap intervals can be used to prevent screen tearing.
604-
// If enabled, the raster thread blocks until the v-blank.
605-
// This is unnecessary if DWM composition is enabled.
606-
// See: https://www.khronos.org/opengl/wiki/Swap_Interval
607-
// See: https://learn.microsoft.com/windows/win32/dwm/composition-ovw
608-
bool enable_vsync = !binding_handler_->DwmIsCompositionEnabled();
609-
610-
engine_->surface_manager()->MakeCurrent();
611-
engine_->surface_manager()->SetVSyncEnabled(enable_vsync);
612-
}
613-
614598
void FlutterWindowsView::DestroyRenderSurface() {
615599
if (engine_ && engine_->surface_manager()) {
616600
engine_->surface_manager()->DestroySurface();
@@ -664,7 +648,7 @@ ui::AXPlatformNodeWin* FlutterWindowsView::AlertNode() const {
664648

665649
void FlutterWindowsView::OnDwmCompositionChanged() {
666650
if (engine_->surface_manager()) {
667-
UpdateSurfaceVsync();
651+
engine_->surface_manager()->SetVSyncEnabled(binding_handler_->NeedsVSync());
668652
}
669653
}
670654

‎shell/platform/windows/flutter_windows_view.h‎

Lines changed: 0 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -73,10 +73,6 @@ class FlutterWindowsView : public WindowBindingHandlerDelegate,
7373
bool MakeResourceCurrent();
7474
bool SwapBuffers();
7575

76-
// Makes the surface's swap block on vsync unless Windows synchronizes
77-
// with vsync.
78-
void UpdateSurfaceVsync();
79-
8076
// Callback for presenting a software bitmap.
8177
bool PresentSoftwareBitmap(const void* allocation,
8278
size_t row_bytes,

‎shell/platform/windows/flutter_windows_view_unittests.cc‎

Lines changed: 124 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -12,6 +12,7 @@
1212
#include <future>
1313
#include <vector>
1414

15+
#include "flutter/fml/synchronization/waitable_event.h"
1516
#include "flutter/shell/platform/common/json_message_codec.h"
1617
#include "flutter/shell/platform/embedder/test_utils/proc_table_replacement.h"
1718
#include "flutter/shell/platform/windows/flutter_window.h"
@@ -27,8 +28,10 @@
2728
namespace flutter {
2829
namespace testing {
2930

31+
using ::testing::_;
3032
using ::testing::InSequence;
3133
using ::testing::NiceMock;
34+
using ::testing::Return;
3235

3336
constexpr uint64_t kScanCodeKeyA = 0x1e;
3437
constexpr uint64_t kVirtualKeyA = 0x41;
@@ -117,8 +120,12 @@ class MockAngleSurfaceManager : public AngleSurfaceManager {
117120
public:
118121
MockAngleSurfaceManager() {}
119122

123+
MOCK_METHOD4(CreateSurface, bool(WindowsRenderTarget*, EGLint, EGLint, bool));
124+
MOCK_METHOD4(ResizeSurface, void(WindowsRenderTarget*, EGLint, EGLint, bool));
120125
MOCK_METHOD0(DestroySurface, void());
121126

127+
MOCK_METHOD1(SetVSyncEnabled, void(bool));
128+
122129
private:
123130
FML_DISALLOW_COPY_AND_ASSIGN(MockAngleSurfaceManager);
124131
};
@@ -714,28 +721,44 @@ TEST(FlutterWindowsViewTest, WindowResizeTests) {
714721

715722
auto window_binding_handler =
716723
std::make_unique<NiceMock<MockWindowBindingHandler>>();
724+
std::unique_ptr<MockAngleSurfaceManager> surface_manager =
725+
std::make_unique<MockAngleSurfaceManager>();
726+
727+
EXPECT_CALL(*window_binding_handler.get(), NeedsVSync)
728+
.WillOnce(Return(false));
729+
EXPECT_CALL(
730+
*surface_manager.get(),
731+
ResizeSurface(_, /*width=*/500, /*height=*/500, /*enable_vsync=*/false))
732+
.Times(1);
733+
EXPECT_CALL(*surface_manager.get(), DestroySurface).Times(1);
717734

718735
FlutterWindowsView view(std::move(window_binding_handler));
736+
modifier.SetSurfaceManager(surface_manager.release());
719737
view.SetEngine(std::move(engine));
720738

721-
bool send_window_metrics_event_called = false;
739+
fml::AutoResetWaitableEvent metrics_sent_latch;
722740
modifier.embedder_api().SendWindowMetricsEvent = MOCK_ENGINE_PROC(
723741
SendWindowMetricsEvent,
724-
([&send_window_metrics_event_called](
725-
auto engine, const FlutterWindowMetricsEvent* even) {
726-
send_window_metrics_event_called = true;
742+
([&metrics_sent_latch](auto engine,
743+
const FlutterWindowMetricsEvent* event) {
744+
metrics_sent_latch.Signal();
727745
return kSuccess;
728746
}));
729747

730-
std::promise<bool> resize_completed;
731-
std::thread([&resize_completed, &view]() {
748+
fml::AutoResetWaitableEvent resized_latch;
749+
std::thread([&resized_latch, &view]() {
750+
// Start the window resize. This sends the new window metrics
751+
// and then blocks until another thread completes the window resize.
732752
view.OnWindowSizeChanged(500, 500);
733-
resize_completed.set_value(true);
753+
resized_latch.Signal();
734754
}).detach();
735755

736-
auto result = resize_completed.get_future().wait_for(std::chrono::seconds(1));
737-
EXPECT_EQ(std::future_status::ready, result);
738-
EXPECT_TRUE(send_window_metrics_event_called);
756+
// Wait until the platform thread has started the window resize.
757+
metrics_sent_latch.Wait();
758+
759+
// Complete the window resize by requesting a buffer with the new window size.
760+
view.GetFrameBufferId(500, 500);
761+
resized_latch.Wait();
739762
}
740763

741764
TEST(FlutterWindowsViewTest, WindowRepaintTests) {
@@ -1083,5 +1106,96 @@ TEST(FlutterWindowsViewTest, TooltipNodeData) {
10831106
EXPECT_EQ(uia_tooltip, "tooltip");
10841107
}
10851108

1109+
// Don't block until the v-blank if it is disabled by the window.
1110+
TEST(FlutterWindowsViewTest, DisablesVSync) {
1111+
std::unique_ptr<MockFlutterWindowsEngine> engine =
1112+
std::make_unique<MockFlutterWindowsEngine>();
1113+
auto window_binding_handler =
1114+
std::make_unique<NiceMock<MockWindowBindingHandler>>();
1115+
std::unique_ptr<MockAngleSurfaceManager> surface_manager =
1116+
std::make_unique<MockAngleSurfaceManager>();
1117+
1118+
EXPECT_CALL(*window_binding_handler.get(), NeedsVSync)
1119+
.WillOnce(Return(false));
1120+
1121+
EngineModifier modifier(engine.get());
1122+
FlutterWindowsView view(std::move(window_binding_handler));
1123+
1124+
InSequence s;
1125+
EXPECT_CALL(*surface_manager.get(),
1126+
CreateSurface(_, _, _, /*vsync_enabled=*/false))
1127+
.Times(1)
1128+
.WillOnce(Return(true));
1129+
1130+
EXPECT_CALL(*engine.get(), Stop).Times(1);
1131+
EXPECT_CALL(*surface_manager.get(), DestroySurface).Times(1);
1132+
1133+
modifier.SetSurfaceManager(surface_manager.release());
1134+
view.SetEngine(std::move(engine));
1135+
1136+
view.CreateRenderSurface();
1137+
}
1138+
1139+
// Blocks until the v-blank if it is enabled by the window.
1140+
TEST(FlutterWindowsViewTest, EnablesVSync) {
1141+
std::unique_ptr<MockFlutterWindowsEngine> engine =
1142+
std::make_unique<MockFlutterWindowsEngine>();
1143+
auto window_binding_handler =
1144+
std::make_unique<NiceMock<MockWindowBindingHandler>>();
1145+
std::unique_ptr<MockAngleSurfaceManager> surface_manager =
1146+
std::make_unique<MockAngleSurfaceManager>();
1147+
1148+
EXPECT_CALL(*window_binding_handler.get(), NeedsVSync).WillOnce(Return(true));
1149+
1150+
EngineModifier modifier(engine.get());
1151+
FlutterWindowsView view(std::move(window_binding_handler));
1152+
1153+
InSequence s;
1154+
EXPECT_CALL(*surface_manager.get(),
1155+
CreateSurface(_, _, _, /*vsync_enabled=*/true))
1156+
.Times(1)
1157+
.WillOnce(Return(true));
1158+
1159+
EXPECT_CALL(*engine.get(), Stop).Times(1);
1160+
EXPECT_CALL(*surface_manager.get(), DestroySurface).Times(1);
1161+
1162+
modifier.SetSurfaceManager(surface_manager.release());
1163+
view.SetEngine(std::move(engine));
1164+
1165+
view.CreateRenderSurface();
1166+
}
1167+
1168+
// Desktop Window Manager composition can be disabled on Windows 7.
1169+
// If this happens, the app must synchronize with the vsync to prevent
1170+
// screen tearing.
1171+
TEST(FlutterWindowsViewTest, UpdatesVSyncOnDwmUpdates) {
1172+
std::unique_ptr<MockFlutterWindowsEngine> engine =
1173+
std::make_unique<MockFlutterWindowsEngine>();
1174+
auto window_binding_handler =
1175+
std::make_unique<NiceMock<MockWindowBindingHandler>>();
1176+
std::unique_ptr<MockAngleSurfaceManager> surface_manager =
1177+
std::make_unique<MockAngleSurfaceManager>();
1178+
1179+
EXPECT_CALL(*window_binding_handler.get(), NeedsVSync)
1180+
.WillOnce(Return(true))
1181+
.WillOnce(Return(false));
1182+
1183+
EngineModifier modifier(engine.get());
1184+
FlutterWindowsView view(std::move(window_binding_handler));
1185+
1186+
InSequence s;
1187+
EXPECT_CALL(*surface_manager.get(), SetVSyncEnabled(true)).Times(1);
1188+
EXPECT_CALL(*surface_manager.get(), SetVSyncEnabled(false)).Times(1);
1189+
1190+
EXPECT_CALL(*engine.get(), Stop).Times(1);
1191+
EXPECT_CALL(*surface_manager.get(), DestroySurface).Times(1);
1192+
1193+
modifier.SetSurfaceManager(surface_manager.release());
1194+
view.SetEngine(std::move(engine));
1195+
1196+
view.GetEngine()->OnDwmCompositionChanged();
1197+
view.GetEngine()->OnDwmCompositionChanged();
1198+
}
1199+
10861200
} // namespace testing
10871201
} // namespace flutter

0 commit comments

Comments
 (0)