Functions
Show_Compressed_Image

Functions

void Show_Compressed_Image (HC_KEY key, float *x, float *y, float *z, char *format, int *width, int *height, int *size, void *data)
 Returns the pixel data associated with provided image key. This API should only be used if the underlying image data is in a compressed form. More...
 
void DShow_Compressed_Image (HC_KEY key, double *x, double *y, double *z, char *format, int *width, int *height, int *size, void *data)
 Similar to Show_Compressed_Image(), but operates on double-precision data. More...
 
void Show_Compressed_Image_Size (HC_KEY key, char *format, int *width, int *height, int *size)
 Finds the size of a particular image, This is useful in determining the size of the data structure that must hold data More...
 

Detailed Description

Function Documentation

void DShow_Compressed_Image ( HC_KEY  key,
double *  x,
double *  y,
double *  z,
char *  format,
int *  width,
int *  height,
int *  size,
void *  data 
)

Similar to Show_Compressed_Image(), but operates on double-precision data.

Parameters
key- Unique numeric identifier pointing to an image in the database.
x- The x coordinate of the center of the image (Returned to caller).
y- The y coordinate of the center of the image. (Returned to caller).
z- The z coordinate of the center of the image. (Returned to caller).
format- A description of how data in the data array is packed (Returned to caller). See Insert_Image() for details.
width- The number of columns (Returned to caller).
height- The number of rows (Returned to caller).
size- Size of the image in bytes. Returned to caller.
data- The pixel values currently stored in the image referenced by key, encoded according to format. Returned to caller. Passed by reference always.
void Show_Compressed_Image ( HC_KEY  key,
float *  x,
float *  y,
float *  z,
char *  format,
int *  width,
int *  height,
int *  size,
void *  data 
)

Returns the pixel data associated with provided image key. This API should only be used if the underlying image data is in a compressed form.

Parameters
key- Unique numeric identifier pointing to an image in the database.
x- The x coordinate of the center of the image. (Returned to caller).
y- The y coordinate of the center of the image. (Returned to caller).
z- The z coordinate of the center of the image. (Returned to caller).
format- A description of how data in the data array is packed (Returned to caller). See Insert_Image() for details.
width- The number of columns (Returned to caller).
height- The number of rows (Returned to caller).
size- Size of the image in bytes. Returned to caller.
data- The pixel values currently stored in the image referenced by key, encoded according to format. Returned to caller. Passed by reference always.

NOTES

You cannot do a Show_Image() on a compressed image or Show_Compressed_Image() on an uncompressed image. To determine which API to use developers should first query the image type via Show_Image_Type and then use the appropriate Show function.

See also
Show_Compressed_Image, Insert_Compressed_Image, Edit_Image.
void Show_Compressed_Image_Size ( HC_KEY  key,
char *  format,
int *  width,
int *  height,
int *  size 
)

Finds the size of a particular image, This is useful in determining the size of the data structure that must hold data

Parameters
key- Unique numeric identifier pointing to a compressed image in the database.
format- A description of how data in the data array is packed. See Insert_Image. Returned to caller. Passed by reference always.
width- The number of columns in data
height- The number of rows in data
size- Size of the image in bytes. Returned to caller.

DETAILS

No additional details. See Show_Compressed_Image().