summaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authorRémi Verschelde <rverschelde@gmail.com>2023-02-17 12:28:39 +0100
committerRémi Verschelde <rverschelde@gmail.com>2023-02-17 12:32:26 +0100
commit1075931c64716f634ed5efb842e6173d813ab03b (patch)
treea9d5205dafdc299695aafcbf2609ac0f71624173 /doc
parentdb9007aef4fff2e23c090646e6f9452cd199213f (diff)
Remove unexposed ProxyTexture, mark AnimatedTexture as deprecated
According to reduz: > [AnimatedTexture] should be removed together with ProxyTexture, its just > not efficient at all in Vulkan and causes invalidation of all descriptor > sets depending on it > it was needed mostly for animated tilemaps, but nowadays there is not a lot > of reason for it Marking AnimatedTexture as deprecated accordingly, until we reach consensus for removing it completely.
Diffstat (limited to 'doc')
-rw-r--r--doc/classes/AnimatedTexture.xml3
1 files changed, 2 insertions, 1 deletions
diff --git a/doc/classes/AnimatedTexture.xml b/doc/classes/AnimatedTexture.xml
index 454b9c1c32..052c55dfb6 100644
--- a/doc/classes/AnimatedTexture.xml
+++ b/doc/classes/AnimatedTexture.xml
@@ -1,5 +1,5 @@
<?xml version="1.0" encoding="UTF-8" ?>
-<class name="AnimatedTexture" inherits="Texture2D" version="4.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="../class.xsd">
+<class name="AnimatedTexture" inherits="Texture2D" is_deprecated="true" version="4.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="../class.xsd">
<brief_description>
Proxy texture for simple frame-based animations.
</brief_description>
@@ -8,6 +8,7 @@
The playback of the animation is controlled by the [member speed_scale] property, as well as each frame's duration (see [method set_frame_duration]). The animation loops, i.e. it will restart at frame 0 automatically after playing the last frame.
[AnimatedTexture] currently requires all frame textures to have the same size, otherwise the bigger ones will be cropped to match the smallest one.
[b]Note:[/b] AnimatedTexture doesn't support using [AtlasTexture]s. Each frame needs to be a separate [Texture2D].
+ [b]Warning:[/b] AnimatedTexture is deprecated, and might be removed in a future release. Its current implementation is not efficient for the modern renderers.
</description>
<tutorials>
</tutorials>