mirror of
https://github.com/vcmi/vcmi.git
synced 2024-12-26 22:57:00 +02:00
107 lines
3.6 KiB
C++
107 lines
3.6 KiB
C++
/*
|
|
* IImage.h, part of VCMI engine
|
|
*
|
|
* Authors: listed in file AUTHORS in main folder
|
|
*
|
|
* License: GNU General Public License v2.0 or later
|
|
* Full text of license available in license.txt file, in main folder
|
|
*
|
|
*/
|
|
#pragma once
|
|
|
|
#include "../../lib/filesystem/ResourcePath.h"
|
|
|
|
VCMI_LIB_NAMESPACE_BEGIN
|
|
|
|
class PlayerColor;
|
|
class Rect;
|
|
class Point;
|
|
class ColorRGBA;
|
|
|
|
VCMI_LIB_NAMESPACE_END
|
|
|
|
struct SDL_Surface;
|
|
struct SDL_Palette;
|
|
class ColorFilter;
|
|
class ISharedImage;
|
|
|
|
/// Defines which blit method will be selected when image is used for rendering
|
|
enum class EImageBlitMode : uint8_t
|
|
{
|
|
/// Preferred for images that don't need any background
|
|
/// Indexed or RGBA: Image can have no transparency and can be only used as background
|
|
OPAQUE,
|
|
|
|
/// Preferred for images that may need transparency
|
|
/// Indexed: Image can have only a single color as transparency and has no semi-transparent areas
|
|
/// RGBA: full alpha transparency range, e.g. shadows
|
|
COLORKEY,
|
|
|
|
/// Should be avoided if possible, use only for images that use def's with semi-transparency
|
|
/// Indexed or RGBA: Image might have full alpha transparency range, e.g. shadows
|
|
ALPHA
|
|
};
|
|
|
|
/// Base class for images for use in client code.
|
|
/// This class represents current state of image, with potential transformations applied, such as player coloring
|
|
class IImage
|
|
{
|
|
public:
|
|
//draws image on surface "where" at position
|
|
virtual void draw(SDL_Surface * where, const Point & pos, const Rect * src = nullptr) const = 0;
|
|
|
|
virtual void scaleTo(const Point & size) = 0;
|
|
virtual void scaleInteger(int factor) = 0;
|
|
|
|
virtual void exportBitmap(const boost::filesystem::path & path) const = 0;
|
|
|
|
//Change palette to specific player
|
|
virtual void playerColored(PlayerColor player) = 0;
|
|
|
|
//test transparency of specific pixel
|
|
virtual bool isTransparent(const Point & coords) const = 0;
|
|
|
|
virtual Point dimensions() const = 0;
|
|
int width() const;
|
|
int height() const;
|
|
|
|
//only indexed bitmaps, 16 colors maximum
|
|
virtual void shiftPalette(uint32_t firstColorID, uint32_t colorsToMove, uint32_t distanceToMove) = 0;
|
|
virtual void adjustPalette(const ColorFilter & shifter, uint32_t colorsToSkipMask) = 0;
|
|
|
|
virtual void setAlpha(uint8_t value) = 0;
|
|
virtual void setBlitMode(EImageBlitMode mode) = 0;
|
|
|
|
//only indexed bitmaps with 7 special colors
|
|
virtual void setOverlayColor(const ColorRGBA & color) = 0;
|
|
|
|
virtual void setShadowEnabled(bool on) = 0;
|
|
virtual void setBodyEnabled(bool on) = 0;
|
|
virtual void setOverlayEnabled(bool on) = 0;
|
|
virtual std::shared_ptr<ISharedImage> getSharedImage() const = 0;
|
|
|
|
virtual ~IImage() = default;
|
|
};
|
|
|
|
/// Base class for image data, mostly for internal use
|
|
/// Represents unmodified pixel data, usually loaded from file
|
|
/// This image can be shared between multiple image handlers (IImage instances)
|
|
class ISharedImage
|
|
{
|
|
public:
|
|
virtual Point dimensions() const = 0;
|
|
virtual void exportBitmap(const boost::filesystem::path & path) const = 0;
|
|
virtual bool isTransparent(const Point & coords) const = 0;
|
|
virtual void draw(SDL_Surface * where, SDL_Palette * palette, const Point & dest, const Rect * src, const ColorRGBA & colorMultiplier, uint8_t alpha, EImageBlitMode mode) const = 0;
|
|
|
|
virtual std::shared_ptr<IImage> createImageReference(EImageBlitMode mode) = 0;
|
|
|
|
virtual std::shared_ptr<ISharedImage> horizontalFlip() const = 0;
|
|
virtual std::shared_ptr<ISharedImage> verticalFlip() const = 0;
|
|
virtual std::shared_ptr<ISharedImage> scaleInteger(int factor, SDL_Palette * palette) const = 0;
|
|
virtual std::shared_ptr<ISharedImage> scaleTo(const Point & size, SDL_Palette * palette) const = 0;
|
|
|
|
|
|
virtual ~ISharedImage() = default;
|
|
};
|