ref/sprite_8h_source.html

#ifndef __LIBDRAGON_SPRITE_H

#define __LIBDRAGON_SPRITE_H


#include <stdint.h>

#include <stdbool.h>

#include <surface.h>


#ifdef __cplusplus

extern "C" {

#endif


typedef struct rdpq_texparms_s rdpq_texparms_t;


typedef struct sprite_s

{

    uint16_t width;

    uint16_t height;

    uint8_t bitdepth __attribute__((deprecated("use TEX_FORMAT_BITDEPTH(sprite->format) instead")));


    union {

    uint8_t format __attribute__((deprecated("use sprite_get_format() instead")));

    uint8_t flags;

    };


    uint8_t hslices;

    uint8_t vslices;


    uint32_t data[0];

} sprite_t;


typedef struct sprite_detail_s

{

    bool            use_main_tex;

    float           blend_factor;

} sprite_detail_t;


#define SPRITE_FLAGS_TEXFORMAT      0x1F

#define SPRITE_FLAGS_OWNEDBUFFER    0x20

#define SPRITE_FLAGS_EXT            0x80


sprite_t *sprite_load(const char *fn);


sprite_t *sprite_load_buf(void *buf, int sz);


void sprite_free(sprite_t *sprite);


inline tex_format_t sprite_get_format(sprite_t *sprite) {

    return (tex_format_t)(sprite->flags & SPRITE_FLAGS_TEXFORMAT);

}


surface_t sprite_get_pixels(sprite_t *sprite);


surface_t sprite_get_lod_pixels(sprite_t *sprite, int num_level);


surface_t sprite_get_detail_pixels(sprite_t *sprite, sprite_detail_t *info, rdpq_texparms_t *infoparms);


surface_t sprite_get_tile(sprite_t *sprite, int h, int v);


uint16_t* sprite_get_palette(sprite_t *sprite);


bool sprite_get_texparms(sprite_t *sprite, rdpq_texparms_t *parms);


int sprite_get_lod_count(sprite_t *sprite);


bool sprite_fits_tmem(sprite_t *sprite);


#ifdef __cplusplus

}

#endif


#endif

rdpq_texparms_t
Texture sampling parameters for rdpq_tex_upload.
Definition rdpq_tex.h:40

sprite_t::height
uint16_t height
Height in pixels.
Definition sprite.h:46

sprite_get_lod_pixels
surface_t sprite_get_lod_pixels(sprite_t *sprite, int num_level)
Create a surface_t pointing to the contents of a LOD level.
Definition sprite.c:102

sprite_get_lod_count
int sprite_get_lod_count(sprite_t *sprite)
Return the number of LOD levels stored within the sprite (including the main image).
Definition sprite.c:210

sprite_get_detail_pixels
surface_t sprite_get_detail_pixels(sprite_t *sprite, sprite_detail_t *info, rdpq_texparms_t *infoparms)
Create a surface_t pointing to the contents of a detail texture.
Definition sprite.c:142

sprite_t::vslices
uint8_t vslices
Number of vertical sub-tiles.
Definition sprite.h:58

sprite_detail_t::blend_factor
float blend_factor
Blend factor of the detail texture in range of 0 to 1.
Definition sprite.h:85

sprite_get_pixels
surface_t sprite_get_pixels(sprite_t *sprite)
Create a surface_t pointing to the full sprite contents.
Definition sprite.c:97

sprite_fits_tmem
bool sprite_fits_tmem(sprite_t *sprite)
Return true if the sprite fits in TMEM without splitting.
Definition sprite.c:222

sprite_load_buf
sprite_t * sprite_load_buf(void *buf, int sz)
Load a sprite from a buffer.
Definition sprite.c:64

sprite_load
sprite_t * sprite_load(const char *fn)
Load a sprite from a filesystem (eg: ROM)
Definition sprite.c:74

SPRITE_FLAGS_TEXFORMAT
#define SPRITE_FLAGS_TEXFORMAT
Pixel format of the sprite.
Definition sprite.h:88

sprite_get_format
tex_format_t sprite_get_format(sprite_t *sprite)
Get the sprite texture format.
Definition sprite.h:136

sprite_t::hslices
uint8_t hslices
Number of horizontal sub-tiles
Definition sprite.h:56

sprite_t::width
uint16_t width
Width in pixels.
Definition sprite.h:44

sprite_free
void sprite_free(sprite_t *sprite)
Deallocate a sprite.
Definition sprite.c:83

sprite_detail_t::use_main_tex
bool use_main_tex
Is the detail texture the same as the main surface of the sprite, used for fractal detailing.
Definition sprite.h:83

sprite_get_tile
surface_t sprite_get_tile(sprite_t *sprite, int h, int v)
Return a surface_t pointing to a specific tile of the spritemap.
Definition sprite.c:171

sprite_get_palette
uint16_t * sprite_get_palette(sprite_t *sprite)
Access the sprite palette (if any)
Definition sprite.c:164

sprite_get_texparms
bool sprite_get_texparms(sprite_t *sprite, rdpq_texparms_t *parms)
Get a copy of the RDP texparms, optionally stored within the sprite.
Definition sprite.c:190

sprite_detail_t
Sprite detail texture information structure.
Definition sprite.h:81

sprite_t
Sprite structure.
Definition sprite.h:42

surface.h
Surface buffers used to draw images.

tex_format_t
tex_format_t
Pixel format enum.
Definition surface.h:105

surface_t
A surface buffer for graphics.
Definition surface.h:140