doxygen/sprites_8h_source.html

/*

** Jo Sega Saturn Engine

** Copyright (c) 2012-2024, Johannes Fetz (johannesfetz@gmail.com)

** All rights reserved.

**

** Redistribution and use in source and binary forms, with or without

** modification, are permitted provided that the following conditions are met:

**     * Redistributions of source code must retain the above copyright

**       notice, this list of conditions and the following disclaimer.

**     * Redistributions in binary form must reproduce the above copyright

**       notice, this list of conditions and the following disclaimer in the

**       documentation and/or other materials provided with the distribution.

**     * Neither the name of the Johannes Fetz nor the

**       names of its contributors may be used to endorse or promote products

**       derived from this software without specific prior written permission.

**

** THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND

** ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED

** WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE

** DISCLAIMED. IN NO EVENT SHALL Johannes Fetz BE LIABLE FOR ANY

** DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES

** (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;

** LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND

** ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT

** (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS

** SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

*/

#ifndef __JO_SPRITES_H__

# define __JO_SPRITES_H__


/*

██╗███╗   ██╗████████╗███████╗██████╗ ███╗   ██╗ █████╗ ██╗

██║████╗  ██║╚══██╔══╝██╔════╝██╔══██╗████╗  ██║██╔══██╗██║

██║██╔██╗ ██║   ██║   █████╗  ██████╔╝██╔██╗ ██║███████║██║

██║██║╚██╗██║   ██║   ██╔══╝  ██╔══██╗██║╚██╗██║██╔══██║██║

██║██║ ╚████║   ██║   ███████╗██║  ██║██║ ╚████║██║  ██║███████╗

╚═╝╚═╝  ╚═══╝   ╚═╝   ╚══════╝╚═╝  ╚═╝╚═╝  ╚═══╝╚═╝  ╚═╝╚══════╝

▲ DO NOT USE THESE FUNCTIONS ▲

*/


extern jo_sprite_attributes    __jo_sprite_attributes;

extern jo_texture_definition        __jo_sprite_def[JO_MAX_SPRITE];

extern jo_picture_definition   __jo_sprite_pic[JO_MAX_SPRITE];

void    jo_sprite_draw(const int sprite_id, const jo_pos3D * const pos, const bool centered_style_coordinates, const bool billboard);

void    jo_sprite_draw_rotate(const int sprite_id, const jo_pos3D * const pos, const int angle, const bool centered_style_coordinates, const bool billboard);

static  __jo_force_inline void  __internal_jo_sprite_set_position3D(const int x, const int y, const int z)

{

    extern jo_pos3D __jo_sprite_pos;

    __jo_sprite_pos.x = x;

    __jo_sprite_pos.y = y;

    __jo_sprite_pos.z = z;

}


/*

 █████╗ ██████╗ ██████╗     ██╗██████╗ ███████╗██████╗ ██╗      █████╗  ██████╗███████╗    ██╗███████╗██████╗ ███████╗███████╗

██╔══██╗██╔══██╗██╔══██╗   ██╔╝██╔══██╗██╔════╝██╔══██╗██║     ██╔══██╗██╔════╝██╔════╝   ██╔╝██╔════╝██╔══██╗██╔════╝██╔════╝

███████║██║  ██║██║  ██║  ██╔╝ ██████╔╝█████╗  ██████╔╝██║     ███████║██║     █████╗    ██╔╝ █████╗  ██████╔╝█████╗  █████╗

██╔══██║██║  ██║██║  ██║ ██╔╝  ██╔══██╗██╔══╝  ██╔═══╝ ██║     ██╔══██║██║     ██╔══╝   ██╔╝  ██╔══╝  ██╔══██╗██╔══╝  ██╔══╝

██║  ██║██████╔╝██████╔╝██╔╝   ██║  ██║███████╗██║     ███████╗██║  ██║╚██████╗███████╗██╔╝   ██║     ██║  ██║███████╗███████╗

╚═╝  ╚═╝╚═════╝ ╚═════╝ ╚═╝    ╚═╝  ╚═╝╚══════╝╚═╝     ╚══════╝╚═╝  ╚═╝ ╚═════╝╚══════╝╚═╝    ╚═╝     ╚═╝  ╚═╝╚══════╝╚══════╝

*/


