Home Explore Help
Sign In
Godot
/
godot-docs
mirror of https://github.com/godotengine/godot-docs.git
2
0
Fork 0
Files Issues 0 Wiki
Branch: master
Branches Tags
godot-docs
/
classes
/
class_pointmesh.rst

class_pointmesh.rst 2.6 KB
Permalink History Raw

123456789101112131415161718192021222324252627282930313233343536 
  1. :github_url: hide
    2. 

  2. 

  3. .. DO NOT EDIT THIS FILE!!!
    4. 

  4. .. Generated automatically from Godot engine sources.
    5. 

  5. .. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py.
    6. 

  6. .. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/PointMesh.xml.
    7. 

  7. 

  8. .. _class_PointMesh:
    9. 

  9. 

  10. PointMesh
    11. 

  11. =========
    12. 

  12. 

  13. **Inherits:** :ref:`PrimitiveMesh<class_PrimitiveMesh>` **<** :ref:`Mesh<class_Mesh>` **<** :ref:`Resource<class_Resource>` **<** :ref:`RefCounted<class_RefCounted>` **<** :ref:`Object<class_Object>`
    14. 

  14. 

  15. Mesh with a single point primitive.
    16. 

  16. 

  17. .. rst-class:: classref-introduction-group
    18. 

  18. 

  19. Description
    20. 

  20. -----------
    21. 

  21. 

  22. A **PointMesh** is a primitive mesh composed of 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 also be used as a cheap way to render billboarded sprites (for example in a point cloud).
    23. 

  23. 

  24. In order to be displayed, point meshes must be used with a material that has a point size. The point size can be accessed in a shader with the ``POINT_SIZE`` built-in, or in a :ref:`BaseMaterial3D<class_BaseMaterial3D>` by setting the :ref:`BaseMaterial3D.use_point_size<class_BaseMaterial3D_property_use_point_size>` and :ref:`BaseMaterial3D.point_size<class_BaseMaterial3D_property_point_size>` properties.
    25. 

  25. 

  26. \ **Note:** When using point meshes, properties that normally affect vertices will be ignored, including :ref:`BaseMaterial3D.billboard_mode<class_BaseMaterial3D_property_billboard_mode>`, :ref:`BaseMaterial3D.grow<class_BaseMaterial3D_property_grow>`, and :ref:`BaseMaterial3D.cull_mode<class_BaseMaterial3D_property_cull_mode>`.
    27. 

  27. 

  28. .. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)`
    29. 

  29. .. |required| replace:: :abbr:`required (This method is required to be overridden when extending its base class.)`
    30. 

  30. .. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)`
    31. 

  31. .. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)`
    32. 

  32. .. |constructor| replace:: :abbr:`constructor (This method is used to construct a type.)`
    33. 

  33. .. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)`
    34. 

  34. .. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)`
    35. 

  35. .. |bitfield| replace:: :abbr:`BitField (This value is an integer composed as a bitmask of the following flags.)`
    36. 

  36. .. |void| replace:: :abbr:`void (No return value.)`
    37.