Home Explore Help
Sign In
godotengine
/
godot-docs
mirror of https://github.com/godotengine/godot-docs
Watch 1
Star 1
Fork 0
Files
Branch: revert-8997-patch-1
Branches Tags
godot-docs
/
classes
/
class_lightmapprobe.rst

class_lightmapprobe.rst 2.1 KB
Permalink History Raw

123456789101112131415161718192021222324252627282930313233 
  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/LightmapProbe.xml.
    7. 

  7. 

  8. .. _class_LightmapProbe:
    9. 

  9. 

  10. LightmapProbe
    11. 

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

  12. 

  13. **Inherits:** :ref:`Node3D<class_Node3D>` **<** :ref:`Node<class_Node>` **<** :ref:`Object<class_Object>`
    14. 

  14. 

  15. Represents a single manually placed probe for dynamic object lighting with :ref:`LightmapGI<class_LightmapGI>`.
    16. 

  16. 

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

  18. 

  19. Description
    20. 

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

  21. 

  22. **LightmapProbe** represents the position of a single manually placed probe for dynamic object lighting with :ref:`LightmapGI<class_LightmapGI>`.
    23. 

  23. 

  24. Typically, :ref:`LightmapGI<class_LightmapGI>` probes are placed automatically by setting :ref:`LightmapGI.generate_probes_subdiv<class_LightmapGI_property_generate_probes_subdiv>` to a value other than :ref:`LightmapGI.GENERATE_PROBES_DISABLED<class_LightmapGI_constant_GENERATE_PROBES_DISABLED>`. By creating **LightmapProbe** nodes before baking lightmaps, you can add more probes in specific areas for greater detail, or disable automatic generation and rely only on manually placed probes instead.
    25. 

  25. 

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

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

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

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

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

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

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

  33.