diff options
Diffstat (limited to 'source/blender/compositor/COM_compositor.h')
-rw-r--r-- | source/blender/compositor/COM_compositor.h | 58 |
1 files changed, 29 insertions, 29 deletions
diff --git a/source/blender/compositor/COM_compositor.h b/source/blender/compositor/COM_compositor.h index a7f9081f3fc..73e66ffeb03 100644 --- a/source/blender/compositor/COM_compositor.h +++ b/source/blender/compositor/COM_compositor.h @@ -74,8 +74,8 @@ extern "C" { * * during the preparation of the execution All ReadBufferOperation will receive an offset. * This offset is used during execution as an optimization trick - * Next all operations will be initialized for execution \see NodeOperation.initExecution - * Next all ExecutionGroup's will be initialized for execution \see ExecutionGroup.initExecution + * Next all operations will be initialized for execution \see NodeOperation.init_execution + * Next all ExecutionGroup's will be initialized for execution \see ExecutionGroup.init_execution * this all is controlled from \see ExecutionSystem.execute * * \section priority Render priority @@ -92,7 +92,7 @@ extern "C" { * When match the ExecutionGroup will be executed (this happens in serial) * * \see ExecutionSystem.execute control of the Render priority - * \see NodeOperation.getRenderPriority receive the render priority + * \see NodeOperation.get_render_priority receive the render priority * \see ExecutionGroup.execute the main loop to execute a whole ExecutionGroup * * \section order Chunk order @@ -121,7 +121,7 @@ extern "C" { * Chunk is finished. * * \see ExecutionGroup.execute - * \see ViewerOperation.getChunkOrder + * \see ViewerOperation.get_chunk_order * \see ChunkOrdering * * \section interest Area of interest @@ -152,13 +152,13 @@ extern "C" { * * In the above example ExecutionGroup B has an outputoperation (ViewerOperation) * and is being executed. - * The first chunk is evaluated [@ref ExecutionGroup.scheduleChunkWhenPossible], + * The first chunk is evaluated [@ref ExecutionGroup.schedule_chunk_when_possible], * but not all input chunks are available. * The relevant ExecutionGroup (that can calculate the missing chunks; ExecutionGroup A) * is asked to calculate the area ExecutionGroup B is missing. - * [@ref ExecutionGroup.scheduleAreaWhenPossible] + * [@ref ExecutionGroup.schedule_area_when_possible] * ExecutionGroup B checks what chunks the area spans, and tries to schedule these chunks. - * If all input data is available these chunks are scheduled [@ref ExecutionGroup.scheduleChunk] + * If all input data is available these chunks are scheduled [@ref ExecutionGroup.schedule_chunk] * * <pre> * @@ -171,18 +171,18 @@ extern "C" { * O------------------------------->O | * . O | * . O-------\ | - * . . | ExecutionGroup.scheduleChunkWhenPossible + * . . | ExecutionGroup.schedule_chunk_when_possible * . . O----/ (*) | * . . O | * . . O | - * . . O ExecutionGroup.scheduleAreaWhenPossible| + * . . O ExecutionGroup.schedule_area_when_possible| * . . O---------------------------------------->O - * . . . O----------\ ExecutionGroup.scheduleChunkWhenPossible + * . . . O----------\ ExecutionGroup.schedule_chunk_when_possible * . . . . | (*) * . . . . O-------/ * . . . . O * . . . . O - * . . . . O-------\ ExecutionGroup.scheduleChunk + * . . . . O-------\ ExecutionGroup.schedule_chunk * . . . . . | * . . . . . O----/ * . . . . O<=O @@ -198,7 +198,7 @@ extern "C" { * This happens until all chunks of (ExecutionGroup B) are finished executing or the user break's the process. * * NodeOperation like the ScaleOperation can influence the area of interest by reimplementing the - * [@ref NodeOperation.determineAreaOfInterest] method + * [@ref NodeOperation.determine_area_of_interest] method * * <pre> * @@ -221,13 +221,13 @@ extern "C" { * * \see ExecutionGroup.execute Execute a complete ExecutionGroup. * Halts until finished or breaked by user - * \see ExecutionGroup.scheduleChunkWhenPossible Tries to schedule a single chunk, + * \see ExecutionGroup.schedule_chunk_when_possible Tries to schedule a single chunk, * checks if all input data is available. Can trigger dependent chunks to be calculated - * \see ExecutionGroup.scheduleAreaWhenPossible + * \see ExecutionGroup.schedule_area_when_possible * Tries to schedule an area. This can be multiple chunks - * (is called from [@ref ExecutionGroup.scheduleChunkWhenPossible]) - * \see ExecutionGroup.scheduleChunk Schedule a chunk on the WorkScheduler - * \see NodeOperation.determineDependingAreaOfInterest Influence the area of interest of a chunk. + * (is called from [@ref ExecutionGroup.schedule_chunk_when_possible]) + * \see ExecutionGroup.schedule_chunk Schedule a chunk on the WorkScheduler + * \see NodeOperation.determine_depending_area_of_interest Influence the area of interest of a chunk. * \see WriteBufferOperation Operation to write to a MemoryProxy/MemoryBuffer * \see ReadBufferOperation Operation to read from a MemoryProxy/MemoryBuffer * \see MemoryProxy proxy for information about memory image @@ -283,16 +283,16 @@ extern "C" { * The OutputOperation of the ExecutionGroup is called to execute the area of the outputbuffer. * * \see ExecutionGroup - * \see NodeOperation.executeRegion executes a single chunk of a NodeOperation + * \see NodeOperation.execute_region executes a single chunk of a NodeOperation * \see CPUDevice.execute * * \subsection GPUDevice OpenCLDevice * * To be completed! - * \see NodeOperation.executeOpenCLRegion + * \see NodeOperation.execute_opencl_region * \see OpenCLDevice.execute * - * \section executePixel executing a pixel + * \section execute_pixel executing a pixel * Finally the last step, the node functionality :) */ @@ -312,10 +312,10 @@ extern "C" { * (true) or editing (false). * based on this setting the system will work differently: * - during rendering only Composite & the File output node will be calculated - * \see NodeOperation.isOutputProgram(int rendering) of the specific operations + * \see NodeOperation.is_output_program(int rendering) of the specific operations * * - during editing all output nodes will be calculated - * \see NodeOperation.isOutputProgram(int rendering) of the specific operations + * \see NodeOperation.is_output_program(int rendering) of the specific operations * * - another quality setting can be used bNodeTree. * The quality is determined by the bNodeTree fields. @@ -326,10 +326,10 @@ extern "C" { * - output nodes can have different priorities in the WorkScheduler. * This is implemented in the COM_execute function. * - * \param viewSettings: + * \param view_settings: * reference to view settings used for color management * - * \param displaySettings: + * \param display_settings: * reference to display settings used for color management * * OCIO_TODO: this options only used in rare cases, namely in output file node, @@ -343,13 +343,13 @@ void COM_execute(RenderData *render_data, Scene *scene, bNodeTree *node_tree, int rendering, - const ColorManagedViewSettings *viewSettings, - const ColorManagedDisplaySettings *displaySettings, - const char *viewName); + const ColorManagedViewSettings *view_settings, + const ColorManagedDisplaySettings *display_settings, + const char *view_name); /** * \brief Deinitialize the compositor caches and allocated memory. - * Use COM_clearCaches to only free the caches. + * Use COM_clear_caches to only free the caches. */ void COM_deinitialize(void); @@ -357,7 +357,7 @@ void COM_deinitialize(void); * \brief Clear all compositor caches. (Compositor system will still remain available). * To deinitialize the compositor use the COM_deinitialize method. */ -// void COM_clearCaches(void); // NOT YET WRITTEN +// void COM_clear_caches(void); // NOT YET WRITTEN #ifdef __cplusplus } |