cc/resources/raster_source.h

   1 // Copyright 2014 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 CC_RESOURCES_RASTER_SOURCE_H_
   6 #define CC_RESOURCES_RASTER_SOURCE_H_
   7
   8 #include <vector>
   9
  10 #include "base/memory/ref_counted.h"
  11 #include "cc/base/cc_export.h"
  12 #include "cc/debug/traced_value.h"
  13 #include "skia/ext/refptr.h"
  14 #include "third_party/skia/include/core/SkColor.h"
  15 #include "third_party/skia/include/core/SkPixelRef.h"
  16 #include "ui/gfx/geometry/rect.h"
  17 #include "ui/gfx/geometry/size.h"
  18
  19 class SkCanvas;
  20 class SkPicture;
  21
  22 namespace cc {
  23
  24 class Picture;
  25
  26 class CC_EXPORT RasterSource : public base::RefCountedThreadSafe<RasterSource> {
  27  public:
  28   struct CC_EXPORT SolidColorAnalysis {
  29     SolidColorAnalysis()
  30         : is_solid_color(false), solid_color(SK_ColorTRANSPARENT) {}
  31     ~SolidColorAnalysis() {}
  32
  33     bool is_solid_color;
  34     SkColor solid_color;
  35   };
  36
  37   // Raster a subrect of this RasterSource into the given canvas. It is
  38   // assumed that contents_scale has already been applied to this canvas.
  39   // Writes the total number of pixels rasterized and the time spent
  40   // rasterizing to the stats if the respective pointer is not nullptr.
  41   // It is assumed that the canvas passed here will only be rasterized by
  42   // this raster source via this call.
  43   virtual void PlaybackToCanvas(SkCanvas* canvas,
  44                                 const gfx::Rect& canvas_rect,
  45                                 float contents_scale) const = 0;
  46
  47   // Similar to above, except that the canvas passed here can (or was already)
  48   // rasterized into by another raster source. That is, it is not safe to clear
  49   // the canvas or discard its underlying memory.
  50   virtual void PlaybackToSharedCanvas(SkCanvas* canvas,
  51                                       const gfx::Rect& canvas_rect,
  52                                       float contents_scale) const = 0;
  53
  54   // Analyze to determine if the given rect at given scale is of solid color in
  55   // this raster source.
  56   virtual void PerformSolidColorAnalysis(
  57       const gfx::Rect& content_rect,
  58       float contents_scale,
  59       SolidColorAnalysis* analysis) const = 0;
  60
  61   // Returns true iff the whole raster source is of solid color.
  62   virtual bool IsSolidColor() const = 0;
  63
  64   // Returns the color of the raster source if it is solid color. The results
  65   // are unspecified if IsSolidColor returns false.
  66   virtual SkColor GetSolidColor() const = 0;
  67
  68   // Returns the size of this raster source.
  69   virtual gfx::Size GetSize() const = 0;
  70
  71   // Populate the given list with all SkPixelRefs that may overlap the given
  72   // rect at given scale.
  73   virtual void GatherPixelRefs(const gfx::Rect& content_rect,
  74                                float contents_scale,
  75                                std::vector<SkPixelRef*>* pixel_refs) const = 0;
  76
  77   // Return true iff this raster source can raster the given rect at given
  78   // scale.
  79   virtual bool CoversRect(const gfx::Rect& content_rect,
  80                           float contents_scale) const = 0;
  81
  82   // Returns true if this raster source has anything to rasterize.
  83   virtual bool HasRecordings() const = 0;
  84
  85   // Informs the raster source that it should attempt to use distance field text
  86   // during rasterization.
  87   virtual void SetShouldAttemptToUseDistanceFieldText() = 0;
  88
  89   virtual void SetBackgoundColor(SkColor background_color) = 0;
  90   virtual void SetRequiresClear(bool requires_clear) = 0;
  91
  92   // Return true iff this raster source would benefit from using distance
  93   // field text.
  94   virtual bool ShouldAttemptToUseDistanceFieldText() const = 0;
  95
  96   // Tracing functionality.
  97   virtual void DidBeginTracing() = 0;
  98   virtual void AsValueInto(base::debug::TracedValue* array) const = 0;
  99   virtual skia::RefPtr<SkPicture> GetFlattenedPicture() = 0;
 100   virtual size_t GetPictureMemoryUsage() const = 0;
 101
 102   // Return true if LCD anti-aliasing may be used when rastering text.
 103   virtual bool CanUseLCDText() const = 0;
 104
 105  protected:
 106   friend class base::RefCountedThreadSafe<RasterSource>;
 107
 108   RasterSource() {}
 109   virtual ~RasterSource() {}
 110
 111  private:
 112   DISALLOW_COPY_AND_ASSIGN(RasterSource);
 113 };
 114
 115 }  // namespace cc
 116
 117 #endif  // CC_RESOURCES_RASTER_SOURCE_H_