class_bakedlightmapdata.rst 6.4 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142
  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 BakedLightmapData.xml source instead.
  4. .. The source is found in doc/classes or modules/<name>/doc_classes.
  5. .. _class_BakedLightmapData:
  6. BakedLightmapData
  7. =================
  8. **Inherits:** :ref:`Resource<class_Resource>` **<** :ref:`Reference<class_Reference>` **<** :ref:`Object<class_Object>`
  9. **Category:** Core
  10. Brief Description
  11. -----------------
  12. Properties
  13. ----------
  14. +-------------------------------------------+------------------------------------------------------------------------------------+
  15. | :ref:`AABB<class_AABB>` | :ref:`bounds<class_BakedLightmapData_property_bounds>` |
  16. +-------------------------------------------+------------------------------------------------------------------------------------+
  17. | :ref:`Transform<class_Transform>` | :ref:`cell_space_transform<class_BakedLightmapData_property_cell_space_transform>` |
  18. +-------------------------------------------+------------------------------------------------------------------------------------+
  19. | :ref:`int<class_int>` | :ref:`cell_subdiv<class_BakedLightmapData_property_cell_subdiv>` |
  20. +-------------------------------------------+------------------------------------------------------------------------------------+
  21. | :ref:`float<class_float>` | :ref:`energy<class_BakedLightmapData_property_energy>` |
  22. +-------------------------------------------+------------------------------------------------------------------------------------+
  23. | :ref:`PoolByteArray<class_PoolByteArray>` | :ref:`octree<class_BakedLightmapData_property_octree>` |
  24. +-------------------------------------------+------------------------------------------------------------------------------------+
  25. Methods
  26. -------
  27. +---------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  28. | void | :ref:`add_user<class_BakedLightmapData_method_add_user>` **(** :ref:`NodePath<class_NodePath>` path, :ref:`Texture<class_Texture>` lightmap, :ref:`int<class_int>` instance **)** |
  29. +---------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  30. | void | :ref:`clear_users<class_BakedLightmapData_method_clear_users>` **(** **)** |
  31. +---------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  32. | :ref:`int<class_int>` | :ref:`get_user_count<class_BakedLightmapData_method_get_user_count>` **(** **)** const |
  33. +---------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  34. | :ref:`Texture<class_Texture>` | :ref:`get_user_lightmap<class_BakedLightmapData_method_get_user_lightmap>` **(** :ref:`int<class_int>` user_idx **)** const |
  35. +---------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  36. | :ref:`NodePath<class_NodePath>` | :ref:`get_user_path<class_BakedLightmapData_method_get_user_path>` **(** :ref:`int<class_int>` user_idx **)** const |
  37. +---------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  38. Property Descriptions
  39. ---------------------
  40. .. _class_BakedLightmapData_property_bounds:
  41. - :ref:`AABB<class_AABB>` **bounds**
  42. +----------+-------------------+
  43. | *Setter* | set_bounds(value) |
  44. +----------+-------------------+
  45. | *Getter* | get_bounds() |
  46. +----------+-------------------+
  47. ----
  48. .. _class_BakedLightmapData_property_cell_space_transform:
  49. - :ref:`Transform<class_Transform>` **cell_space_transform**
  50. +----------+---------------------------------+
  51. | *Setter* | set_cell_space_transform(value) |
  52. +----------+---------------------------------+
  53. | *Getter* | get_cell_space_transform() |
  54. +----------+---------------------------------+
  55. ----
  56. .. _class_BakedLightmapData_property_cell_subdiv:
  57. - :ref:`int<class_int>` **cell_subdiv**
  58. +----------+------------------------+
  59. | *Setter* | set_cell_subdiv(value) |
  60. +----------+------------------------+
  61. | *Getter* | get_cell_subdiv() |
  62. +----------+------------------------+
  63. ----
  64. .. _class_BakedLightmapData_property_energy:
  65. - :ref:`float<class_float>` **energy**
  66. +----------+-------------------+
  67. | *Setter* | set_energy(value) |
  68. +----------+-------------------+
  69. | *Getter* | get_energy() |
  70. +----------+-------------------+
  71. ----
  72. .. _class_BakedLightmapData_property_octree:
  73. - :ref:`PoolByteArray<class_PoolByteArray>` **octree**
  74. +----------+-------------------+
  75. | *Setter* | set_octree(value) |
  76. +----------+-------------------+
  77. | *Getter* | get_octree() |
  78. +----------+-------------------+
  79. Method Descriptions
  80. -------------------
  81. .. _class_BakedLightmapData_method_add_user:
  82. - void **add_user** **(** :ref:`NodePath<class_NodePath>` path, :ref:`Texture<class_Texture>` lightmap, :ref:`int<class_int>` instance **)**
  83. ----
  84. .. _class_BakedLightmapData_method_clear_users:
  85. - void **clear_users** **(** **)**
  86. ----
  87. .. _class_BakedLightmapData_method_get_user_count:
  88. - :ref:`int<class_int>` **get_user_count** **(** **)** const
  89. ----
  90. .. _class_BakedLightmapData_method_get_user_lightmap:
  91. - :ref:`Texture<class_Texture>` **get_user_lightmap** **(** :ref:`int<class_int>` user_idx **)** const
  92. ----
  93. .. _class_BakedLightmapData_method_get_user_path:
  94. - :ref:`NodePath<class_NodePath>` **get_user_path** **(** :ref:`int<class_int>` user_idx **)** const