class_giprobedata.rst 11 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173
  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_GIProbeData:
  4. GIProbeData
  5. ===========
  6. **Inherits:** :ref:`Resource<class_resource>` **<** :ref:`Reference<class_reference>` **<** :ref:`Object<class_object>`
  7. **Category:** Core
  8. Brief Description
  9. -----------------
  10. Member Functions
  11. ----------------
  12. +------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------+
  13. | :ref:`float<class_float>` | :ref:`get_bias<class_GIProbeData_get_bias>` **(** **)** const |
  14. +------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------+
  15. | :ref:`Rect3<class_rect3>` | :ref:`get_bounds<class_GIProbeData_get_bounds>` **(** **)** const |
  16. +------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------+
  17. | :ref:`float<class_float>` | :ref:`get_cell_size<class_GIProbeData_get_cell_size>` **(** **)** const |
  18. +------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------+
  19. | :ref:`PoolIntArray<class_poolintarray>` | :ref:`get_dynamic_data<class_GIProbeData_get_dynamic_data>` **(** **)** const |
  20. +------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------+
  21. | :ref:`int<class_int>` | :ref:`get_dynamic_range<class_GIProbeData_get_dynamic_range>` **(** **)** const |
  22. +------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------+
  23. | :ref:`float<class_float>` | :ref:`get_energy<class_GIProbeData_get_energy>` **(** **)** const |
  24. +------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------+
  25. | :ref:`float<class_float>` | :ref:`get_normal_bias<class_GIProbeData_get_normal_bias>` **(** **)** const |
  26. +------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------+
  27. | :ref:`float<class_float>` | :ref:`get_propagation<class_GIProbeData_get_propagation>` **(** **)** const |
  28. +------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------+
  29. | :ref:`Transform<class_transform>` | :ref:`get_to_cell_xform<class_GIProbeData_get_to_cell_xform>` **(** **)** const |
  30. +------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------+
  31. | :ref:`bool<class_bool>` | :ref:`is_compressed<class_GIProbeData_is_compressed>` **(** **)** const |
  32. +------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------+
  33. | :ref:`bool<class_bool>` | :ref:`is_interior<class_GIProbeData_is_interior>` **(** **)** const |
  34. +------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------+
  35. | void | :ref:`set_bias<class_GIProbeData_set_bias>` **(** :ref:`float<class_float>` bias **)** |
  36. +------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------+
  37. | void | :ref:`set_bounds<class_GIProbeData_set_bounds>` **(** :ref:`Rect3<class_rect3>` bounds **)** |
  38. +------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------+
  39. | void | :ref:`set_cell_size<class_GIProbeData_set_cell_size>` **(** :ref:`float<class_float>` cell_size **)** |
  40. +------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------+
  41. | void | :ref:`set_compress<class_GIProbeData_set_compress>` **(** :ref:`bool<class_bool>` compress **)** |
  42. +------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------+
  43. | void | :ref:`set_dynamic_data<class_GIProbeData_set_dynamic_data>` **(** :ref:`PoolIntArray<class_poolintarray>` dynamic_data **)** |
  44. +------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------+
  45. | void | :ref:`set_dynamic_range<class_GIProbeData_set_dynamic_range>` **(** :ref:`int<class_int>` dynamic_range **)** |
  46. +------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------+
  47. | void | :ref:`set_energy<class_GIProbeData_set_energy>` **(** :ref:`float<class_float>` energy **)** |
  48. +------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------+
  49. | void | :ref:`set_interior<class_GIProbeData_set_interior>` **(** :ref:`bool<class_bool>` interior **)** |
  50. +------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------+
  51. | void | :ref:`set_normal_bias<class_GIProbeData_set_normal_bias>` **(** :ref:`float<class_float>` bias **)** |
  52. +------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------+
  53. | void | :ref:`set_propagation<class_GIProbeData_set_propagation>` **(** :ref:`float<class_float>` propagation **)** |
  54. +------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------+
  55. | void | :ref:`set_to_cell_xform<class_GIProbeData_set_to_cell_xform>` **(** :ref:`Transform<class_transform>` to_cell_xform **)** |
  56. +------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------+
  57. Member Variables
  58. ----------------
  59. - :ref:`float<class_float>` **bias**
  60. - :ref:`Rect3<class_rect3>` **bounds**
  61. - :ref:`float<class_float>` **cell_size**
  62. - :ref:`bool<class_bool>` **compress**
  63. - :ref:`PoolIntArray<class_poolintarray>` **dynamic_data**
  64. - :ref:`int<class_int>` **dynamic_range**
  65. - :ref:`float<class_float>` **energy**
  66. - :ref:`bool<class_bool>` **interior**
  67. - :ref:`float<class_float>` **normal_bias**
  68. - :ref:`float<class_float>` **propagation**
  69. - :ref:`Transform<class_transform>` **to_cell_xform**
  70. Member Function Description
  71. ---------------------------
  72. .. _class_GIProbeData_get_bias:
  73. - :ref:`float<class_float>` **get_bias** **(** **)** const
  74. .. _class_GIProbeData_get_bounds:
  75. - :ref:`Rect3<class_rect3>` **get_bounds** **(** **)** const
  76. .. _class_GIProbeData_get_cell_size:
  77. - :ref:`float<class_float>` **get_cell_size** **(** **)** const
  78. .. _class_GIProbeData_get_dynamic_data:
  79. - :ref:`PoolIntArray<class_poolintarray>` **get_dynamic_data** **(** **)** const
  80. .. _class_GIProbeData_get_dynamic_range:
  81. - :ref:`int<class_int>` **get_dynamic_range** **(** **)** const
  82. .. _class_GIProbeData_get_energy:
  83. - :ref:`float<class_float>` **get_energy** **(** **)** const
  84. .. _class_GIProbeData_get_normal_bias:
  85. - :ref:`float<class_float>` **get_normal_bias** **(** **)** const
  86. .. _class_GIProbeData_get_propagation:
  87. - :ref:`float<class_float>` **get_propagation** **(** **)** const
  88. .. _class_GIProbeData_get_to_cell_xform:
  89. - :ref:`Transform<class_transform>` **get_to_cell_xform** **(** **)** const
  90. .. _class_GIProbeData_is_compressed:
  91. - :ref:`bool<class_bool>` **is_compressed** **(** **)** const
  92. .. _class_GIProbeData_is_interior:
  93. - :ref:`bool<class_bool>` **is_interior** **(** **)** const
  94. .. _class_GIProbeData_set_bias:
  95. - void **set_bias** **(** :ref:`float<class_float>` bias **)**
  96. .. _class_GIProbeData_set_bounds:
  97. - void **set_bounds** **(** :ref:`Rect3<class_rect3>` bounds **)**
  98. .. _class_GIProbeData_set_cell_size:
  99. - void **set_cell_size** **(** :ref:`float<class_float>` cell_size **)**
  100. .. _class_GIProbeData_set_compress:
  101. - void **set_compress** **(** :ref:`bool<class_bool>` compress **)**
  102. .. _class_GIProbeData_set_dynamic_data:
  103. - void **set_dynamic_data** **(** :ref:`PoolIntArray<class_poolintarray>` dynamic_data **)**
  104. .. _class_GIProbeData_set_dynamic_range:
  105. - void **set_dynamic_range** **(** :ref:`int<class_int>` dynamic_range **)**
  106. .. _class_GIProbeData_set_energy:
  107. - void **set_energy** **(** :ref:`float<class_float>` energy **)**
  108. .. _class_GIProbeData_set_interior:
  109. - void **set_interior** **(** :ref:`bool<class_bool>` interior **)**
  110. .. _class_GIProbeData_set_normal_bias:
  111. - void **set_normal_bias** **(** :ref:`float<class_float>` bias **)**
  112. .. _class_GIProbeData_set_propagation:
  113. - void **set_propagation** **(** :ref:`float<class_float>` propagation **)**
  114. .. _class_GIProbeData_set_to_cell_xform:
  115. - void **set_to_cell_xform** **(** :ref:`Transform<class_transform>` to_cell_xform **)**