HDK
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
oidn.h File Reference
#include <stddef.h>
#include <stdbool.h>
#include <stdint.h>
#include "version.h"
+ Include dependency graph for oidn.h:
+ This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Macros

#define OIDN_API
 

Typedefs

typedef void(* OIDNErrorFunction )(void *userPtr, OIDNError code, const char *message)
 
typedef struct OIDNDeviceImpl * OIDNDevice
 
typedef struct OIDNBufferImpl * OIDNBuffer
 
typedef bool(* OIDNProgressMonitorFunction )(void *userPtr, double n)
 
typedef struct OIDNFilterImpl * OIDNFilter
 

Enumerations

enum  OIDNDeviceType { OIDN_DEVICE_TYPE_DEFAULT = 0, OIDN_DEVICE_TYPE_CPU = 1 }
 
enum  OIDNError {
  OIDN_ERROR_NONE = 0, OIDN_ERROR_UNKNOWN = 1, OIDN_ERROR_INVALID_ARGUMENT = 2, OIDN_ERROR_INVALID_OPERATION = 3,
  OIDN_ERROR_OUT_OF_MEMORY = 4, OIDN_ERROR_UNSUPPORTED_HARDWARE = 5, OIDN_ERROR_CANCELLED = 6
}
 
enum  OIDNFormat {
  OIDN_FORMAT_UNDEFINED = 0, OIDN_FORMAT_FLOAT = 1, OIDN_FORMAT_FLOAT2 = 2, OIDN_FORMAT_FLOAT3 = 3,
  OIDN_FORMAT_FLOAT4 = 4
}
 
enum  OIDNAccess { OIDN_ACCESS_READ = 0, OIDN_ACCESS_WRITE = 1, OIDN_ACCESS_READ_WRITE = 2, OIDN_ACCESS_WRITE_DISCARD = 3 }
 

Functions

OIDN_API OIDNDevice oidnNewDevice (OIDNDeviceType type)
 
OIDN_API void oidnRetainDevice (OIDNDevice device)
 
OIDN_API void oidnReleaseDevice (OIDNDevice device)
 
OIDN_API void oidnSetDevice1b (OIDNDevice device, const char *name, bool value)
 
OIDN_API void oidnSetDevice1i (OIDNDevice device, const char *name, int value)
 
OIDN_API bool oidnGetDevice1b (OIDNDevice device, const char *name)
 
OIDN_API int oidnGetDevice1i (OIDNDevice device, const char *name)
 
OIDN_API void oidnSetDeviceErrorFunction (OIDNDevice device, OIDNErrorFunction func, void *userPtr)
 
OIDN_API OIDNError oidnGetDeviceError (OIDNDevice device, const char **outMessage)
 
OIDN_API void oidnCommitDevice (OIDNDevice device)
 
OIDN_API OIDNBuffer oidnNewBuffer (OIDNDevice device, size_t byteSize)
 
OIDN_API OIDNBuffer oidnNewSharedBuffer (OIDNDevice device, void *ptr, size_t byteSize)
 
OIDN_API voidoidnMapBuffer (OIDNBuffer buffer, OIDNAccess access, size_t byteOffset, size_t byteSize)
 
OIDN_API void oidnUnmapBuffer (OIDNBuffer buffer, void *mappedPtr)
 
OIDN_API void oidnRetainBuffer (OIDNBuffer buffer)
 
OIDN_API void oidnReleaseBuffer (OIDNBuffer buffer)
 
OIDN_API OIDNFilter oidnNewFilter (OIDNDevice device, const char *type)
 
OIDN_API void oidnRetainFilter (OIDNFilter filter)
 
OIDN_API void oidnReleaseFilter (OIDNFilter filter)
 
OIDN_API void oidnSetFilterImage (OIDNFilter filter, const char *name, OIDNBuffer buffer, OIDNFormat format, size_t width, size_t height, size_t byteOffset, size_t bytePixelStride, size_t byteRowStride)
 
OIDN_API void oidnSetSharedFilterImage (OIDNFilter filter, const char *name, void *ptr, OIDNFormat format, size_t width, size_t height, size_t byteOffset, size_t bytePixelStride, size_t byteRowStride)
 
OIDN_API void oidnSetFilter1b (OIDNFilter filter, const char *name, bool value)
 
OIDN_API bool oidnGetFilter1b (OIDNFilter filter, const char *name)
 
OIDN_API void oidnSetFilter1i (OIDNFilter filter, const char *name, int value)
 
OIDN_API int oidnGetFilter1i (OIDNFilter filter, const char *name)
 
OIDN_API void oidnSetFilter1f (OIDNFilter filter, const char *name, float value)
 
OIDN_API float oidnGetFilter1f (OIDNFilter filter, const char *name)
 
OIDN_API void oidnSetFilterProgressMonitorFunction (OIDNFilter filter, OIDNProgressMonitorFunction func, void *userPtr)
 
OIDN_API void oidnCommitFilter (OIDNFilter filter)
 
OIDN_API void oidnExecuteFilter (OIDNFilter filter)
 

Macro Definition Documentation

#define OIDN_API

Definition at line 33 of file oidn.h.

Typedef Documentation

typedef struct OIDNBufferImpl* OIDNBuffer

Definition at line 127 of file oidn.h.

