sprite_animator.h File Reference

Jo Engine Sprite Animator. More...

Go to the source code of this file.

Data Structures
struct	jo_sprite_anim
	Internal animation struct. More...

Enumerations
enum	jo_sprite_anim_action { JO_SPRITE_ANIM_START , JO_SPRITE_ANIM_START_REVERSE , JO_SPRITE_ANIM_STOP , JO_SPRITE_ANIM_STOP_AT_LAST_FRAME }
	Animation action. More...

Functions
static __jo_force_inline unsigned char	jo_get_sprite_anim_frame_rate (const int anim_id)
	Get animation frame rate.
static __jo_force_inline unsigned short	jo_get_sprite_anim_frame_count (const int anim_id)
	Get animation frame count.
static __jo_force_inline unsigned short	jo_get_sprite_anim_frame (const int anim_id)
	Get current animation frame.
static __jo_force_inline void	jo_set_sprite_anim_frame (const int anim_id, const unsigned char frame)
	Set animation frame.
static __jo_force_inline void	jo_start_sprite_anim_loop (const int anim_id)
	Start animation loop.
static __jo_force_inline bool	jo_is_sprite_anim_stopped (const int anim_id)
	Determine if the animation is stopped.
static __jo_force_inline void	jo_stop_sprite_anim (const int anim_id)
	Stop animation.
static __jo_force_inline void	jo_start_sprite_anim (const int anim_id)
	Start animation and stop it at the last frame.
static __jo_force_inline void	jo_reset_sprite_anim (const int anim_id)
	Stop animation and reset the animation to the first frame.
static __jo_force_inline void	jo_restart_sprite_anim (const int anim_id)
	Restart animation and stop it at the last frame.
static __jo_force_inline int	jo_get_anim_sprite (const int anim_id)
	Get the sprite to display according to the animation (current frame).
static __jo_force_inline int	jo_get_anim_sprite_reverse (const int anim_id)
	Get the sprite to display according to the animation in reverse (current frame).
static __jo_force_inline int	jo_set_sprite_anim_frame_rate (const int anim_id, const unsigned char framerate)
	Set animation framerate.
int	jo_replace_sprite_anim (const int at, const unsigned short sprite_id, const unsigned short frame_count, const unsigned char frame_rate)
	Replace an existing animation.
int	jo_create_sprite_anim (const unsigned short sprite_id, const unsigned short frame_count, const unsigned char frame_rate)
	Create an animation.
void	jo_remove_sprite_anim (const int anim_id)
	Remove a specific animation by ID.
void	jo_clear_all_sprite_anim (void)
	Clear all sprite animation.

Variables
jo_sprite_anim	__jo_sprite_anim_tab [JO_MAX_SPRITE_ANIM]
	Internal animation table.

Detailed Description

Jo Engine Sprite Animator.

Author

Johannes Fetz

Bug

No known bugs.

---

Data Structure Documentation

jo_sprite_anim

struct jo_sprite_anim

Internal animation struct.

Data Fields
jo_sprite_anim_action	action
unsigned short	cur_frame
unsigned short	frame0_sprite_id
unsigned short	frame_count
unsigned char	frame_rate
unsigned char	frame_skip

Enumeration Type Documentation

jo_sprite_anim_action

enum jo_sprite_anim_action

Animation action.

Enumerator
JO_SPRITE_ANIM_START
JO_SPRITE_ANIM_START_REVERSE
JO_SPRITE_ANIM_STOP
JO_SPRITE_ANIM_STOP_AT_LAST_FRAME

Function Documentation

jo_clear_all_sprite_anim()

void jo_clear_all_sprite_anim

(

void

)

Clear all sprite animation.

jo_create_sprite_anim()

int jo_create_sprite_anim	(	const unsigned short	sprite_id,
		const unsigned short	frame_count,
		const unsigned char	frame_rate )

Create an animation.

Parameters

sprite_id	First sprite id returned by jo_sprite_add() or similar functions
frame_count	Number of frame in the animation (number of continious sprite)
frame_rate	Framerate (linked to the global framerate)

Returns

-1 if failed or Animation Id (ANIM_ID)

jo_get_anim_sprite()

__jo_force_inline int jo_get_anim_sprite ( const int anim_id )

static

Get the sprite to display according to the animation (current frame).

Parameters

anim_id

Id returned by jo_create_sprite_anim()

jo_get_anim_sprite_reverse()

__jo_force_inline int jo_get_anim_sprite_reverse ( const int anim_id )

static

Get the sprite to display according to the animation in reverse (current frame).

Parameters

anim_id

Id returned by jo_create_sprite_anim()

jo_get_sprite_anim_frame()

__jo_force_inline unsigned short jo_get_sprite_anim_frame ( const int anim_id )

static

Get current animation frame.

Parameters

anim_id

Id returned by jo_create_sprite_anim()

Returns

animation frame index (from 0 to "number of sprite in animation")

jo_get_sprite_anim_frame_count()

__jo_force_inline unsigned short jo_get_sprite_anim_frame_count ( const int anim_id )

static

Get animation frame count.

Parameters

anim_id

Id returned by jo_create_sprite_anim()

Returns

animation frame index (from 0 to "number of sprite in animation")

jo_get_sprite_anim_frame_rate()

__jo_force_inline unsigned char jo_get_sprite_anim_frame_rate ( const int anim_id )

static

Get animation frame rate.

Parameters

anim_id

Id returned by jo_create_sprite_anim()

Returns

animation frame index (from 0 to "number of sprite in animation")

jo_is_sprite_anim_stopped()

__jo_force_inline bool jo_is_sprite_anim_stopped ( const int anim_id )

static

Determine if the animation is stopped.

Parameters

anim_id

Id returned by jo_create_sprite_anim()

Returns

true if the animation is stopped otherwise false

jo_remove_sprite_anim()

void jo_remove_sprite_anim

(

const int

anim_id

)

Remove a specific animation by ID.

Parameters

anim_id

Id returned by jo_create_sprite_anim()

jo_replace_sprite_anim()

int jo_replace_sprite_anim	(	const int	at,
		const unsigned short	sprite_id,
		const unsigned short	frame_count,
		const unsigned char	frame_rate )

Replace an existing animation.

Parameters

at	Id returned by jo_create_sprite_anim()
sprite_id	First sprite id returned by jo_sprite_add() or similar functions
frame_count	Number of frame in the animation (number of continious sprite)
frame_rate	Framerate (linked to the global framerate)

Returns

-1 if failed or the "at" param

jo_reset_sprite_anim()

__jo_force_inline void jo_reset_sprite_anim ( const int anim_id )

static

Stop animation and reset the animation to the first frame.

Parameters

anim_id

Id returned by jo_create_sprite_anim()

jo_restart_sprite_anim()

__jo_force_inline void jo_restart_sprite_anim ( const int anim_id )

static

Restart animation and stop it at the last frame.

Parameters

anim_id

Id returned by jo_create_sprite_anim()

jo_set_sprite_anim_frame()

__jo_force_inline void jo_set_sprite_anim_frame ( const int anim_id, const unsigned char frame )

static

Set animation frame.

Parameters

anim_id	Id returned by jo_create_sprite_anim()
frame	Frame of animation to be displayed, where 0 is the first frame.

jo_set_sprite_anim_frame_rate()

__jo_force_inline int jo_set_sprite_anim_frame_rate ( const int anim_id, const unsigned char framerate )

static

Set animation framerate.

Parameters

anim_id	Id returned by jo_create_sprite_anim()
framerate	Frame rate (linked to the global framerate)

jo_start_sprite_anim()

__jo_force_inline void jo_start_sprite_anim ( const int anim_id )

static

Start animation and stop it at the last frame.

Parameters

anim_id

Id returned by jo_create_sprite_anim()

jo_start_sprite_anim_loop()

__jo_force_inline void jo_start_sprite_anim_loop ( const int anim_id )

static

Start animation loop.

Parameters

anim_id

Id returned by jo_create_sprite_anim()

jo_stop_sprite_anim()

__jo_force_inline void jo_stop_sprite_anim ( const int anim_id )

static

Stop animation.

Parameters

anim_id

Id returned by jo_create_sprite_anim()

Variable Documentation

__jo_sprite_anim_tab

jo_sprite_anim __jo_sprite_anim_tab[JO_MAX_SPRITE_ANIM]

extern

Internal animation table.

Warning

MC Hammer: don't touch this