-
Notifications
You must be signed in to change notification settings - Fork 6k
Reland "[Windows] Move to FlutterCompositor for rendering" #49262
Changes from all commits
df604a1
c30b369
e84e19d
6077e6d
9e4b1ba
264385e
917d940
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,39 @@ | ||
// Copyright 2013 The Flutter Authors. All rights reserved. | ||
// Use of this source code is governed by a BSD-style license that can be | ||
// found in the LICENSE file. | ||
|
||
#ifndef FLUTTER_SHELL_PLATFORM_WINDOWS_COMPOSITOR_H_ | ||
#define FLUTTER_SHELL_PLATFORM_WINDOWS_COMPOSITOR_H_ | ||
|
||
#include "flutter/shell/platform/embedder/embedder.h" | ||
|
||
namespace flutter { | ||
|
||
// Enables the Flutter engine to render content on Windows. | ||
// | ||
// The engine uses this to: | ||
// | ||
// 1. Create backing stores used for rendering Flutter content | ||
// 2. Composite and present Flutter content and platform views onto a view | ||
// | ||
// Platform views are not yet supported. | ||
class Compositor { | ||
public: | ||
virtual ~Compositor() = default; | ||
|
||
// Creates a backing store used for rendering Flutter content. | ||
// | ||
// The backing store's configuration is stored in |backing_store_out|. | ||
virtual bool CreateBackingStore(const FlutterBackingStoreConfig& config, | ||
FlutterBackingStore* backing_store_out) = 0; | ||
|
||
// Destroys a backing store and releases its resources. | ||
virtual bool CollectBackingStore(const FlutterBackingStore* store) = 0; | ||
|
||
// Present Flutter content and platform views onto the view. | ||
virtual bool Present(const FlutterLayer** layers, size_t layers_count) = 0; | ||
}; | ||
|
||
} // namespace flutter | ||
|
||
#endif // FLUTTER_SHELL_PLATFORM_WINDOWS_COMPOSITOR_H_ |
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,188 @@ | ||
// Copyright 2013 The Flutter Authors. All rights reserved. | ||
// Use of this source code is governed by a BSD-style license that can be | ||
// found in the LICENSE file. | ||
|
||
#include "flutter/shell/platform/windows/compositor_opengl.h" | ||
|
||
#include "GLES3/gl3.h" | ||
#include "flutter/shell/platform/windows/flutter_windows_view.h" | ||
|
||
namespace flutter { | ||
|
||
namespace { | ||
|
||
constexpr uint32_t kWindowFrameBufferId = 0; | ||
|
||
// The metadata for an OpenGL framebuffer backing store. | ||
struct FramebufferBackingStore { | ||
uint32_t framebuffer_id; | ||
uint32_t texture_id; | ||
}; | ||
|
||
// Based off Skia's logic: | ||
// https://github.com/google/skia/blob/4738ed711e03212aceec3cd502a4adb545f38e63/src/gpu/ganesh/gl/GrGLCaps.cpp#L1963-L2116 | ||
int GetSupportedTextureFormat(const impeller::DescriptionGLES* description) { | ||
if (description->HasExtension("GL_EXT_texture_format_BGRA8888")) { | ||
return GL_BGRA8_EXT; | ||
} else if (description->HasExtension("GL_APPLE_texture_format_BGRA8888") && | ||
description->GetGlVersion().IsAtLeast(impeller::Version(3, 0))) { | ||
return GL_BGRA8_EXT; | ||
} else { | ||
return GL_RGBA8; | ||
} | ||
} | ||
|
||
} // namespace | ||
|
||
CompositorOpenGL::CompositorOpenGL(FlutterWindowsEngine* engine, | ||
impeller::ProcTableGLES::Resolver resolver) | ||
: engine_(engine), resolver_(resolver) {} | ||
|
||
bool CompositorOpenGL::CreateBackingStore( | ||
const FlutterBackingStoreConfig& config, | ||
FlutterBackingStore* result) { | ||
if (!is_initialized_ && !Initialize()) { | ||
return false; | ||
} | ||
|
||
auto store = std::make_unique<FramebufferBackingStore>(); | ||
|
||
gl_->GenTextures(1, &store->texture_id); | ||
gl_->GenFramebuffers(1, &store->framebuffer_id); | ||
|
||
gl_->BindFramebuffer(GL_FRAMEBUFFER, store->framebuffer_id); | ||
|
||
gl_->BindTexture(GL_TEXTURE_2D, store->texture_id); | ||
gl_->TexParameteri(GL_TEXTURE_2D, GL_TEXTURE_MIN_FILTER, GL_NEAREST); | ||
gl_->TexParameteri(GL_TEXTURE_2D, GL_TEXTURE_MAG_FILTER, GL_NEAREST); | ||
gl_->TexParameteri(GL_TEXTURE_2D, GL_TEXTURE_WRAP_S, GL_CLAMP_TO_EDGE); | ||
gl_->TexParameteri(GL_TEXTURE_2D, GL_TEXTURE_WRAP_T, GL_CLAMP_TO_EDGE); | ||
gl_->TexImage2D(GL_TEXTURE_2D, 0, GL_RGBA8, config.size.width, | ||
config.size.height, 0, GL_RGBA, GL_UNSIGNED_BYTE, nullptr); | ||
gl_->BindTexture(GL_TEXTURE_2D, 0); | ||
|
||
gl_->FramebufferTexture2D(GL_FRAMEBUFFER, GL_COLOR_ATTACHMENT0_EXT, | ||
GL_TEXTURE_2D, store->texture_id, 0); | ||
|
||
result->type = kFlutterBackingStoreTypeOpenGL; | ||
result->open_gl.type = kFlutterOpenGLTargetTypeFramebuffer; | ||
result->open_gl.framebuffer.name = store->framebuffer_id; | ||
result->open_gl.framebuffer.target = format_; | ||
result->open_gl.framebuffer.user_data = store.release(); | ||
result->open_gl.framebuffer.destruction_callback = [](void* user_data) { | ||
// Backing store destroyed in `CompositorOpenGL::CollectBackingStore`, set | ||
// on FlutterCompositor.collect_backing_store_callback during engine start. | ||
}; | ||
return true; | ||
} | ||
|
||
bool CompositorOpenGL::CollectBackingStore(const FlutterBackingStore* store) { | ||
FML_DCHECK(is_initialized_); | ||
FML_DCHECK(store->type == kFlutterBackingStoreTypeOpenGL); | ||
FML_DCHECK(store->open_gl.type == kFlutterOpenGLTargetTypeFramebuffer); | ||
|
||
auto user_data = static_cast<FramebufferBackingStore*>( | ||
store->open_gl.framebuffer.user_data); | ||
|
||
gl_->DeleteFramebuffers(1, &user_data->framebuffer_id); | ||
gl_->DeleteTextures(1, &user_data->texture_id); | ||
|
||
delete user_data; | ||
return true; | ||
} | ||
|
||
bool CompositorOpenGL::Present(const FlutterLayer** layers, | ||
size_t layers_count) { | ||
if (!engine_->view()) { | ||
return false; | ||
} | ||
|
||
// Clear the view if there are no layers to present. | ||
if (layers_count == 0) { | ||
// Normally the compositor is initialized when the first backing store is | ||
// created. However, on an empty frame no backing stores are created and | ||
// the present needs to initialize the compositor. | ||
if (!is_initialized_ && !Initialize()) { | ||
return false; | ||
} | ||
|
||
return ClearSurface(); | ||
} | ||
|
||
// TODO: Support compositing layers and platform views. | ||
// See: https://github.com/flutter/flutter/issues/31713 | ||
FML_DCHECK(is_initialized_); | ||
FML_DCHECK(layers_count == 1); | ||
FML_DCHECK(layers[0]->offset.x == 0 && layers[0]->offset.y == 0); | ||
FML_DCHECK(layers[0]->type == kFlutterLayerContentTypeBackingStore); | ||
FML_DCHECK(layers[0]->backing_store->type == kFlutterBackingStoreTypeOpenGL); | ||
FML_DCHECK(layers[0]->backing_store->open_gl.type == | ||
kFlutterOpenGLTargetTypeFramebuffer); | ||
|
||
auto width = layers[0]->size.width; | ||
auto height = layers[0]->size.height; | ||
|
||
// Check if this frame can be presented. This resizes the surface if a resize | ||
// is pending and |width| and |height| match the target size. | ||
if (!engine_->view()->OnFrameGenerated(width, height)) { | ||
return false; | ||
} | ||
|
||
if (!engine_->surface_manager()->MakeCurrent()) { | ||
return false; | ||
} | ||
|
||
auto source_id = layers[0]->backing_store->open_gl.framebuffer.name; | ||
gl_->BindFramebuffer(GL_READ_FRAMEBUFFER, source_id); | ||
gl_->BindFramebuffer(GL_DRAW_FRAMEBUFFER, kWindowFrameBufferId); | ||
|
||
gl_->BlitFramebuffer(0, // srcX0 | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. What version of GL are you using as the base? BlitFramebuffer won't be available on ES2 and you'll have to resort to render to texture instead. There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. From my understanding, ANGLE supports GLES 3.0 if Direct 3D 11 is available, which it is on Windows 7 and higher. I've tested this on a single Windows 7 machine. I'm definitely concerned by this though. I plan to ask the Windows community members to test their apps on the |
||
0, // srcY0 | ||
width, // srcX1 | ||
height, // srcY1 | ||
0, // dstX0 | ||
0, // dstY0 | ||
width, // dstX1 | ||
height, // dstY1 | ||
GL_COLOR_BUFFER_BIT, // mask | ||
GL_NEAREST // filter | ||
); | ||
|
||
return engine_->view()->SwapBuffers(); | ||
} | ||
|
||
bool CompositorOpenGL::Initialize() { | ||
FML_DCHECK(!is_initialized_); | ||
|
||
if (!engine_->surface_manager()->MakeCurrent()) { | ||
return false; | ||
} | ||
|
||
gl_ = std::make_unique<impeller::ProcTableGLES>(resolver_); | ||
if (!gl_->IsValid()) { | ||
gl_.reset(); | ||
return false; | ||
} | ||
|
||
format_ = GetSupportedTextureFormat(gl_->GetDescription()); | ||
is_initialized_ = true; | ||
return true; | ||
} | ||
|
||
bool CompositorOpenGL::ClearSurface() { | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. This clears previously presented layers if the engine presents with 0 layers |
||
FML_DCHECK(is_initialized_); | ||
|
||
// Resize the surface if needed. | ||
engine_->view()->OnEmptyFrameGenerated(); | ||
|
||
if (!engine_->surface_manager()->MakeCurrent()) { | ||
return false; | ||
} | ||
|
||
gl_->ClearColor(0.0f, 0.0f, 0.0f, 0.0f); | ||
gl_->Clear(GL_COLOR_BUFFER_BIT | GL_DEPTH_BUFFER_BIT | GL_STENCIL_BUFFER_BIT); | ||
|
||
return engine_->view()->SwapBuffers(); | ||
} | ||
|
||
} // namespace flutter |
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,61 @@ | ||
// Copyright 2013 The Flutter Authors. All rights reserved. | ||
// Use of this source code is governed by a BSD-style license that can be | ||
// found in the LICENSE file. | ||
|
||
#ifndef FLUTTER_SHELL_PLATFORM_WINDOWS_COMPOSITOR_OPENGL_H_ | ||
#define FLUTTER_SHELL_PLATFORM_WINDOWS_COMPOSITOR_OPENGL_H_ | ||
|
||
#include <memory> | ||
|
||
#include "flutter/impeller/renderer/backend/gles/proc_table_gles.h" | ||
#include "flutter/shell/platform/embedder/embedder.h" | ||
#include "flutter/shell/platform/windows/compositor.h" | ||
#include "flutter/shell/platform/windows/flutter_windows_engine.h" | ||
|
||
namespace flutter { | ||
|
||
// Enables the Flutter engine to render content on Windows using OpenGL. | ||
class CompositorOpenGL : public Compositor { | ||
public: | ||
CompositorOpenGL(FlutterWindowsEngine* engine, | ||
impeller::ProcTableGLES::Resolver resolver); | ||
|
||
/// |Compositor| | ||
bool CreateBackingStore(const FlutterBackingStoreConfig& config, | ||
FlutterBackingStore* result) override; | ||
|
||
/// |Compositor| | ||
bool CollectBackingStore(const FlutterBackingStore* store) override; | ||
|
||
/// |Compositor| | ||
bool Present(const FlutterLayer** layers, size_t layers_count) override; | ||
|
||
private: | ||
// The Flutter engine that manages the views to render. | ||
FlutterWindowsEngine* engine_; | ||
|
||
private: | ||
// The compositor initializes itself lazily once |CreateBackingStore| is | ||
// called. True if initialization completed successfully. | ||
bool is_initialized_ = false; | ||
|
||
// Function used to resolve GLES functions. | ||
impeller::ProcTableGLES::Resolver resolver_ = nullptr; | ||
|
||
// Table of resolved GLES functions. Null until the compositor is initialized. | ||
std::unique_ptr<impeller::ProcTableGLES> gl_ = nullptr; | ||
|
||
// The OpenGL texture target format for backing stores. Invalid value until | ||
// the compositor is initialized. | ||
uint32_t format_ = 0; | ||
|
||
// Initialize the compositor. This must run on the raster thread. | ||
bool Initialize(); | ||
|
||
// Clear the view's surface and removes any previously presented layers. | ||
bool ClearSurface(); | ||
}; | ||
|
||
} // namespace flutter | ||
|
||
#endif // FLUTTER_SHELL_PLATFORM_WINDOWS_COMPOSITOR_OPENGL_H_ |
Uh oh!
There was an error while loading. Please reload this page.