/*
 * videlay
 *
 *  Provides a bit more control than the original version
 *
 * © 1991-1998 Straylight
 */

/*----- Licensing note ----------------------------------------------------*
 *
 * This file is part of Straylight's Steel library.
 *
 * Steel is free software; you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation; either version 2, or (at your option)
 * any later version.
 *
 * Steel is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with Steel.  If not, write to the Free Software Foundation,
 * 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
 */

#ifndef __visdelay_h
#define __visdelay_h

/*
 * This is a strcuture type only defined here for the use of the compiler to
 * get the size right.  You should not rely on any part of the definition of
 * this structure, or even that it will remain a structure.
 */

typedef struct
{
  int count;
  int percent;
}
visdelay_state;

/*
 * visdelay_init() is one of the biggest wastes of space in RISC_OSlib.
 * Well, here we rectify the problem.  In no versions of visdelay included
 * with ArmenLib will a call to visdelay_init() be necessary.
 */

#define visdelay_init(x) ((void)0)

/*
 * void visdelay_begin(void)
 *
 * Use
 *  Starts the hourglass.
 */

void visdelay_begin(void);

/*
 * void visdelay_end(void)
 *
 * Use
 *  Turns off the hourglass.  Note that calls to visdelay_begin() and
 *  visdelay_end() must be matched.
 */

void visdelay_end(void);

/*
 * void visdelay_percent(int percent)
 *
 * Use
 *  Puts up the little percentage indicator on the hourglass.
 *
 * Parameters
 *  int percent == the percentage number to indicate.
 */

void visdelay_percent(int percent);

/*
 * visdelay_state visdelay_suspend(void)
 *
 * Use
 *  Turns the hourglass right off.  It also returns information about the
 *  current state of the hourglass so that it can be resumed.
 *
 * Returns
 *  State information recorded in an undefined manner.
 */

visdelay_state visdelay_suspend(void);

/*
 * void visdelay_resume(visdelay_state state)
 *
 * Use
 *  Returns the hourglass to the state it was in when the last
 *  visdelay_suspend() call was made.
 *
 * Parameters
 *  visdelay_state state == the hourglass state as returned by
 *    visdelay_suspend().
 */

void visdelay_resume(visdelay_state state);

#endif