virtualx-engine/doc/classes/Compositor.xml

<?xml version="1.0" encoding="UTF-8" ?>
<class name="Compositor" inherits="Resource" experimental="More customization of the rendering pipeline will be added in the future." xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="../class.xsd">
	<brief_description>
		Stores attributes used to customize how a Viewport is rendered.
	</brief_description>
	<description>
		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="[]">
			The custom [CompositorEffect]s that are applied during rendering of viewports using this compositor.
		</member>
	</members>
</class>
Implement hooks into renderer 2023-08-03 14:10:03 +02:00			`<?xml version="1.0" encoding="UTF-8" ?>`
Fix various typos with codespell Using 2.2.7.dev217+g10c2abcf. Had to add `colour` to the ignore list as we used it as an alias/keyword for the documentation of color-related APIs. Also ignore recommendations to change `thirdparty` to either `third-party` or `third party`, which are correct but we use the former fairly consistently. 2024-05-07 10:05:42 +02:00			`<class name="Compositor" inherits="Resource" experimental="More customization of the rendering pipeline will be added in the future." xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="../class.xsd">`
Implement hooks into renderer 2023-08-03 14:10:03 +02:00			`<brief_description>`
Overhaul some "uncommon" wording in class reference 2024-03-01 00:59:28 +01:00			`Stores attributes used to customize how a Viewport is rendered.`
Implement hooks into renderer 2023-08-03 14:10:03 +02:00			`</brief_description>`
			`<description>`
Overhaul some "uncommon" wording in class reference 2024-03-01 00:59:28 +01:00			`The compositor resource stores attributes used to customize how a [Viewport] is rendered.`
Implement hooks into renderer 2023-08-03 14:10:03 +02:00			`</description>`
			`<tutorials>`
Add tutorial link in Compositor and CompositorEffect docs 2024-08-15 07:04:12 +02:00			`<link title="The Compositor">$DOCS_URL/tutorials/rendering/compositor.html</link>`
Implement hooks into renderer 2023-08-03 14:10:03 +02:00			`</tutorials>`
			`<members>`
			`<member name="compositor_effects" type="CompositorEffect[]" setter="set_compositor_effects" getter="get_compositor_effects" default="[]">`
			`The custom [CompositorEffect]s that are applied during rendering of viewports using this compositor.`
			`</member>`
			`</members>`
			`</class>`