Headers/SpriteFrame.h File Reference

constants, structures, and function prototypes for sprite frames More...

#include <SWCommonHeaders.h>
#include "SpriteFrame.hpp"

Classes
struct	FrameRec
	frame data structure More...
Enumerations
enum	MaskType { kNoMask = 0, kAlphaChannelMask, kColorKeyMask }
	frame mask type More...
Functions
SWError	SWCreateFrame (FramePtr *newFrameP)
int	SWDisposeFrame (FramePtr *oldFramePP)
SWError	SWCreateFrameFromSurfaceAndRect (FramePtr *newFrameP, SDL_Surface *surface, SWRect *frameRect)
SWError	SWCreateFrameFromSurface (FramePtr *newFrameP, SDL_Surface *theSurface, int isVideoSurface)
SWError	SWCreateBlankFrame (FramePtr *newFrameP, int w, int h, unsigned char depth, SWBoolean createAlphaChannel)
SWError	SWCreateFrameFromFile (FramePtr *newFrameP, const char *filename)
void	SWLockFrame (FramePtr srcFrameP)
void	SWUnlockFrame (FramePtr srcFrameP)
SWError	SWUpdateFrame (FramePtr srcFrameP)

---

Detailed Description

constants, structures, and function prototypes for sprite frames

---

Enumeration Type Documentation

enum MaskType

frame mask type Enumerator: kNoMask  kAlphaChannelMask  kColorKeyMask

---

Function Documentation

SWError SWCreateBlankFrame (  FramePtr *  newFrameP, int  w, int  h, unsigned char  depth, SWBoolean  createAlphaChannel )

SWError SWCreateFrame (  FramePtr *  newFrameP  )

SWError SWCreateFrameFromFile (  FramePtr *  newFrameP, const char *  filename )

SWError SWCreateFrameFromSurface (  FramePtr *  newFrameP, SDL_Surface *  theSurface, int  isVideoSurface )

SWError SWCreateFrameFromSurfaceAndRect (  FramePtr *  newFrameP, SDL_Surface *  surface, SWRect *  frameRect )

int SWDisposeFrame (  FramePtr *  oldFramePP  )

void SWLockFrame (  FramePtr  srcFrameP  )

void SWUnlockFrame (  FramePtr  srcFrameP  )

SWError SWUpdateFrame (  FramePtr  srcFrameP  )

---