Bug 1755481: correct documentation of `nsIClipboard::getData`. r=mccr8
[gecko.git] / image / ImageWrapper.cpp
blob08c5ae685ce22d3872271c29f185c8cf89c4c4c9
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 #include "ImageWrapper.h"
7 #include "mozilla/gfx/2D.h"
8 #include "mozilla/RefPtr.h"
9 #include "Orientation.h"
10 #include "mozilla/image/Resolution.h"
12 #include "mozilla/MemoryReporting.h"
14 namespace mozilla {
16 using dom::Document;
17 using gfx::IntSize;
18 using gfx::SamplingFilter;
19 using gfx::SourceSurface;
20 using layers::ImageContainer;
22 namespace image {
24 // Inherited methods from Image.
26 already_AddRefed<ProgressTracker> ImageWrapper::GetProgressTracker() {
27 return mInnerImage->GetProgressTracker();
30 size_t ImageWrapper::SizeOfSourceWithComputedFallback(
31 SizeOfState& aState) const {
32 return mInnerImage->SizeOfSourceWithComputedFallback(aState);
35 void ImageWrapper::CollectSizeOfSurfaces(
36 nsTArray<SurfaceMemoryCounter>& aCounters,
37 MallocSizeOf aMallocSizeOf) const {
38 mInnerImage->CollectSizeOfSurfaces(aCounters, aMallocSizeOf);
41 void ImageWrapper::IncrementAnimationConsumers() {
42 MOZ_ASSERT(NS_IsMainThread(),
43 "Main thread only to encourage serialization "
44 "with DecrementAnimationConsumers");
45 mInnerImage->IncrementAnimationConsumers();
48 void ImageWrapper::DecrementAnimationConsumers() {
49 MOZ_ASSERT(NS_IsMainThread(),
50 "Main thread only to encourage serialization "
51 "with IncrementAnimationConsumers");
52 mInnerImage->DecrementAnimationConsumers();
55 #ifdef DEBUG
56 uint32_t ImageWrapper::GetAnimationConsumers() {
57 return mInnerImage->GetAnimationConsumers();
59 #endif
61 nsresult ImageWrapper::OnImageDataAvailable(nsIRequest* aRequest,
62 nsIInputStream* aInStr,
63 uint64_t aSourceOffset,
64 uint32_t aCount) {
65 return mInnerImage->OnImageDataAvailable(aRequest, aInStr, aSourceOffset,
66 aCount);
69 nsresult ImageWrapper::OnImageDataComplete(nsIRequest* aRequest,
70 nsresult aStatus, bool aLastPart) {
71 return mInnerImage->OnImageDataComplete(aRequest, aStatus, aLastPart);
74 void ImageWrapper::OnSurfaceDiscarded(const SurfaceKey& aSurfaceKey) {
75 return mInnerImage->OnSurfaceDiscarded(aSurfaceKey);
78 void ImageWrapper::SetInnerWindowID(uint64_t aInnerWindowId) {
79 mInnerImage->SetInnerWindowID(aInnerWindowId);
82 uint64_t ImageWrapper::InnerWindowID() const {
83 return mInnerImage->InnerWindowID();
86 bool ImageWrapper::HasError() { return mInnerImage->HasError(); }
88 void ImageWrapper::SetHasError() { mInnerImage->SetHasError(); }
90 nsIURI* ImageWrapper::GetURI() const { return mInnerImage->GetURI(); }
92 // Methods inherited from XPCOM interfaces.
94 NS_IMPL_ISUPPORTS(ImageWrapper, imgIContainer)
96 NS_IMETHODIMP
97 ImageWrapper::GetWidth(int32_t* aWidth) {
98 return mInnerImage->GetWidth(aWidth);
101 NS_IMETHODIMP
102 ImageWrapper::GetHeight(int32_t* aHeight) {
103 return mInnerImage->GetHeight(aHeight);
106 nsresult ImageWrapper::GetNativeSizes(nsTArray<IntSize>& aNativeSizes) const {
107 return mInnerImage->GetNativeSizes(aNativeSizes);
110 size_t ImageWrapper::GetNativeSizesLength() const {
111 return mInnerImage->GetNativeSizesLength();
114 NS_IMETHODIMP
115 ImageWrapper::GetIntrinsicSize(nsSize* aSize) {
116 return mInnerImage->GetIntrinsicSize(aSize);
119 Maybe<AspectRatio> ImageWrapper::GetIntrinsicRatio() {
120 return mInnerImage->GetIntrinsicRatio();
123 nsresult ImageWrapper::GetHotspotX(int32_t* aX) {
124 return Image::GetHotspotX(aX);
127 nsresult ImageWrapper::GetHotspotY(int32_t* aY) {
128 return Image::GetHotspotY(aY);
131 NS_IMETHODIMP_(Orientation)
132 ImageWrapper::GetOrientation() { return mInnerImage->GetOrientation(); }
134 NS_IMETHODIMP_(Resolution)
135 ImageWrapper::GetResolution() { return mInnerImage->GetResolution(); }
137 NS_IMETHODIMP
138 ImageWrapper::GetType(uint16_t* aType) { return mInnerImage->GetType(aType); }
140 NS_IMETHODIMP
141 ImageWrapper::GetProviderId(uint32_t* aId) {
142 return mInnerImage->GetProviderId(aId);
145 NS_IMETHODIMP
146 ImageWrapper::GetAnimated(bool* aAnimated) {
147 return mInnerImage->GetAnimated(aAnimated);
150 NS_IMETHODIMP_(already_AddRefed<SourceSurface>)
151 ImageWrapper::GetFrame(uint32_t aWhichFrame, uint32_t aFlags) {
152 return mInnerImage->GetFrame(aWhichFrame, aFlags);
155 NS_IMETHODIMP_(already_AddRefed<SourceSurface>)
156 ImageWrapper::GetFrameAtSize(const IntSize& aSize, uint32_t aWhichFrame,
157 uint32_t aFlags) {
158 return mInnerImage->GetFrameAtSize(aSize, aWhichFrame, aFlags);
161 NS_IMETHODIMP_(bool)
162 ImageWrapper::WillDrawOpaqueNow() { return mInnerImage->WillDrawOpaqueNow(); }
164 NS_IMETHODIMP_(bool)
165 ImageWrapper::IsImageContainerAvailable(WindowRenderer* aRenderer,
166 uint32_t aFlags) {
167 return mInnerImage->IsImageContainerAvailable(aRenderer, aFlags);
170 NS_IMETHODIMP_(ImgDrawResult)
171 ImageWrapper::GetImageProvider(WindowRenderer* aRenderer,
172 const gfx::IntSize& aSize,
173 const Maybe<SVGImageContext>& aSVGContext,
174 const Maybe<ImageIntRegion>& aRegion,
175 uint32_t aFlags,
176 WebRenderImageProvider** aProvider) {
177 return mInnerImage->GetImageProvider(aRenderer, aSize, aSVGContext, aRegion,
178 aFlags, aProvider);
181 NS_IMETHODIMP_(ImgDrawResult)
182 ImageWrapper::Draw(gfxContext* aContext, const nsIntSize& aSize,
183 const ImageRegion& aRegion, uint32_t aWhichFrame,
184 SamplingFilter aSamplingFilter,
185 const Maybe<SVGImageContext>& aSVGContext, uint32_t aFlags,
186 float aOpacity) {
187 return mInnerImage->Draw(aContext, aSize, aRegion, aWhichFrame,
188 aSamplingFilter, aSVGContext, aFlags, aOpacity);
191 NS_IMETHODIMP
192 ImageWrapper::StartDecoding(uint32_t aFlags, uint32_t aWhichFrame) {
193 return mInnerImage->StartDecoding(aFlags, aWhichFrame);
196 bool ImageWrapper::StartDecodingWithResult(uint32_t aFlags,
197 uint32_t aWhichFrame) {
198 return mInnerImage->StartDecodingWithResult(aFlags, aWhichFrame);
201 imgIContainer::DecodeResult ImageWrapper::RequestDecodeWithResult(
202 uint32_t aFlags, uint32_t aWhichFrame) {
203 return mInnerImage->RequestDecodeWithResult(aFlags, aWhichFrame);
206 NS_IMETHODIMP
207 ImageWrapper::RequestDecodeForSize(const nsIntSize& aSize, uint32_t aFlags,
208 uint32_t aWhichFrame) {
209 return mInnerImage->RequestDecodeForSize(aSize, aFlags, aWhichFrame);
212 NS_IMETHODIMP
213 ImageWrapper::LockImage() {
214 MOZ_ASSERT(NS_IsMainThread(),
215 "Main thread to encourage serialization with UnlockImage");
216 return mInnerImage->LockImage();
219 NS_IMETHODIMP
220 ImageWrapper::UnlockImage() {
221 MOZ_ASSERT(NS_IsMainThread(),
222 "Main thread to encourage serialization with LockImage");
223 return mInnerImage->UnlockImage();
226 NS_IMETHODIMP
227 ImageWrapper::RequestDiscard() { return mInnerImage->RequestDiscard(); }
229 NS_IMETHODIMP_(void)
230 ImageWrapper::RequestRefresh(const TimeStamp& aTime) {
231 return mInnerImage->RequestRefresh(aTime);
234 NS_IMETHODIMP
235 ImageWrapper::GetAnimationMode(uint16_t* aAnimationMode) {
236 return mInnerImage->GetAnimationMode(aAnimationMode);
239 NS_IMETHODIMP
240 ImageWrapper::SetAnimationMode(uint16_t aAnimationMode) {
241 return mInnerImage->SetAnimationMode(aAnimationMode);
244 NS_IMETHODIMP
245 ImageWrapper::ResetAnimation() { return mInnerImage->ResetAnimation(); }
247 NS_IMETHODIMP_(float)
248 ImageWrapper::GetFrameIndex(uint32_t aWhichFrame) {
249 return mInnerImage->GetFrameIndex(aWhichFrame);
252 NS_IMETHODIMP_(int32_t)
253 ImageWrapper::GetFirstFrameDelay() { return mInnerImage->GetFirstFrameDelay(); }
255 NS_IMETHODIMP_(void)
256 ImageWrapper::SetAnimationStartTime(const TimeStamp& aTime) {
257 mInnerImage->SetAnimationStartTime(aTime);
260 void ImageWrapper::PropagateUseCounters(Document* aReferencingDocument) {
261 mInnerImage->PropagateUseCounters(aReferencingDocument);
264 nsIntSize ImageWrapper::OptimalImageSizeForDest(const gfxSize& aDest,
265 uint32_t aWhichFrame,
266 SamplingFilter aSamplingFilter,
267 uint32_t aFlags) {
268 return mInnerImage->OptimalImageSizeForDest(aDest, aWhichFrame,
269 aSamplingFilter, aFlags);
272 NS_IMETHODIMP_(nsIntRect)
273 ImageWrapper::GetImageSpaceInvalidationRect(const nsIntRect& aRect) {
274 return mInnerImage->GetImageSpaceInvalidationRect(aRect);
277 already_AddRefed<imgIContainer> ImageWrapper::Unwrap() {
278 return mInnerImage->Unwrap();
281 } // namespace image
282 } // namespace mozilla