urho3d/Extras/LuaScript/pkgs/Resource/Image.pkg

$#include "Image.h"

/// Supported compressed image formats.
enum CompressedFormat
{
    CF_NONE = 0,
    CF_DXT1,
    CF_DXT3,
    CF_DXT5,
    CF_ETC1,
    CF_PVRTC_RGB_2BPP,
    CF_PVRTC_RGBA_2BPP,
    CF_PVRTC_RGB_4BPP,
    CF_PVRTC_RGBA_4BPP,
};

/// %Image resource.
class Image : public Resource
{
public:
    /// Flip image vertically.
    void FlipVertical();
    /// Save in BMP format. Return true if successful.
    bool SaveBMP(const char* fileName);
    /// Save in PNG format. Return true if successful.
    bool SavePNG(const char* fileName);
    /// Save in TGA format. Return true if successful.
    bool SaveTGA(const char* fileName);
    /// Save in JPG format with compression quality. Return true if successful.
    bool SaveJPG(const char* fileName, int quality);
    
    /// Return width.
    int GetWidth() const { return width_; }
    /// Return height.
    int GetHeight() const { return height_; }
    /// Return number of color components.
    unsigned GetComponents() const { return components_; }
    /// Return whether is compressed.
    bool IsCompressed() const { return compressedFormat_ != CF_NONE; }
    /// Return compressed format.
    CompressedFormat GetCompressedFormat() const { return compressedFormat_; }
    /// Return number of compressed mip levels.
    unsigned GetNumCompressedLevels() const { return numCompressedLevels_; }
};