From 093cd6a59224005144f8a2751961a04f5ca29aaa Mon Sep 17 00:00:00 2001 From: Joseph Cloutier Date: Tue, 26 Mar 2024 13:11:37 -0400 Subject: [PATCH] Update `ThreadPool` constructor documentation (closes #1772). --- src/lime/system/ThreadPool.hx | 7 +++++-- 1 file changed, 5 insertions(+), 2 deletions(-) diff --git a/src/lime/system/ThreadPool.hx b/src/lime/system/ThreadPool.hx index dc9fb2bda..f0ce2cfcc 100644 --- a/src/lime/system/ThreadPool.hx +++ b/src/lime/system/ThreadPool.hx @@ -165,8 +165,11 @@ class ThreadPool extends WorkOutput /** __Call this only from the main thread.__ - @param doWork A single function capable of performing all of this pool's - jobs. Always provide `doWork`, even though it's marked as optional. + @param minThreads The number of threads that will be kept alive at all + times, even if there's no work to do. The threads won't spin up + immediately; only after enough calls to `run()`. Only applies in + multi-threaded mode. + @param maxThreads The maximum number of threads that will run at once. @param mode Defaults to `MULTI_THREADED` on most targets, but `SINGLE_THREADED` in HTML5. In HTML5, `MULTI_THREADED` mode uses web workers, which impose additional restrictions.