kp::OpSyncLocal Class Reference

#include <OpSyncLocal.hpp>

Inheritance diagram for kp::OpSyncLocal:

Collaboration diagram for kp::OpSyncLocal:

Public Member Functions
	OpSyncLocal (const std::vector< std::shared_ptr< Memory > > &memObjects)
	OpSyncLocal (const OpSyncLocal &)=delete
	Make OpSyncLocal non-copyable.
	OpSyncLocal (const OpSyncLocal &&)=delete
OpSyncLocal &	operator= (const OpSyncLocal &)=delete
OpSyncLocal &	operator= (const OpSyncLocal &&)=delete
	~OpSyncLocal () noexcept override
void	record (const vk::CommandBuffer &commandBuffer) override
virtual void	preEval (const vk::CommandBuffer &commandBuffer) override
virtual void	postEval (const vk::CommandBuffer &commandBuffer) override
Public Member Functions inherited from kp::OpBase
	OpBase ()=default
	Construct a new OpBase object.
	OpBase (const OpBase &)=delete
	Make OpBase non-copyable.
	OpBase (const OpBase &&)=delete
OpBase &	operator= (const OpBase &)=delete
OpBase &	operator= (const OpBase &&)=delete
virtual	~OpBase () noexcept

Detailed Description

Operation that syncs mem object's local memory by mapping device data into the local CPU memory. For MemoryTypes::eDevice it will use a record operation for the memory to be syncd into GPU memory which means that the operation will be done in sync with GPU commands. For MemoryTypes::eHost it will only map the data into host memory which will happen during preEval before the recorded commands are dispatched.

Constructor & Destructor Documentation

OpSyncLocal()

kp::OpSyncLocal::OpSyncLocal

(

const std::vector< std::shared_ptr< Memory > > &

memObjects

)

Default constructor with parameters that provides the core vulkan resources and the memory that will be used in the operation. The memory provided cannot be of type MemoryTypes::eStorage.

Parameters

memObjects

Memory objects that will be used to create in operation.

~OpSyncLocal()

kp::OpSyncLocal::~OpSyncLocal ( )

overridenoexcept

Default destructor. This class does not manage memory so it won't be expecting the parent to perform a release.

Member Function Documentation

postEval()

virtual void kp::OpSyncLocal::postEval ( const vk::CommandBuffer &  commandBuffer )

overridevirtual

For host memory objects it performs the map command from the host memory into local memory.

Parameters

commandBuffer

The command buffer to record the command into.

Implements kp::OpBase.

preEval()

virtual void kp::OpSyncLocal::preEval ( const vk::CommandBuffer &  commandBuffer )

overridevirtual

Does not perform any preEval commands.

Parameters

commandBuffer

The command buffer to record the command into.

Implements kp::OpBase.

record()

void kp::OpSyncLocal::record ( const vk::CommandBuffer &  commandBuffer )

overridevirtual

For device memory objects, it records the copy command for the tensor to copy the data from its device to staging memory.

Parameters

commandBuffer

The command buffer to record the command into.

Implements kp::OpBase.

---

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

• /home/me/development/kompute/src/include/kompute/operations/OpSyncLocal.hpp