int     jo_get_last_sprite_id(void);


int     jo_sprite_add(const jo_img * const img);


int     jo_sprite_add_8bits_image(const jo_img_8bits * const img);


int     jo_sprite_replace(const jo_img * const img, const int sprite_id);


void    jo_sprite_free_from(const int sprite_id);


static  __jo_force_inline void  jo_sprite_free_all(void)

{

    jo_sprite_free_from(0);

}


# ifdef JO_COMPILE_WITH_SPRITE_HASHTABLE


int     jo_sprite_name2id(const char *const filename);

#endif


/*

████████╗██████╗  █████╗ ███╗   ██╗███████╗██████╗  █████╗ ██████╗ ███████╗███╗   ██╗ ██████╗██╗   ██╗

╚══██╔══╝██╔══██╗██╔══██╗████╗  ██║██╔════╝██╔══██╗██╔══██╗██╔══██╗██╔════╝████╗  ██║██╔════╝╚██╗ ██╔╝

   ██║   ██████╔╝███████║██╔██╗ ██║███████╗██████╔╝███████║██████╔╝█████╗  ██╔██╗ ██║██║      ╚████╔╝

   ██║   ██╔══██╗██╔══██║██║╚██╗██║╚════██║██╔═══╝ ██╔══██║██╔══██╗██╔══╝  ██║╚██╗██║██║       ╚██╔╝

   ██║   ██║  ██║██║  ██║██║ ╚████║███████║██║     ██║  ██║██║  ██║███████╗██║ ╚████║╚██████╗   ██║

   ╚═╝   ╚═╝  ╚═╝╚═╝  ╚═╝╚═╝  ╚═══╝╚══════╝╚═╝     ╚═╝  ╚═╝╚═╝  ╚═╝╚══════╝╚═╝  ╚═══╝ ╚═════╝   ╚═╝

*/


/*

** Screen doors filter (old school transparency)

*/


static  __jo_force_inline void  jo_sprite_enable_screen_doors_filter(void)

{

    JO_ADD_FLAG(__jo_sprite_attributes.effect, 0x100);

}


static  __jo_force_inline void  jo_sprite_disable_screen_doors_filter(void)

{

    JO_REMOVE_FLAG(__jo_sprite_attributes.effect, 0x100);

}


/*

** Half transparency

*/


static  __jo_force_inline void  jo_sprite_enable_half_transparency(void)

{

    JO_ADD_FLAG(__jo_sprite_attributes.effect, 0x3);

}


static  __jo_force_inline void  jo_sprite_disable_half_transparency(void)

{

    JO_REMOVE_FLAG(__jo_sprite_attributes.effect, 0x3);

}


/*

███████╗██╗  ██╗ █████╗ ██████╗  ██████╗ ██╗    ██╗

██╔════╝██║  ██║██╔══██╗██╔══██╗██╔═══██╗██║    ██║

███████╗███████║███████║██║  ██║██║   ██║██║ █╗ ██║

╚════██║██╔══██║██╔══██║██║  ██║██║   ██║██║███╗██║

███████║██║  ██║██║  ██║██████╔╝╚██████╔╝╚███╔███╔╝

╚══════╝╚═╝  ╚═╝╚═╝  ╚═╝╚═════╝  ╚═════╝  ╚══╝╚══╝

*/


static  __jo_force_inline void  jo_sprite_enable_shadow_filter(void)

{

    JO_ADD_FLAG(__jo_sprite_attributes.effect, 0x1);

}


static  __jo_force_inline void  jo_sprite_disable_shadow_filter(void)

{

    JO_REMOVE_FLAG(__jo_sprite_attributes.effect, 0x1);

}


/*

** Dark filter

*/


static  __jo_force_inline void  jo_sprite_enable_dark_filter(void)

{

    JO_ADD_FLAG(__jo_sprite_attributes.effect, 0x2);

}


static  __jo_force_inline void  jo_sprite_disable_dark_filter(void)

{

    JO_REMOVE_FLAG(__jo_sprite_attributes.effect, 0x2);

}


