c8h4/imv
1
0
Fork 0
Code Issues Pull requests Actions Packages Projects Releases Wiki Activity

Document imv_loader's methods

Browse source
This commit is contained in:
Harry Jeffery 2015-11-30 22:50:01 +00:00
parent 2457991e3e
commit 8bc695b889
1 changed files with 15 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

15
src/loader.h
View file

@ -40,15 +40,30 @@ struct imv_loader {
double frame_time; double frame_time;
}; };
/* Initialises an instance of imv_loader */
void imv_init_loader(struct imv_loader *img); void imv_init_loader(struct imv_loader *img);
/* Cleans up all resources owned by a imv_loader instance */
void imv_destroy_loader(struct imv_loader *img); void imv_destroy_loader(struct imv_loader *img);
/* Asynchronously load the given file */
void imv_loader_load_path(struct imv_loader *ldr, const char *path); void imv_loader_load_path(struct imv_loader *ldr, const char *path);
/* Returns image data if available. NULL if not. Caller is responsible for
* cleaning up the data returned. Each image is only returned once. */
FIBITMAP *imv_loader_get_image(struct imv_loader *ldr); FIBITMAP *imv_loader_get_image(struct imv_loader *ldr);
/* If a file failed to loadd, return the path to that file. Otherwise returns
* NULL. Only returns the path once. Caller is responsible for cleaning up the
* string returned. */
char *imv_loader_get_error(struct imv_loader *ldr); char *imv_loader_get_error(struct imv_loader *ldr);
/* Trigger the next frame of the currently loaded image to be loaded and
* returned as soon as possible. */
void imv_loader_load_next_frame(struct imv_loader *ldr); void imv_loader_load_next_frame(struct imv_loader *ldr);
/* Tell the loader that dt time has passed. If the current image is animated,
* the loader will automatically load the next frame when it is due. */
void imv_loader_time_passed(struct imv_loader *ldr, double dt); void imv_loader_time_passed(struct imv_loader *ldr, double dt);
#endif #endif