/*************************************************************************/ /* texture.h */ /*************************************************************************/ /* This file is part of: */ /* GODOT ENGINE */ /* https://godotengine.org */ /*************************************************************************/ /* Copyright (c) 2007-2019 Juan Linietsky, Ariel Manzur. */ /* Copyright (c) 2014-2019 Godot Engine contributors (cf. AUTHORS.md) */ /* */ /* Permission is hereby granted, free of charge, to any person obtaining */ /* a copy of this software and associated documentation files (the */ /* "Software"), to deal in the Software without restriction, including */ /* without limitation the rights to use, copy, modify, merge, publish, */ /* distribute, sublicense, and/or sell copies of the Software, and to */ /* permit persons to whom the Software is furnished to do so, subject to */ /* the following conditions: */ /* */ /* The above copyright notice and this permission notice shall be */ /* included in all copies or substantial portions of the Software. */ /* */ /* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, */ /* EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF */ /* MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.*/ /* IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY */ /* CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, */ /* TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE */ /* SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. */ /*************************************************************************/ #ifndef TEXTURE_H #define TEXTURE_H #include "core/io/resource_loader.h" #include "core/math/rect2.h" #include "core/os/mutex.h" #include "core/os/rw_lock.h" #include "core/os/thread_safe.h" #include "core/resource.h" #include "scene/resources/color_ramp.h" #include "scene/resources/curve.h" #include "servers/visual_server.h" /** @author Juan Linietsky <reduzio@gmail.com> */ class Texture : public Resource { GDCLASS(Texture, Resource); OBJ_SAVE_TYPE(Texture); //children are all saved as Texture, so they can be exchanged protected: static void _bind_methods(); public: enum Flags { FLAG_MIPMAPS = VisualServer::TEXTURE_FLAG_MIPMAPS, FLAG_REPEAT = VisualServer::TEXTURE_FLAG_REPEAT, FLAG_FILTER = VisualServer::TEXTURE_FLAG_FILTER, FLAG_ANISOTROPIC_FILTER = VisualServer::TEXTURE_FLAG_ANISOTROPIC_FILTER, FLAG_CONVERT_TO_LINEAR = VisualServer::TEXTURE_FLAG_CONVERT_TO_LINEAR, FLAG_VIDEO_SURFACE = VisualServer::TEXTURE_FLAG_USED_FOR_STREAMING, FLAGS_DEFAULT = FLAG_MIPMAPS | FLAG_REPEAT | FLAG_FILTER, FLAG_MIRRORED_REPEAT = VisualServer::TEXTURE_FLAG_MIRRORED_REPEAT }; virtual int get_width() const = 0; virtual int get_height() const = 0; virtual Size2 get_size() const; virtual RID get_rid() const = 0; virtual bool is_pixel_opaque(int p_x, int p_y) const; virtual bool has_alpha() const = 0; virtual void set_flags(uint32_t p_flags) = 0; virtual uint32_t get_flags() const = 0; virtual void draw(RID p_canvas_item, const Point2 &p_pos, const Color &p_modulate = Color(1, 1, 1), bool p_transpose = false, const Ref<Texture> &p_normal_map = Ref<Texture>()) const; virtual void draw_rect(RID p_canvas_item, const Rect2 &p_rect, bool p_tile = false, const Color &p_modulate = Color(1, 1, 1), bool p_transpose = false, const Ref<Texture> &p_normal_map = Ref<Texture>()) const; virtual void draw_rect_region(RID p_canvas_item, const Rect2 &p_rect, const Rect2 &p_src_rect, const Color &p_modulate = Color(1, 1, 1), bool p_transpose = false, const Ref<Texture> &p_normal_map = Ref<Texture>(), bool p_clip_uv = true) const; virtual bool get_rect_region(const Rect2 &p_rect, const Rect2 &p_src_rect, Rect2 &r_rect, Rect2 &r_src_rect) const; virtual Ref<Image> get_data() const { return Ref<Image>(); } Texture(); }; VARIANT_ENUM_CAST(Texture::Flags); class BitMap; class ImageTexture : public Texture { GDCLASS(ImageTexture, Texture); RES_BASE_EXTENSION("tex"); public: enum Storage { STORAGE_RAW, STORAGE_COMPRESS_LOSSY, STORAGE_COMPRESS_LOSSLESS }; private: RID texture; Image::Format format; uint32_t flags; int w, h; Storage storage; Size2 size_override; float lossy_storage_quality; mutable Ref<BitMap> alpha_cache; protected: virtual void reload_from_file(); bool _set(const StringName &p_name, const Variant &p_value); bool _get(const StringName &p_name, Variant &r_ret) const; void _get_property_list(List<PropertyInfo> *p_list) const; void _reload_hook(const RID &p_hook); virtual void _resource_path_changed(); static void _bind_methods(); void _set_data(Dictionary p_data); public: void create(int p_width, int p_height, Image::Format p_format, uint32_t p_flags = FLAGS_DEFAULT); void create_from_image(const Ref<Image> &p_image, uint32_t p_flags = FLAGS_DEFAULT); void set_flags(uint32_t p_flags); uint32_t get_flags() const; Image::Format get_format() const; #ifndef DISABLE_DEPRECATED Error load(const String &p_path); #endif void set_data(const Ref<Image> &p_image); Ref<Image> get_data() const; int get_width() const; int get_height() const; virtual RID get_rid() const; bool has_alpha() const; virtual void draw(RID p_canvas_item, const Point2 &p_pos, const Color &p_modulate = Color(1, 1, 1), bool p_transpose = false, const Ref<Texture> &p_normal_map = Ref<Texture>()) const; virtual void draw_rect(RID p_canvas_item, const Rect2 &p_rect, bool p_tile = false, const Color &p_modulate = Color(1, 1, 1), bool p_transpose = false, const Ref<Texture> &p_normal_map = Ref<Texture>()) const; virtual void draw_rect_region(RID p_canvas_item, const Rect2 &p_rect, const Rect2 &p_src_rect, const Color &p_modulate = Color(1, 1, 1), bool p_transpose = false, const Ref<Texture> &p_normal_map = Ref<Texture>(), bool p_clip_uv = true) const; void set_storage(Storage p_storage); Storage get_storage() const; bool is_pixel_opaque(int p_x, int p_y) const; void set_lossy_storage_quality(float p_lossy_storage_quality); float get_lossy_storage_quality() const; void set_size_override(const Size2 &p_size); virtual void set_path(const String &p_path, bool p_take_over = false); ImageTexture(); ~ImageTexture(); }; class StreamTexture : public Texture { GDCLASS(StreamTexture, Texture); public: enum DataFormat { DATA_FORMAT_IMAGE, DATA_FORMAT_LOSSLESS, DATA_FORMAT_LOSSY }; enum FormatBits { FORMAT_MASK_IMAGE_FORMAT = (1 << 20) - 1, FORMAT_BIT_LOSSLESS = 1 << 20, FORMAT_BIT_LOSSY = 1 << 21, FORMAT_BIT_STREAM = 1 << 22, FORMAT_BIT_HAS_MIPMAPS = 1 << 23, FORMAT_BIT_DETECT_3D = 1 << 24, FORMAT_BIT_DETECT_SRGB = 1 << 25, FORMAT_BIT_DETECT_NORMAL = 1 << 26, }; private: Error _load_data(const String &p_path, int &tw, int &th, int &flags, Ref<Image> &image, int p_size_limit = 0); String path_to_file; RID texture; Image::Format format; uint32_t flags; int w, h; mutable Ref<BitMap> alpha_cache; virtual void reload_from_file(); static void _requested_3d(void *p_ud); static void _requested_srgb(void *p_ud); static void _requested_normal(void *p_ud); protected: static void _bind_methods(); public: typedef void (*TextureFormatRequestCallback)(const Ref<StreamTexture> &); static TextureFormatRequestCallback request_3d_callback; static TextureFormatRequestCallback request_srgb_callback; static TextureFormatRequestCallback request_normal_callback; uint32_t get_flags() const; Image::Format get_format() const; Error load(const String &p_path); String get_load_path() const; int get_width() const; int get_height() const; virtual RID get_rid() const; virtual void set_path(const String &p_path, bool p_take_over); virtual void draw(RID p_canvas_item, const Point2 &p_pos, const Color &p_modulate = Color(1, 1, 1), bool p_transpose = false, const Ref<Texture> &p_normal_map = Ref<Texture>()) const; virtual void draw_rect(RID p_canvas_item, const Rect2 &p_rect, bool p_tile = false, const Color &p_modulate = Color(1, 1, 1), bool p_transpose = false, const Ref<Texture> &p_normal_map = Ref<Texture>()) const; virtual void draw_rect_region(RID p_canvas_item, const Rect2 &p_rect, const Rect2 &p_src_rect, const Color &p_modulate = Color(1, 1, 1), bool p_transpose = false, const Ref<Texture> &p_normal_map = Ref<Texture>(), bool p_clip_uv = true) const; virtual bool has_alpha() const; virtual void set_flags(uint32_t p_flags); bool is_pixel_opaque(int p_x, int p_y) const; virtual Ref<Image> get_data() const; StreamTexture(); ~StreamTexture(); }; class ResourceFormatLoaderStreamTexture : public ResourceFormatLoader { GDCLASS(ResourceFormatLoaderStreamTexture, ResourceFormatLoader) public: virtual RES load(const String &p_path, const String &p_original_path = "", Error *r_error = NULL); virtual void get_recognized_extensions(List<String> *p_extensions) const; virtual bool handles_type(const String &p_type) const; virtual String get_resource_type(const String &p_path) const; }; VARIANT_ENUM_CAST(ImageTexture::Storage); class AtlasTexture : public Texture { GDCLASS(AtlasTexture, Texture); RES_BASE_EXTENSION("atlastex"); protected: Ref<Texture> atlas; Rect2 region; Rect2 margin; bool filter_clip; static void _bind_methods(); public: virtual int get_width() const; virtual int get_height() const; virtual RID get_rid() const; virtual bool has_alpha() const; virtual void set_flags(uint32_t p_flags); virtual uint32_t get_flags() const; void set_atlas(const Ref<Texture> &p_atlas); Ref<Texture> get_atlas() const; void set_region(const Rect2 &p_region); Rect2 get_region() const; void set_margin(const Rect2 &p_margin); Rect2 get_margin() const; void set_filter_clip(const bool p_enable); bool has_filter_clip() const; virtual void draw(RID p_canvas_item, const Point2 &p_pos, const Color &p_modulate = Color(1, 1, 1), bool p_transpose = false, const Ref<Texture> &p_normal_map = Ref<Texture>()) const; virtual void draw_rect(RID p_canvas_item, const Rect2 &p_rect, bool p_tile = false, const Color &p_modulate = Color(1, 1, 1), bool p_transpose = false, const Ref<Texture> &p_normal_map = Ref<Texture>()) const; virtual void draw_rect_region(RID p_canvas_item, const Rect2 &p_rect, const Rect2 &p_src_rect, const Color &p_modulate = Color(1, 1, 1), bool p_transpose = false, const Ref<Texture> &p_normal_map = Ref<Texture>(), bool p_clip_uv = true) const; virtual bool get_rect_region(const Rect2 &p_rect, const Rect2 &p_src_rect, Rect2 &r_rect, Rect2 &r_src_rect) const; bool is_pixel_opaque(int p_x, int p_y) const; AtlasTexture(); }; class LargeTexture : public Texture { GDCLASS(LargeTexture, Texture); RES_BASE_EXTENSION("largetex"); protected: struct Piece { Point2 offset; Ref<Texture> texture; }; Vector<Piece> pieces; Size2i size; Array _get_data() const; void _set_data(const Array &p_array); static void _bind_methods(); public: virtual int get_width() const; virtual int get_height() const; virtual RID get_rid() const; virtual bool has_alpha() const; virtual void set_flags(uint32_t p_flags); virtual uint32_t get_flags() const; int add_piece(const Point2 &p_offset, const Ref<Texture> &p_texture); void set_piece_offset(int p_idx, const Point2 &p_offset); void set_piece_texture(int p_idx, const Ref<Texture> &p_texture); void set_size(const Size2 &p_size); void clear(); int get_piece_count() const; Vector2 get_piece_offset(int p_idx) const; Ref<Texture> get_piece_texture(int p_idx) const; Ref<Image> to_image() const; virtual void draw(RID p_canvas_item, const Point2 &p_pos, const Color &p_modulate = Color(1, 1, 1), bool p_transpose = false, const Ref<Texture> &p_normal_map = Ref<Texture>()) const; virtual void draw_rect(RID p_canvas_item, const Rect2 &p_rect, bool p_tile = false, const Color &p_modulate = Color(1, 1, 1), bool p_transpose = false, const Ref<Texture> &p_normal_map = Ref<Texture>()) const; virtual void draw_rect_region(RID p_canvas_item, const Rect2 &p_rect, const Rect2 &p_src_rect, const Color &p_modulate = Color(1, 1, 1), bool p_transpose = false, const Ref<Texture> &p_normal_map = Ref<Texture>(), bool p_clip_uv = true) const; bool is_pixel_opaque(int p_x, int p_y) const; LargeTexture(); }; class CubeMap : public Resource { GDCLASS(CubeMap, Resource); RES_BASE_EXTENSION("cubemap"); public: enum Storage { STORAGE_RAW, STORAGE_COMPRESS_LOSSY, STORAGE_COMPRESS_LOSSLESS }; enum Side { SIDE_LEFT, SIDE_RIGHT, SIDE_BOTTOM, SIDE_TOP, SIDE_FRONT, SIDE_BACK }; enum Flags { FLAG_MIPMAPS = VisualServer::TEXTURE_FLAG_MIPMAPS, FLAG_REPEAT = VisualServer::TEXTURE_FLAG_REPEAT, FLAG_FILTER = VisualServer::TEXTURE_FLAG_FILTER, FLAGS_DEFAULT = FLAG_MIPMAPS | FLAG_REPEAT | FLAG_FILTER, }; private: bool valid[6]; RID cubemap; Image::Format format; uint32_t flags; int w, h; Storage storage; Size2 size_override; float lossy_storage_quality; _FORCE_INLINE_ bool _is_valid() const { for (int i = 0; i < 6; i++) { if (valid[i]) return true; } return false; } protected: bool _set(const StringName &p_name, const Variant &p_value); bool _get(const StringName &p_name, Variant &r_ret) const; void _get_property_list(List<PropertyInfo> *p_list) const; static void _bind_methods(); public: void set_flags(uint32_t p_flags); uint32_t get_flags() const; void set_side(Side p_side, const Ref<Image> &p_image); Ref<Image> get_side(Side p_side) const; Image::Format get_format() const; int get_width() const; int get_height() const; virtual RID get_rid() const; void set_storage(Storage p_storage); Storage get_storage() const; void set_lossy_storage_quality(float p_lossy_storage_quality); float get_lossy_storage_quality() const; virtual void set_path(const String &p_path, bool p_take_over = false); CubeMap(); ~CubeMap(); }; VARIANT_ENUM_CAST(CubeMap::Flags) VARIANT_ENUM_CAST(CubeMap::Side) VARIANT_ENUM_CAST(CubeMap::Storage) class TextureLayered : public Resource { GDCLASS(TextureLayered, Resource) public: enum Flags { FLAG_MIPMAPS = VisualServer::TEXTURE_FLAG_MIPMAPS, FLAG_REPEAT = VisualServer::TEXTURE_FLAG_REPEAT, FLAG_FILTER = VisualServer::TEXTURE_FLAG_FILTER, FLAG_CONVERT_TO_LINEAR = VisualServer::TEXTURE_FLAG_CONVERT_TO_LINEAR, FLAGS_DEFAULT = FLAG_FILTER, }; private: bool is_3d; RID texture; Image::Format format; uint32_t flags; int width; int height; int depth; void _set_data(const Dictionary &p_data); Dictionary _get_data() const; protected: static void _bind_methods(); public: void set_flags(uint32_t p_flags); uint32_t get_flags() const; Image::Format get_format() const; uint32_t get_width() const; uint32_t get_height() const; uint32_t get_depth() const; void create(uint32_t p_width, uint32_t p_height, uint32_t p_depth, Image::Format p_format, uint32_t p_flags = FLAGS_DEFAULT); void set_layer_data(const Ref<Image> &p_image, int p_layer); Ref<Image> get_layer_data(int p_layer) const; void set_data_partial(const Ref<Image> &p_image, int p_x_ofs, int p_y_ofs, int p_z, int p_mipmap = 0); virtual RID get_rid() const; virtual void set_path(const String &p_path, bool p_take_over = false); TextureLayered(bool p_3d = false); ~TextureLayered(); }; VARIANT_ENUM_CAST(TextureLayered::Flags) class Texture3D : public TextureLayered { GDCLASS(Texture3D, TextureLayered) public: Texture3D() : TextureLayered(true) {} }; class TextureArray : public TextureLayered { GDCLASS(TextureArray, TextureLayered) public: TextureArray() : TextureLayered(false) {} }; class ResourceFormatLoaderTextureLayered : public ResourceFormatLoader { GDCLASS(ResourceFormatLoaderTextureLayered, ResourceFormatLoader) public: enum Compression { COMPRESSION_LOSSLESS, COMPRESSION_VRAM, COMPRESSION_UNCOMPRESSED }; virtual RES load(const String &p_path, const String &p_original_path = "", Error *r_error = NULL); virtual void get_recognized_extensions(List<String> *p_extensions) const; virtual bool handles_type(const String &p_type) const; virtual String get_resource_type(const String &p_path) const; }; class CurveTexture : public Texture { GDCLASS(CurveTexture, Texture) RES_BASE_EXTENSION("curvetex") private: RID _texture; Ref<Curve> _curve; int _width; void _update(); protected: static void _bind_methods(); public: void set_width(int p_width); int get_width() const; void ensure_default_setup(float p_min = 0, float p_max = 1); void set_curve(Ref<Curve> p_curve); Ref<Curve> get_curve() const; virtual RID get_rid() const; virtual int get_height() const { return 1; } virtual bool has_alpha() const { return false; } virtual void set_flags(uint32_t p_flags) {} virtual uint32_t get_flags() const { return FLAG_FILTER; } CurveTexture(); ~CurveTexture(); }; /* enum CubeMapSide { CUBEMAP_LEFT, CUBEMAP_RIGHT, CUBEMAP_BOTTOM, CUBEMAP_TOP, CUBEMAP_FRONT, CUBEMAP_BACK, }; */ //VARIANT_ENUM_CAST( Texture::CubeMapSide ); class GradientTexture : public Texture { GDCLASS(GradientTexture, Texture) public: struct Point { float offset; Color color; bool operator<(const Point &p_ponit) const { return offset < p_ponit.offset; } }; private: Ref<Gradient> gradient; bool update_pending; RID texture; int width; void _queue_update(); void _update(); protected: static void _bind_methods(); public: void set_gradient(Ref<Gradient> p_gradient); Ref<Gradient> get_gradient() const; void set_width(int p_width); int get_width() const; virtual RID get_rid() const { return texture; } virtual int get_height() const { return 1; } virtual bool has_alpha() const { return true; } virtual void set_flags(uint32_t p_flags) {} virtual uint32_t get_flags() const { return FLAG_FILTER; } virtual Ref<Image> get_data() const; GradientTexture(); virtual ~GradientTexture(); }; class ProxyTexture : public Texture { GDCLASS(ProxyTexture, Texture) private: RID proxy; Ref<Texture> base; protected: static void _bind_methods(); public: void set_base(const Ref<Texture> &p_texture); Ref<Texture> get_base() const; virtual int get_width() const; virtual int get_height() const; virtual RID get_rid() const; virtual bool has_alpha() const; virtual void set_flags(uint32_t p_flags); virtual uint32_t get_flags() const; ProxyTexture(); ~ProxyTexture(); }; class AnimatedTexture : public Texture { GDCLASS(AnimatedTexture, Texture) //use readers writers lock for this, since its far more times read than written to RWLock *rw_lock; private: enum { MAX_FRAMES = 256 }; RID proxy; struct Frame { Ref<Texture> texture; float delay_sec; Frame() { delay_sec = 0; } }; Frame frames[MAX_FRAMES]; int frame_count; int current_frame; float fps; float time; uint64_t prev_ticks; void _update_proxy(); protected: static void _bind_methods(); void _validate_property(PropertyInfo &property) const; public: void set_frames(int p_frames); int get_frames() const; void set_frame_texture(int p_frame, const Ref<Texture> &p_texture); Ref<Texture> get_frame_texture(int p_frame) const; void set_frame_delay(int p_frame, float p_delay_sec); float get_frame_delay(int p_frame) const; void set_fps(float p_fps); float get_fps() const; virtual int get_width() const; virtual int get_height() const; virtual RID get_rid() const; virtual bool has_alpha() const; virtual void set_flags(uint32_t p_flags); virtual uint32_t get_flags() const; virtual Ref<Image> get_data() const; bool is_pixel_opaque(int p_x, int p_y) const; AnimatedTexture(); ~AnimatedTexture(); }; #endif