summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authortetrapod00 <145553014+tetrapod00@users.noreply.github.com>2024-08-14 22:04:12 -0700
committertetrapod00 <145553014+tetrapod00@users.noreply.github.com>2024-08-14 22:04:12 -0700
commitd6ef881418658f700b22067c1489f25b328ba8ed (patch)
tree008916363958dabe1ae282abc9fa4adc1d19b433
parent33c30b9e63a58b860cb2f36957c5e25cee34a627 (diff)
downloadredot-engine-d6ef881418658f700b22067c1489f25b328ba8ed.tar.gz
Add tutorial link in Compositor and CompositorEffect docs
-rw-r--r--doc/classes/Compositor.xml1
-rw-r--r--doc/classes/CompositorEffect.xml1
2 files changed, 2 insertions, 0 deletions
diff --git a/doc/classes/Compositor.xml b/doc/classes/Compositor.xml
index 7605083319..0732526957 100644
--- a/doc/classes/Compositor.xml
+++ b/doc/classes/Compositor.xml
@@ -7,6 +7,7 @@
The compositor resource stores attributes used to customize how a [Viewport] is rendered.
</description>
<tutorials>
+ <link title="The Compositor">$DOCS_URL/tutorials/rendering/compositor.html</link>
</tutorials>
<members>
<member name="compositor_effects" type="CompositorEffect[]" setter="set_compositor_effects" getter="get_compositor_effects" default="[]">
diff --git a/doc/classes/CompositorEffect.xml b/doc/classes/CompositorEffect.xml
index cf3aa9fca4..76a3887918 100644
--- a/doc/classes/CompositorEffect.xml
+++ b/doc/classes/CompositorEffect.xml
@@ -7,6 +7,7 @@
This resource defines a custom rendering effect that can be applied to [Viewport]s through the viewports' [Environment]. You can implement a callback that is called during rendering at a given stage of the rendering pipeline and allows you to insert additional passes. Note that this callback happens on the rendering thread. CompositorEffect is an abstract base class and must be extended to implement specific rendering logic.
</description>
<tutorials>
+ <link title="The Compositor">$DOCS_URL/tutorials/rendering/compositor.html</link>
</tutorials>
<methods>
<method name="_render_callback" qualifiers="virtual">