NAME

xil_storage_get_band_stride, xil_storage_get_pixel_stride, xil_storage_get_scanline_stride, xil_storage_get_offset, xil_storage_get_data − get the values set on an XilStorage object

SYNOPSIS

#include <xil/xil.h>

unsigned int xil_storage_get_band_stride (XilStorage storage);

unsigned int xil_storage_get_pixel_stride (XilStorage storage,

unsigned int band);

unsigned int xil_storage_get_scanline_stride (XilStorage storage,

unsigned int band);

unsigned int xil_storage_get_offset (XilStorage storage,

unsigned int band);

void ∗ xil_storage_get_data (XilStorage storage,

unsigned int band);

DESCRIPTION

Use these functions to get information about 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 when the XilStorage object is used with xil_get_storage_with_copy(3) or xil_get_tile_storage(3), or when set explicitly by the user. 

xil_storage_get_band_stride () returns the band stride of storage.  Band stride represents the distance to the same pixel in the next band.  For XIL_PIXEL_SEQUENTIAL storage, the band stride is always 1.  Band stride is undefined for XIL_GENERAL storage as there is no band correlation for XIL_GENERAL storage. 

xil_storage_get_pixel_stride () returns the pixel stride of the storage for band.  Pixel stride represents the distance to the next pixel on the same scanline.  For XIL_BAND_SEQUENTIAL, pixel stride is always 1. It is only necessary to query for bands other than 0 for XIL_GENERAL storage. 

xil_storage_get_scanline_stride () returns the scanline stride of the storage for band.  Scanline stride represents the distance to the same pixel on the next horizontal scanline (the vertical stride). It is only necessary to query for bands other than 0 for XIL_GENERAL storage. 

xil_storage_get_offset () returns the offset for the data in storage for band.  The offset represents the number of bits to offset to the first pixel.  This call is valid only for XIL_BIT images. It is only necessary to query for bands other than 0 for XIL_GENERAL storage. 

xil_storage_get_data () returns the data pointer for the data in storage for band.  The data pointer is the starting address of the storage with data units of the appropriate type for the image. It is only necessary to query for bands other than 0 for XIL_GENERAL storage. 

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_storage_is_type(3), xil_get_tile_storage(3), xil_get_storage_with_copy(3)

SunOS 5.6  —  Last change: 01 January 1997