Files
godot-docs/classes/class_gpuparticlescollisionsdf.rst
T

125 lines
4.8 KiB
ReStructuredText

:github_url: hide
.. Generated automatically by doc/tools/makerst.py in Godot's source tree.
.. DO NOT EDIT THIS FILE, but the GPUParticlesCollisionSDF.xml source instead.
.. The source is found in doc/classes or modules/<name>/doc_classes.
.. _class_GPUParticlesCollisionSDF:
GPUParticlesCollisionSDF
========================
**Inherits:** :ref:`GPUParticlesCollision3D<class_GPUParticlesCollision3D>` **<** :ref:`VisualInstance3D<class_VisualInstance3D>` **<** :ref:`Node3D<class_Node3D>` **<** :ref:`Node<class_Node>` **<** :ref:`Object<class_Object>`
Properties
----------
+-------------------------------------------------------------+-----------------------------------------------------------------------+----------------------+
| :ref:`Vector3<class_Vector3>` | :ref:`extents<class_GPUParticlesCollisionSDF_property_extents>` | ``Vector3(1, 1, 1)`` |
+-------------------------------------------------------------+-----------------------------------------------------------------------+----------------------+
| :ref:`Resolution<enum_GPUParticlesCollisionSDF_Resolution>` | :ref:`resolution<class_GPUParticlesCollisionSDF_property_resolution>` | ``2`` |
+-------------------------------------------------------------+-----------------------------------------------------------------------+----------------------+
| :ref:`Texture3D<class_Texture3D>` | :ref:`texture<class_GPUParticlesCollisionSDF_property_texture>` | |
+-------------------------------------------------------------+-----------------------------------------------------------------------+----------------------+
| :ref:`float<class_float>` | :ref:`thickness<class_GPUParticlesCollisionSDF_property_thickness>` | ``1.0`` |
+-------------------------------------------------------------+-----------------------------------------------------------------------+----------------------+
Enumerations
------------
.. _enum_GPUParticlesCollisionSDF_Resolution:
.. _class_GPUParticlesCollisionSDF_constant_RESOLUTION_16:
.. _class_GPUParticlesCollisionSDF_constant_RESOLUTION_32:
.. _class_GPUParticlesCollisionSDF_constant_RESOLUTION_64:
.. _class_GPUParticlesCollisionSDF_constant_RESOLUTION_128:
.. _class_GPUParticlesCollisionSDF_constant_RESOLUTION_256:
.. _class_GPUParticlesCollisionSDF_constant_RESOLUTION_512:
.. _class_GPUParticlesCollisionSDF_constant_RESOLUTION_MAX:
enum **Resolution**:
- **RESOLUTION_16** = **0**
- **RESOLUTION_32** = **1**
- **RESOLUTION_64** = **2**
- **RESOLUTION_128** = **3**
- **RESOLUTION_256** = **4**
- **RESOLUTION_512** = **5**
- **RESOLUTION_MAX** = **6**
Property Descriptions
---------------------
.. _class_GPUParticlesCollisionSDF_property_extents:
- :ref:`Vector3<class_Vector3>` **extents**
+-----------+----------------------+
| *Default* | ``Vector3(1, 1, 1)`` |
+-----------+----------------------+
| *Setter* | set_extents(value) |
+-----------+----------------------+
| *Getter* | get_extents() |
+-----------+----------------------+
----
.. _class_GPUParticlesCollisionSDF_property_resolution:
- :ref:`Resolution<enum_GPUParticlesCollisionSDF_Resolution>` **resolution**
+-----------+-----------------------+
| *Default* | ``2`` |
+-----------+-----------------------+
| *Setter* | set_resolution(value) |
+-----------+-----------------------+
| *Getter* | get_resolution() |
+-----------+-----------------------+
----
.. _class_GPUParticlesCollisionSDF_property_texture:
- :ref:`Texture3D<class_Texture3D>` **texture**
+----------+--------------------+
| *Setter* | set_texture(value) |
+----------+--------------------+
| *Getter* | get_texture() |
+----------+--------------------+
----
.. _class_GPUParticlesCollisionSDF_property_thickness:
- :ref:`float<class_float>` **thickness**
+-----------+----------------------+
| *Default* | ``1.0`` |
+-----------+----------------------+
| *Setter* | set_thickness(value) |
+-----------+----------------------+
| *Getter* | get_thickness() |
+-----------+----------------------+
.. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)`
.. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)`
.. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)`
.. |constructor| replace:: :abbr:`constructor (This method is used to construct a type.)`
.. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)`
.. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)`