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
Tree: b51a272459
Branches Tags
godot-docs
/
classes
/
class_bakedlight.rst

class_bakedlight.rst 21 KB
History Raw

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295 
  1. .. Generated automatically by doc/tools/makerst.py in Godot's source tree.
    2. 

  2. .. DO NOT EDIT THIS FILE, but the doc/base/classes.xml source instead.
    3. 

  3. 

  4. .. _class_BakedLight:
    5. 

  5. 

  6. BakedLight
    7. 

  7. ==========
    8. 

  8. 

  9. **Inherits:** :ref:`Resource<class_resource>` **<** :ref:`Reference<class_reference>` **<** :ref:`Object<class_object>`
    10. 

  10. 

  11. **Category:** Core
    12. 

  12. 

  13. Brief Description
    14. 

  14. -----------------
    15. 

  15. 

  16. 

  17. 

  18. Member Functions
    19. 

  19. ----------------
    20. 

  20. 

  21. +----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------+
    22. 

  22. | void                             | :ref:`set_mode<class_BakedLight_set_mode>`  **(** :ref:`int<class_int>` mode  **)**                                                            |
    23. 

  23. +----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------+
    24. 

  24. | :ref:`int<class_int>`            | :ref:`get_mode<class_BakedLight_get_mode>`  **(** **)** const                                                                                  |
    25. 

  25. +----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------+
    26. 

  26. | void                             | :ref:`set_octree<class_BakedLight_set_octree>`  **(** :ref:`RawArray<class_rawarray>` octree  **)**                                            |
    27. 

  27. +----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------+
    28. 

  28. | :ref:`RawArray<class_rawarray>`  | :ref:`get_octree<class_BakedLight_get_octree>`  **(** **)** const                                                                              |
    29. 

  29. +----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------+
    30. 

  30. | void                             | :ref:`set_light<class_BakedLight_set_light>`  **(** :ref:`RawArray<class_rawarray>` light  **)**                                               |
    31. 

  31. +----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------+
    32. 

  32. | :ref:`RawArray<class_rawarray>`  | :ref:`get_light<class_BakedLight_get_light>`  **(** **)** const                                                                                |
    33. 

  33. +----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------+
    34. 

  34. | void                             | :ref:`set_sampler_octree<class_BakedLight_set_sampler_octree>`  **(** :ref:`IntArray<class_intarray>` sampler_octree  **)**                    |
    35. 

  35. +----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------+
    36. 

  36. | :ref:`IntArray<class_intarray>`  | :ref:`get_sampler_octree<class_BakedLight_get_sampler_octree>`  **(** **)** const                                                              |
    37. 

  37. +----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------+
    38. 

  38. | void                             | :ref:`add_lightmap<class_BakedLight_add_lightmap>`  **(** :ref:`Texture<class_texture>` texture, :ref:`Vector2<class_vector2>` gen_size  **)** |
    39. 

  39. +----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------+
    40. 

  40. | void                             | :ref:`erase_lightmap<class_BakedLight_erase_lightmap>`  **(** :ref:`int<class_int>` id  **)**                                                  |
    41. 

  41. +----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------+
    42. 

  42. | void                             | :ref:`clear_lightmaps<class_BakedLight_clear_lightmaps>`  **(** **)**                                                                          |
    43. 

  43. +----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------+
    44. 

  44. | void                             | :ref:`set_cell_subdivision<class_BakedLight_set_cell_subdivision>`  **(** :ref:`int<class_int>` cell_subdivision  **)**                        |
    45. 

  45. +----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------+
    46. 

  46. | :ref:`int<class_int>`            | :ref:`get_cell_subdivision<class_BakedLight_get_cell_subdivision>`  **(** **)** const                                                          |
    47. 

  47. +----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------+
    48. 

  48. | void                             | :ref:`set_initial_lattice_subdiv<class_BakedLight_set_initial_lattice_subdiv>`  **(** :ref:`int<class_int>` cell_subdivision  **)**            |
    49. 

  49. +----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------+
    50. 

  50. | :ref:`int<class_int>`            | :ref:`get_initial_lattice_subdiv<class_BakedLight_get_initial_lattice_subdiv>`  **(** **)** const                                              |
    51. 

  51. +----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------+
    52. 

  52. | void                             | :ref:`set_plot_size<class_BakedLight_set_plot_size>`  **(** :ref:`float<class_float>` plot_size  **)**                                         |
    53. 

  53. +----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------+
    54. 

  54. | :ref:`float<class_float>`        | :ref:`get_plot_size<class_BakedLight_get_plot_size>`  **(** **)** const                                                                        |
    55. 

  55. +----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------+
    56. 

  56. | void                             | :ref:`set_bounces<class_BakedLight_set_bounces>`  **(** :ref:`int<class_int>` bounces  **)**                                                   |
    57. 

  57. +----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------+
    58. 

  58. | :ref:`int<class_int>`            | :ref:`get_bounces<class_BakedLight_get_bounces>`  **(** **)** const                                                                            |
    59. 

  59. +----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------+
    60. 

  60. | void                             | :ref:`set_cell_extra_margin<class_BakedLight_set_cell_extra_margin>`  **(** :ref:`float<class_float>` cell_extra_margin  **)**                 |
    61. 

  61. +----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------+
    62. 

  62. | :ref:`float<class_float>`        | :ref:`get_cell_extra_margin<class_BakedLight_get_cell_extra_margin>`  **(** **)** const                                                        |
    63. 

  63. +----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------+
    64. 

  64. | void                             | :ref:`set_edge_damp<class_BakedLight_set_edge_damp>`  **(** :ref:`float<class_float>` edge_damp  **)**                                         |
    65. 

  65. +----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------+
    66. 

  66. | :ref:`float<class_float>`        | :ref:`get_edge_damp<class_BakedLight_get_edge_damp>`  **(** **)** const                                                                        |
    67. 

  67. +----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------+
    68. 

  68. | void                             | :ref:`set_normal_damp<class_BakedLight_set_normal_damp>`  **(** :ref:`float<class_float>` normal_damp  **)**                                   |
    69. 

  69. +----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------+
    70. 

  70. | :ref:`float<class_float>`        | :ref:`get_normal_damp<class_BakedLight_get_normal_damp>`  **(** **)** const                                                                    |
    71. 

  71. +----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------+
    72. 

  72. | void                             | :ref:`set_tint<class_BakedLight_set_tint>`  **(** :ref:`float<class_float>` tint  **)**                                                        |
    73. 

  73. +----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------+
    74. 

  74. | :ref:`float<class_float>`        | :ref:`get_tint<class_BakedLight_get_tint>`  **(** **)** const                                                                                  |
    75. 

  75. +----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------+
    76. 

  76. | void                             | :ref:`set_saturation<class_BakedLight_set_saturation>`  **(** :ref:`float<class_float>` saturation  **)**                                      |
    77. 

  77. +----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------+
    78. 

  78. | :ref:`float<class_float>`        | :ref:`get_saturation<class_BakedLight_get_saturation>`  **(** **)** const                                                                      |
    79. 

  79. +----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------+
    80. 

  80. | void                             | :ref:`set_ao_radius<class_BakedLight_set_ao_radius>`  **(** :ref:`float<class_float>` ao_radius  **)**                                         |
    81. 

  81. +----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------+
    82. 

  82. | :ref:`float<class_float>`        | :ref:`get_ao_radius<class_BakedLight_get_ao_radius>`  **(** **)** const                                                                        |
    83. 

  83. +----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------+
    84. 

  84. | void                             | :ref:`set_ao_strength<class_BakedLight_set_ao_strength>`  **(** :ref:`float<class_float>` ao_strength  **)**                                   |
    85. 

  85. +----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------+
    86. 

  86. | :ref:`float<class_float>`        | :ref:`get_ao_strength<class_BakedLight_get_ao_strength>`  **(** **)** const                                                                    |
    87. 

  87. +----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------+
    88. 

  88. | void                             | :ref:`set_format<class_BakedLight_set_format>`  **(** :ref:`int<class_int>` format  **)**                                                      |
    89. 

  89. +----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------+
    90. 

  90. | :ref:`int<class_int>`            | :ref:`get_format<class_BakedLight_get_format>`  **(** **)** const                                                                              |
    91. 

  91. +----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------+
    92. 

  92. | void                             | :ref:`set_transfer_lightmaps_only_to_uv2<class_BakedLight_set_transfer_lightmaps_only_to_uv2>`  **(** :ref:`bool<class_bool>` enable  **)**    |
    93. 

  93. +----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------+
    94. 

  94. | :ref:`bool<class_bool>`          | :ref:`get_transfer_lightmaps_only_to_uv2<class_BakedLight_get_transfer_lightmaps_only_to_uv2>`  **(** **)** const                              |
    95. 

  95. +----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------+
    96. 

  96. | void                             | :ref:`set_energy_multiplier<class_BakedLight_set_energy_multiplier>`  **(** :ref:`float<class_float>` energy_multiplier  **)**                 |
    97. 

  97. +----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------+
    98. 

  98. | :ref:`float<class_float>`        | :ref:`get_energy_multiplier<class_BakedLight_get_energy_multiplier>`  **(** **)** const                                                        |
    99. 

  99. +----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------+
    100. 

  100. | void                             | :ref:`set_gamma_adjust<class_BakedLight_set_gamma_adjust>`  **(** :ref:`float<class_float>` gamma_adjust  **)**                                |
    101. 

  101. +----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------+
    102. 

  102. | :ref:`float<class_float>`        | :ref:`get_gamma_adjust<class_BakedLight_get_gamma_adjust>`  **(** **)** const                                                                  |
    103. 

  103. +----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------+
    104. 

  104. | void                             | :ref:`set_bake_flag<class_BakedLight_set_bake_flag>`  **(** :ref:`int<class_int>` flag, :ref:`bool<class_bool>` enabled  **)**                 |
    105. 

  105. +----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------+
    106. 

  106. | :ref:`bool<class_bool>`          | :ref:`get_bake_flag<class_BakedLight_get_bake_flag>`  **(** :ref:`int<class_int>` flag  **)** const                                            |
    107. 

  107. +----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------+
    108. 

  108. 

  109. Numeric Constants
    110. 

  110. -----------------
    111. 

  111. 

  112. - **MODE_OCTREE** = **0**
    113. 

  113. - **MODE_LIGHTMAPS** = **1**
    114. 

  114. - **BAKE_DIFFUSE** = **0**
    115. 

  115. - **BAKE_SPECULAR** = **1**
    116. 

  116. - **BAKE_TRANSLUCENT** = **2**
    117. 

  117. - **BAKE_CONSERVE_ENERGY** = **3**
    118. 

  118. - **BAKE_MAX** = **5**
    119. 

  119. 

  120. Member Function Description
    121. 

  121. ---------------------------
    122. 

  122. 

  123. .. _class_BakedLight_set_mode:
    124. 

  124. 

  125. - void  **set_mode**  **(** :ref:`int<class_int>` mode  **)**
    126. 

  126. 

  127. .. _class_BakedLight_get_mode:
    128. 

  128. 

  129. - :ref:`int<class_int>`  **get_mode**  **(** **)** const
    130. 

  130. 

  131. .. _class_BakedLight_set_octree:
    132. 

  132. 

  133. - void  **set_octree**  **(** :ref:`RawArray<class_rawarray>` octree  **)**
    134. 

  134. 

  135. .. _class_BakedLight_get_octree:
    136. 

  136. 

  137. - :ref:`RawArray<class_rawarray>`  **get_octree**  **(** **)** const
    138. 

  138. 

  139. .. _class_BakedLight_set_light:
    140. 

  140. 

  141. - void  **set_light**  **(** :ref:`RawArray<class_rawarray>` light  **)**
    142. 

  142. 

  143. .. _class_BakedLight_get_light:
    144. 

  144. 

  145. - :ref:`RawArray<class_rawarray>`  **get_light**  **(** **)** const
    146. 

  146. 

  147. .. _class_BakedLight_set_sampler_octree:
    148. 

  148. 

  149. - void  **set_sampler_octree**  **(** :ref:`IntArray<class_intarray>` sampler_octree  **)**
    150. 

  150. 

  151. .. _class_BakedLight_get_sampler_octree:
    152. 

  152. 

  153. - :ref:`IntArray<class_intarray>`  **get_sampler_octree**  **(** **)** const
    154. 

  154. 

  155. .. _class_BakedLight_add_lightmap:
    156. 

  156. 

  157. - void  **add_lightmap**  **(** :ref:`Texture<class_texture>` texture, :ref:`Vector2<class_vector2>` gen_size  **)**
    158. 

  158. 

  159. .. _class_BakedLight_erase_lightmap:
    160. 

  160. 

  161. - void  **erase_lightmap**  **(** :ref:`int<class_int>` id  **)**
    162. 

  162. 

  163. .. _class_BakedLight_clear_lightmaps:
    164. 

  164. 

  165. - void  **clear_lightmaps**  **(** **)**
    166. 

  166. 

  167. .. _class_BakedLight_set_cell_subdivision:
    168. 

  168. 

  169. - void  **set_cell_subdivision**  **(** :ref:`int<class_int>` cell_subdivision  **)**
    170. 

  170. 

  171. .. _class_BakedLight_get_cell_subdivision:
    172. 

  172. 

  173. - :ref:`int<class_int>`  **get_cell_subdivision**  **(** **)** const
    174. 

  174. 

  175. .. _class_BakedLight_set_initial_lattice_subdiv:
    176. 

  176. 

  177. - void  **set_initial_lattice_subdiv**  **(** :ref:`int<class_int>` cell_subdivision  **)**
    178. 

  178. 

  179. .. _class_BakedLight_get_initial_lattice_subdiv:
    180. 

  180. 

  181. - :ref:`int<class_int>`  **get_initial_lattice_subdiv**  **(** **)** const
    182. 

  182. 

  183. .. _class_BakedLight_set_plot_size:
    184. 

  184. 

  185. - void  **set_plot_size**  **(** :ref:`float<class_float>` plot_size  **)**
    186. 

  186. 

  187. .. _class_BakedLight_get_plot_size:
    188. 

  188. 

  189. - :ref:`float<class_float>`  **get_plot_size**  **(** **)** const
    190. 

  190. 

  191. .. _class_BakedLight_set_bounces:
    192. 

  192. 

  193. - void  **set_bounces**  **(** :ref:`int<class_int>` bounces  **)**
    194. 

  194. 

  195. .. _class_BakedLight_get_bounces:
    196. 

  196. 

  197. - :ref:`int<class_int>`  **get_bounces**  **(** **)** const
    198. 

  198. 

  199. .. _class_BakedLight_set_cell_extra_margin:
    200. 

  200. 

  201. - void  **set_cell_extra_margin**  **(** :ref:`float<class_float>` cell_extra_margin  **)**
    202. 

  202. 

  203. .. _class_BakedLight_get_cell_extra_margin:
    204. 

  204. 

  205. - :ref:`float<class_float>`  **get_cell_extra_margin**  **(** **)** const
    206. 

  206. 

  207. .. _class_BakedLight_set_edge_damp:
    208. 

  208. 

  209. - void  **set_edge_damp**  **(** :ref:`float<class_float>` edge_damp  **)**
    210. 

  210. 

  211. .. _class_BakedLight_get_edge_damp:
    212. 

  212. 

  213. - :ref:`float<class_float>`  **get_edge_damp**  **(** **)** const
    214. 

  214. 

  215. .. _class_BakedLight_set_normal_damp:
    216. 

  216. 

  217. - void  **set_normal_damp**  **(** :ref:`float<class_float>` normal_damp  **)**
    218. 

  218. 

  219. .. _class_BakedLight_get_normal_damp:
    220. 

  220. 

  221. - :ref:`float<class_float>`  **get_normal_damp**  **(** **)** const
    222. 

  222. 

  223. .. _class_BakedLight_set_tint:
    224. 

  224. 

  225. - void  **set_tint**  **(** :ref:`float<class_float>` tint  **)**
    226. 

  226. 

  227. .. _class_BakedLight_get_tint:
    228. 

  228. 

  229. - :ref:`float<class_float>`  **get_tint**  **(** **)** const
    230. 

  230. 

  231. .. _class_BakedLight_set_saturation:
    232. 

  232. 

  233. - void  **set_saturation**  **(** :ref:`float<class_float>` saturation  **)**
    234. 

  234. 

  235. .. _class_BakedLight_get_saturation:
    236. 

  236. 

  237. - :ref:`float<class_float>`  **get_saturation**  **(** **)** const
    238. 

  238. 

  239. .. _class_BakedLight_set_ao_radius:
    240. 

  240. 

  241. - void  **set_ao_radius**  **(** :ref:`float<class_float>` ao_radius  **)**
    242. 

  242. 

  243. .. _class_BakedLight_get_ao_radius:
    244. 

  244. 

  245. - :ref:`float<class_float>`  **get_ao_radius**  **(** **)** const
    246. 

  246. 

  247. .. _class_BakedLight_set_ao_strength:
    248. 

  248. 

  249. - void  **set_ao_strength**  **(** :ref:`float<class_float>` ao_strength  **)**
    250. 

  250. 

  251. .. _class_BakedLight_get_ao_strength:
    252. 

  252. 

  253. - :ref:`float<class_float>`  **get_ao_strength**  **(** **)** const
    254. 

  254. 

  255. .. _class_BakedLight_set_format:
    256. 

  256. 

  257. - void  **set_format**  **(** :ref:`int<class_int>` format  **)**
    258. 

  258. 

  259. .. _class_BakedLight_get_format:
    260. 

  260. 

  261. - :ref:`int<class_int>`  **get_format**  **(** **)** const
    262. 

  262. 

  263. .. _class_BakedLight_set_transfer_lightmaps_only_to_uv2:
    264. 

  264. 

  265. - void  **set_transfer_lightmaps_only_to_uv2**  **(** :ref:`bool<class_bool>` enable  **)**
    266. 

  266. 

  267. .. _class_BakedLight_get_transfer_lightmaps_only_to_uv2:
    268. 

  268. 

  269. - :ref:`bool<class_bool>`  **get_transfer_lightmaps_only_to_uv2**  **(** **)** const
    270. 

  270. 

  271. .. _class_BakedLight_set_energy_multiplier:
    272. 

  272. 

  273. - void  **set_energy_multiplier**  **(** :ref:`float<class_float>` energy_multiplier  **)**
    274. 

  274. 

  275. .. _class_BakedLight_get_energy_multiplier:
    276. 

  276. 

  277. - :ref:`float<class_float>`  **get_energy_multiplier**  **(** **)** const
    278. 

  278. 

  279. .. _class_BakedLight_set_gamma_adjust:
    280. 

  280. 

  281. - void  **set_gamma_adjust**  **(** :ref:`float<class_float>` gamma_adjust  **)**
    282. 

  282. 

  283. .. _class_BakedLight_get_gamma_adjust:
    284. 

  284. 

  285. - :ref:`float<class_float>`  **get_gamma_adjust**  **(** **)** const
    286. 

  286. 

  287. .. _class_BakedLight_set_bake_flag:
    288. 

  288. 

  289. - void  **set_bake_flag**  **(** :ref:`int<class_int>` flag, :ref:`bool<class_bool>` enabled  **)**
    290. 

  290. 

  291. .. _class_BakedLight_get_bake_flag:
    292. 

  292. 

  293. - :ref:`bool<class_bool>`  **get_bake_flag**  **(** :ref:`int<class_int>` flag  **)** const
    294. 

  294. 

  295.