Switched enkiGetIsRunning() C function to use !GetIsShutdownRequested…

…() and marked deprecated
dougbinks · May 29, 2024 · 686d0ec · 686d0ec
1 parent 9e588fd
commit 686d0ec
Show file tree

Hide file tree

Showing 2 changed files with 2 additions and 2 deletions.
diff --git a/src/TaskScheduler_c.cpp b/src/TaskScheduler_c.cpp
@@ -155,7 +155,7 @@ struct enkiTaskSchedulerConfig enkiGetTaskSchedulerConfig( enkiTaskScheduler* pE
 
 int enkiGetIsRunning( enkiTaskScheduler* pETS_ )
 {
-    return (int)pETS_->GetIsRunning();
+    return (int)(!pETS_->GetIsShutdownRequested());
 }
 
 int enkiGetIsShutdownRequested(enkiTaskScheduler* pETS_)

diff --git a/src/TaskScheduler_c.h b/src/TaskScheduler_c.h
@@ -140,7 +140,7 @@ ENKITS_API enkiTaskScheduler*  enkiNewTaskSchedulerWithCustomAllocator( struct e
 // Get config. Can be called before enkiInitTaskSchedulerWithConfig to get the defaults
 ENKITS_API struct enkiTaskSchedulerConfig enkiGetTaskSchedulerConfig( enkiTaskScheduler* pETS_ );
 
-
+// DEPRECATED: use GetIsShutdownRequested() instead of GetIsRunning() in external code
 // while( enkiGetIsRunning(pETS) ) {} can be used in tasks which loop, to check if enkiTS has been shutdown.
 // If enkiGetIsRunning() returns false should then exit. Not required for finite tasks
 ENKITS_API int                 enkiGetIsRunning( enkiTaskScheduler* pETS_ );