/*

 ██████╗  ██████╗ ██╗   ██╗██████╗  █████╗ ██╗   ██╗██████╗     ███████╗██╗  ██╗ █████╗ ██████╗ ██╗███╗   ██╗ ██████╗

██╔════╝ ██╔═══██╗██║   ██║██╔══██╗██╔══██╗██║   ██║██╔══██╗    ██╔════╝██║  ██║██╔══██╗██╔══██╗██║████╗  ██║██╔════╝

██║  ███╗██║   ██║██║   ██║██████╔╝███████║██║   ██║██║  ██║    ███████╗███████║███████║██║  ██║██║██╔██╗ ██║██║  ███╗

██║   ██║██║   ██║██║   ██║██╔══██╗██╔══██║██║   ██║██║  ██║    ╚════██║██╔══██║██╔══██║██║  ██║██║██║╚██╗██║██║   ██║

╚██████╔╝╚██████╔╝╚██████╔╝██║  ██║██║  ██║╚██████╔╝██████╔╝    ███████║██║  ██║██║  ██║██████╔╝██║██║ ╚████║╚██████╔╝

 ╚═════╝  ╚═════╝  ╚═════╝ ╚═╝  ╚═╝╚═╝  ╚═╝ ╚═════╝ ╚═════╝     ╚══════╝╚═╝  ╚═╝╚═╝  ╚═╝╚═════╝ ╚═╝╚═╝  ╚═══╝ ╚═════╝

*/


# define JO_NO_GOURAUD_COLOR            (0xc210)


void    jo_set_gouraud_shading_colors(const jo_color topleft_color,

                                      const jo_color topright_color,

                                      const jo_color bottomright_color,

                                      const jo_color bottomleft_color);


static  __jo_force_inline void  jo_sprite_enable_gouraud_shading(void)

{

    JO_ADD_FLAG(__jo_sprite_attributes.effect, 0x4);

}


static  __jo_force_inline void  jo_sprite_disable_gouraud_shading(void)

{

    JO_REMOVE_FLAG(__jo_sprite_attributes.effect, 0x4);

}


# define JO_DEFAULT_BRIGHTNESS      (16)


# define JO_MAX_BRIGHTNESS          (31)


void     jo_set_gouraud_shading_brightness(const unsigned char brightness);


/*

██╗  ██╗ ██████╗ ██████╗ ██╗███████╗    ██╗██╗   ██╗███████╗██████╗ ████████╗    ███████╗██╗     ██╗██████╗

██║  ██║██╔═══██╗██╔══██╗██║╚══███╔╝   ██╔╝██║   ██║██╔════╝██╔══██╗╚══██╔══╝    ██╔════╝██║     ██║██╔══██╗

███████║██║   ██║██████╔╝██║  ███╔╝   ██╔╝ ██║   ██║█████╗  ██████╔╝   ██║       █████╗  ██║     ██║██████╔╝

██╔══██║██║   ██║██╔══██╗██║ ███╔╝   ██╔╝  ╚██╗ ██╔╝██╔══╝  ██╔══██╗   ██║       ██╔══╝  ██║     ██║██╔═══╝

██║  ██║╚██████╔╝██║  ██║██║███████╗██╔╝    ╚████╔╝ ███████╗██║  ██║   ██║       ██║     ███████╗██║██║

╚═╝  ╚═╝ ╚═════╝ ╚═╝  ╚═╝╚═╝╚══════╝╚═╝      ╚═══╝  ╚══════╝╚═╝  ╚═╝   ╚═╝       ╚═╝     ╚══════╝╚═╝╚═╝

*/


static  __jo_force_inline void  jo_sprite_enable_vertical_flip(void)

{

    JO_ADD_FLAG(__jo_sprite_attributes.direction, 0x20);

}


static  __jo_force_inline void  jo_sprite_disable_vertical_flip(void)

{

    JO_REMOVE_FLAG(__jo_sprite_attributes.direction, 0x20);

}


static  __jo_force_inline void  jo_sprite_enable_horizontal_flip(void)

{

    JO_ADD_FLAG(__jo_sprite_attributes.direction, 0x10);

}


static  __jo_force_inline void  jo_sprite_disable_horizontal_flip(void)

{

    JO_REMOVE_FLAG(__jo_sprite_attributes.direction, 0x10);

}


