NAME

xil_open, xil_close − open and close an XIL session

SYNOPSIS

#include <xil/xil.h>

XilSystemState xil_open ();

void xil_close (XilSystemState State);

DESCRIPTION

xil_open () is used to begin an XIL session.  It must be called before any other XIL routine.  A single XilSystemState object is created and returned when xil_open () is invoked. If the function is successful, a handle to the XilSystemState object is returned.  This object can only be destroyed by a subsequent call to xil_close () using the specified handle.

When xil_open () is called, the XIL library creates a predefined kernel object, four predefined dither mask objects, three predefined look-up tables, and ten predefined color space objects.  These objects can be retrieved by using the relevant XIL "get by name" function.  For example, you would use xil_kernel_get_by_name(3) to retrieve the predefined kernel.  Consult the relevant manual pages for more details. 

xil_close () is used to end an XIL session.  A handle to the XilSystemState object describing the session to be terminated is passed to the function.  The XilSystemState object and all resources associated with that XIL session are destroyed, and the XIL session is terminated. 

ERRORS

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

EXAMPLES

Open and close the XIL Library:

XilSystemState State;
State = xil_open();
xil_close(State);

NOTES

Multiple calls to xil_open() produce completely separate system states that provide completely separate XIL environments.  Objects created in one environment cannot be used in another environment.  This feature is intended to allow layered software that uses the XIL library to be completely independent from all other layered software that uses the XIL library.

If your program creates a display image and you do not destroy the image with xil_destroy(), you must close the XIL library (with xil_close()) before you disconnect your program from the X server and display.

SEE ALSO

xil_create(3), xil_cis_create(3), xil_kernel_create(3), xil_lookup_create(3), xil_roi_create(3), xil_sel_create(3), xil_kernel_get_by_name(3), xil_lookup_get_by_name(3), xil_dithermask_get_by_name(3), xil_colorspace_get_by_name(3). 

SunOS   —  Last change: 16 June 1993