HDK
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
Public Member Functions | List of all members
FilterRef Class Reference

#include <oidn.hpp>

Public Member Functions

 FilterRef ()
 
 FilterRef (OIDNFilter handle)
 
 FilterRef (const FilterRef &other)
 
 FilterRef (FilterRef &&other) noexcept
 
FilterRef & operator= (const FilterRef &other)
 
FilterRef & operator= (FilterRef &&other) noexcept
 
FilterRef & operator= (OIDNFilter other)
 
 ~FilterRef ()
 
OIDNFilter getHandle () const
 
 operator bool () const
 
void release ()
 
void setImage (const char *name, const BufferRef &buffer, Format format, size_t width, size_t height, size_t byteOffset=0, size_t pixelByteStride=0, size_t rowByteStride=0)
 
void setImage (const char *name, void *devPtr, Format format, size_t width, size_t height, size_t byteOffset=0, size_t pixelByteStride=0, size_t rowByteStride=0)
 
void unsetImage (const char *name)
 
void removeImage (const char *name)
 
void setData (const char *name, void *hostPtr, size_t byteSize)
 
void updateData (const char *name)
 
void unsetData (const char *name)
 
void removeData (const char *name)
 
void set (const char *name, bool value)
 
void set (const char *name, int value)
 
void set (const char *name, Quality value)
 
void set (const char *name, float value)
 
template<typename T >
T get (const char *name) const
 
void setProgressMonitorFunction (ProgressMonitorFunction func, void *userPtr=nullptr)
 
void commit ()
 
void execute ()
 
void executeAsync ()
 
template<>
bool get (const char *name) const
 
template<>
int get (const char *name) const
 
template<>
Quality get (const char *name) const
 
template<>
float get (const char *name) const
 

Detailed Description

Definition at line 335 of file oidn.hpp.

Constructor & Destructor Documentation

FilterRef::FilterRef ( )
inline

Definition at line 338 of file oidn.hpp.

FilterRef::FilterRef ( OIDNFilter  handle)
inline

Definition at line 339 of file oidn.hpp.

FilterRef::FilterRef ( const FilterRef &  other)
inline

Definition at line 341 of file oidn.hpp.

FilterRef::FilterRef ( FilterRef &&  other)
inlinenoexcept

Definition at line 347 of file oidn.hpp.

FilterRef::~FilterRef ( )
inline

Definition at line 381 of file oidn.hpp.

Member Function Documentation

void FilterRef::commit ( )
inline

Definition at line 505 of file oidn.hpp.

void FilterRef::execute ( )
inline

Definition at line 511 of file oidn.hpp.

void FilterRef::executeAsync ( )
inline

Definition at line 517 of file oidn.hpp.

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

Definition at line 538 of file oidn.hpp.

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

Definition at line 544 of file oidn.hpp.

template<>
Quality FilterRef::get ( const char *  name) const
inline

Definition at line 550 of file oidn.hpp.

template<>
float FilterRef::get ( const char *  name) const
inline

Definition at line 556 of file oidn.hpp.

OIDNFilter FilterRef::getHandle ( ) const
inline

Definition at line 387 of file oidn.hpp.

FilterRef::operator bool ( ) const
inline

Definition at line 392 of file oidn.hpp.

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

Definition at line 352 of file oidn.hpp.

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

Definition at line 365 of file oidn.hpp.

FilterRef& FilterRef::operator= ( OIDNFilter  other)
inline

Definition at line 371 of file oidn.hpp.

void FilterRef::release ( )
inline

Definition at line 398 of file oidn.hpp.

void FilterRef::removeData ( const char *  name)
inline

Definition at line 466 of file oidn.hpp.

void FilterRef::removeImage ( const char *  name)
inline

Definition at line 442 of file oidn.hpp.

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

Definition at line 472 of file oidn.hpp.

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

Definition at line 478 of file oidn.hpp.

void FilterRef::set ( const char *  name,
Quality  value 
)
inline

Definition at line 483 of file oidn.hpp.

void FilterRef::set ( const char *  name,
float  value 
)
inline

Definition at line 489 of file oidn.hpp.

void FilterRef::setData ( const char *  name,
void *  hostPtr,
size_t  byteSize 
)
inline

Definition at line 448 of file oidn.hpp.

void FilterRef::setImage ( const char *  name,
const BufferRef &  buffer,
Format  format,
size_t  width,
size_t  height,
size_t  byteOffset = 0,
size_t  pixelByteStride = 0,
size_t  rowByteStride = 0 
)
inline

Definition at line 408 of file oidn.hpp.

void FilterRef::setImage ( const char *  name,
void *  devPtr,
Format  format,
size_t  width,
size_t  height,
size_t  byteOffset = 0,
size_t  pixelByteStride = 0,
size_t  rowByteStride = 0 
)
inline

Definition at line 422 of file oidn.hpp.

void FilterRef::setProgressMonitorFunction ( ProgressMonitorFunction  func,
void *  userPtr = nullptr 
)
inline

Definition at line 499 of file oidn.hpp.

void FilterRef::unsetData ( const char *  name)
inline

Definition at line 460 of file oidn.hpp.

void FilterRef::unsetImage ( const char *  name)
inline

Definition at line 436 of file oidn.hpp.

void FilterRef::updateData ( const char *  name)
inline

Definition at line 454 of file oidn.hpp.

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