/*

███████╗ ██████╗ █████╗ ██╗     ███████╗

██╔════╝██╔════╝██╔══██╗██║     ██╔════╝

███████╗██║     ███████║██║     █████╗

╚════██║██║     ██╔══██║██║     ██╔══╝

███████║╚██████╗██║  ██║███████╗███████╗

╚══════╝ ╚═════╝╚═╝  ╚═╝╚══════╝╚══════╝

*/


# define JO_NO_ZOOM             (65535)


static  __jo_force_inline void  jo_sprite_change_sprite_scale(const float scale)

{

    __jo_sprite_attributes.fixed_scale_x = jo_float2fixed(scale);

    __jo_sprite_attributes.fixed_scale_y = __jo_sprite_attributes.fixed_scale_x;

}


static  __jo_force_inline void  jo_sprite_change_sprite_scale_xy(const float scale_x, const float scale_y)

{

    __jo_sprite_attributes.fixed_scale_x = jo_float2fixed(scale_x);

    __jo_sprite_attributes.fixed_scale_y = jo_float2fixed(scale_y);

}


static  __jo_force_inline void  jo_sprite_change_sprite_scale_xy_fixed(const jo_fixed scale_x, const jo_fixed scale_y)

{

    __jo_sprite_attributes.fixed_scale_x = scale_x;

    __jo_sprite_attributes.fixed_scale_y = scale_y;

}


static  __jo_force_inline void  jo_sprite_restore_sprite_scale(void)

{

    __jo_sprite_attributes.fixed_scale_x = JO_NO_ZOOM;

    __jo_sprite_attributes.fixed_scale_y = JO_NO_ZOOM;

}


/*

██████╗ ██████╗  █████╗ ██╗    ██╗

██╔══██╗██╔══██╗██╔══██╗██║    ██║

██║  ██║██████╔╝███████║██║ █╗ ██║

██║  ██║██╔══██╗██╔══██║██║███╗██║

██████╔╝██║  ██║██║  ██║╚███╔███╔╝

╚═════╝ ╚═╝  ╚═╝╚═╝  ╚═╝ ╚══╝╚══╝

*/


static  __jo_force_inline void  jo_sprite_set_palette(int palette_id)

{

    __jo_sprite_attributes.color_table_index = JO_MULT_BY_256(palette_id);

}


static  __jo_force_inline void  jo_sprite_draw3D_and_rotate(const int sprite_id, const int x, const int y, const int z, const int angle)

{

    extern jo_pos3D __jo_sprite_pos;

    __internal_jo_sprite_set_position3D(x, y, z);

    jo_sprite_draw_rotate(sprite_id, &__jo_sprite_pos, angle, true, false);

}


static  __jo_force_inline void  jo_sprite_draw3D(const int sprite_id, const int x, const int y, const int z)

{

    extern jo_pos3D __jo_sprite_pos;

    __internal_jo_sprite_set_position3D(x, y, z);

    jo_sprite_draw(sprite_id, &__jo_sprite_pos, true, false);

}


static  __jo_force_inline void  jo_sprite_draw3D_and_rotate2(const int sprite_id, const int x, const int y, const int z, const int angle)

{

    extern jo_pos3D __jo_sprite_pos;

    __internal_jo_sprite_set_position3D(x, y, z);

    jo_sprite_draw_rotate(sprite_id, &__jo_sprite_pos, angle, false, false);

}


static  __jo_force_inline void  jo_sprite_draw3D2(const int sprite_id, const int x, const int y, const int z)

{

    extern jo_pos3D __jo_sprite_pos;

    __internal_jo_sprite_set_position3D(x, y, z);

    jo_sprite_draw(sprite_id, &__jo_sprite_pos, false, false);

}


void        jo_sprite_draw_4p_fixed(const int sprite_id, const jo_pos2D_fixed * const four_points, const jo_fixed z, const bool centered_style_coordinates);


/*

 ██████╗██╗     ██╗██████╗ ██████╗ ██╗███╗   ██╗ ██████╗

██╔════╝██║     ██║██╔══██╗██╔══██╗██║████╗  ██║██╔════╝

██║     ██║     ██║██████╔╝██████╔╝██║██╔██╗ ██║██║  ███╗

██║     ██║     ██║██╔═══╝ ██╔═══╝ ██║██║╚██╗██║██║   ██║

╚██████╗███████╗██║██║     ██║     ██║██║ ╚████║╚██████╔╝

 ╚═════╝╚══════╝╚═╝╚═╝     ╚═╝     ╚═╝╚═╝  ╚═══╝ ╚═════╝

*/


