doxygen/jo_8h_source.html

/*

** 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_H__

# define __JO_H__


/*

** INCLUDES

*/

#include <stdbool.h>

#include "conf.h"

#include "types.h"

#include "sega_saturn.h"

#include "time.h"

#include "smpc.h"

#include "core.h"

#include "math.h"

#include "tools.h"

#include "vdp1_command_pipeline.h"

#include "malloc.h"

#include "colors.h"

#include "list.h"

#include "input.h"

#include "keyboard.h"

#include "console.h"

#include "fs.h"

#include "audio.h"

#include "palette.h"

#include "image.h"

#include "tga.h"

#include "sprites.h"

#include "vdp2_malloc.h"

#include "vdp2.h"

#include "background.h"

#include "hitbox.h"

#include "sprite_animator.h"

#include "map.h"

#include "mode7.h"

#include "physics.h"

#include "3d.h"

#include "model.h"

#include "light.h"

#include "glow.h"

#include "level.h"

#include "entity.h"

#include "cell.h"

#include "weapon.h"


#include "vehicle.h"

#include "backup.h"

#include "video.h"

#include "effects.h"

#include "font.h"

#include "storyboard.h"

#include "software_renderer.h"

#include "voxel.h"

#include "profile.h"

#include "dsp.h"


#endif /* !__JO_H__ */


/*

** END OF FILE

*/

3d.h
Jo Engine 3D basics.

audio.h
Jo Engine Function prototypes for audio.

background.h
Jo Engine Background definition and tools.

backup.h
Jo Engine saving features function prototypes.

cell.h
Cells and portals: the rooms of an inside level (sections CELL and PRTL, see Documentation/level_form...

colors.h
Jo Engine Standard colors.

conf.h
Jo Engine Internal configuration.

console.h
Jo Engine Console function prototypes.

core.h
Jo Engine core function prototypes.

dsp.h
SCU DSP: the third processor of the Saturn (about 14 MHz, one 32 x 32 bits multiply and accumulate pe...

effects.h
Jo Engine Function prototypes special effects (Laser beam, fire, smoke, flash, shake,...

entity.h
Entities: the things of a level that live (barrels that explode, trigger zones, relays,...

font.h
Jo Engine Simple ASCII Font & print support.

fs.h
Jo Engine File System function prototypes.

glow.h
Jo Engine glows: the halo of light around a lamp (a soft disc of its color, without edge,...

hitbox.h
Jo Engine Hitbox and tools.

image.h
Jo Engine Image definition and tools.

input.h
Jo Engine Gamepad functions.

keyboard.h
Jo Engine Keyboard function prototypes.

level.h
Levels (.JOL files): the data of a level of a game (terrain, models, plants, decals....

light.h
Jo Engine point lights: light sources (a position, a color, a radius, a strength; all around like a b...

list.h
Jo Engine Linked list helper.

malloc.h
Jo Engine Malloc.

map.h
Jo Engine MAP file (sprite map).

math.h
Jo Engine Math tools.

mode7.h
Jo Engine Mode7.

model.h
3D models (.JOM files): meshes made with a 3D software, converted by Compiler/COMMON/jo_model....

palette.h
Jo Engine Palette Handling.

physics.h
Jo Engine File Physics function prototypes.

profile.h
Jo Engine profiler: time spent by the CPUs and the VDP1 in each frame.

sega_saturn.h
Jo Engine Sega Saturn constants (addresses, memory sizes, etc).

smpc.h
System Management & Peripheral Control.

software_renderer.h
Fast Triangle based software renderer using fixed number.

sprite_animator.h
Jo Engine Sprite Animator.

sprites.h
Jo Engine Sprite definition and tools.

storyboard.h
Jo Engine Storyboard Animation function prototypes.

tga.h
Jo Engine Truevision Targa format support.

time.h
Time Management.

tools.h
Jo Engine Tools (printf, etc,).

types.h
Jo Engine Types.

vdp1_command_pipeline.h
VDP1 command table handling.

vdp2.h
Jo Engine VDP2 definition and tools.

vdp2_malloc.h
VDP2 memory allocation (cell, map, rotation, scroll, etc).

vehicle.h
Vehicles: entities of the class vehicle (a jeep, a truck), driven by the player. An actor (a model wi...

video.h
Jo Engine Video Player (Sega FILM/CPK File Format).

voxel.h
Jo Engine Voxel renderer.

weapon.h
Weapons of the player: the definitions (section WEAP of a level, for instance a file of definitions s...