content/public/browser/android/compositor.h

   1 // Copyright (c) 2012 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_COMPOSITOR_H_
   6 #define CONTENT_PUBLIC_BROWSER_ANDROID_COMPOSITOR_H_
   7
   8 #include "base/callback.h"
   9 #include "cc/resources/ui_resource_bitmap.h"
  10 #include "cc/resources/ui_resource_client.h"
  11 #include "content/common/content_export.h"
  12 #include "ui/gfx/native_widget_types.h"
  13 #include "ui/gfx/rect.h"
  14 #include "ui/gfx/size.h"
  15
  16 #include "third_party/WebKit/public/platform/WebGraphicsContext3D.h"
  17
  18 namespace cc {
  19 class Layer;
  20 }
  21
  22 namespace gfx {
  23 class JavaBitmap;
  24 }
  25
  26 namespace content {
  27 class CompositorClient;
  28
  29 // An interface to the browser-side compositor.
  30 class CONTENT_EXPORT Compositor {
  31  public:
  32   virtual ~Compositor() {}
  33
  34   // Performs the global initialization needed before any compositor
  35   // instance can be used. This should be called only once.
  36   static void Initialize();
  37
  38   // Creates and returns a compositor instance.  |root_window| needs to outlive
  39   // the compositor as it manages callbacks on the compositor.
  40   static Compositor* Create(CompositorClient* client,
  41                             gfx::NativeWindow root_window);
  42
  43   // Attaches the layer tree.
  44   virtual void SetRootLayer(scoped_refptr<cc::Layer> root) = 0;
  45
  46   // Set the scale factor from DIP to pixel.
  47   virtual void setDeviceScaleFactor(float factor) = 0;
  48
  49   // Set the output surface bounds.
  50   virtual void SetWindowBounds(const gfx::Size& size) = 0;
  51
  52   // Sets the window visibility. When becoming invisible, resources will get
  53   // freed and other calls into the compositor are not allowed until after
  54   // having been made visible again.
  55   virtual void SetVisible(bool visible) = 0;
  56
  57   // Set the output surface handle which the compositor renders into.
  58   // DEPRECATED: Use SetSurface() which takes a Java Surface object.
  59   virtual void SetWindowSurface(ANativeWindow* window) = 0;
  60
  61   // Set the output surface which the compositor renders into.
  62   virtual void SetSurface(jobject surface) = 0;
  63
  64   // Tells the view tree to assume a transparent background when rendering.
  65   virtual void SetHasTransparentBackground(bool flag) = 0;
  66
  67   // Attempts to composite and read back the result into the provided buffer.
  68   // The buffer must be at least window width * height * 4 (RGBA) bytes large.
  69   // The buffer is not modified if false is returned.
  70   virtual bool CompositeAndReadback(void *pixels, const gfx::Rect& rect) = 0;
  71
  72   // Composite immediately. Used in single-threaded mode.
  73   virtual void Composite() = 0;
  74
  75   // Generates a UIResource and returns a UIResourceId.  May return 0.
  76   virtual cc::UIResourceId GenerateUIResource(
  77       const cc::UIResourceBitmap& bitmap) = 0;
  78
  79   // Deletes a UIResource.
  80   virtual void DeleteUIResource(cc::UIResourceId resource_id) = 0;
  81
  82   // Generates an OpenGL texture and returns a texture handle.  May return 0
  83   // if the current context is lost.
  84   virtual blink::WebGLId GenerateTexture(gfx::JavaBitmap& bitmap) = 0;
  85
  86   // Generates an OpenGL compressed texture and returns a texture handle.  May
  87   // return 0 if the current context is lost.
  88   virtual blink::WebGLId GenerateCompressedTexture(gfx::Size& size,
  89                                                     int data_size,
  90                                                     void* data) = 0;
  91
  92   // Deletes an OpenGL texture.
  93   virtual void DeleteTexture(blink::WebGLId texture_id) = 0;
  94
  95   // Grabs a copy of |texture_id| and saves it into |bitmap|.  No scaling is
  96   // done.  It is assumed that the texture size matches that of the bitmap.
  97   virtual bool CopyTextureToBitmap(blink::WebGLId texture_id,
  98                                    gfx::JavaBitmap& bitmap) = 0;
  99
 100   // Grabs a copy of |texture_id| and saves it into |bitmap|.  No scaling is
 101   // done. |src_rect| allows the caller to specify which rect of |texture_id|
 102   // to copy to |bitmap|.  It needs to match the size of |bitmap|.  Returns
 103   // true if the |texture_id| was copied into |bitmap|, false if not.
 104   virtual bool CopyTextureToBitmap(blink::WebGLId texture_id,
 105                                    const gfx::Rect& src_rect,
 106                                    gfx::JavaBitmap& bitmap) = 0;
 107  protected:
 108   Compositor() {}
 109 };
 110
 111 }  // namespace content
 112
 113 #endif  // CONTENT_PUBLIC_BROWSER_ANDROID_COMPOSITOR_H_