xil_toss(3)

NAME

xil_toss − throw away the contents of an image without destroying it

SYNOPSIS

#include <xil/xil.h>

void xil_toss (XilImage image);

DESCRIPTION

This function throws away the contents of an image without destroying it. This function provides a way to inform the XIL library that the user is no longer concerned about the contents of an image. After xil_toss(3) is called, the value of the image is undefined.

This function can sometimes be useful for code optimization. Sometimes the XIL library will perform more optimally if xil_toss () is called when the results of an intermediate operation are no longer needed. When used properly, this function will not change the results of operations.

ERRORS

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

NOTES

It is illegal to use a tossed image as a source without first using it as a destination.