Merge pull request #95347 from calsbrook/update-compositor-effect-docs

Clarify usage of CompositorEffect as an abstract base class
This commit is contained in:
Rémi Verschelde 2024-08-12 22:41:52 +02:00
commit b8e8b339c4
No known key found for this signature in database
GPG Key ID: C3336907360768E1

View File

@ -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>