Kernel Tuning Toolkit 2.3
 
Loading...
Searching...
No Matches
ktt::BufferOutputDescriptor Class Reference

#include <BufferOutputDescriptor.h>

Public Member Functions

 BufferOutputDescriptor (const ArgumentId &id, void *outputDestination)
 
 BufferOutputDescriptor (const ArgumentId &id, void *outputDestination, const size_t outputSize)
 
const ArgumentIdGetArgumentId () const
 
void * GetOutputDestination () const
 
size_t GetOutputSize () const
 

Detailed Description

Class which can be used to retrieve kernel argument data when calling certain KTT API methods.

Constructor & Destructor Documentation

◆ BufferOutputDescriptor() [1/2]

ktt::BufferOutputDescriptor::BufferOutputDescriptor ( const ArgumentId id,
void *  outputDestination 
)
explicit

Constructor, which creates new output descriptor object for specified kernel argument.

Parameters
idId of vector argument which will be retrieved.
outputDestinationPointer to destination where vector argument data will be copied. Destination buffer size needs to be equal or greater than argument size.

◆ BufferOutputDescriptor() [2/2]

ktt::BufferOutputDescriptor::BufferOutputDescriptor ( const ArgumentId id,
void *  outputDestination,
const size_t  outputSize 
)
explicit

Constructor, which creates new output descriptor object for specified kernel argument.

Parameters
idId of vector argument which will be retrieved.
outputDestinationPointer to destination where vector argument data will be copied. Destination buffer size needs to be equal or greater than specified output size.
outputSizeSize of output in bytes which will be copied to specified destination, starting with the first byte in argument.

Member Function Documentation

◆ GetArgumentId()

const ArgumentId & ktt::BufferOutputDescriptor::GetArgumentId ( ) const

Getter for id of argument tied to output descriptor.

Returns
Id of argument tied to output descriptor.

◆ GetOutputDestination()

void * ktt::BufferOutputDescriptor::GetOutputDestination ( ) const

Getter for pointer to destination buffer tied to output descriptor.

Returns
Pointer to destination buffer tied to output descriptor.

◆ GetOutputSize()

size_t ktt::BufferOutputDescriptor::GetOutputSize ( ) const

Getter for data size retrieved with output descriptor.

Returns
Data size in bytes retrieved with output descriptor. Returns 0 if entire argument is retrieved.

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