class_giprobe.rst 11 KB

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