godotengine / godotengine/godot-docs

WorkerThreadPool docs do not specify how Thread count is set

Open
#8,937 4 comments 2 reactions 0 assignees View on GitHub
area:class reference enhancement
Dominant language
reStructuredText
Stars
5.7k
Forks
3.8k
Avg merge
1d 20h
Merged PRs (30d)
25

Description

**Your Godot version:**
4.2

**Issue description:**
The docs for WorkerThreadPool say the following:
> A singleton that allocates *some* Threads on startup
> The WorkerThreadPool singleton allocates *a set* of Threads (called worker threads) on project startup

This is vague, and does not explain how WorkerThreadPool decides how many Threads to create (nor does WorkerThreadPool provide any way to either configure this or check the current thread count).

This creates a lot of confusion trying to use WorkerThreadPool efficiently alongside other manually created Threads.

**URL to the documentation page (if already existing):**
https://docs.godotengine.org/en/stable/classes/class_workerthreadpool.html

Contributor guide

No contributing guide indexed for this repository

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.