| // 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_FLOW_SURFACE_FRAME_H_ |
| #define FLUTTER_FLOW_SURFACE_FRAME_H_ |
| |
| #include <memory> |
| #include <optional> |
| |
| #include "flutter/common/graphics/gl_context_switch.h" |
| #include "flutter/fml/macros.h" |
| #include "flutter/fml/time/time_point.h" |
| #include "third_party/skia/include/core/SkCanvas.h" |
| #include "third_party/skia/include/core/SkSurface.h" |
| |
| namespace flutter { |
| |
| // This class represents a frame that has been fully configured for the |
| // underlying client rendering API. A frame may only be submitted once. |
| class SurfaceFrame { |
| public: |
| using SubmitCallback = |
| std::function<bool(const SurfaceFrame& surface_frame, SkCanvas* canvas)>; |
| |
| // Information about the underlying framebuffer |
| struct FramebufferInfo { |
| // Indicates whether or not the surface supports pixel readback as used in |
| // circumstances such as a BackdropFilter. |
| bool supports_readback = false; |
| |
| // This is the area of framebuffer that lags behind the front buffer. |
| // |
| // Correctly providing exiting_damage is necessary for supporting double and |
| // triple buffering. Embedder is responsible for tracking this area for each |
| // of the back buffers used. When doing partial redraw, this area will be |
| // repainted alongside of dirty area determined by diffing current and |
| // last successfully rasterized layer tree; |
| // |
| // If existing damage is unspecified (nullopt), entire frame will be |
| // rasterized (no partial redraw). To signal that there is no existing |
| // damage use an empty SkIRect. |
| std::optional<SkIRect> existing_damage; |
| }; |
| |
| SurfaceFrame(sk_sp<SkSurface> surface, |
| FramebufferInfo framebuffer_info, |
| const SubmitCallback& submit_callback); |
| |
| SurfaceFrame(sk_sp<SkSurface> surface, |
| FramebufferInfo framebuffer_info, |
| const SubmitCallback& submit_callback, |
| std::unique_ptr<GLContextResult> context_result); |
| |
| ~SurfaceFrame(); |
| |
| struct SubmitInfo { |
| // The frame damage for frame n is the difference between frame n and |
| // frame (n-1), and represents the area that a compositor must recompose. |
| // |
| // Corresponds to EGL_KHR_swap_buffers_with_damage |
| std::optional<SkIRect> frame_damage; |
| |
| // The buffer damage for a frame is the area changed since that same buffer |
| // was last used. If the buffer has not been used before, the buffer damage |
| // is the entire area of the buffer. |
| // |
| // Corresponds to EGL_KHR_partial_update |
| std::optional<SkIRect> buffer_damage; |
| |
| // The vsync target time. |
| // |
| // Backends may use this information to avoid overloading the GPU with |
| // multiple frames per vsync. |
| fml::TimePoint target_time; |
| }; |
| |
| bool Submit(); |
| |
| bool IsSubmitted() const; |
| |
| SkCanvas* SkiaCanvas(); |
| |
| sk_sp<SkSurface> SkiaSurface() const; |
| |
| const FramebufferInfo& framebuffer_info() const { return framebuffer_info_; } |
| |
| void set_submit_info(const SubmitInfo& submit_info) { |
| submit_info_ = submit_info; |
| } |
| const SubmitInfo& submit_info() const { return submit_info_; } |
| |
| private: |
| bool submitted_ = false; |
| sk_sp<SkSurface> surface_; |
| FramebufferInfo framebuffer_info_; |
| SubmitInfo submit_info_; |
| SubmitCallback submit_callback_; |
| std::unique_ptr<GLContextResult> context_result_; |
| |
| bool PerformSubmit(); |
| |
| FML_DISALLOW_COPY_AND_ASSIGN(SurfaceFrame); |
| }; |
| |
| } // namespace flutter |
| |
| #endif // FLUTTER_FLOW_SURFACE_FRAME_H_ |