Clarify in default texture repeat and filter docs that they only impact the built in texture #98738
Conversation
clayjohn
added
the
cherrypick:4.3
…ct the built in texture
clayjohn
force-pushed
the
DOC-default-texture-filter
branch
from
58cbf09 to
fa4f701
Compare
| @@ -2890,11 +2890,11 @@ | |||
| If [code]true[/code], forces vertex shading for all rendering. This can increase performance a lot, but also reduces quality immensely. Can be used to optimize performance on low-end mobile devices. | |||
| </member> | |||
| <member name="rendering/textures/canvas_textures/default_texture_filter" type="int" setter="" getter="" default="1"> | |||
| The default texture filtering mode to use on [CanvasItem]s. | |||
| The default texture filtering mode to use for [CanvasItem]s built-in texture. In shaders, this texture is accessed as [code]TEXTURE[/code]. | |||
There was a problem hiding this comment.
| The default texture filtering mode to use for [CanvasItem]s built-in texture. In shaders, this texture is accessed as [code]TEXTURE[/code]. | |
| The default texture filtering mode used to render the built-in texture for [CanvasItem] nodes. In shaders, this texture is accessed as [code]TEXTURE[/code]. |
There was a problem hiding this comment.
Notably texture is not a property of CanvasItem - it's a property of several nodes that inherit CanvasItem:
https://docs.godotengine.org/en/stable/classes/class_texturerect.html#class-texturerect-property-texture
https://docs.godotengine.org/en/stable/classes/class_sprite2d.html#class-sprite2d-property-texture
https://docs.godotengine.org/en/stable/classes/class_line2d.html#class-line2d-property-texture
If this note goes on texture, it would have to be repeated in several places.
I also think that the project settings are a reasonable place to put general information about Godot that don't fit anywhere else in the class reference. At least that's how they are used currently. This note seems fine to me.
| [b]Note:[/b] For pixel art aesthetics, see also [member rendering/2d/snap/snap_2d_vertices_to_pixel] and [member rendering/2d/snap/snap_2d_transforms_to_pixel]. | ||
| </member> | ||
| <member name="rendering/textures/canvas_textures/default_texture_repeat" type="int" setter="" getter="" default="0"> | ||
| The default texture repeating mode to use on [CanvasItem]s. | ||
| The default texture repeating mode to use for [CanvasItem]s built-in texture. In shaders, this texture is accessed as [code]TEXTURE[/code]. |
There was a problem hiding this comment.
| The default texture repeating mode to use for [CanvasItem]s built-in texture. In shaders, this texture is accessed as [code]TEXTURE[/code]. | |
| The default texture repeating mode used to render the built-in texture for [CanvasItem] nodes. In shaders, this texture is accessed as [code]TEXTURE[/code]. |
There was a problem hiding this comment.
I don't think this addition is correct. Or, at the very least, it is confusing.
This setting changes how the texture is sampled when it is used in a shader. In some situations that may change how the CanvasItem is rendered to the Viewport, and in others it won't. Importantly though, this setting doesn't change how the texture itself is created, which this addition seems to say.
Sampling is the process of reading from a texture. So basically this tells the shader what to do when it is asked to read from an area outside the texture's boundary.
|
Thanks! |
Helps clarify for situations like #57679 where users expect that this setting will apply to all textures.