rcdev.h

Go to the documentation of this file.

#ifndef RAYCOMPOSER_DEVICE_API_H
#define RAYCOMPOSER_DEVICE_API_H

#ifdef __cplusplus
extern "C" {
#endif

#define RCAPI_VERSION 0x0106

#if defined(_MSC_VER) || defined(__MINGW32__)

  #define RCCALL __stdcall
  //  Microsoft
  #ifdef RCAPI_BUILD

    #define RCAPI __declspec(dllexport) __stdcall
  #else

    #define RCAPI __declspec(dllimport) __stdcall
  #endif
#else

  #define RCCALL
  #if __GNUC__ >= 4

    #define RCAPI __attribute__ ((visibility ("default")))
  #else

    #define RCAPI
  #endif
#endif

enum RCReturnCode {
  RCOk = 0,
  RCErrorNotInitialised = -1,
  RCErrorNotEnumerated = -2,
  RCErrorInvalidHandle = -3,
  RCErrorNotStarted =-4,
  RCErrorIO = -5,
  RCErrorParameterOutOfRange = -6,
  RCErrorParameterInvalid = -7,
};

enum RCUniverseDirection {
  RCOutput = 0,
  RCInput = 1
};

struct RCPoint {
  signed short x;
  signed short y;
  unsigned short red;
  unsigned short green;
  unsigned short blue;
  unsigned short intensity;
  unsigned short user1;
  unsigned short user2;
};

int RCAPI RCInit();
typedef int (RCCALL *TRCInit)();

int RCAPI RCExit();
typedef int (RCCALL *TRCExit)();

int RCAPI RCEnumerateDevices();
typedef int (RCCALL *TRCEnumerateDevices)();

int RCAPI RCDeviceID(unsigned int index, char *deviceId, unsigned int maxLength);
typedef int (RCCALL *TRCDeviceID)(unsigned int, char *, unsigned int);

int RCAPI RCOpenDevice(const char *deviceId);
typedef int (RCCALL *TRCOpenDevice)(const char *);


int RCAPI RCCloseDevice(int handle);
typedef int (RCCALL *TRCCloseDevice)(int);

int RCAPI RCDeviceLabel(int handle, char *deviceLabel, unsigned int maxLength);
typedef int (RCCALL *TRCDeviceLabel)(int, char *, unsigned int);

int RCAPI RCSetDeviceLabel(int handle, const char *deviceLabel);
typedef int (RCCALL *TRCSetDeviceLabel)(int, const char *);

int RCAPI RCStartOutput(int handle);
typedef int (RCCALL *TRCStartOutput)(int);

int RCAPI RCStopOutput(int handle);
typedef int (RCCALL *TRCStopOutput)(int);

int RCAPI RCWaitForReady(int handle, int timeout);
typedef int (RCCALL *TRCWaitForReady)(int, int);

int RCAPI RCMaxSpeed(int handle);
typedef int (RCCALL *TRCMaxSpeed)(int);

int RCAPI RCWriteFrame(int handle, const struct RCPoint *points, unsigned int count, unsigned int speed, unsigned int repeat);
typedef int (RCCALL *TRCWriteFrame)(int, const struct RCPoint *, unsigned int, unsigned int, unsigned int);

int RCAPI RCUniverseCount(int handle);
typedef int (RCCALL *TRCUniverseCount)(int);


int RCAPI RCUniverseQuery(int handle, unsigned int universeIndex, char *universeName, unsigned int maxLength, enum RCUniverseDirection *pUniverseDirection, unsigned int *pChannelCount);
typedef int (RCCALL *TRCUniverseQuery)(int, unsigned int, char *, unsigned int, enum RCUniverseDirection *, unsigned int *);

int RCAPI RCUniverseWrite(int handle, unsigned int universeIndex, unsigned int startChannel, const unsigned char *data, unsigned int count);
typedef int (RCCALL *TRCUniverseWrite)(int, unsigned int, unsigned int, const unsigned char *, unsigned int);

int RCAPI RCUniverseRead(int handle, unsigned int universeIndex, unsigned int startChannel, unsigned char *data, unsigned int count);
typedef int (RCCALL *TRCUniverseRead)(int, unsigned int, unsigned int, unsigned char *, unsigned int);

int RCAPI RCUniverseUpdate(int handle, unsigned int universeIndex);
typedef int (RCCALL *TRCUniverseUpdate)(int, unsigned int);

#ifdef __cplusplus
}
#endif

#endif /* RAYCOMPOSER_DEVICE_API_H */