//--STRIP #ifndef IMAGE_H #define IMAGE_H //--STRIP /*************************************************************************/ /* image.h */ /* From https://github.com/Relintai/pandemonium_engine (MIT) */ /*************************************************************************/ //--STRIP #include "sfw.h" //--STRIP class Image : public Reference { SFW_OBJECT(Image, Reference); public: enum { MAX_WIDTH = 16384, // force a limit somehow MAX_HEIGHT = 16384 // force a limit somehow }; enum Format { FORMAT_L8, //luminance FORMAT_LA8, //luminance-alpha FORMAT_R8, FORMAT_RG8, FORMAT_RGB8, FORMAT_RGBA8, FORMAT_RGBA4444, FORMAT_RGBA5551, FORMAT_RF, //float FORMAT_RGF, FORMAT_RGBF, FORMAT_RGBAF, FORMAT_MAX }; static const char *format_names[FORMAT_MAX]; enum Interpolation { INTERPOLATE_NEAREST, INTERPOLATE_BILINEAR, INTERPOLATE_CUBIC, INTERPOLATE_TRILINEAR, INTERPOLATE_LANCZOS, /* INTERPOLATE_TRICUBIC, */ /* INTERPOLATE GAUSS */ }; bool write_lock; private: void _create_empty(int p_width, int p_height, bool p_use_mipmaps, Format p_format) { create(p_width, p_height, p_use_mipmaps, p_format); } void _create_from_data(int p_width, int p_height, bool p_use_mipmaps, Format p_format, const Vector &p_data) { create(p_width, p_height, p_use_mipmaps, p_format, p_data); } Format format; Vector data; int width, height; bool mipmaps; void _copy_internals_from(const Image &p_image) { format = p_image.format; width = p_image.width; height = p_image.height; mipmaps = p_image.mipmaps; data = p_image.data; } _FORCE_INLINE_ void _get_mipmap_offset_and_size(int p_mipmap, int &r_offset, int &r_width, int &r_height) const; //get where the mipmap begins in data static int _get_dst_image_size(int p_width, int p_height, Format p_format, int &r_mipmaps, int p_mipmaps = -1); bool _can_modify(Format p_format) const; _FORCE_INLINE_ void _put_pixelb(int p_x, int p_y, uint32_t p_pixel_size, uint8_t *p_data, const uint8_t *p_pixel); _FORCE_INLINE_ void _get_pixelb(int p_x, int p_y, uint32_t p_pixel_size, const uint8_t *p_data, uint8_t *p_pixel); _FORCE_INLINE_ void _repeat_pixel_over_subsequent_memory(uint8_t *p_pixel, int p_pixel_size, int p_count); static void average_4_uint8(uint8_t &p_out, const uint8_t &p_a, const uint8_t &p_b, const uint8_t &p_c, const uint8_t &p_d); static void average_4_float(float &p_out, const float &p_a, const float &p_b, const float &p_c, const float &p_d); static void average_4_half(uint16_t &p_out, const uint16_t &p_a, const uint16_t &p_b, const uint16_t &p_c, const uint16_t &p_d); static void average_4_rgbe9995(uint32_t &p_out, const uint32_t &p_a, const uint32_t &p_b, const uint32_t &p_c, const uint32_t &p_d); static void renormalize_uint8(uint8_t *p_rgb); static void renormalize_float(float *p_rgb); static void renormalize_half(uint16_t *p_rgb); static void renormalize_rgbe9995(uint32_t *p_rgb); public: int get_width() const; ///< Get image width int get_height() const; ///< Get image height Vector2 get_size() const; bool has_mipmaps() const; int get_mipmap_count() const; /** * Convert the image to another format, conversion only to raw byte format */ void convert(Format p_new_format); /** * Get the current image format. */ Format get_format() const; int get_mipmap_offset(int p_mipmap) const; //get where the mipmap begins in data void get_mipmap_offset_and_size(int p_mipmap, int &r_ofs, int &r_size) const; //get where the mipmap begins in data void get_mipmap_offset_size_and_dimensions(int p_mipmap, int &r_ofs, int &r_size, int &w, int &h) const; //get where the mipmap begins in data /** * Resize the image, using the preferred interpolation method. */ void resize_to_po2(bool p_square = false, Interpolation p_interpolation = INTERPOLATE_BILINEAR); void resize(int p_width, int p_height, Interpolation p_interpolation = INTERPOLATE_BILINEAR); void shrink_x2(); bool is_size_po2() const; /** * Crop the image to a specific size, if larger, then the image is filled by black */ void crop_from_point(int p_x, int p_y, int p_width, int p_height); void crop(int p_width, int p_height); void flip_x(); void flip_y(); /** * Generate a mipmap to an image (creates an image 1/4 the size, with averaging of 4->1) */ int generate_mipmaps(bool p_renormalize = false); void clear_mipmaps(); void normalize(); //for normal maps void clear(); /** * Create a new image of a given size and format. Current image will be lost */ void load_from_file(const String &file_name, Format p_format = FORMAT_RGBA8); void create(int p_width, int p_height, bool p_use_mipmaps, Format p_format); void create(int p_width, int p_height, bool p_use_mipmaps, Format p_format, const Vector &p_data); void create(const char **p_xpm); void create(int p_width, int p_height, bool p_use_mipmaps, Format p_format, const PoolVector &p_data) { int size = p_data.size(); Vector data; data.resize(size); uint8_t *wptr = data.ptrw(); PoolVector::Read r = p_data.read(); const uint8_t *rptr = r.ptr(); for (int i = 0; i < size; ++i) { wptr[i] = rptr[i]; } create(p_width, p_height, p_use_mipmaps, p_format, data); } //Save Error save_png(const String &file_name); Error save_bmp(const String &file_name); Error save_tga(const String &file_name); Error save_jpg(const String &file_name, const int quality); Error save_hdr(const String &file_name); /** * returns true when the image is empty (0,0) in size */ bool empty() const; Vector get_data() const; const uint8_t *datar() const; uint8_t *dataw(); int get_data_size() const; Image(); Image(int p_width, int p_height, bool p_use_mipmaps, Format p_format); Image(int p_width, int p_height, bool p_mipmaps, Format p_format, const Vector &p_data); enum AlphaMode { ALPHA_NONE, ALPHA_BIT, ALPHA_BLEND }; AlphaMode detect_alpha() const; bool is_invisible() const; static int get_format_pixel_size(Format p_format); static int get_format_pixel_rshift(Format p_format); static int get_format_block_size(Format p_format); static void get_format_min_pixel_size(Format p_format, int &r_w, int &r_h); static int get_image_data_size(int p_width, int p_height, Format p_format, bool p_mipmaps = false); static int get_image_required_mipmaps(int p_width, int p_height, Format p_format); static int get_image_mipmap_offset(int p_width, int p_height, Format p_format, int p_mipmap); enum CompressMode { COMPRESS_S3TC, COMPRESS_PVRTC2, COMPRESS_PVRTC4, COMPRESS_ETC, COMPRESS_ETC2, COMPRESS_BPTC, COMPRESS_MAX, }; bool is_compressed() const; void fix_alpha_edges(); void premultiply_alpha(); void srgb_to_linear(); void normalmap_to_xy(); Ref rgbe_to_srgb(); void bumpmap_to_normalmap(float bump_scale = 1.0); void blit_rect(const Ref &p_src, const Rect2 &p_src_rect, const Vector2 &p_dest); void blit_rect_mask(const Ref &p_src, const Ref &p_mask, const Rect2 &p_src_rect, const Vector2 &p_dest); void blend_rect(const Ref &p_src, const Rect2 &p_src_rect, const Vector2 &p_dest); void blend_rect_mask(const Ref &p_src, const Ref &p_mask, const Rect2 &p_src_rect, const Vector2 &p_dest); void fill(const Color &p_color); void fill_rect(const Rect2 &p_rect, const Color &p_color); Rect2 get_used_rect() const; Ref get_rect(const Rect2 &p_area) const; static String get_format_name(Format p_format); Image(const char **p_xpm); Ref duplicate() const; void lock(); void unlock(); //this is used for compression enum DetectChannels { DETECTED_L, DETECTED_LA, DETECTED_R, DETECTED_RG, DETECTED_RGB, DETECTED_RGBA, }; DetectChannels get_detected_channels(); void optimize_channels(); Color get_pixelv(const Vector2 &p_src) const; Color get_pixel(int p_x, int p_y) const; void set_pixelv(const Vector2 &p_dst, const Color &p_color); void set_pixel(int p_x, int p_y, const Color &p_color); void copy_internals_from(const Ref &p_image) { ERR_FAIL_COND(p_image.is_null()); format = p_image->format; width = p_image->width; height = p_image->height; mipmaps = p_image->mipmaps; data = p_image->data; } ~Image(); }; //--STRIP #endif //--STRIP