types.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_TYPES_H__
# define __JO_TYPES_H__

# define __jo_force_inline                  __attribute__((always_inline)) inline

typedef unsigned short jo_color;

typedef int             jo_fixed;

typedef short           jo_angle;

typedef struct
{
    int                 x;
    int                 y;
}                       jo_pos2D;

typedef struct
{
    jo_fixed            x;
    jo_fixed            y;
}                       jo_pos2D_fixed;

typedef struct
{
    int                 x;
    int                 y;
    int                 z;
}                       jo_pos3D;

typedef struct
{
    float               x;
    float               y;
    float               z;
}                       jo_pos3Df;

typedef struct
{
    jo_fixed            x;
    jo_fixed            y;
    jo_fixed            z;
}                       jo_pos3D_fixed;

typedef struct
{
    int                 rx;
    int                 ry;
    int                 rz;
}                       jo_rot3D;

typedef struct
{
    float               rx;
    float               ry;
    float               rz;
}                       jo_rot3Df;

typedef struct
{
    jo_pos3D;
    short               rz;
}                       jo_2d_object_attributes;

typedef struct
{
    jo_2d_object_attributes;
    short               rx;
    short               ry;
}                       jo_3d_object_attributes;

typedef struct
{
    float               x;
    float               y;
    float               z;
}                       jo_vectorf;

typedef struct
{
    jo_pos3D;
}                       jo_vector;

typedef struct
{
    jo_pos3D_fixed;
}                       jo_vector_fixed;

typedef struct
{
    jo_fixed            x;
    jo_fixed            y;
}                       jo_vector2_fixed;

typedef struct
{
    jo_pos3D_fixed;
    jo_fixed            w;
}                       jo_vector4_fixed;

typedef union
{
    float               m[4][4];
    float               table[16];
    struct
    {
        float           m00, m01, m02, m03;
        float           m10, m11, m12, m13;
        float           m20, m21, m22, m23;
        float           m30, m31, m32, m33;
    };
}                       jo_matrixf;

typedef union
{
    jo_fixed            m[4][4];
    jo_fixed            table[16];
    struct
    {
        jo_fixed        m00, m01, m02, m03;
        jo_fixed        m10, m11, m12, m13;
        jo_fixed        m20, m21, m22, m23;
        jo_fixed        m30, m31, m32, m33;
    };
}                       jo_matrix;

typedef struct      __jo_size
{
    unsigned short  width;
    unsigned short  height;
}                   jo_size;

typedef struct
{
    unsigned short      width;
    unsigned short      height;
    unsigned short      adr;
    unsigned short      size;
}                       jo_texture_definition;

typedef struct
{
    unsigned short      index;
    unsigned short      color_mode;
    void                *data;
}                       jo_picture_definition;

typedef struct
{
    unsigned short  width;
    unsigned short  height;
    jo_color        *data;
}                   jo_img;

typedef struct
{
    unsigned short  width;
    unsigned short  height;
    unsigned char   *data;
}                   jo_img_8bits;

typedef struct
{
    unsigned short  width;
    unsigned short  height;
    void            *data;
}                   jo_raw_img;

typedef struct
{
    jo_color    *data;
    int         id;
}               jo_palette;

typedef struct
{
    int                 x;
    int                 y;
    unsigned short  width;
    unsigned short  height;
}                   jo_tile;

typedef struct
{
    unsigned short      effect;
    unsigned short      direction;
    unsigned int        color_table_index;
    unsigned int        gouraud_shading_index;
    jo_fixed            fixed_scale_x;
    jo_fixed            fixed_scale_y;
    unsigned int        clipping;
}                       jo_sprite_attributes;

typedef union
{
    float f;
    struct
    {
        unsigned int sign : 1;
        unsigned int exponent : 8;
        unsigned int mantissa : 23;
 
    } field;
}                       jo_IEEE754;

typedef struct
{
    int         id;
    int         size;
    int         read;
    void        *handle;
    char        *read_buffer;
    int         read_index;
    int         read_buffer_size;
}               jo_file;

typedef enum
{
    NONE,
    LEFT,
    RIGHT,
    UP,
    DOWN,
    UP_LEFT,
    UP_RIGHT,
    DOWN_LEFT,
    DOWN_RIGHT
}               jo_8_directions;

typedef enum
{
    /* Technical Name */
    JO_NBG0_SCREEN = (1<<0),
    JO_NBG1_SCREEN = (1<<1),
    JO_NBG2_SCREEN = (1<<2),
    JO_NBG3_SCREEN = (1<<3),
    JO_RBG0_SCREEN = (1<<4),
    JO_BACK_SCREEN = (1<<5),
    JO_SPRITE_SCREEN = (1<<6),
    /* User friendly alias */
    JO_VDP2_3D_PLANE_SCREEN = JO_RBG0_SCREEN,
    JO_LNCL_SCREEN = JO_BACK_SCREEN,
    /* Helper */
    JO_ALL_SCROLL_SCREEN = JO_NBG0_SCREEN | JO_NBG1_SCREEN | JO_NBG2_SCREEN | JO_NBG3_SCREEN | JO_RBG0_SCREEN | JO_BACK_SCREEN | JO_SPRITE_SCREEN
}               jo_scroll_screen;
 
#endif /* !__JO_TYPES_H__ */
 
/*
** END OF FILE
*/