Skip to content

Commit a109836

Browse files
committed
Merge pull request #109877 from Calinou/doc-sprite2d-region-rect-shader
Document `REGION_RECT` canvas shader built-in in Sprite2D region property
2 parents 8cb6bb9 + e00b1f2 commit a109836

File tree

1 file changed

+1
-0
lines changed

1 file changed

+1
-0
lines changed

doc/classes/Sprite2D.xml

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -75,6 +75,7 @@
7575
</member>
7676
<member name="region_enabled" type="bool" setter="set_region_enabled" getter="is_region_enabled" default="false">
7777
If [code]true[/code], texture is cut from a larger atlas texture. See [member region_rect].
78+
[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.
7879
</member>
7980
<member name="region_filter_clip_enabled" type="bool" setter="set_region_filter_clip_enabled" getter="is_region_filter_clip_enabled" default="false">
8081
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].

0 commit comments

Comments
 (0)