xil_get_imagetype(3)

NAME

xil_get_imagetype − get an XilImageType object

SYNOPSIS

#include <xil/xil.h>

XilImageType xil_get_imagetype (XilImage image);

DESCRIPTION

This function returns an XilImageType object that contains information about the size, data type, and color space of an image. This function may be called on all images. An XilImageType object describes the characteristics of an image that will be generated (or expected) by a particular device (for example, a frame grabber or an output device). The characteristics of an XilImageType object are xsize, ysize, nbands, datatype, and colorspace. You obtain an XilImageType object from a call to xil_cis_get_output_type(3) or xil_cis_get_input_type(3). You use an XilImageType object to create images (via an xil_create_from_type(3) call) that will be compatible with a given device, compressor, and so on.

ERRORS

For a complete list of XIL error messages by number, consult Appendix B of the XIL Programmer’s Guide.

EXAMPLES

Get the imagetype of a particular image:

XilImage image;
XilImageType imagetype;
imagetype = xil_get_imagetype (image);

NOTES

After image is destroyed, the handle to the XilImageType object is no longer valid.

Museum

Related Articles