ScummVM API documentation
image_decoder.h
1/* ScummVM - Graphic Adventure Engine
2 *
3 * ScummVM is the legal property of its developers, whose names
4 * are too numerous to list here. Please refer to the COPYRIGHT
5 * file distributed with this source distribution.
6 *
7 * This program is free software: you can redistribute it and/or modify
8 * it under the terms of the GNU General Public License as published by
9 * the Free Software Foundation, either version 3 of the License, or
10 * (at your option) any later version.
11 *
12 * This program 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
15 * GNU General Public License for more details.
16 *
17 * You should have received a copy of the GNU General Public License
18 * along with this program. If not, see <http://www.gnu.org/licenses/>.
19 *
20 */
21
22#ifndef IMAGE_IMAGEDECODER_H
23#define IMAGE_IMAGEDECODER_H
24
25#include "common/scummsys.h"
26#include "common/str.h"
27#include "graphics/palette.h"
28
29namespace Common {
30class SeekableReadStream;
31}
32
33namespace Graphics {
34struct Surface;
35}
36
37namespace Image {
38
54public:
55 virtual ~ImageDecoder() {}
56
70 virtual bool loadStream(Common::SeekableReadStream &stream) = 0;
71
78 virtual void destroy() = 0;
79
89 virtual const Graphics::Surface *getSurface() const = 0;
90
100 virtual const Graphics::Palette &getPalette() const = 0;
101
105 virtual bool hasPalette() const { return !getPalette().empty(); }
106
108 virtual bool hasTransparentColor() const { return false; }
110 virtual uint32 getTransparentColor() const { return 0; }
111
115 virtual const Graphics::Surface *getMask() const { return 0; }
116
120 virtual bool hasMask() const { return getMask() != 0; }
121};
123} // End of namespace Image
124
125#endif
Definition: stream.h:745
Simple class for handling a palette data.
Definition: palette.h:61
bool empty() const
Definition: palette.h:121
Definition: image_decoder.h:53
virtual uint32 getTransparentColor() const
Definition: image_decoder.h:110
virtual bool hasPalette() const
Definition: image_decoder.h:105
virtual void destroy()=0
virtual bool hasMask() const
Definition: image_decoder.h:120
virtual const Graphics::Palette & getPalette() const =0
virtual bool hasTransparentColor() const
Definition: image_decoder.h:108
virtual const Graphics::Surface * getMask() const
Definition: image_decoder.h:115
virtual bool loadStream(Common::SeekableReadStream &stream)=0
virtual const Graphics::Surface * getSurface() const =0
Definition: algorithm.h:29
Definition: formatinfo.h:28
Definition: surface.h:67