xil_state_get_default_tiling_mode(3)

NAME

xil_state_get_default_tiling_mode, xil_state_set_default_tiling_mode - get and set the default tiling mode for all images created with a particular XilSystemState

SYNOPSIS

#include <xil/xil.h>

XilTilingMode xil_state_get_default_tiling_mode (XilSystemState State);
int xil_state_set_default_tilesize (XilSystemState State,

XilTilingMode tiling_mode);

DESCRIPTION

tiling mode is the tiling mode of the images, which can be one of the following enumeration constants of type XilTiling mode:

XIL_WHOLE_IMAGE
The default setting. Each image is stored as a contiguous memory buffer.

XIL_TILING Very large images are stored in separate buffers of contiguous memory. Each of the buffers is the tile_xsize by the tile_ysize.

XIL_STRIPPING
Images are stored in a contiguous memory buffer, but accessed as separate "strips". Each strip is the width of the image by the tile_ysize.

xil_state_get_default_tiling_mode () returns the tiling mode to be used for all images created under State. Unless modified by a call to xil_state_set_default_tiling_mode () , the default tiling mode is always XIL_WHOLE_IMAGE.

xil_state_set_default_tiling_mode () sets the tiling mode to be used for all images created under State. If not set by the user, the default tiling mode is XIL_WHOLE_IMAGE.

ERRORS

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

NOTES

When the tiling mode is set to XIL_WHOLE_IMAGE, the user can only call xil_set_tilesize(3) on an image with a tile_xsize greater than or equal to the image width, and tile_ysize greater than or equal to the image height.

When the tiling mode of an image is set to XIL_STRIPPING, the user can only explicitly set the tile_xsize to 0 or to a value greater than or equal to the width of the image.

Museum