diff options
Diffstat (limited to 'source/blender/compositor/intern/COM_NodeOperation.h')
| -rw-r--r-- | source/blender/compositor/intern/COM_NodeOperation.h | 50 |
1 files changed, 25 insertions, 25 deletions
diff --git a/source/blender/compositor/intern/COM_NodeOperation.h b/source/blender/compositor/intern/COM_NodeOperation.h index c0957d57040..10161343444 100644 --- a/source/blender/compositor/intern/COM_NodeOperation.h +++ b/source/blender/compositor/intern/COM_NodeOperation.h @@ -143,8 +143,8 @@ public: /** * \brief determine the resolution of this node * \note this method will not set the resolution, this is the responsibility of the caller - * \param resolution the result of this operation - * \param preferredResolution the preferable resolution as no resolution could be determined + * \param resolution: the result of this operation + * \param preferredResolution: the preferable resolution as no resolution could be determined */ virtual void determineResolution(unsigned int resolution[2], unsigned int preferredResolution[2]); @@ -155,7 +155,7 @@ public: * * \see ExecutionSystem * \group check - * \param rendering [true false] + * \param rendering: [true false] * true: rendering * false: editing * @@ -171,9 +171,9 @@ public: /** * \brief when a chunk is executed by a CPUDevice, this method is called * \ingroup execution - * \param rect the rectangle of the chunk (location and size) - * \param chunkNumber the chunkNumber to be calculated - * \param memoryBuffers all input MemoryBuffer's needed + * \param rect: the rectangle of the chunk (location and size) + * \param chunkNumber: the chunkNumber to be calculated + * \param memoryBuffers: all input MemoryBuffer's needed */ virtual void executeRegion(rcti * /*rect*/, unsigned int /*chunkNumber*/) {} @@ -182,13 +182,13 @@ public: * \brief when a chunk is executed by an OpenCLDevice, this method is called * \ingroup execution * \note this method is only implemented in WriteBufferOperation - * \param context the OpenCL context - * \param program the OpenCL program containing all compositor kernels - * \param queue the OpenCL command queue of the device the chunk is executed on - * \param rect the rectangle of the chunk (location and size) - * \param chunkNumber the chunkNumber to be calculated - * \param memoryBuffers all input MemoryBuffer's needed - * \param outputBuffer the outputbuffer to write to + * \param context: the OpenCL context + * \param program: the OpenCL program containing all compositor kernels + * \param queue: the OpenCL command queue of the device the chunk is executed on + * \param rect: the rectangle of the chunk (location and size) + * \param chunkNumber: the chunkNumber to be calculated + * \param memoryBuffers: all input MemoryBuffer's needed + * \param outputBuffer: the outputbuffer to write to */ virtual void executeOpenCLRegion(OpenCLDevice * /*device*/, rcti * /*rect*/, @@ -199,14 +199,14 @@ public: /** * \brief custom handle to add new tasks to the OpenCL command queue in order to execute a chunk on an GPUDevice * \ingroup execution - * \param context the OpenCL context - * \param program the OpenCL program containing all compositor kernels - * \param queue the OpenCL command queue of the device the chunk is executed on - * \param outputMemoryBuffer the allocated memory buffer in main CPU memory - * \param clOutputBuffer the allocated memory buffer in OpenCLDevice memory - * \param inputMemoryBuffers all input MemoryBuffer's needed - * \param clMemToCleanUp all created cl_mem references must be added to this list. Framework will clean this after execution - * \param clKernelsToCleanUp all created cl_kernel references must be added to this list. Framework will clean this after execution + * \param context: the OpenCL context + * \param program: the OpenCL program containing all compositor kernels + * \param queue: the OpenCL command queue of the device the chunk is executed on + * \param outputMemoryBuffer: the allocated memory buffer in main CPU memory + * \param clOutputBuffer: the allocated memory buffer in OpenCLDevice memory + * \param inputMemoryBuffers: all input MemoryBuffer's needed + * \param clMemToCleanUp: all created cl_mem references must be added to this list. Framework will clean this after execution + * \param clKernelsToCleanUp: all created cl_kernel references must be added to this list. Framework will clean this after execution */ virtual void executeOpenCL(OpenCLDevice * /*device*/, MemoryBuffer * /*outputMemoryBuffer*/, @@ -222,7 +222,7 @@ public: /** * \brief set the resolution - * \param resolution the resolution to set + * \param resolution: the resolution to set */ void setResolution(unsigned int resolution[2]) { if (!isResolutionSet()) { @@ -271,7 +271,7 @@ public: /** * \brief set the index of the input socket that will determine the resolution of this operation - * \param index the index to set + * \param index: the index to set */ void setResolutionInputSocketIndex(unsigned int index); @@ -397,8 +397,8 @@ public: /** * \brief determine the resolution of this data going through this socket - * \param resolution the result of this operation - * \param preferredResolution the preferable resolution as no resolution could be determined + * \param resolution: the result of this operation + * \param preferredResolution: the preferable resolution as no resolution could be determined */ void determineResolution(unsigned int resolution[2], unsigned int preferredResolution[2]); |