virtualx-engine/doc/classes/VisualShaderNodeFloatParameter.xml

<?xml version="1.0" encoding="UTF-8" ?>
<class name="VisualShaderNodeFloatParameter" inherits="VisualShaderNodeParameter" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="../class.xsd">
	<brief_description>
		A scalar float parameter to be used within the visual shader graph.
	</brief_description>
	<description>
		Translated to [code]uniform float[/code] in the shader language.
	</description>
	<tutorials>
	</tutorials>
	<members>
		<member name="default_value" type="float" setter="set_default_value" getter="get_default_value" default="0.0">
			A default value to be assigned within the shader.
		</member>
		<member name="default_value_enabled" type="bool" setter="set_default_value_enabled" getter="is_default_value_enabled" default="false">
			Enables usage of the [member default_value].
		</member>
		<member name="hint" type="int" setter="set_hint" getter="get_hint" enum="VisualShaderNodeFloatParameter.Hint" default="0">
			A hint applied to the uniform, which controls the values it can take when set through the Inspector.
		</member>
		<member name="max" type="float" setter="set_max" getter="get_max" default="1.0">
			Minimum value for range hints. Used if [member hint] is set to [constant HINT_RANGE] or [constant HINT_RANGE_STEP].
		</member>
		<member name="min" type="float" setter="set_min" getter="get_min" default="0.0">
			Maximum value for range hints. Used if [member hint] is set to [constant HINT_RANGE] or [constant HINT_RANGE_STEP].
		</member>
		<member name="step" type="float" setter="set_step" getter="get_step" default="0.1">
			Step (increment) value for the range hint with step. Used if [member hint] is set to [constant HINT_RANGE_STEP].
		</member>
	</members>
	<constants>
		<constant name="HINT_NONE" value="0" enum="Hint">
			No hint used.
		</constant>
		<constant name="HINT_RANGE" value="1" enum="Hint">
			A range hint for scalar value, which limits possible input values between [member min] and [member max]. Translated to [code]hint_range(min, max)[/code] in shader code.
		</constant>
		<constant name="HINT_RANGE_STEP" value="2" enum="Hint">
			A range hint for scalar value with step, which limits possible input values between [member min] and [member max], with a step (increment) of [member step]). Translated to [code]hint_range(min, max, step)[/code] in shader code.
		</constant>
		<constant name="HINT_MAX" value="3" enum="Hint">
			Represents the size of the [enum Hint] enum.
		</constant>
	</constants>
</class>