ui/gl/gl_image.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 UI_GL_GL_IMAGE_H_
   6 #define UI_GL_GL_IMAGE_H_
   7
   8 #include "base/memory/ref_counted.h"
   9 #include "ui/gfx/geometry/point.h"
  10 #include "ui/gfx/geometry/rect.h"
  11 #include "ui/gfx/geometry/rect_f.h"
  12 #include "ui/gfx/geometry/size.h"
  13 #include "ui/gfx/native_widget_types.h"
  14 #include "ui/gfx/overlay_transform.h"
  15 #include "ui/gl/gl_export.h"
  16
  17 namespace gfx {
  18
  19 // Encapsulates an image that can be bound to a texture, hiding platform
  20 // specific management.
  21 class GL_EXPORT GLImage : public base::RefCounted<GLImage> {
  22  public:
  23   GLImage() {}
  24
  25   // Destroys the image.
  26   virtual void Destroy(bool have_context) = 0;
  27
  28   // Get the size of the image.
  29   virtual gfx::Size GetSize() = 0;
  30
  31   // Get the internal format of the image.
  32   virtual unsigned GetInternalFormat() = 0;
  33
  34   // Bind image to texture currently bound to |target|.
  35   virtual bool BindTexImage(unsigned target) = 0;
  36
  37   // Release image from texture currently bound to |target|.
  38   virtual void ReleaseTexImage(unsigned target) = 0;
  39
  40   // Copy |rect| of image to |offset| in texture currently bound to |target|.
  41   virtual bool CopyTexSubImage(unsigned target,
  42                                const Point& offset,
  43                                const Rect& rect) = 0;
  44
  45   // Called before the texture is used for drawing.
  46   virtual void WillUseTexImage() = 0;
  47
  48   // Called after the texture has been used for drawing.
  49   virtual void DidUseTexImage() = 0;
  50
  51   // Called before the texture image data will be modified.
  52   virtual void WillModifyTexImage() = 0;
  53
  54   // Called after the texture image data has been modified.
  55   virtual void DidModifyTexImage() = 0;
  56
  57   // Schedule image as an overlay plane to be shown at swap time for |widget|.
  58   virtual bool ScheduleOverlayPlane(gfx::AcceleratedWidget widget,
  59                                     int z_order,
  60                                     OverlayTransform transform,
  61                                     const Rect& bounds_rect,
  62                                     const RectF& crop_rect) = 0;
  63
  64  protected:
  65   virtual ~GLImage() {}
  66
  67  private:
  68   friend class base::RefCounted<GLImage>;
  69
  70   DISALLOW_COPY_AND_ASSIGN(GLImage);
  71 };
  72
  73 }  // namespace gfx
  74
  75 #endif  // UI_GL_GL_IMAGE_H_