class_giprobedata.rst 10 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159
  1. .. Generated automatically by doc/tools/makerst.py in Godot's source tree.
  2. .. DO NOT EDIT THIS FILE, but the GIProbeData.xml source instead.
  3. .. The source is found in doc/classes or modules/<name>/doc_classes.
  4. .. _class_GIProbeData:
  5. GIProbeData
  6. ===========
  7. **Inherits:** :ref:`Resource<class_resource>` **<** :ref:`Reference<class_reference>` **<** :ref:`Object<class_object>`
  8. **Category:** Core
  9. Brief Description
  10. -----------------
  11. Member Functions
  12. ----------------
  13. +------------------------------------------+------------------------------------------------------------------------------------------------------------------------------+
  14. | :ref:`float<class_float>` | :ref:`get_bias<class_GIProbeData_get_bias>` **(** **)** const |
  15. +------------------------------------------+------------------------------------------------------------------------------------------------------------------------------+
  16. | :ref:`AABB<class_aabb>` | :ref:`get_bounds<class_GIProbeData_get_bounds>` **(** **)** const |
  17. +------------------------------------------+------------------------------------------------------------------------------------------------------------------------------+
  18. | :ref:`float<class_float>` | :ref:`get_cell_size<class_GIProbeData_get_cell_size>` **(** **)** const |
  19. +------------------------------------------+------------------------------------------------------------------------------------------------------------------------------+
  20. | :ref:`PoolIntArray<class_poolintarray>` | :ref:`get_dynamic_data<class_GIProbeData_get_dynamic_data>` **(** **)** const |
  21. +------------------------------------------+------------------------------------------------------------------------------------------------------------------------------+
  22. | :ref:`int<class_int>` | :ref:`get_dynamic_range<class_GIProbeData_get_dynamic_range>` **(** **)** const |
  23. +------------------------------------------+------------------------------------------------------------------------------------------------------------------------------+
  24. | :ref:`float<class_float>` | :ref:`get_energy<class_GIProbeData_get_energy>` **(** **)** const |
  25. +------------------------------------------+------------------------------------------------------------------------------------------------------------------------------+
  26. | :ref:`float<class_float>` | :ref:`get_normal_bias<class_GIProbeData_get_normal_bias>` **(** **)** const |
  27. +------------------------------------------+------------------------------------------------------------------------------------------------------------------------------+
  28. | :ref:`float<class_float>` | :ref:`get_propagation<class_GIProbeData_get_propagation>` **(** **)** const |
  29. +------------------------------------------+------------------------------------------------------------------------------------------------------------------------------+
  30. | :ref:`Transform<class_transform>` | :ref:`get_to_cell_xform<class_GIProbeData_get_to_cell_xform>` **(** **)** const |
  31. +------------------------------------------+------------------------------------------------------------------------------------------------------------------------------+
  32. | :ref:`bool<class_bool>` | :ref:`is_compressed<class_GIProbeData_is_compressed>` **(** **)** const |
  33. +------------------------------------------+------------------------------------------------------------------------------------------------------------------------------+
  34. | :ref:`bool<class_bool>` | :ref:`is_interior<class_GIProbeData_is_interior>` **(** **)** const |
  35. +------------------------------------------+------------------------------------------------------------------------------------------------------------------------------+
  36. | void | :ref:`set_bias<class_GIProbeData_set_bias>` **(** :ref:`float<class_float>` bias **)** |
  37. +------------------------------------------+------------------------------------------------------------------------------------------------------------------------------+
  38. | void | :ref:`set_bounds<class_GIProbeData_set_bounds>` **(** :ref:`AABB<class_aabb>` bounds **)** |
  39. +------------------------------------------+------------------------------------------------------------------------------------------------------------------------------+
  40. | void | :ref:`set_cell_size<class_GIProbeData_set_cell_size>` **(** :ref:`float<class_float>` cell_size **)** |
  41. +------------------------------------------+------------------------------------------------------------------------------------------------------------------------------+
  42. | void | :ref:`set_compress<class_GIProbeData_set_compress>` **(** :ref:`bool<class_bool>` compress **)** |
  43. +------------------------------------------+------------------------------------------------------------------------------------------------------------------------------+
  44. | void | :ref:`set_dynamic_data<class_GIProbeData_set_dynamic_data>` **(** :ref:`PoolIntArray<class_poolintarray>` dynamic_data **)** |
  45. +------------------------------------------+------------------------------------------------------------------------------------------------------------------------------+
  46. | void | :ref:`set_dynamic_range<class_GIProbeData_set_dynamic_range>` **(** :ref:`int<class_int>` dynamic_range **)** |
  47. +------------------------------------------+------------------------------------------------------------------------------------------------------------------------------+
  48. | void | :ref:`set_energy<class_GIProbeData_set_energy>` **(** :ref:`float<class_float>` energy **)** |
  49. +------------------------------------------+------------------------------------------------------------------------------------------------------------------------------+
  50. | void | :ref:`set_interior<class_GIProbeData_set_interior>` **(** :ref:`bool<class_bool>` interior **)** |
  51. +------------------------------------------+------------------------------------------------------------------------------------------------------------------------------+
  52. | void | :ref:`set_normal_bias<class_GIProbeData_set_normal_bias>` **(** :ref:`float<class_float>` bias **)** |
  53. +------------------------------------------+------------------------------------------------------------------------------------------------------------------------------+
  54. | void | :ref:`set_propagation<class_GIProbeData_set_propagation>` **(** :ref:`float<class_float>` propagation **)** |
  55. +------------------------------------------+------------------------------------------------------------------------------------------------------------------------------+
  56. | void | :ref:`set_to_cell_xform<class_GIProbeData_set_to_cell_xform>` **(** :ref:`Transform<class_transform>` to_cell_xform **)** |
  57. +------------------------------------------+------------------------------------------------------------------------------------------------------------------------------+
  58. Member Function Description
  59. ---------------------------
  60. .. _class_GIProbeData_get_bias:
  61. - :ref:`float<class_float>` **get_bias** **(** **)** const
  62. .. _class_GIProbeData_get_bounds:
  63. - :ref:`AABB<class_aabb>` **get_bounds** **(** **)** const
  64. .. _class_GIProbeData_get_cell_size:
  65. - :ref:`float<class_float>` **get_cell_size** **(** **)** const
  66. .. _class_GIProbeData_get_dynamic_data:
  67. - :ref:`PoolIntArray<class_poolintarray>` **get_dynamic_data** **(** **)** const
  68. .. _class_GIProbeData_get_dynamic_range:
  69. - :ref:`int<class_int>` **get_dynamic_range** **(** **)** const
  70. .. _class_GIProbeData_get_energy:
  71. - :ref:`float<class_float>` **get_energy** **(** **)** const
  72. .. _class_GIProbeData_get_normal_bias:
  73. - :ref:`float<class_float>` **get_normal_bias** **(** **)** const
  74. .. _class_GIProbeData_get_propagation:
  75. - :ref:`float<class_float>` **get_propagation** **(** **)** const
  76. .. _class_GIProbeData_get_to_cell_xform:
  77. - :ref:`Transform<class_transform>` **get_to_cell_xform** **(** **)** const
  78. .. _class_GIProbeData_is_compressed:
  79. - :ref:`bool<class_bool>` **is_compressed** **(** **)** const
  80. .. _class_GIProbeData_is_interior:
  81. - :ref:`bool<class_bool>` **is_interior** **(** **)** const
  82. .. _class_GIProbeData_set_bias:
  83. - void **set_bias** **(** :ref:`float<class_float>` bias **)**
  84. .. _class_GIProbeData_set_bounds:
  85. - void **set_bounds** **(** :ref:`AABB<class_aabb>` bounds **)**
  86. .. _class_GIProbeData_set_cell_size:
  87. - void **set_cell_size** **(** :ref:`float<class_float>` cell_size **)**
  88. .. _class_GIProbeData_set_compress:
  89. - void **set_compress** **(** :ref:`bool<class_bool>` compress **)**
  90. .. _class_GIProbeData_set_dynamic_data:
  91. - void **set_dynamic_data** **(** :ref:`PoolIntArray<class_poolintarray>` dynamic_data **)**
  92. .. _class_GIProbeData_set_dynamic_range:
  93. - void **set_dynamic_range** **(** :ref:`int<class_int>` dynamic_range **)**
  94. .. _class_GIProbeData_set_energy:
  95. - void **set_energy** **(** :ref:`float<class_float>` energy **)**
  96. .. _class_GIProbeData_set_interior:
  97. - void **set_interior** **(** :ref:`bool<class_bool>` interior **)**
  98. .. _class_GIProbeData_set_normal_bias:
  99. - void **set_normal_bias** **(** :ref:`float<class_float>` bias **)**
  100. .. _class_GIProbeData_set_propagation:
  101. - void **set_propagation** **(** :ref:`float<class_float>` propagation **)**
  102. .. _class_GIProbeData_set_to_cell_xform:
  103. - void **set_to_cell_xform** **(** :ref:`Transform<class_transform>` to_cell_xform **)**