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_light2d.rst

class_light2d.rst 16 KB
History Raw

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250 
  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_Light2D:
    5. 

  5. 

  6. Light2D
    7. 

  7. =======
    8. 

  8. 

  9. **Inherits:** :ref:`Node2D<class_node2d>` **<** :ref:`CanvasItem<class_canvasitem>` **<** :ref:`Node<class_node>` **<** :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_enabled<class_Light2D_set_enabled>`  **(** :ref:`bool<class_bool>` enabled  **)**                                  |
    23. 

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

  24. | :ref:`bool<class_bool>`        | :ref:`is_enabled<class_Light2D_is_enabled>`  **(** **)** const                                                               |
    25. 

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

  26. | void                           | :ref:`set_texture<class_Light2D_set_texture>`  **(** :ref:`Object<class_object>` texture  **)**                              |
    27. 

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

  28. | :ref:`Object<class_object>`    | :ref:`get_texture<class_Light2D_get_texture>`  **(** **)** const                                                             |
    29. 

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

  30. | void                           | :ref:`set_texture_offset<class_Light2D_set_texture_offset>`  **(** :ref:`Vector2<class_vector2>` texture_offset  **)**       |
    31. 

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

  32. | :ref:`Vector2<class_vector2>`  | :ref:`get_texture_offset<class_Light2D_get_texture_offset>`  **(** **)** const                                               |
    33. 

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

  34. | void                           | :ref:`set_color<class_Light2D_set_color>`  **(** :ref:`Color<class_color>` color  **)**                                      |
    35. 

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

  36. | :ref:`Color<class_color>`      | :ref:`get_color<class_Light2D_get_color>`  **(** **)** const                                                                 |
    37. 

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

  38. | void                           | :ref:`set_height<class_Light2D_set_height>`  **(** :ref:`float<class_float>` height  **)**                                   |
    39. 

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

  40. | :ref:`float<class_float>`      | :ref:`get_height<class_Light2D_get_height>`  **(** **)** const                                                               |
    41. 

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

  42. | void                           | :ref:`set_energy<class_Light2D_set_energy>`  **(** :ref:`float<class_float>` energy  **)**                                   |
    43. 

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

  44. | :ref:`float<class_float>`      | :ref:`get_energy<class_Light2D_get_energy>`  **(** **)** const                                                               |
    45. 

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

  46. | void                           | :ref:`set_texture_scale<class_Light2D_set_texture_scale>`  **(** :ref:`float<class_float>` texture_scale  **)**              |
    47. 

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

  48. | :ref:`float<class_float>`      | :ref:`get_texture_scale<class_Light2D_get_texture_scale>`  **(** **)** const                                                 |
    49. 

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

  50. | void                           | :ref:`set_z_range_min<class_Light2D_set_z_range_min>`  **(** :ref:`int<class_int>` z  **)**                                  |
    51. 

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

  52. | :ref:`int<class_int>`          | :ref:`get_z_range_min<class_Light2D_get_z_range_min>`  **(** **)** const                                                     |
    53. 

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

  54. | void                           | :ref:`set_z_range_max<class_Light2D_set_z_range_max>`  **(** :ref:`int<class_int>` z  **)**                                  |
    55. 

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

  56. | :ref:`int<class_int>`          | :ref:`get_z_range_max<class_Light2D_get_z_range_max>`  **(** **)** const                                                     |
    57. 

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

  58. | void                           | :ref:`set_layer_range_min<class_Light2D_set_layer_range_min>`  **(** :ref:`int<class_int>` layer  **)**                      |
    59. 

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

  60. | :ref:`int<class_int>`          | :ref:`get_layer_range_min<class_Light2D_get_layer_range_min>`  **(** **)** const                                             |
    61. 

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

  62. | void                           | :ref:`set_layer_range_max<class_Light2D_set_layer_range_max>`  **(** :ref:`int<class_int>` layer  **)**                      |
    63. 

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

  64. | :ref:`int<class_int>`          | :ref:`get_layer_range_max<class_Light2D_get_layer_range_max>`  **(** **)** const                                             |
    65. 

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

  66. | void                           | :ref:`set_item_mask<class_Light2D_set_item_mask>`  **(** :ref:`int<class_int>` item_mask  **)**                              |
    67. 

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

  68. | :ref:`int<class_int>`          | :ref:`get_item_mask<class_Light2D_get_item_mask>`  **(** **)** const                                                         |
    69. 

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

  70. | void                           | :ref:`set_item_shadow_mask<class_Light2D_set_item_shadow_mask>`  **(** :ref:`int<class_int>` item_shadow_mask  **)**         |
    71. 

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

  72. | :ref:`int<class_int>`          | :ref:`get_item_shadow_mask<class_Light2D_get_item_shadow_mask>`  **(** **)** const                                           |
    73. 

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

  74. | void                           | :ref:`set_mode<class_Light2D_set_mode>`  **(** :ref:`int<class_int>` mode  **)**                                             |
    75. 

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

  76. | :ref:`int<class_int>`          | :ref:`get_mode<class_Light2D_get_mode>`  **(** **)** const                                                                   |
    77. 

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

  78. | void                           | :ref:`set_shadow_enabled<class_Light2D_set_shadow_enabled>`  **(** :ref:`bool<class_bool>` enabled  **)**                    |
    79. 

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

  80. | :ref:`bool<class_bool>`        | :ref:`is_shadow_enabled<class_Light2D_is_shadow_enabled>`  **(** **)** const                                                 |
    81. 

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

  82. | void                           | :ref:`set_shadow_buffer_size<class_Light2D_set_shadow_buffer_size>`  **(** :ref:`int<class_int>` size  **)**                 |
    83. 

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

  84. | :ref:`int<class_int>`          | :ref:`get_shadow_buffer_size<class_Light2D_get_shadow_buffer_size>`  **(** **)** const                                       |
    85. 

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

  86. | void                           | :ref:`set_shadow_esm_multiplier<class_Light2D_set_shadow_esm_multiplier>`  **(** :ref:`float<class_float>` multiplier  **)** |
    87. 

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

  88. | :ref:`float<class_float>`      | :ref:`get_shadow_esm_multiplier<class_Light2D_get_shadow_esm_multiplier>`  **(** **)** const                                 |
    89. 

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

  90. | void                           | :ref:`set_shadow_color<class_Light2D_set_shadow_color>`  **(** :ref:`Color<class_color>` shadow_color  **)**                 |
    91. 

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

  92. | :ref:`Color<class_color>`      | :ref:`get_shadow_color<class_Light2D_get_shadow_color>`  **(** **)** const                                                   |
    93. 

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

  94. 

  95. Numeric Constants
    96. 

  96. -----------------
    97. 

  97. 

  98. - **MODE_ADD** = **0**
    99. 

  99. - **MODE_SUB** = **1**
    100. 

  100. - **MODE_MIX** = **2**
    101. 

  101. - **MODE_MASK** = **3**
    102. 

  102. 

  103. Member Function Description
    104. 

  104. ---------------------------
    105. 

  105. 

  106. .. _class_Light2D_set_enabled:
    107. 

  107. 

  108. - void  **set_enabled**  **(** :ref:`bool<class_bool>` enabled  **)**
    109. 

  109. 

  110. .. _class_Light2D_is_enabled:
    111. 

  111. 

  112. - :ref:`bool<class_bool>`  **is_enabled**  **(** **)** const
    113. 

  113. 

  114. .. _class_Light2D_set_texture:
    115. 

  115. 

  116. - void  **set_texture**  **(** :ref:`Object<class_object>` texture  **)**
    117. 

  117. 

  118. .. _class_Light2D_get_texture:
    119. 

  119. 

  120. - :ref:`Object<class_object>`  **get_texture**  **(** **)** const
    121. 

  121. 

  122. .. _class_Light2D_set_texture_offset:
    123. 

  123. 

  124. - void  **set_texture_offset**  **(** :ref:`Vector2<class_vector2>` texture_offset  **)**
    125. 

  125. 

  126. .. _class_Light2D_get_texture_offset:
    127. 

  127. 

  128. - :ref:`Vector2<class_vector2>`  **get_texture_offset**  **(** **)** const
    129. 

  129. 

  130. .. _class_Light2D_set_color:
    131. 

  131. 

  132. - void  **set_color**  **(** :ref:`Color<class_color>` color  **)**
    133. 

  133. 

  134. .. _class_Light2D_get_color:
    135. 

  135. 

  136. - :ref:`Color<class_color>`  **get_color**  **(** **)** const
    137. 

  137. 

  138. .. _class_Light2D_set_height:
    139. 

  139. 

  140. - void  **set_height**  **(** :ref:`float<class_float>` height  **)**
    141. 

  141. 

  142. .. _class_Light2D_get_height:
    143. 

  143. 

  144. - :ref:`float<class_float>`  **get_height**  **(** **)** const
    145. 

  145. 

  146. .. _class_Light2D_set_energy:
    147. 

  147. 

  148. - void  **set_energy**  **(** :ref:`float<class_float>` energy  **)**
    149. 

  149. 

  150. .. _class_Light2D_get_energy:
    151. 

  151. 

  152. - :ref:`float<class_float>`  **get_energy**  **(** **)** const
    153. 

  153. 

  154. .. _class_Light2D_set_texture_scale:
    155. 

  155. 

  156. - void  **set_texture_scale**  **(** :ref:`float<class_float>` texture_scale  **)**
    157. 

  157. 

  158. .. _class_Light2D_get_texture_scale:
    159. 

  159. 

  160. - :ref:`float<class_float>`  **get_texture_scale**  **(** **)** const
    161. 

  161. 

  162. .. _class_Light2D_set_z_range_min:
    163. 

  163. 

  164. - void  **set_z_range_min**  **(** :ref:`int<class_int>` z  **)**
    165. 

  165. 

  166. .. _class_Light2D_get_z_range_min:
    167. 

  167. 

  168. - :ref:`int<class_int>`  **get_z_range_min**  **(** **)** const
    169. 

  169. 

  170. .. _class_Light2D_set_z_range_max:
    171. 

  171. 

  172. - void  **set_z_range_max**  **(** :ref:`int<class_int>` z  **)**
    173. 

  173. 

  174. .. _class_Light2D_get_z_range_max:
    175. 

  175. 

  176. - :ref:`int<class_int>`  **get_z_range_max**  **(** **)** const
    177. 

  177. 

  178. .. _class_Light2D_set_layer_range_min:
    179. 

  179. 

  180. - void  **set_layer_range_min**  **(** :ref:`int<class_int>` layer  **)**
    181. 

  181. 

  182. .. _class_Light2D_get_layer_range_min:
    183. 

  183. 

  184. - :ref:`int<class_int>`  **get_layer_range_min**  **(** **)** const
    185. 

  185. 

  186. .. _class_Light2D_set_layer_range_max:
    187. 

  187. 

  188. - void  **set_layer_range_max**  **(** :ref:`int<class_int>` layer  **)**
    189. 

  189. 

  190. .. _class_Light2D_get_layer_range_max:
    191. 

  191. 

  192. - :ref:`int<class_int>`  **get_layer_range_max**  **(** **)** const
    193. 

  193. 

  194. .. _class_Light2D_set_item_mask:
    195. 

  195. 

  196. - void  **set_item_mask**  **(** :ref:`int<class_int>` item_mask  **)**
    197. 

  197. 

  198. .. _class_Light2D_get_item_mask:
    199. 

  199. 

  200. - :ref:`int<class_int>`  **get_item_mask**  **(** **)** const
    201. 

  201. 

  202. .. _class_Light2D_set_item_shadow_mask:
    203. 

  203. 

  204. - void  **set_item_shadow_mask**  **(** :ref:`int<class_int>` item_shadow_mask  **)**
    205. 

  205. 

  206. .. _class_Light2D_get_item_shadow_mask:
    207. 

  207. 

  208. - :ref:`int<class_int>`  **get_item_shadow_mask**  **(** **)** const
    209. 

  209. 

  210. .. _class_Light2D_set_mode:
    211. 

  211. 

  212. - void  **set_mode**  **(** :ref:`int<class_int>` mode  **)**
    213. 

  213. 

  214. .. _class_Light2D_get_mode:
    215. 

  215. 

  216. - :ref:`int<class_int>`  **get_mode**  **(** **)** const
    217. 

  217. 

  218. .. _class_Light2D_set_shadow_enabled:
    219. 

  219. 

  220. - void  **set_shadow_enabled**  **(** :ref:`bool<class_bool>` enabled  **)**
    221. 

  221. 

  222. .. _class_Light2D_is_shadow_enabled:
    223. 

  223. 

  224. - :ref:`bool<class_bool>`  **is_shadow_enabled**  **(** **)** const
    225. 

  225. 

  226. .. _class_Light2D_set_shadow_buffer_size:
    227. 

  227. 

  228. - void  **set_shadow_buffer_size**  **(** :ref:`int<class_int>` size  **)**
    229. 

  229. 

  230. .. _class_Light2D_get_shadow_buffer_size:
    231. 

  231. 

  232. - :ref:`int<class_int>`  **get_shadow_buffer_size**  **(** **)** const
    233. 

  233. 

  234. .. _class_Light2D_set_shadow_esm_multiplier:
    235. 

  235. 

  236. - void  **set_shadow_esm_multiplier**  **(** :ref:`float<class_float>` multiplier  **)**
    237. 

  237. 

  238. .. _class_Light2D_get_shadow_esm_multiplier:
    239. 

  239. 

  240. - :ref:`float<class_float>`  **get_shadow_esm_multiplier**  **(** **)** const
    241. 

  241. 

  242. .. _class_Light2D_set_shadow_color:
    243. 

  243. 

  244. - void  **set_shadow_color**  **(** :ref:`Color<class_color>` shadow_color  **)**
    245. 

  245. 

  246. .. _class_Light2D_get_shadow_color:
    247. 

  247. 

  248. - :ref:`Color<class_color>`  **get_shadow_color**  **(** **)** const
    249. 

  249. 

  250.