35#ifndef __JO_SPRITES_H__
36# define __JO_SPRITES_H__
67void jo_sprite_draw(
const int sprite_id,
const jo_pos3D *
const pos,
const bool centered_style_coordinates,
const bool billboard);
71void jo_sprite_draw_rotate(
const int sprite_id,
const jo_pos3D *
const pos,
const int angle,
const bool centered_style_coordinates,
const bool billboard);
76 __jo_sprite_pos.
x = x;
77 __jo_sprite_pos.
y = y;
78 __jo_sprite_pos.
z = z;
102# define __JO_SPRITE_IS_MISSING(SPRITE_ID) \
103 ((int)(SPRITE_ID) > jo_get_last_sprite_id() && \
104 (jo_core_error("Sprite %d not added (last one: %d)", (int)(SPRITE_ID), jo_get_last_sprite_id()), true))
192# ifdef JO_COMPILE_WITH_SPRITE_HASHTABLE
303# define JO_NO_GOURAUD_COLOR (0xc210)
344# define JO_DEFAULT_BRIGHTNESS (16)
347# define JO_MAX_BRIGHTNESS (31)
402# define JO_NO_ZOOM (65536)
618 const bool centered_style_coordinates);
679 return (
data[x + y * image_width]);
691 return (
data[x + y * image_width]);
#define JO_COLOR_Transparent
Transparent color.
Definition colors.h:87
#define __JO_INDEX_IS_WRONG(INDEX, COUNT, WHAT)
Check an index given to a function of the engine (Internal usage, JO_DEBUG).
Definition core.h:55
void * data
Definition entity.h:19
int height
Definition entity.h:4
#define JO_MULT_BY_256(X)
Multiply a variable by 256.
Definition math.h:111
#define JO_MULT_BY_8(X)
Multiply a variable by 8.
Definition math.h:81
#define JO_REMOVE_FLAG(BYTEFIELD, FLAG)
Remove flag in bytefield.
Definition math.h:381
#define JO_ADD_FLAG(BYTEFIELD, FLAG)
Add flag in bytefield.
Definition math.h:375
#define JO_PALETTE_MAX
Define the maximum of palette (the 256 colors palettes of the color RAM).
Definition sega_saturn.h:157
#define JO_VDP1_VRAM
VDP1 VRAM (512 kilobytes).
Definition sega_saturn.h:90
void jo_sprite_draw(const int sprite_id, const jo_pos3D *const pos, const bool centered_style_coordinates, const bool billboard)
(internal engine usage)
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)
Change Gouraud Shading colors (a new table for the sprites displayed after this call with jo_sprite_e...
unsigned int jo_sprite_free_memory(void)
Get the free sprite memory (VDP1 VRAM).
void jo_set_gouraud_shading_brightness(const unsigned char brightness)
Change Gouraud Shading brightness.
void __jo_vdp1_draw_sprite3D2(const int sprite_id, const int x, const int y, const int z)
Draw a sprite of the current sprite attributes without rotation (internal usage: see jo_sprite_draw3D...
void jo_sprite_free_from(const int sprite_id)
Free all sprites from the given sprite_id.
static __jo_force_inline void jo_sprite_disable_vertical_flip(void)
Disable vertical flip for every sprite displayed after this call.
Definition sprites.h:372
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)
Display a sprite in 3 dimensional space.
Definition sprites.h:508
void jo_sprite_set_system_clipping_area(const unsigned int width, const unsigned int height)
Set the VDP1 drawing area (system clipping).
jo_texture_definition __jo_sprite_def[JO_MAX_SPRITE]
(internal engine usage)
static __jo_force_inline void jo_sprite_enable_horizontal_flip(void)
Activate horizontal flip for every sprite displayed after this call.
Definition sprites.h:378
int jo_sprite_name2id(const char *const filename)
Retrive the Sprite Id from filename based on the four first character in the filename.
static __jo_force_inline int jo_sprite_count(void)
Get sprite count.
Definition sprites.h:776
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)
Get a specific pixel palette index from image bytes.
Definition sprites.h:689
int jo_sprite_replace(const jo_img *const img, const int sprite_id)
Replace a sprite.
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)
Get if a specific pixel is transparent (JO_COLOR_Transparent) in image bytes.
Definition sprites.h:702
void jo_sprite_draw_color_4p_fixed(const jo_pos2D_fixed *const four_points, const jo_color color, const jo_fixed z, const bool centered_style_coordinates)
Draw a quadrilateral of one color (no texture) on 4 points: jo_sprite_draw_4p_fixed() with a color in...
static __jo_force_inline void jo_sprite_draw3D(const int sprite_id, const int x, const int y, const int z)
Display a sprite in 3 dimensional space.
Definition sprites.h:521
static __jo_force_inline int jo_sprite_add_rgb(const jo_color *const pixels, const unsigned short width, const unsigned short height)
Add a sprite from its pixels (jo_sprite_add() without the image struct: a texture in an array of the ...
Definition sprites.h:120
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)
Set user clipping area.
static __jo_force_inline void jo_sprite_enable_clipping(bool outside)
Activate sprite clipping for every sprite displayed after this call.
Definition sprites.h:632
static __jo_force_inline void jo_sprite_draw3D2(const int sprite_id, const int x, const int y, const int z)
Display a sprite in 3 dimensional space.
Definition sprites.h:546
static __jo_force_inline void jo_sprite_set_additive_palette(int palette_id)
Change palette for every 8 bits sprite displayed after this call: their light is added to the image u...
Definition sprites.h:475
void __jo_vdp1_draw_sprite3D(const int sprite_id, const int x, const int y, const int z)
Draw a sprite of the current sprite attributes without rotation (internal usage: see jo_sprite_draw3D...
void jo_sprite_draw_rotated_fixed(const int sprite_id, const jo_fixed x, const jo_fixed y, const jo_fixed z, const jo_fixed half_width, const jo_fixed half_height, const int angle)
Display a sprite turned on the screen (any angle: the 4 corners are computed, the sprite is distorted...
int jo_sprite_usage_percent(void)
Get sprite memory usage.
static __jo_force_inline void jo_sprite_disable_clipping(void)
Disable sprite clipping for every sprite displayed after this call.
Definition sprites.h:639
static __jo_force_inline void jo_sprite_disable_screen_doors_filter(void)
Disable screen doors filter for every sprite displayed after this call.
Definition sprites.h:223
static __jo_force_inline int jo_sprite_get_width(const int sprite_id)
Get sprite width.
Definition sprites.h:711
static __jo_force_inline void jo_sprite_change_sprite_scale_fixed(const jo_fixed scale)
Change scale for every sprite displayed after this call using fixed number.
Definition sprites.h:407
jo_picture_definition __jo_sprite_pic[JO_MAX_SPRITE]
(internal engine usage)
static __jo_force_inline void jo_sprite_disable_gouraud_shading(void)
Disable Gouraud Shading for every sprite displayed after this call.
Definition sprites.h:329
static __jo_force_inline void jo_sprite_change_sprite_scale_xy(const float scale_x, const float scale_y)
Change scale for every sprite displayed after this call.
Definition sprites.h:426
static __jo_force_inline void jo_sprite_change_sprite_scale(const float scale)
Change scale for every sprite displayed after this call.
Definition sprites.h:417
int jo_sprite_add(const jo_img *const img)
Add a sprite.
static __jo_force_inline void jo_sprite_change_sprite_scale_xy_fixed(const jo_fixed scale_x, const jo_fixed scale_y)
Change scale for every sprite displayed after this call using fixed number.
Definition sprites.h:436
static __jo_force_inline void jo_sprite_restore_sprite_scale(void)
Restore default scale for every sprite displayed after this call.
Definition sprites.h:444
static __jo_force_inline void jo_sprite_disable_horizontal_flip(void)
Disable horizontal flip for every sprite displayed after this call.
Definition sprites.h:385
static __jo_force_inline void jo_sprite_set_palette(int palette_id)
Change palette for every 8 bits sprite displayed after this call.
Definition sprites.h:462
static __jo_force_inline int jo_sprite_get_height(const int sprite_id)
Get sprite height.
Definition sprites.h:724
static __jo_force_inline void __internal_jo_sprite_set_position3D(const int x, const int y, const int z)
Internal usage don't use it.
Definition sprites.h:73
int jo_sprite_add_image_4bits_lut(const jo_img *const img)
Add an RGB image of 14 colors at most (the index 15 is the end code of the VDP1) as a 16 colors textu...
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)
(internal engine usage)
static __jo_force_inline void jo_sprite_enable_vertical_flip(void)
Activate vertical flip for every sprite displayed after this call.
Definition sprites.h:365
static __jo_force_inline void jo_sprite_disable_half_transparency(void)
Disable half transparency for every sprite displayed after this call.
Definition sprites.h:242
static __jo_force_inline jo_color * jo_sprite_get_lut(const int sprite_id)
Get the color lookup table of a 16 colors texture (jo_sprite_add_4bits_lut()): its 16 entries in the ...
Definition sprites.h:754
unsigned short __jo_sprite_lut[JO_MAX_SPRITE]
(internal engine usage)
static __jo_force_inline void jo_sprite_set_gouraud_table(const unsigned short table)
Gouraud table of the sprites displayed after this call with jo_sprite_enable_gouraud_shading() (inste...
Definition sprites.h:338
void jo_sprite_draw_rectangle(const int x, const int y, const int width, const int height, const jo_color color, const int z)
Draw a rectangle of one color (no texture): a health bar, a frame, a window of text,...
jo_sprite_attributes __jo_sprite_attributes
Current displayed sprite attribute (internal engine usage).
#define __JO_SPRITE_IS_MISSING(SPRITE_ID)
Check the id of a sprite given to a function of the engine (Internal usage, JO_DEBUG).
Definition sprites.h:102
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)
Get a specific pixel color from image bytes.
Definition sprites.h:677
bool jo_sprite_add_end_codes(const int sprite_id)
Write the VDP1 end codes after the last visible pixel of each line of a sprite (RGB sprites).
static __jo_force_inline void jo_sprite_enable_half_transparency(void)
Activate half transparency for every sprite displayed after this call.
Definition sprites.h:234
static __jo_force_inline void * jo_sprite_get_raw_data(const int sprite_id)
Get sprite raw image contents.
Definition sprites.h:737
static __jo_force_inline void jo_sprite_free_all(void)
Free all sprites.
Definition sprites.h:187
int jo_sprite_add_4bits_lut(const unsigned char *const pixels, const unsigned short width, const unsigned short height, const jo_color *const lut)
Add a 16 colors texture with its color lookup table: 4 bits per pixel (4 times less VRAM than an RGB ...
int jo_get_last_sprite_id(void)
Get last Sprite Id.
static __jo_force_inline void jo_sprite_disable_shadow_filter(void)
Disable shadow filter for every sprite displayed after this call.
Definition sprites.h:267
int jo_sprite_add_8bits_image(const jo_img_8bits *const img)
Add a 8 bits sprite.
static __jo_force_inline void jo_sprite_enable_screen_doors_filter(void)
Activate screen doors filter for every sprite displayed after this call.
Definition sprites.h:216
#define JO_NO_ZOOM
Value used to keep the original scale (1.0 in jo_fixed).
Definition sprites.h:402
static __jo_force_inline void jo_sprite_enable_gouraud_shading(void)
Activate Gouraud Shading for every sprite displayed after this call.
Definition sprites.h:319
static __jo_force_inline void jo_sprite_enable_dark_filter(void)
Activate dark filter for every sprite displayed after this call.
Definition sprites.h:279
static __jo_force_inline void jo_sprite_enable_shadow_filter(void)
Activate shadow filter for every sprite displayed after this call.
Definition sprites.h:259
static __jo_force_inline void jo_sprite_disable_dark_filter(void)
Disable dark filter for every sprite displayed after this call.
Definition sprites.h:287
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)
Display a sprite in 3 dimensional space.
Definition sprites.h:533
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)
Display a sprite on 4 points (distorted sprite).
#define __jo_force_inline
force inline attribute (and prevent Doxygen prototype parsing bug)
Definition types.h:39
int y
Definition types.h:87
unsigned int color_table_index
Definition types.h:287
unsigned short height
Definition types.h:244
unsigned short jo_color
15 bits color type
Definition types.h:53
unsigned short effect
Definition types.h:285
unsigned int clipping
Definition types.h:291
jo_color * data
Definition types.h:245
unsigned short width
Definition types.h:243
jo_fixed fixed_scale_y
Definition types.h:290
int jo_fixed
Fixed point Q16.16 number.
Definition types.h:59
int x
Definition types.h:86
int z
Definition types.h:88
unsigned int gouraud_shading_index
Definition types.h:288
unsigned short direction
Definition types.h:286
jo_fixed fixed_scale_x
Definition types.h:289
15 bits image struct
Definition types.h:242
8 bits image struct
Definition types.h:250
Picture definition.
Definition types.h:234
2D position using fixed number
Definition types.h:76
3D position
Definition types.h:85
Sprite attributes.
Definition types.h:284
Texture definition.
Definition types.h:225
#define JO_VDP1_NO_WINDOW
No clipping window.
Definition vdp1_command_pipeline.h:133
#define JO_VDP1_WINDOW_IN
Draw inside the user clipping area.
Definition vdp1_command_pipeline.h:135
#define JO_VDP1_WINDOW_OUT
Draw outside the user clipping area.
Definition vdp1_command_pipeline.h:137