content/public/browser/android/synchronous_compositor.h

   1 // Copyright 2013 The Chromium Authors. All rights reserved.
   2 // Use of this source code is governed by a BSD-style license that can be
   3 // found in the LICENSE file.
   4
   5 #ifndef CONTENT_PUBLIC_BROWSER_ANDROID_SYNCHRONOUS_COMPOSITOR_H_
   6 #define CONTENT_PUBLIC_BROWSER_ANDROID_SYNCHRONOUS_COMPOSITOR_H_
   7
   8 #include "base/memory/ref_counted.h"
   9 #include "content/common/content_export.h"
  10 #include "gpu/command_buffer/service/in_process_command_buffer.h"
  11 #include "ui/gfx/geometry/rect.h"
  12 #include "ui/gfx/geometry/size.h"
  13
  14 class SkCanvas;
  15
  16 namespace cc {
  17 class CompositorFrame;
  18 class CompositorFrameAck;
  19 }
  20
  21 namespace gfx {
  22 class Transform;
  23 };
  24
  25 namespace gpu {
  26 class GLInProcessContext;
  27 }
  28
  29 namespace content {
  30
  31 class SynchronousCompositorClient;
  32 class WebContents;
  33
  34 // Interface for embedders that wish to direct compositing operations
  35 // synchronously under their own control. Only meaningful when the
  36 // kEnableSyncrhonousRendererCompositor flag is specified.
  37 class CONTENT_EXPORT SynchronousCompositor {
  38  public:
  39   // Must be called once per WebContents instance. Will create the compositor
  40   // instance as needed, but only if |client| is non-nullptr.
  41   static void SetClientForWebContents(WebContents* contents,
  42                                       SynchronousCompositorClient* client);
  43
  44   static void SetGpuService(
  45       scoped_refptr<gpu::InProcessCommandBuffer::Service> service);
  46
  47   // By default, synchronous compopsitor records the full layer, not only
  48   // what is inside and around the view port. This can be used to switch
  49   // between this record-full-layer behavior and normal record-around-viewport
  50   // behavior.
  51   static void SetRecordFullDocument(bool record_full_document);
  52
  53   // Synchronously initialize compositor for hardware draw. Can only be called
  54   // while compositor is in software only mode, either after compositor is
  55   // first created or after ReleaseHwDraw is called. It is invalid to
  56   // DemandDrawHw before this returns true.
  57   virtual bool InitializeHwDraw() = 0;
  58
  59   // Reverse of InitializeHwDraw above. Can only be called while hardware draw
  60   // is already initialized. Brings compositor back to software only mode and
  61   // releases all hardware resources.
  62   virtual void ReleaseHwDraw() = 0;
  63
  64   // "On demand" hardware draw. The content is first clipped to |damage_area|,
  65   // then transformed through |transform|, and finally clipped to |view_size|.
  66   virtual scoped_ptr<cc::CompositorFrame> DemandDrawHw(
  67       gfx::Size surface_size,
  68       const gfx::Transform& transform,
  69       gfx::Rect viewport,
  70       gfx::Rect clip,
  71       gfx::Rect viewport_rect_for_tile_priority,
  72       const gfx::Transform& transform_for_tile_priority) = 0;
  73
  74   // For delegated rendering, return resources from parent compositor to this.
  75   // Note that all resources must be returned before ReleaseHwDraw.
  76   virtual void ReturnResources(const cc::CompositorFrameAck& frame_ack) = 0;
  77
  78   // "On demand" SW draw, into the supplied canvas (observing the transform
  79   // and clip set there-in).
  80   virtual bool DemandDrawSw(SkCanvas* canvas) = 0;
  81
  82   // Set the memory limit policy of this compositor.
  83   virtual void SetMemoryPolicy(size_t bytes_limit) = 0;
  84
  85   // Should be called by the embedder after the embedder had modified the
  86   // scroll offset of the root layer (as returned by
  87   // SynchronousCompositorClient::GetTotalRootLayerScrollOffset).
  88   virtual void DidChangeRootLayerScrollOffset() = 0;
  89
  90   // Called by the embedder to notify that the compositor is active. The
  91   // compositor won't ask for vsyncs when it's inactive. NOTE: The compositor
  92   // starts off as inactive and needs a SetActive(true) call to begin.
  93   virtual void SetIsActive(bool is_active) = 0;
  94
  95  protected:
  96   virtual ~SynchronousCompositor() {}
  97 };
  98
  99 }  // namespace content
 100
 101 #endif  // CONTENT_PUBLIC_BROWSER_ANDROID_SYNCHRONOUS_COMPOSITOR_H_