class_pointmesh.rst 1.3 KB

123456789101112131415161718192021222324
  1. :github_url: hide
  2. .. Generated automatically by doc/tools/makerst.py in Godot's source tree.
  3. .. DO NOT EDIT THIS FILE, but the PointMesh.xml source instead.
  4. .. The source is found in doc/classes or modules/<name>/doc_classes.
  5. .. _class_PointMesh:
  6. PointMesh
  7. =========
  8. **Inherits:** :ref:`PrimitiveMesh<class_PrimitiveMesh>` **<** :ref:`Mesh<class_Mesh>` **<** :ref:`Resource<class_Resource>` **<** :ref:`Reference<class_Reference>` **<** :ref:`Object<class_Object>`
  9. Mesh with a single Point primitive.
  10. Description
  11. -----------
  12. The PointMesh is made from a single point. Instead of relying on triangles, points are rendered as a single rectangle on the screen with a constant size. They are intended to be used with Particle systems, but can be used as a cheap way to render constant size billboarded sprites (for example in a point cloud).
  13. PointMeshes, must be used with a material that has a point size. Point size can be accessed in a shader with ``POINT_SIZE``, or in a :ref:`BaseMaterial3D<class_BaseMaterial3D>` by setting :ref:`BaseMaterial3D.use_point_size<class_BaseMaterial3D_property_use_point_size>` and the variable :ref:`BaseMaterial3D.point_size<class_BaseMaterial3D_property_point_size>`.
  14. When using PointMeshes, properties that normally alter vertices will be ignored, including billboard mode, grow, and cull face.