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/. */
6 #ifndef mozilla_image_FrozenImage_h
7 #define mozilla_image_FrozenImage_h
9 #include "ImageWrapper.h"
10 #include "mozilla/gfx/2D.h"
11 #include "mozilla/RefPtr.h"
17 * An Image wrapper that disables animation, freezing the image at its first
18 * frame. It does this using two strategies. If this is the only instance of the
19 * image, animation will never start, because IncrementAnimationConsumers is
20 * ignored. If there is another instance that is animated, that's still OK,
21 * because any imgIContainer method that is affected by animation gets its
22 * aWhichFrame argument set to FRAME_FIRST when it passes through FrozenImage.
24 * XXX(seth): There a known (performance, not correctness) issue with
25 * GetImageContainer. See the comments for that method for more information.
27 class FrozenImage
: public ImageWrapper
{
28 typedef gfx::SourceSurface SourceSurface
;
31 NS_INLINE_DECL_REFCOUNTING_INHERITED(FrozenImage
, ImageWrapper
)
33 virtual void IncrementAnimationConsumers() override
;
34 virtual void DecrementAnimationConsumers() override
;
36 bool IsNonAnimated() const;
38 NS_IMETHOD
GetAnimated(bool* aAnimated
) override
;
39 NS_IMETHOD_(already_AddRefed
<SourceSurface
>)
40 GetFrame(uint32_t aWhichFrame
, uint32_t aFlags
) override
;
41 NS_IMETHOD_(already_AddRefed
<SourceSurface
>)
42 GetFrameAtSize(const gfx::IntSize
& aSize
, uint32_t aWhichFrame
,
43 uint32_t aFlags
) override
;
45 IsImageContainerAvailable(layers::LayerManager
* aManager
,
46 uint32_t aFlags
) override
;
47 NS_IMETHOD_(already_AddRefed
<layers::ImageContainer
>)
48 GetImageContainer(WindowRenderer
* aRenderer
, uint32_t aFlags
) override
;
50 IsImageContainerAvailableAtSize(layers::LayerManager
* aManager
,
51 const gfx::IntSize
& aSize
,
52 uint32_t aFlags
) override
;
53 NS_IMETHOD_(ImgDrawResult
)
54 GetImageContainerAtSize(WindowRenderer
* aRenderer
, const gfx::IntSize
& aSize
,
55 const Maybe
<SVGImageContext
>& aSVGContext
,
56 const Maybe
<ImageIntRegion
>& aRegion
, uint32_t aFlags
,
57 layers::ImageContainer
** aOutContainer
) override
;
58 NS_IMETHOD_(ImgDrawResult
)
59 Draw(gfxContext
* aContext
, const nsIntSize
& aSize
, const ImageRegion
& aRegion
,
60 uint32_t aWhichFrame
, gfx::SamplingFilter aSamplingFilter
,
61 const Maybe
<SVGImageContext
>& aSVGContext
, uint32_t aFlags
,
62 float aOpacity
) override
;
63 NS_IMETHOD
StartDecoding(uint32_t aFlags
, uint32_t aWhichFrame
) override
;
65 StartDecodingWithResult(uint32_t aFlags
, uint32_t aWhichFrame
) override
;
66 NS_IMETHOD_(DecodeResult
)
67 RequestDecodeWithResult(uint32_t aFlags
, uint32_t aWhichFrame
) override
;
68 NS_IMETHOD
RequestDecodeForSize(const nsIntSize
& aSize
, uint32_t aFlags
,
69 uint32_t aWhichFrame
) override
;
70 NS_IMETHOD_(void) RequestRefresh(const TimeStamp
& aTime
) override
;
71 NS_IMETHOD
GetAnimationMode(uint16_t* aAnimationMode
) override
;
72 NS_IMETHOD
SetAnimationMode(uint16_t aAnimationMode
) override
;
73 NS_IMETHOD
ResetAnimation() override
;
74 NS_IMETHOD_(float) GetFrameIndex(uint32_t aWhichFrame
) override
;
77 explicit FrozenImage(Image
* aImage
) : ImageWrapper(aImage
) {}
78 virtual ~FrozenImage() {}
81 friend class ImageOps
;
85 } // namespace mozilla
87 #endif // mozilla_image_FrozenImage_h