virtualx-engine/doc/classes/CurveTexture.xml

<?xml version="1.0" encoding="UTF-8" ?>
<class name="CurveTexture" inherits="Texture2D" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="../class.xsd">
	<brief_description>
		A 1D texture where pixel brightness corresponds to points on a curve.
	</brief_description>
	<description>
		A 1D texture where pixel brightness corresponds to points on a [Curve] resource, either in grayscale or in red. This visual representation simplifies the task of saving curves as image files.
		If you need to store up to 3 curves within a single texture, use [CurveXYZTexture] instead. See also [GradientTexture1D] and [GradientTexture2D].
	</description>
	<tutorials>
	</tutorials>
	<members>
		<member name="curve" type="Curve" setter="set_curve" getter="get_curve">
			The [Curve] that is rendered onto the texture.
		</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="texture_mode" type="int" setter="set_texture_mode" getter="get_texture_mode" enum="CurveTexture.TextureMode" default="0">
			The format the texture should be generated with. When passing a CurveTexture as an input to a [Shader], this may need to be adjusted.
		</member>
		<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>
	<constants>
		<constant name="TEXTURE_MODE_RGB" value="0" enum="TextureMode">
			Store the curve equally across the red, green and blue channels. This uses more video memory, but is more compatible with shaders that only read the green and blue values.
		</constant>
		<constant name="TEXTURE_MODE_RED" value="1" enum="TextureMode">
			Store the curve only in the red channel. This saves video memory, but some custom shaders may not be able to work with this.
		</constant>
	</constants>
</class>
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them. 2017-09-12 22:42:36 +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="CurveTexture" inherits="Texture2D" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="../class.xsd">`
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them. 2017-09-12 22:42:36 +02:00			`<brief_description>`
Improve the top docs sections of VFX classes 2023-06-24 13:19:58 +02:00			`A 1D texture where pixel brightness corresponds to points on a curve.`
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them. 2017-09-12 22:42:36 +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 pixel brightness corresponds to points on a [Curve] resource, either in grayscale or in red. This visual representation 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 need to store up to 3 curves within a single texture, use [CurveXYZTexture] instead. See also [GradientTexture1D] and [GradientTexture2D].`
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them. 2017-09-12 22:42:36 +02:00			`</description>`
			`<tutorials>`
			`</tutorials>`
			`<members>`
doc: Sync classref with current source 2019-07-15 20:42:47 +02:00			`<member name="curve" type="Curve" setter="set_curve" getter="get_curve">`
Document the CurveXYZTexture class, improve CurveTexture documentation 2022-06-10 22:56:35 +02:00			`The [Curve] that is rendered onto the texture.`
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them. 2017-09-12 22:42:36 +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" />`
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 name="texture_mode" type="int" setter="set_texture_mode" getter="get_texture_mode" enum="CurveTexture.TextureMode" default="0">`
Fixed various typos across the docs 2023-05-02 00:09:49 +02:00			`The format the texture should be generated with. When passing a CurveTexture as an input to a [Shader], this may need to be adjusted.`
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>`
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.`
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them. 2017-09-12 22:42:36 +02:00			`</member>`
			`</members>`
			`<constants>`
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			`<constant name="TEXTURE_MODE_RGB" value="0" enum="TextureMode">`
Document the CurveXYZTexture class, improve CurveTexture documentation 2022-06-10 22:56:35 +02:00			`Store the curve equally across the red, green and blue channels. This uses more video memory, but is more compatible with shaders that only read the green and blue values.`
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			`</constant>`
			`<constant name="TEXTURE_MODE_RED" value="1" enum="TextureMode">`
Document the CurveXYZTexture class, improve CurveTexture documentation 2022-06-10 22:56:35 +02:00			`Store the curve only in the red channel. This saves video memory, but some custom shaders may not be able to work with this.`
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			`</constant>`
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them. 2017-09-12 22:42:36 +02:00			`</constants>`
			`</class>`