xil_storage_create(3)

NAME

xil_storage_create, xil_storage_destroy − create and destroy XilStorage object

SYNOPSIS

#include <xil/xil.h>

XilStorage xil_storage_create (XilSystemState State,

XilImage∗ image);

void xil_storage_destroy (XilStorage storage);

DESCRIPTION

xil_storage_create () creates an XilStorage object. At creation, all attributes of the storage object are intitialized to zero or NULL, with the exception of the storage type, which is initialized to XIL_GENERAL. All setting and getting of storage description parameters is accomplished using a set of API bindings for accessing the XilStorage object. Although the XilImage is associated with the storage at creation, the XilStorage object does not contain information about the image’s storage until storage parameters are explicitly set with xil_get_tile_storage(), or by the application. xil_storage_create() does not need to be called in order to use the xil_get_storage_with_copy() call.

xil_storage_destroy () destroys the specified XilStorage object.

EXAMPLES

Create storage associated with an image and then access the storage located at the upper left corner of the image.

XilImage image;
XilStorage storage;
/∗
∗ load the image from elsewhere...
∗/
storage = xil_storage_create(image);
xil_export(image);
xil_get_tile_storage(image, 0, 0, storage);
/∗
∗ access the information and data in the storage object....
∗/
/∗
∗ After use, destroy the storage object.
∗/
xil_storage_destroy(storage);

ERRORS

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

NOTES

The use of the XilStorage object is mutually exclusive with the xil_get_memory_storage() and xil_set_memory_storage() calls.

Museum

Related Articles