NAME

xil_storage_set_band_stride, xil_storage_set_pixel_stride, xil_storage_set_scanline_stride, xil_storage_set_offset and xil_storage_set_data, xil_storage_set_data_release − set values on an XilStorage object

SYNOPSIS

#include <xil/xil.h>

void xil_storage_set_band_stride (XilStorage storage,

unsigned int band_stride);

void xil_storage_set_pixel_stride (XilStorage storage,

unsigned int band,
unsigned int pixel_stride);

void xil_storage_set_scanline_stride (XilStorage storage,

unsigned int band,
unsigned int scanline_stride);

void xil_storage_set_offset (XilStorage storage,

unsigned int band,
unsigned int offset);

void xil_storage_set_data (XilStorage storage,

unsigned int band,
void ∗data);

void xil_storage_set_data_release (XilStorage storage,

XilDataReleaseFuncPtr release_func,
void∗ user_args);

DESCRIPTION

Use these functions to set information on an XilStorage object.  When an XilStorage object is first created, the band stride, pixel stride, and scanline stride attributes are set to zero and the pointer to the image data is set to NULL. This information is filled in by the user prior to calling either xil_set_storage_with_copy(3) or xil_set_tile_storage(3). 

xil_storage_set_band_stride () sets the band stride of storage.  Band stride represents the distance to the same pixel in the next band.  Band stride is only valid for XIL_BAND_SEQUENTIAL and therefore does not take a band argument (which is of use only to XIL_GENERAL type storage). 

xil_storage_set_pixel_stride () sets the pixel stride of storage.  Pixel stride represents the distance to the next pixel on the same scanline.  For XIL_BAND_SEQUENTIAL, pixel stride is always 1.  The band argument is for use with XIL_GENERAL storage since each band may have a different pixel stride. For XIL_PIXEL_SEQUENTIAL images, it is only necessary to set the pixel stride for band 0. 

xil_storage_set_scanline_stride () sets the scanline stride of storage.  Scanline stride represents the distance to the same pixel on the next horizontal scanline (the vertical stride). The band argument is for use with XIL_GENERAL storage since each band may have a different scanline stride. For XIL_PIXEL_SEQUENTIAL and XIL_BAND_SEQUENTIAL images, it is only necessary to set the scanline stride for band 0. 

xil_storage_set_offset () sets the offset into the first byte storage.  The offset represents the number of bits to offset to the first pixel.  This call is valid only for XIL_BIT images. The band argument is for use with XIL_GENERAL storage since each band may have a different offset. For XIL_BAND_SEQUENTIAL images, it is only necessary to set the offset for band 0. 

xil_storage_set_data () sets the data pointer. The data pointer is the starting address of the storage with data units of the appropriate type for the image. The band argument is for use with XIL_GENERAL storage since each band may have a different data pointer. For XIL_PIXEL_SEQUENTIAL or XIL_BAND_SEQUENTIAL storage, it is only necessary to set the data pointer for band 0. 

The user may choose to add a data release function pointer to the storage object. If this function pointer is set, XIL will call back to the user when it is done with the data. If the function pointer is not set, no action is taken when XIL is done with the data. The prototype for the XilDataReleaseFuncPtr is:

typedef void (∗XilDataReleaseFuncPtr)(void∗, void∗);

The first argument is the data pointer that is no longer used. The second argument is for the arguments provided as user_args in xil_storage_set_data_release ().

ERRORS

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

SEE ALSO

Storage(3), xil_set_tile_storage(3), xil_set_storage_with_copy(3). 

SunOS 5.6  —  Last change: 01 January 1997