diff options
Diffstat (limited to 'source/blender/compositor/intern/COM_MemoryProxy.h')
-rw-r--r-- | source/blender/compositor/intern/COM_MemoryProxy.h | 36 |
1 files changed, 18 insertions, 18 deletions
diff --git a/source/blender/compositor/intern/COM_MemoryProxy.h b/source/blender/compositor/intern/COM_MemoryProxy.h index a628c09fa1f..884b32fd6ff 100644 --- a/source/blender/compositor/intern/COM_MemoryProxy.h +++ b/source/blender/compositor/intern/COM_MemoryProxy.h @@ -31,40 +31,40 @@ class ExecutionGroup; class WriteBufferOperation; /** - * @brief A MemoryProxy is a unique identifier for a memory buffer. + * \brief A MemoryProxy is a unique identifier for a memory buffer. * A single MemoryProxy is used among all chunks of the same buffer, * the MemoryBuffer only stores the data of a single chunk. - * @ingroup Memory + * \ingroup Memory */ class MemoryProxy { private: /** - * @brief reference to the ouput operation of the executiongroup + * \brief reference to the ouput operation of the executiongroup */ WriteBufferOperation *m_writeBufferOperation; /** - * @brief reference to the executor. the Execution group that can fill a chunk + * \brief reference to the executor. the Execution group that can fill a chunk */ ExecutionGroup *m_executor; /** - * @brief datatype of this MemoryProxy + * \brief datatype of this MemoryProxy */ /* DataType m_datatype; */ /* UNUSED */ /** - * @brief channel information of this buffer + * \brief channel information of this buffer */ /* ChannelInfo m_channelInfo[COM_NUMBER_OF_CHANNELS]; */ /* UNUSED */ /** - * @brief the allocated memory + * \brief the allocated memory */ MemoryBuffer *m_buffer; /** - * @brief datatype of this MemoryProxy + * \brief datatype of this MemoryProxy */ DataType m_datatype; @@ -72,40 +72,40 @@ public: MemoryProxy(DataType type); /** - * @brief set the ExecutionGroup that can be scheduled to calculate a certain chunk. - * @param group the ExecutionGroup to set + * \brief set the ExecutionGroup that can be scheduled to calculate a certain chunk. + * \param group the ExecutionGroup to set */ void setExecutor(ExecutionGroup *executor) { this->m_executor = executor; } /** - * @brief get the ExecutionGroup that can be scheduled to calculate a certain chunk. + * \brief get the ExecutionGroup that can be scheduled to calculate a certain chunk. */ ExecutionGroup *getExecutor() { return this->m_executor; } /** - * @brief set the WriteBufferOperation that is responsible for writing to this MemoryProxy - * @param operation + * \brief set the WriteBufferOperation that is responsible for writing to this MemoryProxy + * \param operation */ void setWriteBufferOperation(WriteBufferOperation *operation) { this->m_writeBufferOperation = operation; } /** - * @brief get the WriteBufferOperation that is responsible for writing to this MemoryProxy - * @return WriteBufferOperation + * \brief get the WriteBufferOperation that is responsible for writing to this MemoryProxy + * \return WriteBufferOperation */ WriteBufferOperation *getWriteBufferOperation() { return this->m_writeBufferOperation; } /** - * @brief allocate memory of size width x height + * \brief allocate memory of size width x height */ void allocate(unsigned int width, unsigned int height); /** - * @brief free the allocated memory + * \brief free the allocated memory */ void free(); /** - * @brief get the allocated memory + * \brief get the allocated memory */ inline MemoryBuffer *getBuffer() { return this->m_buffer; } |