mirror of
https://github.com/godotengine/godot.git
synced 2025-10-31 21:51:22 +00:00
2d20fc39aa
We already removed it from the online docs with #35132. Currently it can only be "Built-In Types" (Variant types) or "Core" (everything else), which is of limited use. We might also want to consider dropping it from `ClassDB` altogether in Godot 4.0.
62 lines
3.1 KiB
XML
62 lines
3.1 KiB
XML
<?xml version="1.0" encoding="UTF-8" ?>
|
|
<class name="VisualShaderNodeCompare" inherits="VisualShaderNode" version="3.2">
|
|
<brief_description>
|
|
A comparison function for common types within the visual shader graph.
|
|
</brief_description>
|
|
<description>
|
|
Compares [code]a[/code] and [code]b[/code] of [member type] by [member function]. Returns a boolean scalar. Translates to [code]if[/code] instruction in shader code.
|
|
</description>
|
|
<tutorials>
|
|
</tutorials>
|
|
<methods>
|
|
</methods>
|
|
<members>
|
|
<member name="condition" type="int" setter="set_condition" getter="get_condition" enum="VisualShaderNodeCompare.Condition" default="0">
|
|
Extra condition which is applied if [member type] is set to [constant CTYPE_VECTOR].
|
|
</member>
|
|
<member name="function" type="int" setter="set_function" getter="get_function" enum="VisualShaderNodeCompare.Function" default="0">
|
|
A comparison function. See [enum Function] for options.
|
|
</member>
|
|
<member name="type" type="int" setter="set_comparison_type" getter="get_comparison_type" enum="VisualShaderNodeCompare.ComparisonType" default="0">
|
|
The type to be used in the comparison. See [enum ComparisonType] for options.
|
|
</member>
|
|
</members>
|
|
<constants>
|
|
<constant name="CTYPE_SCALAR" value="0" enum="ComparisonType">
|
|
A floating-point scalar.
|
|
</constant>
|
|
<constant name="CTYPE_VECTOR" value="1" enum="ComparisonType">
|
|
A 3D vector type.
|
|
</constant>
|
|
<constant name="CTYPE_BOOLEAN" value="2" enum="ComparisonType">
|
|
A boolean type.
|
|
</constant>
|
|
<constant name="CTYPE_TRANSFORM" value="3" enum="ComparisonType">
|
|
A transform ([code]mat4[/code]) type.
|
|
</constant>
|
|
<constant name="FUNC_EQUAL" value="0" enum="Function">
|
|
Comparison for equality ([code]a == b[/code]).
|
|
</constant>
|
|
<constant name="FUNC_NOT_EQUAL" value="1" enum="Function">
|
|
Comparison for inequality ([code]a != b[/code]).
|
|
</constant>
|
|
<constant name="FUNC_GREATER_THAN" value="2" enum="Function">
|
|
Comparison for greater than ([code]a > b[/code]). Cannot be used if [member type] set to [constant CTYPE_BOOLEAN] or [constant CTYPE_TRANSFORM].
|
|
</constant>
|
|
<constant name="FUNC_GREATER_THAN_EQUAL" value="3" enum="Function">
|
|
Comparison for greater than or equal ([code]a >= b[/code]). Cannot be used if [member type] set to [constant CTYPE_BOOLEAN] or [constant CTYPE_TRANSFORM].
|
|
</constant>
|
|
<constant name="FUNC_LESS_THAN" value="4" enum="Function">
|
|
Comparison for less than ([code]a < b[/code]). Cannot be used if [member type] set to [constant CTYPE_BOOLEAN] or [constant CTYPE_TRANSFORM].
|
|
</constant>
|
|
<constant name="FUNC_LESS_THAN_EQUAL" value="5" enum="Function">
|
|
Comparison for less than or equal ([code]a < b[/code]). Cannot be used if [member type] set to [constant CTYPE_BOOLEAN] or [constant CTYPE_TRANSFORM].
|
|
</constant>
|
|
<constant name="COND_ALL" value="0" enum="Condition">
|
|
The result will be true if all of component in vector satisfy the comparison condition.
|
|
</constant>
|
|
<constant name="COND_ANY" value="1" enum="Condition">
|
|
The result will be true if any of component in vector satisfy the comparison condition.
|
|
</constant>
|
|
</constants>
|
|
</class>
|