effects.h

Go to the documentation of this file.

/*
** Jo Sega Saturn Engine
** Copyright (c) 2012-2026, 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_EFFECTS_H__
# define __JO_EFFECTS_H__
 
#ifdef JO_COMPILE_WITH_EFFECTS_SUPPORT
 
/*
██╗  ██╗ ██████╗ ███╗   ███╗██╗███╗   ██╗ ██████╗     ██╗      █████╗ ███████╗███████╗██████╗
██║  ██║██╔═══██╗████╗ ████║██║████╗  ██║██╔════╝     ██║     ██╔══██╗██╔════╝██╔════╝██╔══██╗
███████║██║   ██║██╔████╔██║██║██╔██╗ ██║██║  ███╗    ██║     ███████║███████╗█████╗  ██████╔╝
██╔══██║██║   ██║██║╚██╔╝██║██║██║╚██╗██║██║   ██║    ██║     ██╔══██║╚════██║██╔══╝  ██╔══██╗
██║  ██║╚██████╔╝██║ ╚═╝ ██║██║██║ ╚████║╚██████╔╝    ███████╗██║  ██║███████║███████╗██║  ██║
╚═╝  ╚═╝ ╚═════╝ ╚═╝     ╚═╝╚═╝╚═╝  ╚═══╝ ╚═════╝     ╚══════╝╚═╝  ╚═╝╚══════╝╚══════╝╚═╝  ╚═╝
*/

typedef struct
{
    jo_vector_fixed     source;
    bool                use_intermediate_point_a;
    jo_vector_fixed     intermediate_point_a;
    bool                use_intermediate_point_b;
    jo_vector_fixed     intermediate_point_b;
    jo_vector_fixed     target;
    jo_fixed            length;
    jo_fixed            horizontal_thickness;
    jo_fixed            vertical_thickness;
    jo_fixed            section_step;
    int                 sprite_id;
    bool                center_sprites_according_to_thickness;
}                       jo_homing_laser;

void    jo_init_homing_laser(jo_homing_laser * const homing_laser, const int sprite_id, const unsigned short thickness,
                             const int z, const unsigned short nb_sections);

void    jo_draw_homing_laser(jo_homing_laser * const homing_laser);
 
#ifdef JO_COMPILE_WITH_3D_SUPPORT
 
/*
** Effects of the 3D world: animated sprites (fire, smoke, dust, sparks...), flash of the screen, shake of the camera.
** Cheap on the Saturn: the sprites are opaque with end codes (half transparency costs a lot of VDP1 time), the flash is
** the color offset of the VDP2 (free), the shake is an offset of the camera given to the game.
** The explosions of the entities use them (see entity.h)
*/

# define JO_EFFECT_MAX                      (32)
# define JO_EFFECT_MAX_FRAMES               (4)

# define JO_EFFECT_HALF_TRANSPARENT         (0x01)
# define JO_EFFECT_STANDING                 (0x02)
# define JO_EFFECT_RANDOM_FLIP              (0x04)

typedef struct
{
    short                           sprites[JO_EFFECT_MAX_FRAMES];  // Frames of the animation (played once during the life)
    unsigned char                   frame_count;
    unsigned char                   life;           // Frames of the game
    unsigned char                   flags;          // JO_EFFECT_xxx
    unsigned char                   __pad;
    short                           size_start;     // Half size at the start and at the end (world units)
    short                           size_end;
    short                           rise;           // Speed up (1/16 world units per frame of the game)
    short                           __pad2;
}                                   jo_effect_def;

void                                jo_effect_add(const jo_effect_def * const def, const jo_pos3D_fixed * const position, const int delay);

void                                jo_effects_clear(void);

void                                jo_effects_update(void);

int                                 jo_effects_draw(void);

void                                jo_effect_flash(const int r, const int g, const int b, const int frames);

void                                jo_effect_fade(const int darkness, const int frames);

bool                                jo_effect_is_fading(void);

void                                jo_effect_shake(const int amount, const int frames);

void                                jo_effect_get_shake(jo_pos3D_fixed * const offset);
 
#endif /* !JO_COMPILE_WITH_3D_SUPPORT */
 
#endif /* !JO_COMPILE_WITH_EFFECTS_SUPPORT */
 
#endif /* !__JO_EFFECTS_H__ */
 
/*
** END OF FILE
*/