RayComposer Device API Documentation  1.6
Public API for RayComposer laser show DAC interfaces.
 All Data Structures Files Functions Variables Typedefs Enumerations Enumerator Macros Modules Pages
Laser Output

Start and Stop laser output. Write frames and query buffer status. More...

Typedefs

typedef int(RCCALLTRCStartOutput )(int)
 
typedef int(RCCALLTRCStopOutput )(int)
 
typedef int(RCCALLTRCWaitForReady )(int, int)
 
typedef int(RCCALLTRCMaxSpeed )(int)
 
typedef int(RCCALLTRCWriteFrame )(int, const struct RCPoint *, unsigned int, unsigned int, unsigned int)
 

Functions

int RCAPI RCStartOutput (int handle)
 Start Laser Output. More...
 
int RCAPI RCStopOutput (int handle)
 Stop Laser Output. More...
 
int RCAPI RCWaitForReady (int handle, int timeout)
 Wait for Buffer. More...
 
int RCAPI RCMaxSpeed (int handle)
 Query maximum sampling rate of the device. More...
 
int RCAPI RCWriteFrame (int handle, const struct RCPoint *points, unsigned int count, unsigned int speed, unsigned int repeat)
 Write Frame. More...
 

Detailed Description

Start and Stop laser output. Write frames and query buffer status.

Typedef Documentation

typedef int(RCCALL * TRCStartOutput)(int)

Function type definition for RCStartOutput()

typedef int(RCCALL * TRCStopOutput)(int)

Function type definition for RCStopOutput()

typedef int(RCCALL * TRCWaitForReady)(int, int)

Function type definition for RCWaitForReady()

typedef int(RCCALL * TRCMaxSpeed)(int)

Function type definition for RCMaxSpeed()

typedef int(RCCALL * TRCWriteFrame)(int, const struct RCPoint *, unsigned int, unsigned int, unsigned int)

Function type definition for RCWriteFrame()

Function Documentation

int RCAPI RCStartOutput ( int  handle)

Start Laser Output.

This function initialises the device and activates the shutter signal.

Parameters
handleDevice handle as obtained by RCOpenDevice();
Returns
RCOk on success. If an error occured, a negative value indicating one of the RCReturnCode error codes is returned.
int RCAPI RCStopOutput ( int  handle)

Stop Laser Output.

This function stops the laser output and deactivates the shutter signal.

Parameters
handleDevice handle as obtained by RCOpenDevice();
Returns
RCOk on success. If an error occured, a negative value indicating one of the RCReturnCode error codes is returned.
int RCAPI RCWaitForReady ( int  handle,
int  timeout 
)

Wait for Buffer.

Parameters
handleDevice handle as obtained by RCOpenDevice();
timeoutThe maximum time to wait for a buffer to become free in milliseconds.

If timeOut is is zero, this function does not wait und returns the number of free buffers immediately. If timeOut is negative, this function will wait for a buffer to become free without timing out.

Returns
The number of free buffers. If an error occured, a negative value indicating one of the RCReturnCode error codes is returned.
int RCAPI RCMaxSpeed ( int  handle)

Query maximum sampling rate of the device.

This function queries the maximum sampling rate of the device in Hz.

Parameters
handleDevice handle as obtained by RCOpenDevice(int handle);
Returns
The maximum sampling rate of the device in Hz. If an error occured, a negative value indicating one of the RCReturnCode error codes is returned.
int RCAPI RCWriteFrame ( int  handle,
const struct RCPoint points,
unsigned int  count,
unsigned int  speed,
unsigned int  repeat 
)

Write Frame.

Write a frame to the device.

Parameters
handleDevice handle as obtained by RCOpenDevice()
pointspointer to an array of RCPoint structures containing the vector data;
countnumber of points that should be written
speedsampling rate in Hz that should be used for this frame
repeathow often this frame should be repeated. If 0, the frame will be repeated continuously until a new frame is written.
Returns
RCOk on success. If an error occured, a negative value indicating one of the RCReturnCode error codes is returned.