image_decoder.h

/* ScummVM - Graphic Adventure Engine
 *
 * ScummVM is the legal property of its developers, whose names
 * are too numerous to list here. Please refer to the COPYRIGHT
 * file distributed with this source distribution.
 *
 * This program is free software: you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program.  If not, see <http://www.gnu.org/licenses/>.
 *
 */

#ifndef IMAGE_IMAGEDECODER_H
#define IMAGE_IMAGEDECODER_H

#include "common/scummsys.h"
#include "common/str.h"
#include "graphics/palette.h"

namespace Common {
class SeekableReadStream;
}

namespace Graphics {
struct Surface;
}

namespace Image {

class ImageDecoder {
public:
    virtual ~ImageDecoder() {}

    virtual bool loadStream(Common::SeekableReadStream &stream) = 0;

    virtual void destroy() = 0;

    virtual const Graphics::Surface *getSurface() const = 0;

    virtual const Graphics::Palette &getPalette() const = 0;

    virtual bool hasPalette() const { return !getPalette().empty(); }

    virtual bool hasTransparentColor() const { return false; }
    virtual uint32 getTransparentColor() const { return 0; }

    virtual const Graphics::Surface *getMask() const { return 0; }

    virtual bool hasMask() const { return getMask() != 0; }
};
} // End of namespace Image

#endif