animation.h File Reference

A simple animation system capable of loading a spritesheet with fixed sized frames. More...

#include <SDL.h>
#include <stdbool.h>
#include <vec2.h>

Go to the source code of this file.

Classes
struct	AnimationFrame
	Represents a single frame in an animation. More...
struct	AnimationClip
	Represents an animation clip, which is a sequence of frames. More...
struct	AnimationClipData
	Data structure for defining an animation clip. More...
struct	Animation
	The main animation structure. More...
struct	AnimationData
	Configuration data for creating an animation. More...

Typedefs
typedef struct AnimationFrame	AnimationFrame
	Represents a single frame in an animation.
typedef struct AnimationClip	AnimationClip
	Represents an animation clip, which is a sequence of frames.
typedef struct AnimationClipData	AnimationClipData
	Data structure for defining an animation clip.
typedef struct Animation	Animation
	The main animation structure.
typedef struct AnimationData	AnimationData
	Configuration data for creating an animation.

Functions
Animation *	Animation_Create (AnimationData *data)
	Creates a new animation from animation data.
void	Animation_Destroy (Animation *animation)
	Destroys an animation and frees its memory.
int	Animation_AddClipFromGrid (Animation *animation, const char *name, int startFrameIndex, int endFrameIndex, float frameDuration, bool looping)
	Adds a new animation clip from a grid-based spritesheet.
void	Animation_Play (Animation *animation, const char *clipName)
	Plays an animation clip by name.
void	Animation_Stop (Animation *animation)
	Stops the animation.
void	Animation_Pause (Animation *animation)
	Pauses the animation.
void	Animation_Resume (Animation *animation)
	Resumes the animation.
void	Animation_Update (Animation *animation)
	Updates the animation.
void	Animation_Render (Animation *animation, Vec2 destPosition, Vec2 destSize, float angle, SDL_Point *rotationCenter, SDL_RendererFlip flip)
	Renders the animation.
bool	Animation_ClipIsFinished (Animation *animation)

Detailed Description

A simple animation system capable of loading a spritesheet with fixed sized frames.

The spritesheet you select should have all of its states on it, like running, walking etc.

Warning

This system doesn't support loading animation clips from multiple files into one animation.

Usage

To load an animation, you need 3 steps:

Step 1: Create animation with an AnimationData struct

An example of an AnimationData struct can be found in src/Game/Player/player_data.c

After that, you can call:

Animation* animation = Animation_Create(data);

Step 2: Play the animation based on a certain state

Animation_Play(animation, "running");

Step 3: Update and render the animation every frame

// Inside update loop
Animation_Update(animation);
 
// Inside render loop
Animation_Render(
    animation,          // The animation
    (Vec2) {x, y},      // The position to render
    (Vec2) {w, h},      // The size to render
    angle,              // Rotation angle in degrees
    NULL,               // The rotation center, NULL for center
    SDL_FLIP_NONE       // Flip the sprite, SDL_FLIP_NONE for no flip
);

Author

Mango

Date

2025-03-01

Typedef Documentation

Animation

typedef struct Animation Animation

The main animation structure.

AnimationClip

typedef struct AnimationClip AnimationClip

Represents an animation clip, which is a sequence of frames.

AnimationClipData

typedef struct AnimationClipData AnimationClipData

Data structure for defining an animation clip.

AnimationData

typedef struct AnimationData AnimationData

Configuration data for creating an animation.

AnimationFrame

typedef struct AnimationFrame AnimationFrame

Represents a single frame in an animation.

Function Documentation

Animation_AddClipFromGrid()

int Animation_AddClipFromGrid	(	Animation *	animation,
		const char *	name,
		int	startFrameIndex,
		int	endFrameIndex,
		float	frameDuration,
		bool	looping
	)

Adds a new animation clip from a grid-based spritesheet.

Parameters

animation	The animation to add the clip to.
name	The name of the clip.
startFrameIndex	The index of the first frame.
endFrameIndex	The index of the last frame.
frameDuration	The duration of each frame in seconds.
looping	Whether the animation should loop.

Returns

The index of the newly added clip.

Adds a new animation clip from a grid-based spritesheet.

Creates a new clip by extracting frames from the spritesheet using a grid-based layout. Frame indices start from 0, reading from left to right, then top to bottom.

Parameters

animation	The animation to add the clip to
name	Name of the clip (e.g., "idle", "walk")
startFrameIndex	Index of the first frame in the clip
endFrameIndex	Index of the last frame in the clip
frameDuration	Time between frames in seconds
looping	Whether the animation should loop

Returns

int 0 on success, 1 on failure

Animation_ClipIsFinished()

bool Animation_ClipIsFinished

(

Animation *

animation

)

Animation_Create()

Animation * Animation_Create

(

AnimationData *

animData

)

Creates a new animation from animation data.

Parameters

data	The animation data.

Returns

A pointer to the newly created animation.

This only works with spritesheets with constant frame size. After creating an animation, calling Animation_AddClipFromGrid can add additional animation clips.

Parameters

animData

Pointer to the animation data configuration

Returns

Animation* Pointer to the new animation, or NULL if failed

Animation_Destroy()

void Animation_Destroy

(

Animation *

animation

)

Destroys an animation and frees its memory.

Parameters

animation

The animation to destroy.

Destroys an animation and frees its memory.

Parameters

animation

Pointer to the animation to destroy

Animation_Pause()

void Animation_Pause

(

Animation *

animation

)

Pauses the animation.

Parameters

animation

The animation to pause.

Pauses the animation.

Parameters

animation

The animation to pause

Animation_Play()

void Animation_Play	(	Animation *	animation,
		const char *	clipName
	)

Plays an animation clip by name.

Parameters

animation	The animation to play.
clipName	The name of the clip to play.

If the target clip is already playing, this function does nothing.

Parameters

animation	The animation to play
clipName	The name of the clip to play

Animation_Render()

void Animation_Render	(	Animation *	animation,
		Vec2	destPosition,
		Vec2	destSize,
		float	angle,
		SDL_Point *	rotationCenter,
		SDL_RendererFlip	flip
	)

Renders the animation.

Parameters

animation	The animation to render.
destPosition	The position to render the animation at.
destSize	The size to render the animation at.
angle	The angle to rotate the animation.
rotationCenter	The center of rotation. NULL for center.
flip	The flip mode for the sprite.

Renders the animation.

Parameters

animation	The animation to render
destPosition	Position where the animation should be drawn
destSize	Size of the drawn animation
angle	Rotation angle in degrees
rotationCenter	Center point for rotation
flip	Flip flags for rendering (horizontal/vertical)

Animation_Resume()

void Animation_Resume

(

Animation *

animation

)

Resumes the animation.

Parameters

animation

The animation to resume.

Resumes the animation.

Parameters

animation

The animation to resume

Animation_Stop()

void Animation_Stop

(

Animation *

animation

)

Stops the animation.

Parameters

animation

The animation to stop.

Stops the animation.

Parameters

animation

The animation to stop

Animation_Update()

void Animation_Update

(

Animation *

animation

)

Updates the animation.

Parameters

animation

The animation to update.

Updates the animation.

This function should be called every frame to advance animations. It handles transitions between frames, respecting frame durations and looping settings.

Parameters

animation

Pointer to the animation to update