diff options
author | Campbell Barton <ideasman42@gmail.com> | 2012-06-14 03:31:47 +0400 |
---|---|---|
committer | Campbell Barton <ideasman42@gmail.com> | 2012-06-14 03:31:47 +0400 |
commit | bde7e6c96b9e180b293ee6e49ab813a30fac0635 (patch) | |
tree | cf9f09aa0b3bb0528553546674269f0e5e96bd93 /source/blender/compositor/intern/COM_WorkScheduler.h | |
parent | 906b9e0584b93094b1c45514fbf6fd8c62e6d015 (diff) |
stule cleanup: node headers
Diffstat (limited to 'source/blender/compositor/intern/COM_WorkScheduler.h')
-rw-r--r-- | source/blender/compositor/intern/COM_WorkScheduler.h | 90 |
1 files changed, 45 insertions, 45 deletions
diff --git a/source/blender/compositor/intern/COM_WorkScheduler.h b/source/blender/compositor/intern/COM_WorkScheduler.h index b03b514d139..e52e0295607 100644 --- a/source/blender/compositor/intern/COM_WorkScheduler.h +++ b/source/blender/compositor/intern/COM_WorkScheduler.h @@ -32,83 +32,83 @@ extern "C" { #include "COM_Device.h" /** @brief the workscheduler - * @ingroup execution - */ + * @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 - * inside this loop new work is queried and being executed - */ + * @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 - * inside this loop new work is queried and being executed - */ + * @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. - * An execution group schedules a chunk in the WorkScheduler - * when ExecutionGroup.isOpenCL is set the work will be handled by a OpenCLDevice - * otherwide 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 - */ + * @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 + * otherwide 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 + */ static void schedule(ExecutionGroup *group, int chunkNumber); /** - * @brief initialize the WorkScheduler - * - * during initialization the mutexes are initialized. - * there are two mutexes (for every device type one) - * After mutex initialization the system is queried in order to count the number of CPUDevices and GPUDevices to be created. - * For every hardware thread a CPUDevice and for every OpenCL GPU device a OpenCLDevice is created. - * these devices are stored in a separate list (cpudevices & gpudevices) - */ + * @brief initialize the WorkScheduler + * + * during initialization the mutexes are initialized. + * there are two mutexes (for every device type one) + * After mutex initialization the system is queried in order to count the number of CPUDevices and GPUDevices to be created. + * For every hardware thread a CPUDevice and for every OpenCL GPU device a OpenCLDevice is created. + * these devices are stored in a separate list (cpudevices & gpudevices) + */ static void initialize(); /** - * @brief deinitialize the WorkScheduler - * free all allocated resources - */ + * @brief deinitialize the WorkScheduler + * free all allocated resources + */ static void deinitialize(); /** - * @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 - */ + * @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 + */ static void start(CompositorContext &context); /** - * @brief stop the execution - * All created thread by the start method are destroyed. - * @see start - */ + * @brief stop the execution + * All created thread by the start method are destroyed. + * @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? - * the result of this method is stored in the CompositorContext - * A node can generate a different operation tree when OpenCLDevices exists. - * @see CompositorContext.getHasActiveOpenCLDevices - */ + * @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 + */ static bool hasGPUDevices(); }; #endif |