include/sgefadefx.h

Go to the documentation of this file.

#ifndef _SGEFADEEFFECTS_H
#define _SGEFADEEFFECTS_H

#ifdef __cplusplus
extern "C" {
#endif

/*
 * Copyright (c) 2007 Heiko Irrgang
 *
 * The license and distribution terms for this file may be
 * found in the file COPYING in this distribution or at
 * http://93-interactive.com/cms/products/software/sdl-game-engine/license/
 */

enum SGEFADEFX_TYPES {
        SGEFADEFX_FADE, 
        SGEFADEFX_WIPE_LEFT, 
        SGEFADEFX_WIPE_RIGHT, 
        SGEFADEFX_WIPE_TOP, 
        SGEFADEFX_WIPE_BOTTOM, 
        SGEFADEFX_SCROLL_LEFT, 
        SGEFADEFX_SCROLL_RIGHT, 
        SGEFADEFX_SCROLL_TOP, 
        SGEFADEFX_SCROLL_BOTTOM 
};

typedef struct {
        Uint8 finished;
        void (*updateFunction)(void *);
        Uint32 type;
        Uint32 runTime;
        Uint32 startTime;
        Uint32 realStartTime;
        Uint32 current;
        SDL_Surface *src;
        SDL_Surface *dst;
        SGESPRITE *srcSprite;
        SGESPRITE *dstSprite;
        Uint32 preDelay;
        Uint32 postDelay;
        Uint8 deleteSurfaces;
        SDL_Surface *surface;
} SGEFADEFX;

SGEFADEFX *sgeFadeFXNew(Uint32 type, Uint32 runTime, SGESPRITE *source, SGESPRITE *destination);

SGEFADEFX *sgeFadeFXNewSDLSurface(Uint32 type, Uint32 runTime, SDL_Surface *source, SDL_Surface *destination);

void sgeFadeFXDestroy(SGEFADEFX *fx);

void sgeFadeFXDeleteSurfaces(SGEFADEFX *fx, Uint8 yesno);

#define sgeFadeFXDeleteSprites(fx, yesno) sgeFadeFXDeleteSurfaces(fx, yesno)

void sgeFadeFXPreDelay(SGEFADEFX *fx, Uint32 delay);

void sgeFadeFXPostDelay(SGEFADEFX *fx, Uint32 delay);

void sgeFadeFXSetTarget(SGEFADEFX *fx, SDL_Surface *surface);

void sgeFadeFXDraw(SGEFADEFX *fx);

int sgeFadeFXFinished(SGEFADEFX *fx);

void sgeFadeFXFadeUpdate(void *fxdata);
void sgeFadeFXWipeScrollUpdate(void *fxdata);

// }@

#ifdef __cplusplus
}
#endif

#endif