Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Convert image data returned from GrabFrame(), or similarly formatted image, to RGB. The output is normally 32 bits per pixel with B – G – R – X byte order.
The converted image could conceivably have different dimensions than the input image. The rgbWidth, rgbHeight and rgbBitDepth parameters will be filled in with the converted image size. These parameters may be NULL.

...

void SaveFrame(VARIANT Image)

Parameters

sState – Name of an integer-valued color pipe state variable.

Return Value

Value of the variable.

Remarks

Get the value of an integer-valued color pipe state variable. See the State Variables for a list of color pipe variables.

void SetState(BSTR sState, LONG nValue)

Parameters

sState – Name of an integer-valued color pipe state variable.
nValue – New value for the variable.

Remarks

Set the value of an integer-valued color pipe state variable.  See the State Variables for a list of color pipe variables.

BSTR GetStateStr(BSTR sState)

Parameters

sState – Name of a string-valued color pipe state variable.

Return Value

Value of the variable.

Remarks

Get the value of a string-valued color pipe state variable.  See the State Variables for a list of color pipe variables.

...

Image – An image received from the device, or a similarly formatted image.

Remarks

Save an image from GrabFrame() in any of several file formats, similar to the capability of the Image Save Options dialog in DevWareX. This function will use the ColorPipe() function to create RGB images for file formats requiring RGB. Set the file saving options and path with SetState() and SetStateStr() before calling this function.
Use LastError for the error code.

void GrabFrameAndSave(void)

Remarks

A convenience function equivalent to calling SaveFrame(GrabFrame()). This function is therefore similar to the Grab button on DevWareX.
Use LastError for the error code.

LONG GetState(BSTR sState)

Parameters

sState – Name of an stringinteger-valued color pipe state variable.sValue – New value for

Return Value

Value of the variable.

Remarks

Set Get the value of a stringan integer-valued color pipe state variable.  See See the State Variables for a list of color pipe variables.

void SetState(BSTR sState, LONG nValue)

Parameters

sState – Name of an integer-valued color pipe state variable.
nValue – New value for the variable.

Remarks

Set the value of an integer-valued color pipe state variable.  See the State Variables for a list of color pipe variables.

BSTR GetStateStr(BSTR sState)

Parameters

sState – Name of a string-valued color pipe state variable.

Return Value

Value of the variable.

Remarks

Get the value of a string-valued color pipe state variable.  See the State Variables for a list of color pipe variables.

void SetStateStr(BSTR sState, BSTR sValue)

Parameters

sState – Name of an string-valued color pipe state variable.
sValue – New value for the variable.

Remarks

Set the value of a string-valued color pipe state variable.  See the State Variables for a list of color pipe variables.

BSTR SystemDump(BSTR sAppFileName)

Parameters

sAppFileName – A a string containing the application name, which will be included in the output text.

Return Value

The System Dump text.

Remarks

This function creates the System Dump text, as on the DevWareX System Dump menu, or the xx_info.txt files saved by DevWareX. This function will read all device registers, and so can take several seconds.

The text from the szAppFileName parameter will appear in the output text as 'Application Name = ...'.

Functions for Enumerating Sensor or ISP Registers

...