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: 2be4e9b938
Branches Tags
godot-docs
/
classes
/
class_workerthreadpool.rst

class_workerthreadpool.rst 7.0 KB
History Raw

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384 
  1. :github_url: hide
    2. 

  2. 

  3. .. DO NOT EDIT THIS FILE!!!
    4. 

  4. .. Generated automatically from Godot engine sources.
    5. 

  5. .. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py.
    6. 

  6. .. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/WorkerThreadPool.xml.
    7. 

  7. 

  8. .. _class_WorkerThreadPool:
    9. 

  9. 

  10. WorkerThreadPool
    11. 

  11. ================
    12. 

  12. 

  13. **Inherits:** :ref:`Object<class_Object>`
    14. 

  14. 

  15. 

  16. 

  17. Methods
    18. 

  18. -------
    19. 

  19. 

  20. +-------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    21. 

  21. | :ref:`int<class_int>`   | :ref:`add_group_task<class_WorkerThreadPool_method_add_group_task>` **(** :ref:`Callable<class_Callable>` action, :ref:`int<class_int>` elements, :ref:`int<class_int>` tasks_needed=-1, :ref:`bool<class_bool>` high_priority=false, :ref:`String<class_String>` description="" **)** |
    22. 

  22. +-------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    23. 

  23. | :ref:`int<class_int>`   | :ref:`add_task<class_WorkerThreadPool_method_add_task>` **(** :ref:`Callable<class_Callable>` action, :ref:`bool<class_bool>` high_priority=false, :ref:`String<class_String>` description="" **)**                                                                                    |
    24. 

  24. +-------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    25. 

  25. | :ref:`int<class_int>`   | :ref:`get_group_processed_element_count<class_WorkerThreadPool_method_get_group_processed_element_count>` **(** :ref:`int<class_int>` group_id **)** |const|                                                                                                                           |
    26. 

  26. +-------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    27. 

  27. | :ref:`bool<class_bool>` | :ref:`is_group_task_completed<class_WorkerThreadPool_method_is_group_task_completed>` **(** :ref:`int<class_int>` group_id **)** |const|                                                                                                                                               |
    28. 

  28. +-------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    29. 

  29. | :ref:`bool<class_bool>` | :ref:`is_task_completed<class_WorkerThreadPool_method_is_task_completed>` **(** :ref:`int<class_int>` task_id **)** |const|                                                                                                                                                            |
    30. 

  30. +-------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    31. 

  31. | void                    | :ref:`wait_for_group_task_completion<class_WorkerThreadPool_method_wait_for_group_task_completion>` **(** :ref:`int<class_int>` group_id **)**                                                                                                                                         |
    32. 

  32. +-------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    33. 

  33. | void                    | :ref:`wait_for_task_completion<class_WorkerThreadPool_method_wait_for_task_completion>` **(** :ref:`int<class_int>` task_id **)**                                                                                                                                                      |
    34. 

  34. +-------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    35. 

  35. 

  36. Method Descriptions
    37. 

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

  38. 

  39. .. _class_WorkerThreadPool_method_add_group_task:
    40. 

  40. 

  41. - :ref:`int<class_int>` **add_group_task** **(** :ref:`Callable<class_Callable>` action, :ref:`int<class_int>` elements, :ref:`int<class_int>` tasks_needed=-1, :ref:`bool<class_bool>` high_priority=false, :ref:`String<class_String>` description="" **)**
    42. 

  42. 

  43. ----
    44. 

  44. 

  45. .. _class_WorkerThreadPool_method_add_task:
    46. 

  46. 

  47. - :ref:`int<class_int>` **add_task** **(** :ref:`Callable<class_Callable>` action, :ref:`bool<class_bool>` high_priority=false, :ref:`String<class_String>` description="" **)**
    48. 

  48. 

  49. ----
    50. 

  50. 

  51. .. _class_WorkerThreadPool_method_get_group_processed_element_count:
    52. 

  52. 

  53. - :ref:`int<class_int>` **get_group_processed_element_count** **(** :ref:`int<class_int>` group_id **)** |const|
    54. 

  54. 

  55. ----
    56. 

  56. 

  57. .. _class_WorkerThreadPool_method_is_group_task_completed:
    58. 

  58. 

  59. - :ref:`bool<class_bool>` **is_group_task_completed** **(** :ref:`int<class_int>` group_id **)** |const|
    60. 

  60. 

  61. ----
    62. 

  62. 

  63. .. _class_WorkerThreadPool_method_is_task_completed:
    64. 

  64. 

  65. - :ref:`bool<class_bool>` **is_task_completed** **(** :ref:`int<class_int>` task_id **)** |const|
    66. 

  66. 

  67. ----
    68. 

  68. 

  69. .. _class_WorkerThreadPool_method_wait_for_group_task_completion:
    70. 

  70. 

  71. - void **wait_for_group_task_completion** **(** :ref:`int<class_int>` group_id **)**
    72. 

  72. 

  73. ----
    74. 

  74. 

  75. .. _class_WorkerThreadPool_method_wait_for_task_completion:
    76. 

  76. 

  77. - void **wait_for_task_completion** **(** :ref:`int<class_int>` task_id **)**
    78. 

  78. 

  79. .. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)`
    80. 

  80. .. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)`
    81. 

  81. .. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)`
    82. 

  82. .. |constructor| replace:: :abbr:`constructor (This method is used to construct a type.)`
    83. 

  83. .. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)`
    84. 

  84. .. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)`
    85.