resspr

/* Copyright 1996 Acorn Computers Ltd
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
/****************************************************************************
 * This source file was written by Acorn Computers Limited. It is part of   *
 * the RISCOS library for writing applications in C for RISC OS. It may be  *
 * used freely in the creation of programs for Archimedes. It should be     *
 * used with Acorn's C Compiler Release 3 or later.                         *
 *                                                                          *
 ***************************************************************************/

/*
 * Title:   resspr.h
 * Purpose: Access to sprite resources
 *
 */

# ifndef __resspr_h
# define __resspr_h

# ifndef __sprite_h
# include "sprite.h"
# endif

/* ----------------------------- resspr_init -------------------------------
 * Description:   Initialises, ready for calls to resspr functions.
 *
 * Parameters:    void
 * Returns:       void.
 * Other Info:    call before using any resspr functions and before using
 *                template_init() !! This function reads in your sprites.
 *
 */

void resspr_init(void);


/* ----------------------------- resspr_readfile ---------------------------
 * Description:   Read in sprite file and initialise, ready for calls to
 *                resspr functions.
 *
 * Parameters:    char *name -- the name of the sprite file to be read.
 * Returns:       void.
 * Other Info:    call before using any resspr functions and before using
 *                template_init() !! This function reads in your sprites.
 *
 */

#define resspr_readfile(s) resspr_init()


/* ------------------------------ resspr_area ------------------------------
 * Description:   Return pointer to sprite area being used.
 *
 * Parameters:    void
 * Returns:       pointer to sprite area being used.
 * Other Info:    useful for passing params to functions like baricon which
 *                expect to be told sprite area to use.
 *
 */

sprite_area *resspr_area(void);

#endif

/* end of resspr.h */