1/**************************************************************************/
2/* atlas_texture.h */
3/**************************************************************************/
4/* This file is part of: */
5/* GODOT ENGINE */
6/* https://godotengine.org */
7/**************************************************************************/
8/* Copyright (c) 2014-present Godot Engine contributors (see AUTHORS.md). */
9/* Copyright (c) 2007-2014 Juan Linietsky, Ariel Manzur. */
10/* */
11/* Permission is hereby granted, free of charge, to any person obtaining */
12/* a copy of this software and associated documentation files (the */
13/* "Software"), to deal in the Software without restriction, including */
14/* without limitation the rights to use, copy, modify, merge, publish, */
15/* distribute, sublicense, and/or sell copies of the Software, and to */
16/* permit persons to whom the Software is furnished to do so, subject to */
17/* the following conditions: */
18/* */
19/* The above copyright notice and this permission notice shall be */
20/* included in all copies or substantial portions of the Software. */
21/* */
22/* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, */
23/* EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF */
24/* MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. */
25/* IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY */
26/* CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, */
27/* TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE */
28/* SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. */
29/**************************************************************************/
30
31#ifndef ATLAS_TEXTURE_H
32#define ATLAS_TEXTURE_H
33
34#include "scene/resources/texture.h"
35
36class AtlasTexture : public Texture2D {
37 GDCLASS(AtlasTexture, Texture2D);
38 RES_BASE_EXTENSION("atlastex");
39
40protected:
41 Ref<Texture2D> atlas;
42 Rect2 region;
43 Rect2 margin;
44 bool filter_clip = false;
45
46 static void _bind_methods();
47
48public:
49 virtual int get_width() const override;
50 virtual int get_height() const override;
51 virtual RID get_rid() const override;
52
53 virtual bool has_alpha() const override;
54
55 void set_atlas(const Ref<Texture2D> &p_atlas);
56 Ref<Texture2D> get_atlas() const;
57
58 void set_region(const Rect2 &p_region);
59 Rect2 get_region() const;
60
61 void set_margin(const Rect2 &p_margin);
62 Rect2 get_margin() const;
63
64 void set_filter_clip(const bool p_enable);
65 bool has_filter_clip() const;
66
67 virtual void draw(RID p_canvas_item, const Point2 &p_pos, const Color &p_modulate = Color(1, 1, 1), bool p_transpose = false) const override;
68 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 override;
69 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, bool p_clip_uv = true) const override;
70 virtual bool get_rect_region(const Rect2 &p_rect, const Rect2 &p_src_rect, Rect2 &r_rect, Rect2 &r_src_rect) const override;
71
72 bool is_pixel_opaque(int p_x, int p_y) const override;
73
74 virtual Ref<Image> get_image() const override;
75
76 AtlasTexture();
77};
78
79#endif // ATLAS_TEXTURE_H
80