class_giprobe.rst 11 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212
  1. .. Generated automatically by doc/tools/makerst.py in Godot's source tree.
  2. .. DO NOT EDIT THIS FILE, but the GIProbe.xml source instead.
  3. .. The source is found in doc/classes or modules/<name>/doc_classes.
  4. .. _class_GIProbe:
  5. GIProbe
  6. =======
  7. **Inherits:** :ref:`VisualInstance<class_visualinstance>` **<** :ref:`Spatial<class_spatial>` **<** :ref:`Node<class_node>` **<** :ref:`Object<class_object>`
  8. **Category:** Core
  9. Brief Description
  10. -----------------
  11. Member Functions
  12. ----------------
  13. +----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------+
  14. | void | :ref:`bake<class_GIProbe_bake>` **(** :ref:`Node<class_node>` from_node=null, :ref:`bool<class_bool>` create_visual_debug=false **)** |
  15. +----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------+
  16. | void | :ref:`debug_bake<class_GIProbe_debug_bake>` **(** **)** |
  17. +----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------+
  18. | :ref:`float<class_float>` | :ref:`get_bias<class_GIProbe_get_bias>` **(** **)** const |
  19. +----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------+
  20. | :ref:`int<class_int>` | :ref:`get_dynamic_range<class_GIProbe_get_dynamic_range>` **(** **)** const |
  21. +----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------+
  22. | :ref:`float<class_float>` | :ref:`get_energy<class_GIProbe_get_energy>` **(** **)** const |
  23. +----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------+
  24. | :ref:`Vector3<class_vector3>` | :ref:`get_extents<class_GIProbe_get_extents>` **(** **)** const |
  25. +----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------+
  26. | :ref:`float<class_float>` | :ref:`get_normal_bias<class_GIProbe_get_normal_bias>` **(** **)** const |
  27. +----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------+
  28. | :ref:`GIProbeData<class_giprobedata>` | :ref:`get_probe_data<class_GIProbe_get_probe_data>` **(** **)** const |
  29. +----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------+
  30. | :ref:`float<class_float>` | :ref:`get_propagation<class_GIProbe_get_propagation>` **(** **)** const |
  31. +----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------+
  32. | :ref:`int<class_int>` | :ref:`get_subdiv<class_GIProbe_get_subdiv>` **(** **)** const |
  33. +----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------+
  34. | :ref:`bool<class_bool>` | :ref:`is_compressed<class_GIProbe_is_compressed>` **(** **)** const |
  35. +----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------+
  36. | :ref:`bool<class_bool>` | :ref:`is_interior<class_GIProbe_is_interior>` **(** **)** const |
  37. +----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------+
  38. | void | :ref:`set_bias<class_GIProbe_set_bias>` **(** :ref:`float<class_float>` max **)** |
  39. +----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------+
  40. | void | :ref:`set_compress<class_GIProbe_set_compress>` **(** :ref:`bool<class_bool>` enable **)** |
  41. +----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------+
  42. | void | :ref:`set_dynamic_range<class_GIProbe_set_dynamic_range>` **(** :ref:`int<class_int>` max **)** |
  43. +----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------+
  44. | void | :ref:`set_energy<class_GIProbe_set_energy>` **(** :ref:`float<class_float>` max **)** |
  45. +----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------+
  46. | void | :ref:`set_extents<class_GIProbe_set_extents>` **(** :ref:`Vector3<class_vector3>` extents **)** |
  47. +----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------+
  48. | void | :ref:`set_interior<class_GIProbe_set_interior>` **(** :ref:`bool<class_bool>` enable **)** |
  49. +----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------+
  50. | void | :ref:`set_normal_bias<class_GIProbe_set_normal_bias>` **(** :ref:`float<class_float>` max **)** |
  51. +----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------+
  52. | void | :ref:`set_probe_data<class_GIProbe_set_probe_data>` **(** :ref:`GIProbeData<class_giprobedata>` data **)** |
  53. +----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------+
  54. | void | :ref:`set_propagation<class_GIProbe_set_propagation>` **(** :ref:`float<class_float>` max **)** |
  55. +----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------+
  56. | void | :ref:`set_subdiv<class_GIProbe_set_subdiv>` **(** :ref:`int<class_int>` subdiv **)** |
  57. +----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------+
  58. Member Variables
  59. ----------------
  60. .. _class_GIProbe_bias:
  61. - :ref:`float<class_float>` **bias**
  62. .. _class_GIProbe_compress:
  63. - :ref:`bool<class_bool>` **compress**
  64. .. _class_GIProbe_data:
  65. - :ref:`GIProbeData<class_giprobedata>` **data**
  66. .. _class_GIProbe_dynamic_range:
  67. - :ref:`int<class_int>` **dynamic_range**
  68. .. _class_GIProbe_energy:
  69. - :ref:`float<class_float>` **energy**
  70. .. _class_GIProbe_extents:
  71. - :ref:`Vector3<class_vector3>` **extents**
  72. .. _class_GIProbe_interior:
  73. - :ref:`bool<class_bool>` **interior**
  74. .. _class_GIProbe_normal_bias:
  75. - :ref:`float<class_float>` **normal_bias**
  76. .. _class_GIProbe_propagation:
  77. - :ref:`float<class_float>` **propagation**
  78. .. _class_GIProbe_subdiv:
  79. - :ref:`int<class_int>` **subdiv**
  80. Numeric Constants
  81. -----------------
  82. - **SUBDIV_64** = **0**
  83. - **SUBDIV_128** = **1**
  84. - **SUBDIV_256** = **2**
  85. - **SUBDIV_512** = **3**
  86. - **SUBDIV_MAX** = **4**
  87. Member Function Description
  88. ---------------------------
  89. .. _class_GIProbe_bake:
  90. - void **bake** **(** :ref:`Node<class_node>` from_node=null, :ref:`bool<class_bool>` create_visual_debug=false **)**
  91. .. _class_GIProbe_debug_bake:
  92. - void **debug_bake** **(** **)**
  93. .. _class_GIProbe_get_bias:
  94. - :ref:`float<class_float>` **get_bias** **(** **)** const
  95. .. _class_GIProbe_get_dynamic_range:
  96. - :ref:`int<class_int>` **get_dynamic_range** **(** **)** const
  97. .. _class_GIProbe_get_energy:
  98. - :ref:`float<class_float>` **get_energy** **(** **)** const
  99. .. _class_GIProbe_get_extents:
  100. - :ref:`Vector3<class_vector3>` **get_extents** **(** **)** const
  101. .. _class_GIProbe_get_normal_bias:
  102. - :ref:`float<class_float>` **get_normal_bias** **(** **)** const
  103. .. _class_GIProbe_get_probe_data:
  104. - :ref:`GIProbeData<class_giprobedata>` **get_probe_data** **(** **)** const
  105. .. _class_GIProbe_get_propagation:
  106. - :ref:`float<class_float>` **get_propagation** **(** **)** const
  107. .. _class_GIProbe_get_subdiv:
  108. - :ref:`int<class_int>` **get_subdiv** **(** **)** const
  109. .. _class_GIProbe_is_compressed:
  110. - :ref:`bool<class_bool>` **is_compressed** **(** **)** const
  111. .. _class_GIProbe_is_interior:
  112. - :ref:`bool<class_bool>` **is_interior** **(** **)** const
  113. .. _class_GIProbe_set_bias:
  114. - void **set_bias** **(** :ref:`float<class_float>` max **)**
  115. .. _class_GIProbe_set_compress:
  116. - void **set_compress** **(** :ref:`bool<class_bool>` enable **)**
  117. .. _class_GIProbe_set_dynamic_range:
  118. - void **set_dynamic_range** **(** :ref:`int<class_int>` max **)**
  119. .. _class_GIProbe_set_energy:
  120. - void **set_energy** **(** :ref:`float<class_float>` max **)**
  121. .. _class_GIProbe_set_extents:
  122. - void **set_extents** **(** :ref:`Vector3<class_vector3>` extents **)**
  123. .. _class_GIProbe_set_interior:
  124. - void **set_interior** **(** :ref:`bool<class_bool>` enable **)**
  125. .. _class_GIProbe_set_normal_bias:
  126. - void **set_normal_bias** **(** :ref:`float<class_float>` max **)**
  127. .. _class_GIProbe_set_probe_data:
  128. - void **set_probe_data** **(** :ref:`GIProbeData<class_giprobedata>` data **)**
  129. .. _class_GIProbe_set_propagation:
  130. - void **set_propagation** **(** :ref:`float<class_float>` max **)**
  131. .. _class_GIProbe_set_subdiv:
  132. - void **set_subdiv** **(** :ref:`int<class_int>` subdiv **)**