Added FrameFuture class

content/public/browser/android/synchronous_compositor.h

 // Copyright 2013 The Chromium 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 CONTENT_PUBLIC_BROWSER_ANDROID_SYNCHRONOUS_COMPOSITOR_H_
 #define CONTENT_PUBLIC_BROWSER_ANDROID_SYNCHRONOUS_COMPOSITOR_H_
 
 #include <stddef.h>
 
 #include <memory>
 
 #include "base/memory/ref_counted.h"
+#include "base/synchronization/waitable_event.h"
 #include "base/time/time.h"
 #include "cc/resources/returned_resource.h"
 #include "content/common/content_export.h"
 #include "ui/gfx/geometry/rect.h"
 #include "ui/gfx/geometry/size.h"
 
 class SkCanvas;
 
 namespace cc {
 class CompositorFrame;
 class CompositorFrameAck;
 }
 
 namespace gfx {
 class Point;
 class ScrollOffset;
 class Transform;
 };
 
 namespace content {
 
 class SynchronousCompositorClient;
 class WebContents;
+class FrameFuture;

[boliu, 2016/09/16 16:26:12]

remove, this class does not actually exist

[ojars, 2016/09/19 22:02:37]

Done.

 
 // Interface for embedders that wish to direct compositing operations
 // synchronously under their own control. Only meaningful when the
 // kEnableSyncrhonousRendererCompositor flag is specified.
 class CONTENT_EXPORT SynchronousCompositor {
  public:
   // Must be called once per WebContents instance. Will create the compositor
   // instance as needed, but only if |client| is non-nullptr.
   static void SetClientForWebContents(WebContents* contents,
                                       SynchronousCompositorClient* client);
 
   struct Frame {
     Frame();
     ~Frame();
 
     // Movable type.
     Frame(Frame&& rhs);
     Frame& operator=(Frame&& rhs);
 
     uint32_t output_surface_id;
     std::unique_ptr<cc::CompositorFrame> frame;
 
    private:
     DISALLOW_COPY_AND_ASSIGN(Frame);
   };
 
+  class FrameFuture : public base::RefCountedThreadSafe<FrameFuture> {
+   public:
+    FrameFuture();
+    void setFrame(std::unique_ptr<SynchronousCompositor::Frame> frame);
+    SynchronousCompositor::Frame* getFrame();
+    bool hasFrame();
+
+   private:
+    base::WaitableEvent waitable_event_;
+    std::unique_ptr<content::SynchronousCompositor::Frame> frame_;
+    friend class base::RefCountedThreadSafe<FrameFuture>;
+    ~FrameFuture();
+  };
+
   // "On demand" hardware draw. Parameters are used by compositor for this draw.
   // |viewport_size| is the current size to improve results during resize.
   // |viewport_rect_for_tile_priority| and |transform_for_tile_priority| are
   // used to customize the tiling decisions of compositor.
-  virtual Frame DemandDrawHw(
+  // TODO(ojars): update this and the next documentation
+  virtual scoped_refptr<FrameFuture> DemandDrawHw(
       const gfx::Size& viewport_size,
       const gfx::Rect& viewport_rect_for_tile_priority,
       const gfx::Transform& transform_for_tile_priority) = 0;
 
   // Same as DemandDrawHw, but uses asynchronous IPC messages. Calls
   // SynchronousCompositorClient::OnDrawHardwareProcessFrame to return the
   // frame.
-  virtual void DemandDrawHwAsync(
+  virtual scoped_refptr<FrameFuture> DemandDrawHwAsync(
       const gfx::Size& viewport_size,
       const gfx::Rect& viewport_rect_for_tile_priority,
       const gfx::Transform& transform_for_tile_priority) = 0;
 
   // For delegated rendering, return resources from parent compositor to this.
   // Note that all resources must be returned before ReleaseHwDraw.
   virtual void ReturnResources(uint32_t output_surface_id,
                                const cc::ReturnedResourceArray& resources) = 0;
 
   // "On demand" SW draw, into the supplied canvas (observing the transform
@@ skipping 17 matching lines @@
   // and if any input animation is active, it should tick now.
   virtual void OnComputeScroll(base::TimeTicks animation_time) = 0;
 
  protected:
   virtual ~SynchronousCompositor() {}
 };
 
 }  // namespace content
 
 #endif  // CONTENT_PUBLIC_BROWSER_ANDROID_SYNCHRONOUS_COMPOSITOR_H_