HDK
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
DeviceRef Class Reference

#include <oidn.hpp>

Public Member Functions

 DeviceRef ()
 
 DeviceRef (OIDNDevice handle)
 
 DeviceRef (const DeviceRef &other)
 
 DeviceRef (DeviceRef &&other) noexcept
 
DeviceRefoperator= (const DeviceRef &other)
 
DeviceRefoperator= (DeviceRef &&other) noexcept
 
DeviceRefoperator= (OIDNDevice other)
 
 ~DeviceRef ()
 
OIDNDevice getHandle () const
 
 operator bool () const
 
void release ()
 
void set (const char *name, bool value)
 
void set (const char *name, int value)
 
void set (const char *name, unsigned int value)
 
template<typename T >
T get (const char *name) const
 
void setErrorFunction (ErrorFunction func, void *userPtr=nullptr)
 
Error getError ()
 
Error getError (const char *&outMessage)
 
void commit ()
 
void sync ()
 
BufferRef newBuffer (size_t byteSize) const
 
BufferRef newBuffer (size_t byteSize, Storage storage) const
 
BufferRef newBuffer (void *ptr, size_t byteSize) const
 
BufferRef newBuffer (ExternalMemoryTypeFlag fdType, int fd, size_t byteSize) const
 
BufferRef newBuffer (ExternalMemoryTypeFlag handleType, void *handle, const void *name, size_t byteSize) const
 
FilterRef newFilter (const char *type) const
 
template<>
bool get (const char *name) const
 
template<>
int get (const char *name) const
 
template<>
unsigned int get (const char *name) const
 
template<>
DeviceType get (const char *name) const
 
template<>
ExternalMemoryTypeFlags get (const char *name) const
 

Detailed Description

Definition at line 612 of file oidn.hpp.

Constructor & Destructor Documentation

DeviceRef::DeviceRef ( )
inline

Definition at line 615 of file oidn.hpp.

DeviceRef::DeviceRef ( OIDNDevice  handle)
inline

Definition at line 616 of file oidn.hpp.

DeviceRef::DeviceRef ( const DeviceRef other)
inline

Definition at line 618 of file oidn.hpp.

DeviceRef::DeviceRef ( DeviceRef &&  other)
inlinenoexcept

Definition at line 624 of file oidn.hpp.

DeviceRef::~DeviceRef ( )
inline

Definition at line 658 of file oidn.hpp.

Member Function Documentation

void DeviceRef::commit ( )
inline

Definition at line 729 of file oidn.hpp.

template<typename T >
T DeviceRef::get ( const char *  name) const
template<>
bool DeviceRef::get ( const char *  name) const
inline

Definition at line 793 of file oidn.hpp.

template<>
int DeviceRef::get ( const char *  name) const
inline

Definition at line 799 of file oidn.hpp.

template<>
unsigned int DeviceRef::get ( const char *  name) const
inline

Definition at line 805 of file oidn.hpp.

template<>
DeviceType DeviceRef::get ( const char *  name) const
inline

Definition at line 811 of file oidn.hpp.

template<>
ExternalMemoryTypeFlags DeviceRef::get ( const char *  name) const
inline

Definition at line 817 of file oidn.hpp.

Error DeviceRef::getError ( )
inline

Definition at line 715 of file oidn.hpp.

Error DeviceRef::getError ( const char *&  outMessage)
inline

Definition at line 722 of file oidn.hpp.

OIDNDevice DeviceRef::getHandle ( ) const
inline

Definition at line 664 of file oidn.hpp.

BufferRef DeviceRef::newBuffer ( size_t  byteSize) const
inline

Definition at line 741 of file oidn.hpp.

BufferRef DeviceRef::newBuffer ( size_t  byteSize,
Storage  storage 
) const
inline

Definition at line 747 of file oidn.hpp.

BufferRef DeviceRef::newBuffer ( void ptr,
size_t  byteSize 
) const
inline

Definition at line 754 of file oidn.hpp.

BufferRef DeviceRef::newBuffer ( ExternalMemoryTypeFlag  fdType,
int  fd,
size_t  byteSize 
) const
inline

Definition at line 760 of file oidn.hpp.

BufferRef DeviceRef::newBuffer ( ExternalMemoryTypeFlag  handleType,
void handle,
const void name,
size_t  byteSize 
) const
inline

Definition at line 767 of file oidn.hpp.

FilterRef DeviceRef::newFilter ( const char *  type) const
inline

Definition at line 783 of file oidn.hpp.

DeviceRef::operator bool ( ) const
inline

Definition at line 669 of file oidn.hpp.

DeviceRef& DeviceRef::operator= ( const DeviceRef other)
inline

Definition at line 629 of file oidn.hpp.

DeviceRef& DeviceRef::operator= ( DeviceRef &&  other)
inlinenoexcept

Definition at line 642 of file oidn.hpp.

DeviceRef& DeviceRef::operator= ( OIDNDevice  other)
inline

Definition at line 648 of file oidn.hpp.

void DeviceRef::release ( )
inline

Definition at line 675 of file oidn.hpp.

void DeviceRef::set ( const char *  name,
bool  value 
)
inline

Definition at line 685 of file oidn.hpp.

void DeviceRef::set ( const char *  name,
int  value 
)
inline

Definition at line 691 of file oidn.hpp.

void DeviceRef::set ( const char *  name,
unsigned int  value 
)
inline

Definition at line 697 of file oidn.hpp.

void DeviceRef::setErrorFunction ( ErrorFunction  func,
void userPtr = nullptr 
)
inline

Definition at line 707 of file oidn.hpp.

void DeviceRef::sync ( )
inline

Definition at line 735 of file oidn.hpp.


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