virtualx-engine/doc/classes/CurveXYZTexture.xml

<?xml version="1.0" encoding="UTF-8" ?>
<class name="CurveXYZTexture" inherits="Texture2D" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="../class.xsd">
	<brief_description>
		A 1D texture where the red, green, and blue color channels correspond to points on 3 curves.
	</brief_description>
	<description>
		A 1D texture where the red, green, and blue color channels correspond to points on 3 [Curve] resources. Compared to using separate [CurveTexture]s, this further simplifies the task of saving curves as image files.
		If you only need to store one curve within a single texture, use [CurveTexture] instead. See also [GradientTexture1D] and [GradientTexture2D].
	</description>
	<tutorials>
	</tutorials>
	<members>
		<member name="curve_x" type="Curve" setter="set_curve_x" getter="get_curve_x">
			The [Curve] that is rendered onto the texture's red channel.
		</member>
		<member name="curve_y" type="Curve" setter="set_curve_y" getter="get_curve_y">
			The [Curve] that is rendered onto the texture's green channel.
		</member>
		<member name="curve_z" type="Curve" setter="set_curve_z" getter="get_curve_z">
			The [Curve] that is rendered onto the texture's blue channel.
		</member>
		<member name="resource_local_to_scene" type="bool" setter="set_local_to_scene" getter="is_local_to_scene" overrides="Resource" default="false" />
		<member name="width" type="int" setter="set_width" getter="get_width" default="256">
			The width of the texture (in pixels). Higher values make it possible to represent high-frequency data better (such as sudden direction changes), at the cost of increased generation time and memory usage.
		</member>
	</members>
</class>
Implement Curve3Texture * This was required by users in some scenarios, such as animating individual axes over time with a single texture. * Examples: Shaders, Particles, etc. * CurveTexture now defaults to RGB, can be changed to Red if needed, this allows to freely exchange them. 2021-07-01 20:25:35 +02:00			`<?xml version="1.0" encoding="UTF-8" ?>`
Doctool: Remove version attribute from XML header We don't use that info for anything, and it generates unnecessary diffs every time we bump the minor version (and CI failures if we forget to sync some files from opt-in modules (mono, text_server_fb). 2023-07-06 10:08:05 +02:00			`<class name="CurveXYZTexture" inherits="Texture2D" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="../class.xsd">`
Implement Curve3Texture * This was required by users in some scenarios, such as animating individual axes over time with a single texture. * Examples: Shaders, Particles, etc. * CurveTexture now defaults to RGB, can be changed to Red if needed, this allows to freely exchange them. 2021-07-01 20:25:35 +02:00			`<brief_description>`
Improve the top docs sections of VFX classes 2023-06-24 13:19:58 +02:00			`A 1D texture where the red, green, and blue color channels correspond to points on 3 curves.`
Implement Curve3Texture * This was required by users in some scenarios, such as animating individual axes over time with a single texture. * Examples: Shaders, Particles, etc. * CurveTexture now defaults to RGB, can be changed to Red if needed, this allows to freely exchange them. 2021-07-01 20:25:35 +02:00			`</brief_description>`
			`<description>`
Improve the top docs sections of VFX classes 2023-06-24 13:19:58 +02:00			`A 1D texture where the red, green, and blue color channels correspond to points on 3 [Curve] resources. Compared to using separate [CurveTexture]s, this further simplifies the task of saving curves as image files.`
Document the CurveXYZTexture class, improve CurveTexture documentation 2022-06-10 22:56:35 +02:00			`If you only need to store one curve within a single texture, use [CurveTexture] instead. See also [GradientTexture1D] and [GradientTexture2D].`
Implement Curve3Texture * This was required by users in some scenarios, such as animating individual axes over time with a single texture. * Examples: Shaders, Particles, etc. * CurveTexture now defaults to RGB, can be changed to Red if needed, this allows to freely exchange them. 2021-07-01 20:25:35 +02:00			`</description>`
			`<tutorials>`
			`</tutorials>`
			`<members>`
			`<member name="curve_x" type="Curve" setter="set_curve_x" getter="get_curve_x">`
Document the CurveXYZTexture class, improve CurveTexture documentation 2022-06-10 22:56:35 +02:00			`The [Curve] that is rendered onto the texture's red channel.`
Implement Curve3Texture * This was required by users in some scenarios, such as animating individual axes over time with a single texture. * Examples: Shaders, Particles, etc. * CurveTexture now defaults to RGB, can be changed to Red if needed, this allows to freely exchange them. 2021-07-01 20:25:35 +02:00			`</member>`
			`<member name="curve_y" type="Curve" setter="set_curve_y" getter="get_curve_y">`
Document the CurveXYZTexture class, improve CurveTexture documentation 2022-06-10 22:56:35 +02:00			`The [Curve] that is rendered onto the texture's green channel.`
Implement Curve3Texture * This was required by users in some scenarios, such as animating individual axes over time with a single texture. * Examples: Shaders, Particles, etc. * CurveTexture now defaults to RGB, can be changed to Red if needed, this allows to freely exchange them. 2021-07-01 20:25:35 +02:00			`</member>`
			`<member name="curve_z" type="Curve" setter="set_curve_z" getter="get_curve_z">`
Document the CurveXYZTexture class, improve CurveTexture documentation 2022-06-10 22:56:35 +02:00			`The [Curve] that is rendered onto the texture's blue channel.`
Implement Curve3Texture * This was required by users in some scenarios, such as animating individual axes over time with a single texture. * Examples: Shaders, Particles, etc. * CurveTexture now defaults to RGB, can be changed to Red if needed, this allows to freely exchange them. 2021-07-01 20:25:35 +02:00			`</member>`
Fix default values on virtual classes causing errors in projects 2022-11-09 08:59:49 +01:00			`<member name="resource_local_to_scene" type="bool" setter="set_local_to_scene" getter="is_local_to_scene" overrides="Resource" default="false" />`
Decrease the default GradientTexture and CurveTexture size This provides better usability when a GradientTexture or CurveTexture is added to a Control node. Visual appearance of most GradientTextures and CurveTextures will be unaffected. 2022-01-29 00:28:10 +01:00			`<member name="width" type="int" setter="set_width" getter="get_width" default="256">`
Document the CurveXYZTexture class, improve CurveTexture documentation 2022-06-10 22:56:35 +02:00			`The width of the texture (in pixels). Higher values make it possible to represent high-frequency data better (such as sudden direction changes), at the cost of increased generation time and memory usage.`
Implement Curve3Texture * This was required by users in some scenarios, such as animating individual axes over time with a single texture. * Examples: Shaders, Particles, etc. * CurveTexture now defaults to RGB, can be changed to Red if needed, this allows to freely exchange them. 2021-07-01 20:25:35 +02:00			`</member>`
			`</members>`
			`</class>`