Blender  V2.93
Public Member Functions | List of all members
blender::compositor::MemoryProxy Class Reference

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. More...

#include <COM_MemoryProxy.h>

Public Member Functions

 MemoryProxy (DataType type)
 
void setExecutor (ExecutionGroup *executor)
 set the ExecutionGroup that can be scheduled to calculate a certain chunk. More...
 
ExecutionGroupgetExecutor () const
 get the ExecutionGroup that can be scheduled to calculate a certain chunk. More...
 
void setWriteBufferOperation (WriteBufferOperation *operation)
 set the WriteBufferOperation that is responsible for writing to this MemoryProxy More...
 
WriteBufferOperationgetWriteBufferOperation () const
 get the WriteBufferOperation that is responsible for writing to this MemoryProxy More...
 
void allocate (unsigned int width, unsigned int height)
 allocate memory of size width x height More...
 
void free ()
 free the allocated memory More...
 
MemoryBuffergetBuffer ()
 get the allocated memory More...
 
DataType getDataType ()
 

Detailed Description

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.

Definition at line 36 of file COM_MemoryProxy.h.

Constructor & Destructor Documentation

◆ MemoryProxy()

blender::compositor::MemoryProxy::MemoryProxy ( DataType  type)

Definition at line 27 of file COM_MemoryProxy.cc.

Member Function Documentation

◆ allocate()

void blender::compositor::MemoryProxy::allocate ( unsigned int  width,
unsigned int  height 
)

allocate memory of size width x height

Definition at line 34 of file COM_MemoryProxy.cc.

References blender::compositor::Default, height, result, and width.

Referenced by blender::compositor::WriteBufferOperation::initExecution().

◆ free()

void blender::compositor::MemoryProxy::free ( )

free the allocated memory

Definition at line 45 of file COM_MemoryProxy.cc.

Referenced by blender::compositor::WriteBufferOperation::deinitExecution().

◆ getBuffer()

MemoryBuffer* blender::compositor::MemoryProxy::getBuffer ( )
inline

◆ getDataType()

DataType blender::compositor::MemoryProxy::getDataType ( )
inline

Definition at line 114 of file COM_MemoryProxy.h.

Referenced by blender::compositor::MemoryBuffer::MemoryBuffer().

◆ getExecutor()

ExecutionGroup* blender::compositor::MemoryProxy::getExecutor ( ) const
inline

◆ getWriteBufferOperation()

WriteBufferOperation* blender::compositor::MemoryProxy::getWriteBufferOperation ( ) const
inline

◆ setExecutor()

void blender::compositor::MemoryProxy::setExecutor ( ExecutionGroup executor)
inline

set the ExecutionGroup that can be scheduled to calculate a certain chunk.

Parameters
groupthe ExecutionGroup to set

Definition at line 65 of file COM_MemoryProxy.h.

Referenced by blender::compositor::NodeOperationBuilder::group_operations(), and blender::compositor::WriteBufferOperation::WriteBufferOperation().

◆ setWriteBufferOperation()

void blender::compositor::MemoryProxy::setWriteBufferOperation ( WriteBufferOperation operation)
inline

set the WriteBufferOperation that is responsible for writing to this MemoryProxy

Parameters
operation

Definition at line 82 of file COM_MemoryProxy.h.

Referenced by blender::compositor::WriteBufferOperation::WriteBufferOperation().


The documentation for this class was generated from the following files: