sprite Struct Reference

#include <sprite.h>

Data Fields
short int	y
short int	x
short int	hy
short int	hx
char	remainder
char	vscale
char	hscale
phrase *	data
animation_chunk *	animation
struct {
short int   counter
}	animation_data
unsigned long long	scaled: 1
unsigned long long	animated: 1
unsigned long long	invisible: 1
unsigned long long	use_hotspot: 1
unsigned long long	firstpix: 6
unsigned long long	release: 1
unsigned long long	trans: 1
unsigned long long	rmw: 1
unsigned long long	reflect: 1
unsigned long long	index: 7
unsigned long long	iwidth: 10
unsigned long long	dwidth: 10
unsigned long long	depth: 3
unsigned long long	height: 10
unsigned short int	has_looped: 1
unsigned short int	index: 15

---

Detailed Description

The sprite data structure.

---

Field Documentation

unsigned long long sprite::animated

If set, the sprite use animation described by sprite::animation.

animation_chunk* sprite::animation

Address of an array of animation_chunk that describes the animation. The last animation_chunk should have it animation_chunk::data field set to NULL

struct { ... } sprite::animation_data

Animation global characteritics

short int sprite::counter

Countdown until the next animation_chunk is fetched

phrase* sprite::data

Address of the graphical data: this must be aligned to a phrase boundary in memory.

unsigned long long sprite::depth

Depth of the graphical data.

unsigned long long sprite::dwidth

Data width in phrases.

unsigned long long sprite::firstpix

First pixel to be displayed for low resolution graphics.

unsigned short int sprite::has_looped

If set, the animation has just looped

unsigned long long sprite::height

Height of the sprite (unscaled).

char sprite::hscale

Horizontal scale as a 3.5 number.

short int sprite::hx

Y coordinate of the hot spot.

short int sprite::hy

X coordinate of the hot spot.

unsigned short int sprite::index

Index if the current animation_chunk

unsigned long long sprite::index

Index in the CLUT for less than 8 bit depth data.

unsigned long long sprite::invisible

If set, the sprite is invisible.

unsigned long long sprite::iwidth

Image width in phrases.

unsigned long long sprite::reflect

If set, the sprite is horizontally flipped.

unsigned long long sprite::release

Release the bus when displaying the sprite.

char sprite::remainder

Remainder as a 3.5 number.

unsigned long long sprite::rmw

Use RMW mode when drawing.

unsigned long long sprite::scaled

If set, the sprite is scaled according to sprite::hscale and sprite::vscale.

unsigned long long sprite::trans

If set, then use transparency mode.

unsigned long long sprite::use_hotspot

If set, the sprite uses a hot spot different of left-upper corner.

char sprite::vscale

Vertical scale as a 3.5 number.

short int sprite::x

Y coordinate of the sprite.

short int sprite::y

X coordinate of the sprite.

---