class_bakedlightmapdata.rst 6.1 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124
  1. .. Generated automatically by doc/tools/makerst.py in Godot's source tree.
  2. .. DO NOT EDIT THIS FILE, but the BakedLightmapData.xml source instead.
  3. .. The source is found in doc/classes or modules/<name>/doc_classes.
  4. .. _class_BakedLightmapData:
  5. BakedLightmapData
  6. =================
  7. **Inherits:** :ref:`Resource<class_Resource>` **<** :ref:`Reference<class_Reference>` **<** :ref:`Object<class_Object>`
  8. **Category:** Core
  9. Brief Description
  10. -----------------
  11. Properties
  12. ----------
  13. +-------------------------------------------+---------------------------------------------------------------------------+
  14. | :ref:`AABB<class_AABB>` | :ref:`bounds<class_BakedLightmapData_bounds>` |
  15. +-------------------------------------------+---------------------------------------------------------------------------+
  16. | :ref:`Transform<class_Transform>` | :ref:`cell_space_transform<class_BakedLightmapData_cell_space_transform>` |
  17. +-------------------------------------------+---------------------------------------------------------------------------+
  18. | :ref:`int<class_int>` | :ref:`cell_subdiv<class_BakedLightmapData_cell_subdiv>` |
  19. +-------------------------------------------+---------------------------------------------------------------------------+
  20. | :ref:`float<class_float>` | :ref:`energy<class_BakedLightmapData_energy>` |
  21. +-------------------------------------------+---------------------------------------------------------------------------+
  22. | :ref:`PoolByteArray<class_PoolByteArray>` | :ref:`octree<class_BakedLightmapData_octree>` |
  23. +-------------------------------------------+---------------------------------------------------------------------------+
  24. Methods
  25. -------
  26. +----------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  27. | void | :ref:`add_user<class_BakedLightmapData_add_user>` **(** :ref:`NodePath<class_NodePath>` path, :ref:`Texture<class_Texture>` lightmap, :ref:`int<class_int>` instance **)** |
  28. +----------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  29. | void | :ref:`clear_users<class_BakedLightmapData_clear_users>` **(** **)** |
  30. +----------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  31. | :ref:`int<class_int>` | :ref:`get_user_count<class_BakedLightmapData_get_user_count>` **(** **)** const |
  32. +----------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  33. | :ref:`Texture<class_Texture>` | :ref:`get_user_lightmap<class_BakedLightmapData_get_user_lightmap>` **(** :ref:`int<class_int>` user_idx **)** const |
  34. +----------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  35. | :ref:`NodePath<class_NodePath>` | :ref:`get_user_path<class_BakedLightmapData_get_user_path>` **(** :ref:`int<class_int>` user_idx **)** const |
  36. +----------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  37. Property Descriptions
  38. ---------------------
  39. .. _class_BakedLightmapData_bounds:
  40. - :ref:`AABB<class_AABB>` **bounds**
  41. +----------+-------------------+
  42. | *Setter* | set_bounds(value) |
  43. +----------+-------------------+
  44. | *Getter* | get_bounds() |
  45. +----------+-------------------+
  46. .. _class_BakedLightmapData_cell_space_transform:
  47. - :ref:`Transform<class_Transform>` **cell_space_transform**
  48. +----------+---------------------------------+
  49. | *Setter* | set_cell_space_transform(value) |
  50. +----------+---------------------------------+
  51. | *Getter* | get_cell_space_transform() |
  52. +----------+---------------------------------+
  53. .. _class_BakedLightmapData_cell_subdiv:
  54. - :ref:`int<class_int>` **cell_subdiv**
  55. +----------+------------------------+
  56. | *Setter* | set_cell_subdiv(value) |
  57. +----------+------------------------+
  58. | *Getter* | get_cell_subdiv() |
  59. +----------+------------------------+
  60. .. _class_BakedLightmapData_energy:
  61. - :ref:`float<class_float>` **energy**
  62. +----------+-------------------+
  63. | *Setter* | set_energy(value) |
  64. +----------+-------------------+
  65. | *Getter* | get_energy() |
  66. +----------+-------------------+
  67. .. _class_BakedLightmapData_octree:
  68. - :ref:`PoolByteArray<class_PoolByteArray>` **octree**
  69. +----------+-------------------+
  70. | *Setter* | set_octree(value) |
  71. +----------+-------------------+
  72. | *Getter* | get_octree() |
  73. +----------+-------------------+
  74. Method Descriptions
  75. -------------------
  76. .. _class_BakedLightmapData_add_user:
  77. - void **add_user** **(** :ref:`NodePath<class_NodePath>` path, :ref:`Texture<class_Texture>` lightmap, :ref:`int<class_int>` instance **)**
  78. .. _class_BakedLightmapData_clear_users:
  79. - void **clear_users** **(** **)**
  80. .. _class_BakedLightmapData_get_user_count:
  81. - :ref:`int<class_int>` **get_user_count** **(** **)** const
  82. .. _class_BakedLightmapData_get_user_lightmap:
  83. - :ref:`Texture<class_Texture>` **get_user_lightmap** **(** :ref:`int<class_int>` user_idx **)** const
  84. .. _class_BakedLightmapData_get_user_path:
  85. - :ref:`NodePath<class_NodePath>` **get_user_path** **(** :ref:`int<class_int>` user_idx **)** const