typedef struct OIDNDeviceImpl* OIDNDevice

Definition at line 65 of file oidn.h.

typedef void(* OIDNErrorFunction)(void *userPtr, OIDNError code, const char *message)

Definition at line 62 of file oidn.h.

typedef struct OIDNFilterImpl* OIDNFilter

Definition at line 157 of file oidn.h.

typedef bool(* OIDNProgressMonitorFunction)(void *userPtr, double n)

Definition at line 154 of file oidn.h.

Enumeration Type Documentation

enum OIDNAccess
Enumerator
OIDN_ACCESS_READ 
OIDN_ACCESS_WRITE 
OIDN_ACCESS_READ_WRITE 
OIDN_ACCESS_WRITE_DISCARD 

Definition at line 118 of file oidn.h.

Enumerator
OIDN_DEVICE_TYPE_DEFAULT 
OIDN_DEVICE_TYPE_CPU 

Definition at line 42 of file oidn.h.

enum OIDNError
Enumerator
OIDN_ERROR_NONE 
OIDN_ERROR_UNKNOWN 
OIDN_ERROR_INVALID_ARGUMENT 
OIDN_ERROR_INVALID_OPERATION 
OIDN_ERROR_OUT_OF_MEMORY 
OIDN_ERROR_UNSUPPORTED_HARDWARE 
OIDN_ERROR_CANCELLED 

Definition at line 50 of file oidn.h.

enum OIDNFormat
Enumerator
OIDN_FORMAT_UNDEFINED 
OIDN_FORMAT_FLOAT 
OIDN_FORMAT_FLOAT2 
OIDN_FORMAT_FLOAT3 
OIDN_FORMAT_FLOAT4 

Definition at line 106 of file oidn.h.

Function Documentation

OIDN_API void oidnCommitDevice ( OIDNDevice  device)
OIDN_API void oidnCommitFilter ( OIDNFilter  filter)
OIDN_API void oidnExecuteFilter ( OIDNFilter  filter)
OIDN_API bool oidnGetDevice1b ( OIDNDevice  device,
const char *  name 
)
OIDN_API int oidnGetDevice1i ( OIDNDevice  device,
const char *  name 
)
OIDN_API OIDNError oidnGetDeviceError ( OIDNDevice  device,
const char **  outMessage 
)
OIDN_API bool oidnGetFilter1b ( OIDNFilter  filter,
const char *  name 
)
OIDN_API float oidnGetFilter1f ( OIDNFilter  filter,
const char *  name 
)
OIDN_API int oidnGetFilter1i ( OIDNFilter  filter,
const char *  name 
)
OIDN_API void* oidnMapBuffer ( OIDNBuffer  buffer,
OIDNAccess  access,
size_t  byteOffset,
size_t  byteSize 
)
OIDN_API OIDNBuffer oidnNewBuffer ( OIDNDevice  device,
size_t  byteSize 
)
OIDN_API OIDNDevice oidnNewDevice ( OIDNDeviceType  type)
OIDN_API OIDNFilter oidnNewFilter ( OIDNDevice  device,
const char *  type 
)
OIDN_API OIDNBuffer oidnNewSharedBuffer ( OIDNDevice  device,
void ptr,
size_t  byteSize 
)
OIDN_API void oidnReleaseBuffer ( OIDNBuffer  buffer)
OIDN_API void oidnReleaseDevice ( OIDNDevice  device)
OIDN_API void oidnReleaseFilter ( OIDNFilter  filter)
OIDN_API void oidnRetainBuffer ( OIDNBuffer  buffer)
OIDN_API void oidnRetainDevice ( OIDNDevice  device)
OIDN_API void oidnRetainFilter ( OIDNFilter  filter)
OIDN_API void oidnSetDevice1b ( OIDNDevice  device,
const char *  name,
bool  value 
)
OIDN_API void oidnSetDevice1i ( OIDNDevice  device,
const char *  name,
int  value 
)
OIDN_API void oidnSetDeviceErrorFunction ( OIDNDevice  device,
OIDNErrorFunction  func,
void userPtr 
)
OIDN_API void oidnSetFilter1b ( OIDNFilter  filter,
const char *  name,
bool  value 
)
OIDN_API void oidnSetFilter1f ( OIDNFilter  filter,
const char *  name,
float  value 
)
OIDN_API void oidnSetFilter1i ( OIDNFilter  filter,
const char *  name,
int  value 
)
OIDN_API void oidnSetFilterImage ( OIDNFilter  filter,
const char *  name,
OIDNBuffer  buffer,
OIDNFormat  format,
size_t  width,
size_t  height,
size_t  byteOffset,
size_t  bytePixelStride,
size_t  byteRowStride 
)
OIDN_API void oidnSetFilterProgressMonitorFunction ( OIDNFilter  filter,
OIDNProgressMonitorFunction  func,
void userPtr 
)
OIDN_API void oidnSetSharedFilterImage ( OIDNFilter  filter,
const char *  name,
void ptr,
OIDNFormat  format,
size_t  width,
size_t  height,
size_t  byteOffset,
size_t  bytePixelStride,
size_t  byteRowStride 
)
OIDN_API void oidnUnmapBuffer ( OIDNBuffer  buffer,
void mappedPtr 
)