Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Rename Image's get_rect to get_region #66017

Merged
merged 1 commit into from
Nov 2, 2022
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 4 additions & 4 deletions core/io/image.cpp
Original file line number Diff line number Diff line change
Expand Up @@ -2636,9 +2636,9 @@ Rect2i Image::get_used_rect() const {
}
}

Ref<Image> Image::get_rect(const Rect2i &p_area) const {
Ref<Image> img = memnew(Image(p_area.size.x, p_area.size.y, mipmaps, format));
img->blit_rect(Ref<Image>((Image *)this), p_area, Point2i(0, 0));
Ref<Image> Image::get_region(const Rect2i &p_region) const {
Ref<Image> img = memnew(Image(p_region.size.x, p_region.size.y, mipmaps, format));
img->blit_rect(Ref<Image>((Image *)this), p_region, Point2i(0, 0));
return img;
}

Expand Down Expand Up @@ -3362,7 +3362,7 @@ void Image::_bind_methods() {
ClassDB::bind_method(D_METHOD("fill_rect", "rect", "color"), &Image::fill_rect);

ClassDB::bind_method(D_METHOD("get_used_rect"), &Image::get_used_rect);
ClassDB::bind_method(D_METHOD("get_rect", "rect"), &Image::get_rect);
ClassDB::bind_method(D_METHOD("get_region", "region"), &Image::get_region);

ClassDB::bind_method(D_METHOD("copy_from", "src"), &Image::copy_internals_from);

Expand Down
2 changes: 1 addition & 1 deletion core/io/image.h
Original file line number Diff line number Diff line change
Expand Up @@ -377,7 +377,7 @@ class Image : public Resource {
void fill_rect(const Rect2i &p_rect, const Color &p_color);

Rect2i get_used_rect() const;
Ref<Image> get_rect(const Rect2i &p_area) const;
Ref<Image> get_region(const Rect2i &p_area) const;

static void set_compress_bc_func(void (*p_compress_func)(Image *, float, UsedChannels));
static void set_compress_bptc_func(void (*p_compress_func)(Image *, float, UsedChannels));
Expand Down
6 changes: 3 additions & 3 deletions doc/classes/Image.xml
Original file line number Diff line number Diff line change
Expand Up @@ -241,11 +241,11 @@
This is the same as [method get_pixel], but with a [Vector2i] argument instead of two integer arguments.
</description>
</method>
<method name="get_rect" qualifiers="const">
<method name="get_region" qualifiers="const">
<return type="Image" />
<param index="0" name="rect" type="Rect2i" />
<param index="0" name="region" type="Rect2i" />
<description>
Returns a new image that is a copy of the image's area specified with [param rect].
Returns a new [Image] that is a copy of this [Image]'s area specified with [param region].
</description>
</method>
<method name="get_size" qualifiers="const">
Expand Down
2 changes: 1 addition & 1 deletion editor/import/resource_importer_layered_texture.cpp
Original file line number Diff line number Diff line change
Expand Up @@ -368,7 +368,7 @@ Error ResourceImporterLayeredTexture::import(const String &p_source_file, const
for (int j = 0; j < hslices; j++) {
int x = slice_w * j;
int y = slice_h * i;
Ref<Image> slice = image->get_rect(Rect2i(x, y, slice_w, slice_h));
Ref<Image> slice = image->get_region(Rect2i(x, y, slice_w, slice_h));
ERR_CONTINUE(slice.is_null() || slice->is_empty());
if (slice->get_width() != slice_w || slice->get_height() != slice_h) {
slice->resize(slice_w, slice_h);
Expand Down
2 changes: 1 addition & 1 deletion editor/plugins/editor_preview_plugins.cpp
Original file line number Diff line number Diff line change
Expand Up @@ -93,7 +93,7 @@ Ref<Texture2D> EditorTexturePreviewPlugin::generate(const Ref<Resource> &p_from,
return Ref<Texture2D>();
}

img = atlas->get_rect(atex->get_region());
img = atlas->get_region(atex->get_region());
} else {
Ref<Texture2D> tex = p_from;
if (tex.is_valid()) {
Expand Down
2 changes: 1 addition & 1 deletion scene/resources/texture.cpp
Original file line number Diff line number Diff line change
Expand Up @@ -1663,7 +1663,7 @@ Ref<Image> AtlasTexture::get_image() const {
return Ref<Image>();
}

return atlas->get_image()->get_rect(region);
return atlas->get_image()->get_region(region);
}

AtlasTexture::AtlasTexture() {}
Expand Down
2 changes: 1 addition & 1 deletion tests/core/io/test_image.h
Original file line number Diff line number Diff line change
Expand Up @@ -162,7 +162,7 @@ TEST_CASE("[Image] Basic getters") {
CHECK(image->get_size() == Vector2(8, 4));
CHECK(image->get_format() == Image::FORMAT_LA8);
CHECK(image->get_used_rect() == Rect2i(0, 0, 0, 0));
Ref<Image> image_get_rect = image->get_rect(Rect2i(0, 0, 2, 1));
Ref<Image> image_get_rect = image->get_region(Rect2i(0, 0, 2, 1));
CHECK(image_get_rect->get_size() == Vector2(2, 1));
}

Expand Down