diff options
Diffstat (limited to 'source/blender/compositor/intern/COM_WorkScheduler.h')
| -rw-r--r-- | source/blender/compositor/intern/COM_WorkScheduler.h | 36 |
1 files changed, 18 insertions, 18 deletions
diff --git a/source/blender/compositor/intern/COM_WorkScheduler.h b/source/blender/compositor/intern/COM_WorkScheduler.h index a08b3856a8b..a6de517983e 100644 --- a/source/blender/compositor/intern/COM_WorkScheduler.h +++ b/source/blender/compositor/intern/COM_WorkScheduler.h @@ -31,43 +31,43 @@ extern "C" { #include "COM_defines.h" #include "COM_Device.h" -/** @brief the workscheduler - * @ingroup execution +/** \brief the workscheduler + * \ingroup execution */ class WorkScheduler { #if COM_CURRENT_THREADING_MODEL == COM_TM_QUEUE /** - * @brief are we being stopped. + * \brief are we being stopped. */ static bool isStopping(); /** - * @brief main thread loop for cpudevices + * \brief main thread loop for cpudevices * inside this loop new work is queried and being executed */ static void *thread_execute_cpu(void *data); /** - * @brief main thread loop for gpudevices + * \brief main thread loop for gpudevices * inside this loop new work is queried and being executed */ static void *thread_execute_gpu(void *data); #endif public: /** - * @brief schedule a chunk of a group to be calculated. + * \brief schedule a chunk of a group to be calculated. * An execution group schedules a chunk in the WorkScheduler * when ExecutionGroup.isOpenCL is set the work will be handled by a OpenCLDevice * otherwise the work is scheduled for an CPUDevice - * @see ExecutionGroup.execute - * @param group the execution group - * @param chunkNumber the number of the chunk in the group to be executed + * \see ExecutionGroup.execute + * \param group the execution group + * \param chunkNumber the number of the chunk in the group to be executed */ static void schedule(ExecutionGroup *group, int chunkNumber); /** - * @brief initialize the WorkScheduler + * \brief initialize the WorkScheduler * * during initialization the mutexes are initialized. * there are two mutexes (for every device type one) @@ -80,36 +80,36 @@ public: static void initialize(bool use_opencl, int num_cpu_threads); /** - * @brief deinitialize the WorkScheduler + * \brief deinitialize the WorkScheduler * free all allocated resources */ static void deinitialize(); /** - * @brief Start the execution + * \brief Start the execution * this methods will start the WorkScheduler. Inside this method all threads are initialized. * for every device a thread is created. - * @see initialize Initialization and query of the number of devices + * \see initialize Initialization and query of the number of devices */ static void start(CompositorContext &context); /** - * @brief stop the execution + * \brief stop the execution * All created thread by the start method are destroyed. - * @see start + * \see start */ static void stop(); /** - * @brief wait for all work to be completed. + * \brief wait for all work to be completed. */ static void finish(); /** - * @brief Are there OpenCL capable GPU devices initialized? + * \brief Are there OpenCL capable GPU devices initialized? * the result of this method is stored in the CompositorContext * A node can generate a different operation tree when OpenCLDevices exists. - * @see CompositorContext.getHasActiveOpenCLDevices + * \see CompositorContext.getHasActiveOpenCLDevices */ static bool hasGPUDevices(); |