[Windows] Move to FlutterCompositor for rendering
#48849
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| 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; | ||
|
|
||
| // Create 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_ |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,154 @@ | ||
| // 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 { | ||
|
|
||
| // 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) {} | ||
|
|
||
|
There was a problem hiding this comment. The engine/shell/platform/linux/fl_backing_store_provider.cc Lines 19 to 102 in 101396f |
||
| 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) { | ||
| // TODO: Support compositing layers and platform views. | ||
| // See: https://github.com/flutter/flutter/issues/31713 | ||
| FML_DCHECK(is_initialized_); | ||
| FML_DCHECK(layers_count == 1); | ||
loic-sharma marked this conversation as resolved.
Show resolved
Hide resolved
|
||
| FML_DCHECK(layers[0]->type == kFlutterLayerContentTypeBackingStore); | ||
| FML_DCHECK(layers[0]->backing_store->type == kFlutterBackingStoreTypeOpenGL); | ||
| FML_DCHECK(layers[0]->backing_store->open_gl.type == | ||
| kFlutterOpenGLTargetTypeFramebuffer); | ||
|
|
||
| if (!engine_->view()) { | ||
| return false; | ||
| } | ||
|
|
||
| auto width = layers[0]->size.width; | ||
| auto height = layers[0]->size.height; | ||
|
|
||
| // Acquiring the view's framebuffer ID resizes its surface if necessary. | ||
| auto destination_id = engine_->view()->GetFrameBufferId(width, height); | ||
| auto source_id = layers[0]->backing_store->open_gl.framebuffer.name; | ||
|
|
||
| if (!engine_->surface_manager()->MakeCurrent()) { | ||
| return false; | ||
| } | ||
|
|
||
| gl_->BindFramebuffer(GL_READ_FRAMEBUFFER, source_id); | ||
| gl_->BindFramebuffer(GL_DRAW_FRAMEBUFFER, destination_id); | ||
|
|
||
| gl_->BlitFramebuffer(0, // srcX0 | ||
| 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; | ||
| } | ||
|
|
||
| } // namespace flutter | ||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,58 @@ | ||
| // 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(); | ||
| }; | ||
|
|
||
| } // namespace flutter | ||
|
|
||
| #endif // FLUTTER_SHELL_PLATFORM_WINDOWS_COMPOSITOR_OPENGL_H_ |
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The Windows embedder uses Impeller's
ProcTableGLESandDescriptionGLESto resolve OpenGLES functions and determine the GL version and extensions. This was the approach recommended by Impeller folks: https://discord.com/channels/608014603317936148/1173336353187041380/1182110838849536040Also note that Windows has a
GlProcTablewhich is a worse version of Impeller'sProcTableGLES. I was hoping to converge everything toProcTableGLES, however,ProcTableGLES's initialization requires that the GL context is current. This prevents us from usingProcTableGLESon the platform thread as it ideally shouldn't make the context current. We'll want to clean this up somehow in the future...There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
why does impeller require the context to be current - do we combine creation of the proc table with looking up gl state? Could we split that functionality out of proc table so you could use it exclusively?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Yes. The proc table uses the
DescriptionGLESto determine capabilities and determine supported extension functions, and theDescriptionGLESconstructor fails if the context isn't current.I think so. We could have a "raw" proc table that can be initialized without a GL context, does not have the description/capabilities, and includes potentially unsupported extension functions. The "safe" proc table would load the description/capabilities and remove unsupported functions. This might require a little experimentation to get the API right.