VisualShaderNodeScalarUniform.xml 2.3 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546
  1. <?xml version="1.0" encoding="UTF-8" ?>
  2. <class name="VisualShaderNodeScalarUniform" inherits="VisualShaderNodeUniform" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="../class.xsd">
  3. <brief_description>
  4. </brief_description>
  5. <description>
  6. </description>
  7. <tutorials>
  8. </tutorials>
  9. <methods>
  10. </methods>
  11. <members>
  12. <member name="default_value" type="float" setter="set_default_value" getter="get_default_value" default="0.0">
  13. A default value to be assigned within the shader.
  14. </member>
  15. <member name="default_value_enabled" type="bool" setter="set_default_value_enabled" getter="is_default_value_enabled" default="false">
  16. Enables usage of the [member default_value].
  17. </member>
  18. <member name="hint" type="int" setter="set_hint" getter="get_hint" enum="VisualShaderNodeScalarUniform.Hint" default="0">
  19. A hint applied to the uniform, which controls the values it can take when set through the inspector.
  20. </member>
  21. <member name="max" type="float" setter="set_max" getter="get_max" default="1.0">
  22. Minimum value for range hints. Used if [member hint] is set to [constant HINT_RANGE] or [constant HINT_RANGE_STEP].
  23. </member>
  24. <member name="min" type="float" setter="set_min" getter="get_min" default="0.0">
  25. Maximum value for range hints. Used if [member hint] is set to [constant HINT_RANGE] or [constant HINT_RANGE_STEP].
  26. </member>
  27. <member name="step" type="float" setter="set_step" getter="get_step" default="0.1">
  28. Step (increment) value for the range hint with step. Used if [member hint] is set to [constant HINT_RANGE_STEP].
  29. </member>
  30. </members>
  31. <constants>
  32. <constant name="HINT_NONE" value="0" enum="Hint">
  33. No hint used.
  34. </constant>
  35. <constant name="HINT_RANGE" value="1" enum="Hint">
  36. 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.
  37. </constant>
  38. <constant name="HINT_RANGE_STEP" value="2" enum="Hint">
  39. 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.
  40. </constant>
  41. <constant name="HINT_MAX" value="3" enum="Hint">
  42. Represents the size of the [enum Hint] enum.
  43. </constant>
  44. </constants>
  45. </class>