Campbell Barton
c434782e3a
Use a shorter/simpler license convention, stops the header taking so much space. Follow the SPDX license specification: https://spdx.org/licenses - C/C++/objc/objc++ - Python - Shell Scripts - CMake, GNUmakefile While most of the source tree has been included - `./extern/` was left out. - `./intern/cycles` & `./intern/atomic` are also excluded because they use different header conventions. doc/license/SPDX-license-identifiers.txt has been added to list SPDX all used identifiers. See P2788 for the script that automated these edits. Reviewed By: brecht, mont29, sergey Ref D14069
114 lines
2.3 KiB
C++
114 lines
2.3 KiB
C++
/* SPDX-License-Identifier: GPL-2.0-or-later
|
|
* Copyright 2011 Blender Foundation. */
|
|
|
|
#pragma once
|
|
|
|
#ifdef WITH_CXX_GUARDEDALLOC
|
|
# include "MEM_guardedalloc.h"
|
|
#endif
|
|
|
|
#include "COM_defines.h"
|
|
|
|
namespace blender::compositor {
|
|
|
|
/* Forward declarations. */
|
|
class MemoryBuffer;
|
|
class ExecutionGroup;
|
|
class WriteBufferOperation;
|
|
|
|
/**
|
|
* \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
|
|
*/
|
|
class MemoryProxy {
|
|
private:
|
|
/**
|
|
* \brief reference to the output operation of the executiongroup
|
|
*/
|
|
WriteBufferOperation *write_buffer_operation_;
|
|
|
|
/**
|
|
* \brief reference to the executor. the Execution group that can fill a chunk
|
|
*/
|
|
ExecutionGroup *executor_;
|
|
|
|
/**
|
|
* \brief the allocated memory
|
|
*/
|
|
MemoryBuffer *buffer_;
|
|
|
|
/**
|
|
* \brief datatype of this MemoryProxy
|
|
*/
|
|
DataType datatype_;
|
|
|
|
public:
|
|
MemoryProxy(DataType type);
|
|
|
|
/**
|
|
* \brief set the ExecutionGroup that can be scheduled to calculate a certain chunk.
|
|
* \param group: the ExecutionGroup to set
|
|
*/
|
|
void set_executor(ExecutionGroup *executor)
|
|
{
|
|
executor_ = executor;
|
|
}
|
|
|
|
/**
|
|
* \brief get the ExecutionGroup that can be scheduled to calculate a certain chunk.
|
|
*/
|
|
ExecutionGroup *get_executor() const
|
|
{
|
|
return executor_;
|
|
}
|
|
|
|
/**
|
|
* \brief set the WriteBufferOperation that is responsible for writing to this MemoryProxy
|
|
* \param operation:
|
|
*/
|
|
void set_write_buffer_operation(WriteBufferOperation *operation)
|
|
{
|
|
write_buffer_operation_ = operation;
|
|
}
|
|
|
|
/**
|
|
* \brief get the WriteBufferOperation that is responsible for writing to this MemoryProxy
|
|
* \return WriteBufferOperation
|
|
*/
|
|
WriteBufferOperation *get_write_buffer_operation() const
|
|
{
|
|
return write_buffer_operation_;
|
|
}
|
|
|
|
/**
|
|
* \brief allocate memory of size width x height
|
|
*/
|
|
void allocate(unsigned int width, unsigned int height);
|
|
|
|
/**
|
|
* \brief free the allocated memory
|
|
*/
|
|
void free();
|
|
|
|
/**
|
|
* \brief get the allocated memory
|
|
*/
|
|
inline MemoryBuffer *get_buffer()
|
|
{
|
|
return buffer_;
|
|
}
|
|
|
|
inline DataType get_data_type()
|
|
{
|
|
return datatype_;
|
|
}
|
|
|
|
#ifdef WITH_CXX_GUARDEDALLOC
|
|
MEM_CXX_CLASS_ALLOC_FUNCS("COM:MemoryProxy")
|
|
#endif
|
|
};
|
|
|
|
} // namespace blender::compositor
|