47b8f999ed
This patch doesn't change behavior; it's just a rename. Without this, it's easy to get confused and assume that img.intrinsicSize would just be a shorthand for img.width and img.height -- but it's not. (It has different units from the 'width' and 'height' attributes, and in some cases -- e.g. the VectorImage implementation -- it queries for its answer in a different way from how 'width' and 'height' do. (I'm doing this partly because I'll soon be adding a new attribute that *does* just represent img.width and img.height, and that new attribute will also be named something like "intrinsicSize"; and I want to minimize confusion between that new attribute and this existing one.) Differential Revision: https://phabricator.services.mozilla.com/D248492
99 lines
3.9 KiB
C++
99 lines
3.9 KiB
C++
/* -*- Mode: C++; tab-width: 2; indent-tabs-mode: nil; c-basic-offset: 2 -*- */
|
|
/* This Source Code Form is subject to the terms of the Mozilla Public
|
|
* License, v. 2.0. If a copy of the MPL was not distributed with this
|
|
* file, You can obtain one at http://mozilla.org/MPL/2.0/. */
|
|
|
|
#ifndef mozilla_image_ClippedImage_h
|
|
#define mozilla_image_ClippedImage_h
|
|
|
|
#include "ImageWrapper.h"
|
|
#include "mozilla/gfx/2D.h"
|
|
#include "mozilla/Maybe.h"
|
|
#include "mozilla/RefPtr.h"
|
|
#include "mozilla/UniquePtr.h"
|
|
|
|
#include <utility>
|
|
|
|
namespace mozilla {
|
|
namespace image {
|
|
|
|
class ClippedImageCachedSurface;
|
|
class DrawSingleTileCallback;
|
|
|
|
/**
|
|
* An Image wrapper that clips an image against a rectangle. Right now only
|
|
* absolute coordinates in pixels are supported.
|
|
*
|
|
* XXX(seth): There a known (performance, not correctness) issue with
|
|
* GetImageContainer. See the comments for that method for more information.
|
|
*/
|
|
class ClippedImage : public ImageWrapper {
|
|
typedef gfx::SourceSurface SourceSurface;
|
|
|
|
public:
|
|
NS_INLINE_DECL_REFCOUNTING_INHERITED(ClippedImage, ImageWrapper)
|
|
|
|
NS_IMETHOD GetWidth(int32_t* aWidth) override;
|
|
NS_IMETHOD GetHeight(int32_t* aHeight) override;
|
|
NS_IMETHOD GetIntrinsicSizeInAppUnits(nsSize* aSize) override;
|
|
AspectRatio GetIntrinsicRatio() override;
|
|
NS_IMETHOD_(already_AddRefed<SourceSurface>)
|
|
GetFrame(uint32_t aWhichFrame, uint32_t aFlags) override;
|
|
NS_IMETHOD_(already_AddRefed<SourceSurface>)
|
|
GetFrameAtSize(const gfx::IntSize& aSize, uint32_t aWhichFrame,
|
|
uint32_t aFlags) override;
|
|
NS_IMETHOD_(bool)
|
|
IsImageContainerAvailable(WindowRenderer* aRenderer,
|
|
uint32_t aFlags) override;
|
|
NS_IMETHOD_(ImgDrawResult)
|
|
GetImageProvider(WindowRenderer* aRenderer, const gfx::IntSize& aSize,
|
|
const SVGImageContext& aSVGContext,
|
|
const Maybe<ImageIntRegion>& aRegion, uint32_t aFlags,
|
|
WebRenderImageProvider** aProvider) override;
|
|
NS_IMETHOD_(ImgDrawResult)
|
|
Draw(gfxContext* aContext, const nsIntSize& aSize, const ImageRegion& aRegion,
|
|
uint32_t aWhichFrame, gfx::SamplingFilter aSamplingFilter,
|
|
const SVGImageContext& aSVGContext, uint32_t aFlags,
|
|
float aOpacity) override;
|
|
NS_IMETHOD RequestDiscard() override;
|
|
NS_IMETHOD_(Orientation) GetOrientation() override;
|
|
NS_IMETHOD_(nsIntRect)
|
|
GetImageSpaceInvalidationRect(const nsIntRect& aRect) override;
|
|
nsIntSize OptimalImageSizeForDest(const gfxSize& aDest, uint32_t aWhichFrame,
|
|
gfx::SamplingFilter aSamplingFilter,
|
|
uint32_t aFlags) override;
|
|
|
|
protected:
|
|
ClippedImage(Image* aImage, nsIntRect aClip,
|
|
const Maybe<nsSize>& aSVGViewportSize);
|
|
|
|
virtual ~ClippedImage();
|
|
|
|
private:
|
|
std::pair<ImgDrawResult, RefPtr<SourceSurface>> GetFrameInternal(
|
|
const nsIntSize& aSize, const SVGImageContext& aSVGContext,
|
|
const Maybe<ImageIntRegion>& aRegion, uint32_t aWhichFrame,
|
|
uint32_t aFlags, float aOpacity);
|
|
bool ShouldClip();
|
|
ImgDrawResult DrawSingleTile(gfxContext* aContext, const nsIntSize& aSize,
|
|
const ImageRegion& aRegion, uint32_t aWhichFrame,
|
|
gfx::SamplingFilter aSamplingFilter,
|
|
const SVGImageContext& aSVGContext,
|
|
uint32_t aFlags, float aOpacity);
|
|
|
|
// If we are forced to draw a temporary surface, we cache it here.
|
|
UniquePtr<ClippedImageCachedSurface> mCachedSurface;
|
|
|
|
nsIntRect mClip; // The region to clip to.
|
|
Maybe<bool> mShouldClip; // Memoized ShouldClip() if present.
|
|
Maybe<nsIntSize> mSVGViewportSize; // If we're clipping a VectorImage, this
|
|
// is the size of viewport of that image.
|
|
friend class DrawSingleTileCallback;
|
|
friend class ImageOps;
|
|
};
|
|
|
|
} // namespace image
|
|
} // namespace mozilla
|
|
|
|
#endif // mozilla_image_ClippedImage_h
|