summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorcalsbrook <CameronAlsbrook@gmail.com>2024-08-09 21:28:31 -0700
committercalsbrook <CameronAlsbrook@gmail.com>2024-08-09 21:28:31 -0700
commit3217bc283cf22d0718a8052fe98cd70d81caaaed (patch)
tree23b29eff249328ce156ceeb8c6edabfcc35fc72d
parent88f3b5f9d52f740b24fabfb8bc01b8b7026ba279 (diff)
downloadredot-engine-3217bc283cf22d0718a8052fe98cd70d81caaaed.tar.gz
Clarify usage of CompositorEffect as an abstract base class in the documentation
-rw-r--r--doc/classes/CompositorEffect.xml2
1 files changed, 1 insertions, 1 deletions
diff --git a/doc/classes/CompositorEffect.xml b/doc/classes/CompositorEffect.xml
index b05dc44cf6..cf3aa9fca4 100644
--- a/doc/classes/CompositorEffect.xml
+++ b/doc/classes/CompositorEffect.xml
@@ -4,7 +4,7 @@
This resource allows for creating a custom rendering effect.
</brief_description>
<description>
- 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.
+ 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>
</tutorials>