image/DynamicImage.h

   1 /* -*- Mode: C++; tab-width: 2; indent-tabs-mode: nil; c-basic-offset: 2 -*- */
   2 /* This Source Code Form is subject to the terms of the Mozilla Public
   3  * License, v. 2.0. If a copy of the MPL was not distributed with this
   4  * file, You can obtain one at http://mozilla.org/MPL/2.0/. */
   5
   6 #ifndef mozilla_image_DynamicImage_h
   7 #define mozilla_image_DynamicImage_h
   8
   9 #include "mozilla/MemoryReporting.h"
  10 #include "gfxDrawable.h"
  11 #include "Image.h"
  12
  13 namespace mozilla {
  14 namespace image {
  15
  16 /**
  17  * An Image that is dynamically created. The content of the image is provided by
  18  * a gfxDrawable. It's anticipated that most uses of DynamicImage will be
  19  * ephemeral.
  20  */
  21 class DynamicImage : public Image {
  22  public:
  23   NS_DECL_ISUPPORTS
  24   NS_DECL_IMGICONTAINER
  25
  26   explicit DynamicImage(gfxDrawable* aDrawable) : mDrawable(aDrawable) {
  27     MOZ_ASSERT(aDrawable, "Must have a gfxDrawable to wrap");
  28   }
  29
  30   // Inherited methods from Image.
  31   nsresult GetNativeSizes(nsTArray<gfx::IntSize>& aNativeSizes) const override;
  32   size_t GetNativeSizesLength() const override;
  33   virtual already_AddRefed<ProgressTracker> GetProgressTracker() override;
  34   virtual size_t SizeOfSourceWithComputedFallback(
  35       SizeOfState& aState) const override;
  36   virtual void CollectSizeOfSurfaces(nsTArray<SurfaceMemoryCounter>& aCounters,
  37                                      MallocSizeOf aMallocSizeOf) const override;
  38
  39   virtual void IncrementAnimationConsumers() override;
  40   virtual void DecrementAnimationConsumers() override;
  41 #ifdef DEBUG
  42   virtual uint32_t GetAnimationConsumers() override;
  43 #endif
  44
  45   virtual nsresult OnImageDataAvailable(nsIRequest* aRequest,
  46                                         nsISupports* aContext,
  47                                         nsIInputStream* aInStr,
  48                                         uint64_t aSourceOffset,
  49                                         uint32_t aCount) override;
  50   virtual nsresult OnImageDataComplete(nsIRequest* aRequest,
  51                                        nsISupports* aContext, nsresult aStatus,
  52                                        bool aLastPart) override;
  53
  54   virtual void OnSurfaceDiscarded(const SurfaceKey& aSurfaceKey) override;
  55
  56   virtual void SetInnerWindowID(uint64_t aInnerWindowId) override;
  57   virtual uint64_t InnerWindowID() const override;
  58
  59   virtual bool HasError() override;
  60   virtual void SetHasError() override;
  61
  62   nsIURI* GetURI() const override;
  63
  64  private:
  65   virtual ~DynamicImage() {}
  66
  67   RefPtr<gfxDrawable> mDrawable;
  68 };
  69
  70 }  // namespace image
  71 }  // namespace mozilla
  72
  73 #endif  // mozilla_image_DynamicImage_h