diff options
| author | Rémi Verschelde <remi@verschelde.fr> | 2021-05-31 12:23:01 +0200 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2021-05-31 12:23:01 +0200 |
| commit | 4e3d5148ff8a26b96b2ebc035ff46753f6704dd8 (patch) | |
| tree | 9e73cdb181a27f0a1fb6f4df8746c71b68ece447 /doc | |
| parent | 1d35a35d4f6ddf2e0d4af517b1dd3ee0d273c56e (diff) | |
| parent | f06db8b77871cbb9d5d3c0fe5090a8885bb90efd (diff) | |
Merge pull request #49157 from Chaosus/vs_billboard
Added Billboard Node to Visual Shaders
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/classes/VisualShaderNodeBillboard.xml | 38 |
1 files changed, 38 insertions, 0 deletions
diff --git a/doc/classes/VisualShaderNodeBillboard.xml b/doc/classes/VisualShaderNodeBillboard.xml new file mode 100644 index 0000000000..53bcfa7b5c --- /dev/null +++ b/doc/classes/VisualShaderNodeBillboard.xml @@ -0,0 +1,38 @@ +<?xml version="1.0" encoding="UTF-8" ?> +<class name="VisualShaderNodeBillboard" inherits="VisualShaderNode" version="4.0"> + <brief_description> + A node that controls how the object faces the camera to be used within the visual shader graph. + </brief_description> + <description> + The output port of this node needs to be connected to [code]Model View Matrix[/code] port of [VisualShaderNodeOutput]. + </description> + <tutorials> + </tutorials> + <methods> + </methods> + <members> + <member name="billboard_type" type="int" setter="set_billboard_type" getter="get_billboard_type" enum="VisualShaderNodeBillboard.BillboardType" default="1"> + Controls how the object faces the camera. See [enum BillboardType]. + </member> + <member name="keep_scale" type="bool" setter="set_keep_scale_enabled" getter="is_keep_scale_enabled" default="false"> + If [code]true[/code], the shader will keep the scale set for the mesh. Otherwise, the scale is lost when billboarding. + </member> + </members> + <constants> + <constant name="BILLBOARD_TYPE_DISABLED" value="0" enum="BillboardType"> + Billboarding is disabled and the node does nothing. + </constant> + <constant name="BILLBOARD_TYPE_ENABLED" value="1" enum="BillboardType"> + A standard billboarding algorithm is enabled. + </constant> + <constant name="BILLBOARD_TYPE_FIXED_Y" value="2" enum="BillboardType"> + A billboarding algorithm to rotate around Y-axis is enabled. + </constant> + <constant name="BILLBOARD_TYPE_PARTICLES" value="3" enum="BillboardType"> + A billboarding algorithm designed to use on particles is enabled. + </constant> + <constant name="BILLBOARD_TYPE_MAX" value="4" enum="BillboardType"> + Represents the size of the [enum BillboardType] enum. + </constant> + </constants> +</class> |