godotengine/godot-docs
1
0
Fork 0
mirror of https://github.com/godotengine/godot-docs.git synced 2026-01-04 14:11:02 +03:00
Code Issues Packages Projects Releases Wiki Activity

Document REGION_RECT canvas shader built-in

Browse Source 
This was added in 4.5 to better accomodate Sprite2D with regions enabled.
This commit is contained in:
Hugo Locurcio
2025-08-22 18:18:33 +02:00
parent a1632ef08e
commit 0fc73a7c0d
1 changed files with 9 additions and 2 deletions
Download Patch File Download Diff File Expand all files Collapse all files

11
tutorials/shaders/shader_reference/canvas_item_shader.rst
View File

@@ -6,8 +6,8 @@ CanvasItem shaders
CanvasItem shaders are used to draw all 2D elements in Godot. These include
all nodes that inherit from CanvasItems, and all GUI elements.
CanvasItem shaders contain fewer built-in variables and functionality than
:ref:`Spatial shaders<doc_spatial_shader>`, but they maintain the same basic structure
CanvasItem shaders contain fewer built-in variables and functionality than
:ref:`Spatial shaders<doc_spatial_shader>`, but they maintain the same basic structure
with vertex, fragment, and light processor functions.
Render modes
@@ -223,6 +223,10 @@ it to the ``NORMAL_MAP`` property. Godot will handle converting it for use in 2D
+---------------------------------------------+---------------------------------------------------------------+
| in vec2 **SCREEN_PIXEL_SIZE** | Size of individual pixels. Equal to inverse of resolution. |
+---------------------------------------------+---------------------------------------------------------------+
| in vec4 **REGION_RECT** | Visible area of the sprite region in format |
| | ``(x, y, width, height)``. Varies according to |
| | Sprite2D's ``region_enabled`` property. |
+---------------------------------------------+---------------------------------------------------------------+
| in vec2 **POINT_COORD** | Coordinate for drawing points. |
+---------------------------------------------+---------------------------------------------------------------+
| sampler2D **TEXTURE** | Default 2D texture. |
@@ -238,6 +242,9 @@ it to the ``NORMAL_MAP`` property. Godot will handle converting it for use in 2D
| in vec4 **SPECULAR_SHININESS** | Specular shininess color, as sampled from the texture. |
+---------------------------------------------+---------------------------------------------------------------+
| in vec2 **UV** | UV from the ``vertex()`` function. |
| | For Sprite2D with region enabled, this will sample the entire |
| | texture. Use ``REGION_RECT`` instead to sample only the |
| | region defined in the Sprite2D's properties. |
+---------------------------------------------+---------------------------------------------------------------+
| in vec2 **SCREEN_UV** | Screen UV coordinate for current pixel. |
+---------------------------------------------+---------------------------------------------------------------+