/*
 * gSprite.c
 *
 * Handling of template file sprite windows and areas
 *
 * © 1994-1998 Straylight
 */

/*----- Licensing note ----------------------------------------------------*
 *
 * This file is part of Straylight's Glass.
 *
 * Glass 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.
 *
 * Glass 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 Glass.  If not, write to the Free Software Foundation,
 * 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
 */

#ifndef __gSprite_h
#define __gSprite_h

/*----- Required header files ---------------------------------------------*/

#ifndef __gStruct_h
  #include "gStruct.h"
#endif

/*----- External routines -------------------------------------------------*/

/*
 * void gSprite_kill(glass_tfile *t)
 *
 * Use
 *  Closes the sprite viewer and frees the sprite area
 *
 * Parameters
 *  glass_tfile *t == the template file that's closing
 */

void gSprite_kill(glass_tfile *t);

/*
 * void gSprite_display(glass_tfile *t)
 *
 * Use
 *  Displays the sprite viewer for the specified template file.
 *
 * glass_tfile *t == the template file whose sprites we want to see
 */

void gSprite_display(glass_tfile *t);

/*
 * void gSprite_mergeFromMemory(glass_tfile *t,void **p)
 *
 * Use
 *  Merges a sprite file which is stored in memory.  This is so I can do
 *  in-memory transfer of sprites.
 *
 * Parameters
 *  glass_tfile *t == the template file owner of the sprite area
 *  void **p == the flex block stroing the sprite file
 */

void gSprite_mergeFromMemory(glass_tfile *t,void **p);

/*
 * void gSprite_mergeFromFile(glass_tfile *t,char *name)
 *
 * Use
 *  Merges the given file into the sprite area specified.
 *
 * Parameters
 *  glass_tfile *t == the template file that we're going to load for
 *  char *name == the name of the file to load
 */

void gSprite_mergeFromFile(glass_tfile *t,char *name);

/*
 * void gSprite_new(glass_tfile *t)
 *
 * Use
 *  Creates a sprite file for the given template file.  Initially, the file
 *  is blank.  On failure, an error is generated and sprite area 1 (WIMP
 *  pool) is used instead.  Note that at present, this section uses indir
 *  for allocation of sprite areas.
 *
 * Parameters
 *  glass_tfile *t == the file to use
 */

void gSprite_new(glass_tfile *t);

/*
 * sprite_area *gSprite_area(void)
 *
 * Use
 *  Returns the address of the Glass default sprite file, or 1 for the
 *  WIMP sprite area if no default sprites are loaded
 */

sprite_area *gSprite_area(void);

/*
 * void gSprite_init(void)
 *
 * Use
 *  Loads the Glass default sprite area into memory.
 */

void gSprite_init(void);

#endif