EnqueueReadSubBuffer

void tt::tt_metal::v0::EnqueueReadSubBuffer(CommandQueue &cq, std::variant<std::reference_wrapper<Buffer>, std::shared_ptr<Buffer>> buffer, void *dst, const BufferRegion &region, bool blocking)

Reads a specified region of the buffer from the device

Return value: void

Argument

Description

Type

Valid Range

Required

cq

The command queue object which dispatches the command to the hardware

CommandQueue &

Yes

buffer

The device buffer we are reading from

Buffer & or std::shared_ptr<Buffer>

Yes

dst

The memory where the result will be stored

void*

Yes

region

The region of the buffer that we are reading from

const BufferRegion &

Yes

blocking

Whether or not this is a blocking operation

bool

Yes

template<typename DType>
void tt::tt_metal::v0::EnqueueReadSubBuffer(CommandQueue &cq, Buffer &buffer, std::vector<DType> &dst, const BufferRegion &region, bool blocking)

Reads a specified region of the buffer from the device

Return value: void

Argument

Description

Type

Valid Range

Required

cq

The command queue object which dispatches the command to the hardware

CommandQueue &

Yes

buffer

The device buffer we are reading from

Buffer & or std::shared_ptr<Buffer>

Yes

dst

The vector where the results that are read will be stored

vector<DType> &

Yes

region

The region of the buffer that we are reading from

const BufferRegion &

Yes

blocking

Whether or not this is a blocking operation

bool

Yes