image/RecyclingSourceSurface.h

   1 /* -*- Mode: C++; tab-width: 2; indent-tabs-mode: nil; c-basic-offset: 2 -*- */
   2 /* vim: set ts=2 et sw=2 tw=80: */
   3 /* This Source Code Form is subject to the terms of the Mozilla Public
   4  * License, v. 2.0. If a copy of the MPL was not distributed with this
   5  * file, You can obtain one at http://mozilla.org/MPL/2.0/. */
   6
   7 #ifndef mozilla_image_RecyclingSourceSurface_h
   8 #define mozilla_image_RecyclingSourceSurface_h
   9
  10 #include "mozilla/gfx/2D.h"
  11
  12 namespace mozilla {
  13 namespace image {
  14
  15 class imgFrame;
  16
  17 /**
  18  * This surface subclass will prevent the underlying surface from being recycled
  19  * as long as it is still alive. We will create this surface to wrap imgFrame's
  20  * mLockedSurface, if we are accessing it on a path that will keep the surface
  21  * alive for an indeterminate period of time (e.g. imgFrame::GetSourceSurface,
  22  * imgFrame::Draw with a recording or capture DrawTarget).
  23  */
  24 class RecyclingSourceSurface final : public gfx::DataSourceSurface {
  25  public:
  26   RecyclingSourceSurface(imgFrame* aParent, gfx::DataSourceSurface* aSurface);
  27
  28   MOZ_DECLARE_REFCOUNTED_VIRTUAL_TYPENAME(RecyclingSourceSurface, override);
  29
  30   uint8_t* GetData() override { return mSurface->GetData(); }
  31   int32_t Stride() override { return mSurface->Stride(); }
  32   gfx::SurfaceType GetType() const override { return mType; }
  33   gfx::IntSize GetSize() const override { return mSurface->GetSize(); }
  34   gfx::SurfaceFormat GetFormat() const override {
  35     return mSurface->GetFormat();
  36   }
  37
  38   void AddSizeOfExcludingThis(MallocSizeOf aMallocSizeOf, size_t& aHeapSizeOut,
  39                               size_t& aNonHeapSizeOut, size_t& aExtHandlesOut,
  40                               uint64_t& aExtIdOut) const override {}
  41
  42   bool OnHeap() const override { return mSurface->OnHeap(); }
  43   bool Map(MapType aType, MappedSurface* aMappedSurface) override {
  44     return mSurface->Map(aType, aMappedSurface);
  45   }
  46   void Unmap() override { mSurface->Unmap(); }
  47
  48   gfx::DataSourceSurface* GetChildSurface() const { return mSurface; }
  49
  50  protected:
  51   void GuaranteePersistance() override {}
  52
  53   ~RecyclingSourceSurface() override;
  54
  55   RefPtr<imgFrame> mParent;
  56   RefPtr<DataSourceSurface> mSurface;
  57   gfx::SurfaceType mType;
  58 };
  59
  60 }  // namespace image
  61 }  // namespace mozilla
  62
  63 #endif  // mozilla_image_RecyclingSourceSurface_h