瀏覽代碼

Clarify usage of CompositorEffect as an abstract base class in the documentation

calsbrook 1 年之前
父節點
當前提交
3217bc283c
共有 1 個文件被更改,包括 1 次插入1 次删除
  1. 1 1
      doc/classes/CompositorEffect.xml

+ 1 - 1
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>