NAME

xil_state_get_show_action, xil_state_set_show_action − show information about when deferred actions are taken and which actions have been put together into molecules

SYNOPSIS

#include <xil/xil.h>

int xil_state_get_show_action (XilSystemState State);

void xil_state_set_show_action (XilSystemState State,

int env_on_off);

DESCRIPTION

XIL provides a deferred execution facility that automatically recognizes certain sequences of XIL functions (atoms) and executes the sequences as a single high-performance molecule. An example is a sequence of XIL functions that scales (implicitly capturing) and compresses an image. XIL defers execution of the scale function to see if a compression function follows. If it does, the two functions are executed together as a high-performance molecule.  XIL defines a set of general-purpose molecules that perform sequences of operations such as color conversion and decompression. 

To determine if XIL functions are executing within molecules, set the SHOW_ACTION attribute of XilSystemState.  This causes the XIL library to print a message to stderr whenever an operation that affects an XIL image or compressed image sequence is executed. 

xil_state_get_show_action () gets the current value of the SHOW_ACTION attribute of State. 

xil_state_set_show_action () sets the current value of the SHOW_ACTION attribute of State. 

When SHOW_ACTION is set to -1, the XIL library checks the value of the environment variable XIL_DEBUG, and it sets the attribute SHOW_ACTION to 0 if the environment variable XIL_DEBUG does not contain the string "show_action"; it sets the attribute to 1 if XIL_DEBUG contains the string "show_action". 

The default value for SHOW_ACTION is -1. When SHOW_ACTION is 1, the library prints information to stderr about when deferred actions happen and when they are combined into molecules.  When SHOW_ACTION is 0, no information is printed. 

ERRORS

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

EXAMPLES

Show the output of XIL_SHOW_ACTION in a segment of code, but only if the XIL_DEBUG environment variable is set to "show_action". 

XilSystemState State;
State = xil_open();
xil_state_set_show_action(State, 0);    /∗ turn off default behavior ∗/
/∗ ... set up code ... ∗/
xil_state_set_show_action(State, -1);   /∗ turn on output (only if environment ∗/
          /∗ variable is set) ∗/
/∗ ... area of interest ... ∗/
xil_state_set_show_action(State, 0);    /∗ turn off output ∗/

NOTES

These functions do not produce any semantic differences in the execution of the program.  They are only useful for debugging and performance tuning.  Consult the XIL Programmer’s Guide for information on performance tuning. 
 
 
 

SunOS   —  Last change: 16 June 1993