static  __jo_force_inline void  jo_sprite_enable_clipping(bool outside)

{

    __jo_sprite_attributes.clipping = outside ? Window_Out : Window_In;

}


static  __jo_force_inline void  jo_sprite_disable_clipping(void)

{

    __jo_sprite_attributes.clipping = No_Window;

}


void jo_sprite_set_clipping_area(const unsigned int x, const unsigned int y, const unsigned int width, const unsigned int height, const int depth);


/*

 ██████╗ ███████╗████████╗    ███████╗██████╗ ██████╗ ██╗████████╗███████╗    ██╗███╗   ██╗███████╗ ██████╗

██╔════╝ ██╔════╝╚══██╔══╝    ██╔════╝██╔══██╗██╔══██╗██║╚══██╔══╝██╔════╝    ██║████╗  ██║██╔════╝██╔═══██╗

██║  ███╗█████╗     ██║       ███████╗██████╔╝██████╔╝██║   ██║   █████╗      ██║██╔██╗ ██║█████╗  ██║   ██║

██║   ██║██╔══╝     ██║       ╚════██║██╔═══╝ ██╔══██╗██║   ██║   ██╔══╝      ██║██║╚██╗██║██╔══╝  ██║   ██║

╚██████╔╝███████╗   ██║       ███████║██║     ██║  ██║██║   ██║   ███████╗    ██║██║ ╚████║██║     ╚██████╔╝

 ╚═════╝ ╚══════╝   ╚═╝       ╚══════╝╚═╝     ╚═╝  ╚═╝╚═╝   ╚═╝   ╚══════╝    ╚═╝╚═╝  ╚═══╝╚═╝      ╚═════╝

*/


static  __jo_force_inline jo_color        jo_sprite_get_pixel_color(const jo_color * const data, const unsigned int x, const unsigned int y, const unsigned int image_width)

{

    return (data[x + y * image_width]);

}


static  __jo_force_inline unsigned char     jo_sprite_get_pixel_palette_index(const unsigned char * const data, const unsigned int x, const unsigned int y, const unsigned int image_width)

{

    return (data[x + y * image_width]);

}


static  __jo_force_inline bool        jo_sprite_is_pixel_transparent(const jo_color * const data, const unsigned int x, const unsigned int y, const unsigned int image_width)

{

    return (jo_sprite_get_pixel_color(data, x, y, image_width) == JO_COLOR_Transparent);

}


static  __jo_force_inline int         jo_sprite_get_width(const int sprite_id)

{

    return (__jo_sprite_def[sprite_id].width);

}


static  __jo_force_inline int           jo_sprite_get_height(const int sprite_id)

{

    return (__jo_sprite_def[sprite_id].height);

}


static  __jo_force_inline void          *jo_sprite_get_raw_data(const int sprite_id)

{

    return (__jo_sprite_pic[sprite_id].data);

}


/*

███████╗████████╗ █████╗ ████████╗██╗███████╗████████╗██╗ ██████╗███████╗

██╔════╝╚══██╔══╝██╔══██╗╚══██╔══╝██║██╔════╝╚══██╔══╝██║██╔════╝██╔════╝

███████╗   ██║   ███████║   ██║   ██║███████╗   ██║   ██║██║     ███████╗

╚════██║   ██║   ██╔══██║   ██║   ██║╚════██║   ██║   ██║██║     ╚════██║

███████║   ██║   ██║  ██║   ██║   ██║███████║   ██║   ██║╚██████╗███████║

╚══════╝   ╚═╝   ╚═╝  ╚═╝   ╚═╝   ╚═╝╚══════╝   ╚═╝   ╚═╝ ╚═════╝╚══════╝

*/


static  __jo_force_inline int         jo_sprite_count(void)

{

    return (jo_get_last_sprite_id() + 1);

}


int                                   jo_sprite_usage_percent(void);


#endif /* !__JO_SPRITES_H__ */


/*

** END OF FILE

*/