1/*
2 Copyright (C) 1998 Lars Knoll (knoll@mpi-hd.mpg.de)
3 Copyright (C) 2001 Dirk Mueller <mueller@kde.org>
4 Copyright (C) 2006 Samuel Weinig (sam.weinig@gmail.com)
5 Copyright (C) 2004, 2005, 2006, 2007 Apple Inc. All rights reserved.
6
7 This library is free software; you can redistribute it and/or
8 modify it under the terms of the GNU Library General Public
9 License as published by the Free Software Foundation; either
10 version 2 of the License, or (at your option) any later version.
11
12 This library is distributed in the hope that it will be useful,
13 but WITHOUT ANY WARRANTY; without even the implied warranty of
14 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
15 Library General Public License for more details.
16
17 You should have received a copy of the GNU Library General Public License
18 along with this library; see the file COPYING.LIB. If not, write to
19 the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
20 Boston, MA 02110-1301, USA.
21*/
22
23#pragma once
24
25#include "CachedResourceClient.h"
26#include "ImageTypes.h"
27
28namespace WebCore {
29
30class CachedImage;
31class IntRect;
32
33enum class VisibleInViewportState { Unknown, Yes, No };
34
35class CachedImageClient : public CachedResourceClient {
36public:
37 virtual ~CachedImageClient() = default;
38 static CachedResourceClientType expectedType() { return ImageType; }
39 CachedResourceClientType resourceClientType() const override { return expectedType(); }
40
41 // Called whenever a frame of an image changes because we got more data from the network.
42 // If not null, the IntRect is the changed rect of the image.
43 virtual void imageChanged(CachedImage*, const IntRect* = nullptr) { }
44
45 virtual bool canDestroyDecodedData() { return true; }
46
47 // Called when a new decoded frame for a large image is available or when an animated image is ready to advance to the next frame.
48 virtual VisibleInViewportState imageFrameAvailable(CachedImage& image, ImageAnimatingState, const IntRect* changeRect) { imageChanged(&image, changeRect); return VisibleInViewportState::No; }
49
50 virtual void didRemoveCachedImageClient(CachedImage&) { }
51};
52
53} // namespace WebCore
54