Stowage/godot
2
0
Fork 0
mirror of https://github.com/godotengine/godot.git synced 2025-10-19 07:53:26 +00:00
Code Issues Projects Releases Packages Wiki Activity

Document REGION_RECT canvas shader built-in in Sprite2D region property

Browse source
This commit is contained in:
Hugo Locurcio 2025-08-22 19:41:48 +02:00
parent b432e108d5
commit e00b1f2f4f
No known key found for this signature in database
GPG key ID: 39E8F8BE30B0A49C
1 changed files with 1 additions and 0 deletions
Download patch file Download diff file Expand all files Collapse all files

1
doc/classes/Sprite2D.xml
View file

@ -75,6 +75,7 @@
</member>
<member name="region_enabled" type="bool" setter="set_region_enabled" getter="is_region_enabled" default="false">
If [code]true[/code], texture is cut from a larger atlas texture. See [member region_rect].
[b]Note:[/b] When using a custom [Shader] on a [Sprite2D], the [code]UV[/code] shader built-in will refer to the entire texture space. Use the [code]REGION_RECT[/code] built-in to get the currently visible region defined in [member region_rect] instead. See [url=$DOCS_URL/tutorials/shaders/shader_reference/canvas_item_shader.html]CanvasItem shaders[/url] for details.
</member>
<member name="region_filter_clip_enabled" type="bool" setter="set_region_filter_clip_enabled" getter="is_region_filter_clip_enabled" default="false">
If [code]true[/code], the area outside of the [member region_rect] is clipped to avoid bleeding of the surrounding texture pixels. [member region_enabled] must be [code]true[/code].