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 
28 namespace Common {
29 class SeekableReadStream;
30 }
31 
32 namespace Graphics {
33 struct Surface;
34 }
35 
36 namespace Image {
37 
52 class ImageDecoder {
53 public:
54  virtual ~ImageDecoder() {}
55 
69  virtual bool loadStream(Common::SeekableReadStream &stream) = 0;
70 
77  virtual void destroy() = 0;
78 
88  virtual const Graphics::Surface *getSurface() const = 0;
89 
102  virtual const byte *getPalette() const { return 0; }
103 
107  virtual bool hasPalette() const { return getPaletteColorCount() != 0; }
108 
110  virtual uint16 getPaletteColorCount() const { return 0; }
111 
113  virtual bool hasTransparentColor() const { return false; }
115  virtual uint32 getTransparentColor() const { return 0; }
116 };
118 } // End of namespace Image
119 
120 #endif
Definition: image_decoder.h:52
Definition: surface.h:67
virtual const byte * getPalette() const
Definition: image_decoder.h:102
Definition: stream.h:745
virtual bool hasPalette() const
Definition: image_decoder.h:107
virtual bool hasTransparentColor() const
Definition: image_decoder.h:113
Definition: algorithm.h:29
Definition: formatinfo.h:28
virtual uint32 getTransparentColor() const
Definition: image_decoder.h:115
virtual uint16 getPaletteColorCount() const
Definition: image_decoder.h:110
Definition: movie_decoder.h:32