Skip to content

Commit

Permalink
Merge pull request #43278 from Calinou/doc-atlastexture-no-repeat
Browse files Browse the repository at this point in the history
Document AtlasTexture not supporting repetition
  • Loading branch information
akien-mga authored Nov 6, 2020
2 parents d3ffff3 + fab38f7 commit be625f6
Show file tree
Hide file tree
Showing 2 changed files with 3 additions and 0 deletions.
1 change: 1 addition & 0 deletions doc/classes/AtlasTexture.xml
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,7 @@
</brief_description>
<description>
[Texture] resource aimed at managing big textures files that pack multiple smaller textures. Consists of a [Texture], a margin that defines the border width, and a region that defines the actual area of the AtlasTexture.
[b]Note:[/b] AtlasTextures don't support repetition. The [constant Texture.FLAG_REPEAT] and [constant Texture.FLAG_MIRRORED_REPEAT] flags are ignored when using an AtlasTexture.
</description>
<tutorials>
</tutorials>
Expand Down
2 changes: 2 additions & 0 deletions doc/classes/Texture.xml
Original file line number Diff line number Diff line change
Expand Up @@ -118,6 +118,7 @@
</constant>
<constant name="FLAG_REPEAT" value="2" enum="Flags">
Repeats the texture (instead of clamp to edge).
[b]Note:[/b] Ignored when using an [AtlasTexture] as these don't support repetition.
</constant>
<constant name="FLAG_FILTER" value="4" enum="Flags">
Uses a magnifying filter, to enable smooth zooming in of the texture.
Expand All @@ -131,6 +132,7 @@
</constant>
<constant name="FLAG_MIRRORED_REPEAT" value="32" enum="Flags">
Repeats the texture with alternate sections mirrored.
[b]Note:[/b] Ignored when using an [AtlasTexture] as these don't support repetition.
</constant>
<constant name="FLAG_VIDEO_SURFACE" value="2048" enum="Flags">
Texture is a video surface.
Expand Down

0 comments on commit be625f6

Please sign in to comment.