sprites.h File Reference

Jo Engine Sprite definition and tools. More...

Go to the source code of this file.

Macros
#define	JO_NO_GOURAUD_COLOR
	Value used to keep the original color for jo_set_gouraud_shading_colors().
#define	JO_DEFAULT_BRIGHTNESS
	Default brightness for jo_set_gouraud_shading_brightness().
#define	JO_MAX_BRIGHTNESS
	Maximum brightness value for jo_set_gouraud_shading_brightness().
#define	JO_NO_ZOOM
	Value used to keep the original scale (1.0 in jo_fixed).

Functions
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_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	__internal_jo_sprite_set_position3D (const int x, const int y, const int z)
	Internal usage don't use it.
int	jo_get_last_sprite_id (void)
	Get last Sprite Id.
int	jo_sprite_add (const jo_img *const img)
	Add a sprite.
int	jo_sprite_add_8bits_image (const jo_img_8bits *const img)
	Add a 8 bits sprite.
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 texture), drawn like an RGB texture (the colors of the table are RGB: gouraud shading, half transparency, lights).
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 texture with its color lookup table (see jo_sprite_add_4bits_lut()): the same pixels for 4 times less VRAM (a grey detail texture tinted by the gouraud shading has a few levels of grey).
int	__jo_sprite_add_4bits (const void *const pixels, const unsigned short width, const unsigned short height, const unsigned short lut)
	Add a 16 colors texture that uses the color lookup table of another one (internal engine usage: smaller copies, tiles, see 3d.c).
int	jo_sprite_replace (const jo_img *const img, const int sprite_id)
	Replace a sprite.
int	__jo_sprite_replace (const jo_img *const img, const int sprite_id, const bool async)
	Replace a sprite (internal usage).
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).
void	jo_sprite_free_from (const int sprite_id)
	Free all sprites from the given sprite_id.
static __jo_force_inline void	jo_sprite_free_all (void)
	Free all sprites.
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 void	jo_sprite_enable_screen_doors_filter (void)
	Activate screen doors filter for every sprite displayed after this call.
static __jo_force_inline void	jo_sprite_disable_screen_doors_filter (void)
	Disable screen doors filter for every sprite displayed after this call.
static __jo_force_inline void	jo_sprite_enable_half_transparency (void)
	Activate half transparency for every sprite displayed after this call.
static __jo_force_inline void	jo_sprite_disable_half_transparency (void)
	Disable half transparency for every sprite displayed after this call.
static __jo_force_inline void	jo_sprite_enable_shadow_filter (void)
	Activate shadow filter for every sprite displayed after this call.
static __jo_force_inline void	jo_sprite_disable_shadow_filter (void)
	Disable shadow filter for every sprite displayed after this call.
static __jo_force_inline void	jo_sprite_enable_dark_filter (void)
	Activate dark filter for every sprite displayed after this call.
static __jo_force_inline void	jo_sprite_disable_dark_filter (void)
	Disable dark filter for every sprite displayed after this call.
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.
static __jo_force_inline void	jo_sprite_enable_gouraud_shading (void)
	Activate Gouraud Shading for every sprite displayed after this call.
static __jo_force_inline void	jo_sprite_disable_gouraud_shading (void)
	Disable Gouraud Shading for every sprite displayed after this call.
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() (instead of the last table of jo_set_gouraud_shading_colors(): the tables given by jo_3d_add_gouraud_tables() are kept from a frame to the next).
void	jo_set_gouraud_shading_brightness (const unsigned char brightness)
	Change Gouraud Shading brightness.
static __jo_force_inline void	jo_sprite_enable_vertical_flip (void)
	Activate vertical flip for every sprite displayed after this call.
static __jo_force_inline void	jo_sprite_disable_vertical_flip (void)
	Disable vertical flip for every sprite displayed after this call.
static __jo_force_inline void	jo_sprite_enable_horizontal_flip (void)
	Activate horizontal flip for every sprite displayed after this call.
static __jo_force_inline void	jo_sprite_disable_horizontal_flip (void)
	Disable horizontal flip for every sprite displayed after this call.
static __jo_force_inline void	jo_sprite_change_sprite_scale (const float scale)
	Change scale for every sprite displayed after this call.
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.
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.
static __jo_force_inline void	jo_sprite_restore_sprite_scale (void)
	Restore default scale for every sprite displayed after this call.
static __jo_force_inline void	jo_sprite_set_palette (int palette_id)
	Change palette for every 8 bits sprite displayed after this call.
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 under them (see jo_enable_additive_sprites()).
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.
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.
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.
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.
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)
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 by the VDP1).
static __jo_force_inline void	jo_sprite_enable_clipping (bool outside)
	Activate sprite clipping for every sprite displayed after this call.
static __jo_force_inline void	jo_sprite_disable_clipping (void)
	Disable sprite clipping for every sprite displayed after this call.
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.
void	jo_sprite_set_system_clipping_area (const unsigned int width, const unsigned int height)
	Set the VDP1 drawing area (system clipping).
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.
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.
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.
static __jo_force_inline int	jo_sprite_get_width (const int sprite_id)
	Get sprite width.
static __jo_force_inline int	jo_sprite_get_height (const int sprite_id)
	Get sprite height.
static __jo_force_inline void *	jo_sprite_get_raw_data (const int sprite_id)
	Get sprite raw image contents.
static __jo_force_inline int	jo_sprite_count (void)
	Get sprite count.
int	jo_sprite_usage_percent (void)
	Get sprite memory usage.
unsigned int	jo_sprite_free_memory (void)
	Get the free sprite memory (VDP1 VRAM).

Variables
jo_sprite_attributes	__jo_sprite_attributes
	Current displayed sprite attribute (internal engine usage).
jo_texture_definition	__jo_sprite_def [JO_MAX_SPRITE]
	(internal engine usage)
jo_picture_definition	__jo_sprite_pic [JO_MAX_SPRITE]
	(internal engine usage)
unsigned short	__jo_sprite_lut [JO_MAX_SPRITE]
	(internal engine usage) Color lookup table of a 16 colors texture (VRAM address / 8), 0: none

Detailed Description

Jo Engine Sprite definition and tools.

Author

Johannes Fetz

Bug

No known bugs.

Macro Definition Documentation

JO_DEFAULT_BRIGHTNESS

#define JO_DEFAULT_BRIGHTNESS

Default brightness for jo_set_gouraud_shading_brightness().

JO_MAX_BRIGHTNESS

#define JO_MAX_BRIGHTNESS

Maximum brightness value for jo_set_gouraud_shading_brightness().

JO_NO_GOURAUD_COLOR

#define JO_NO_GOURAUD_COLOR

Value used to keep the original color for jo_set_gouraud_shading_colors().

JO_NO_ZOOM

#define JO_NO_ZOOM

Value used to keep the original scale (1.0 in jo_fixed).

Remarks

Sprites without scale and rotation are drawn pixel perfect with the VDP1 normal sprite command

Function Documentation

__internal_jo_sprite_set_position3D()

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

static

Internal usage don't use it.

__jo_sprite_add_4bits()

int __jo_sprite_add_4bits	(	const void *const	pixels,
		const unsigned short	width,
		const unsigned short	height,
		const unsigned short	lut )

Add a 16 colors texture that uses the color lookup table of another one (internal engine usage: smaller copies, tiles, see 3d.c).

Parameters

pixels	2 pixels per byte
width	Width (multiple of 8)
height	Height
lut	Table (VRAM address / 8, see __jo_sprite_lut)

Returns

Sprite Id or -1 if failed

__jo_sprite_replace()

int __jo_sprite_replace	(	const jo_img *const	img,
		const int	sprite_id,
		const bool	async )

Replace a sprite (internal usage).

Parameters

img	Pointer to a image struct
sprite_id	Sprite ID to replace
async	true: the copy is done by the DMA controller in the background (see jo_dma_wait())

Returns

sprite_id

jo_get_last_sprite_id()

int jo_get_last_sprite_id

(

void

)

Get last Sprite Id.

Returns

Last Sprite Id

jo_set_gouraud_shading_brightness()

void jo_set_gouraud_shading_brightness

(

const unsigned char

brightness

)

Change Gouraud Shading brightness.

Parameters

brightness

Brightness from 0 to 31

jo_set_gouraud_shading_colors()

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.

Parameters

topleft_color	Top left corner color in sprite
topright_color	Top right corner color in sprite
bottomright_color	bottom right corner color in sprite
bottomleft_color	bottom left corner color in sprite

jo_sprite_add()

int jo_sprite_add

(

const jo_img *const

img

)

Add a sprite.

Parameters

img	Pointer to a 15 bits image struct

Returns

Sprite Id or -1 if failed

jo_sprite_add_4bits_lut()

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 texture), drawn like an RGB texture (the colors of the table are RGB: gouraud shading, half transparency, lights).

Parameters

pixels	2 pixels per byte (the left pixel in the high bits), the color 0 is transparent
width	Width (multiple of 8)
height	Height
lut	The 16 colors (RGB 555 of the Saturn, the color 0 is not used: transparent)

Returns

Sprite Id or -1 if failed

Remarks

The table is kept in the VRAM just before the pixels, in the place of the texture (no sprite of its own)

jo_sprite_add_8bits_image()

int jo_sprite_add_8bits_image

(

const jo_img_8bits *const

img

)

Add a 8 bits sprite.

Parameters

img	Pointer to a 8 bits bits image struct

Returns

Sprite Id or -1 if failed

Warning

255 colors maximum not 256 !

jo_sprite_add_end_codes()

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).

Parameters

sprite_id

Sprite Id

Returns

false if the sprite is not a RGB sprite

Remarks

The VDP1 stops drawing a line of a sprite after 2 end codes: the transparent pixels at the right of the lines (and the transparent lines) are not drawn, the sprite is drawn faster. Useful for the sprites with many transparent pixels (plants, clouds, smoke). The VDP1 draws all the pixels of a sprite flipped horizontally (it reads the lines from their end). Call it before jo_3d_set_texture_mipmaps()

Warning

The end code of the RGB sprites is the color 0x7FFF (white without the MSB): not used by the images

jo_sprite_add_image_4bits_lut()

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 texture with its color lookup table (see jo_sprite_add_4bits_lut()): the same pixels for 4 times less VRAM (a grey detail texture tinted by the gouraud shading has a few levels of grey).

Parameters

img	Image (RGB, the width a multiple of 8, JO_COLOR_Transparent: transparent)

Returns

Sprite Id, -1 if the image has more than 14 colors (add it with jo_sprite_add()) or if failed

jo_sprite_change_sprite_scale()

__jo_force_inline void jo_sprite_change_sprite_scale ( const float scale )

static

Change scale for every sprite displayed after this call.

Parameters

scale

Sprite scale

jo_sprite_change_sprite_scale_xy()

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

static

Change scale for every sprite displayed after this call.

Parameters

scale_x	Horizontal sprite scale
scale_y	Vertical sprite scale

jo_sprite_change_sprite_scale_xy_fixed()

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

static

Change scale for every sprite displayed after this call using fixed number.

Parameters

scale_x	Horizontal sprite scale
scale_y	Vertical sprite scale

jo_sprite_count()

__jo_force_inline int jo_sprite_count ( void )

static

Get sprite count.

Returns

Count

jo_sprite_disable_clipping()

__jo_force_inline void jo_sprite_disable_clipping ( void )

static

Disable sprite clipping for every sprite displayed after this call.

jo_sprite_disable_dark_filter()

__jo_force_inline void jo_sprite_disable_dark_filter ( void )

static

Disable dark filter for every sprite displayed after this call.

jo_sprite_disable_gouraud_shading()

__jo_force_inline void jo_sprite_disable_gouraud_shading ( void )

static

Disable Gouraud Shading for every sprite displayed after this call.

jo_sprite_disable_half_transparency()

__jo_force_inline void jo_sprite_disable_half_transparency ( void )

static

Disable half transparency for every sprite displayed after this call.

jo_sprite_disable_horizontal_flip()

__jo_force_inline void jo_sprite_disable_horizontal_flip ( void )

static

Disable horizontal flip for every sprite displayed after this call.

jo_sprite_disable_screen_doors_filter()

__jo_force_inline void jo_sprite_disable_screen_doors_filter ( void )

static

Disable screen doors filter for every sprite displayed after this call.

jo_sprite_disable_shadow_filter()

__jo_force_inline void jo_sprite_disable_shadow_filter ( void )

static

Disable shadow filter for every sprite displayed after this call.

jo_sprite_disable_vertical_flip()

__jo_force_inline void jo_sprite_disable_vertical_flip ( void )

static

Disable vertical flip for every sprite displayed after this call.

jo_sprite_draw()

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

(internal engine usage)

Warning

MC Hammer: don't touch this

jo_sprite_draw3D()

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

static

Display a sprite in 3 dimensional space.

Parameters

sprite_id	Sprite Id
x	Horizontal position from the center of the screen
y	Vertical position from the center of the screen
z	Z index (depth))

jo_sprite_draw3D2()

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

static

Display a sprite in 3 dimensional space.

Parameters

sprite_id	Sprite Id returned by jo_sprite_add(), jo_sprite_add_tga() or jo_sprite_add_image_pack()
x	Horizontal position from the top left corner
y	Vertical position from the top left corner
z	Z index (depth)

jo_sprite_draw3D_and_rotate()

__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 )

static

Display a sprite in 3 dimensional space.

Parameters

sprite_id	Sprite Id
x	Horizontal position from the center of the screen
y	Vertical position from the center of the screen
z	Z index (depth)
angle	Angle (Z axe)

jo_sprite_draw3D_and_rotate2()

__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 )

static

Display a sprite in 3 dimensional space.

Parameters

sprite_id	Sprite Id returned by jo_sprite_add(), jo_sprite_add_tga() or jo_sprite_add_image_pack()
x	Horizontal position from the top left corner
y	Vertical position from the top left corner
z	Z index (depth)
angle	Angle (Z axe)

jo_sprite_draw_4p_fixed()

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 )

jo_sprite_draw_rotate()

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)

Warning

MC Hammer: don't touch this

jo_sprite_draw_rotated_fixed()

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 by the VDP1).

Parameters

sprite_id	Sprite Id returned by jo_sprite_add(), jo_sprite_add_tga() or jo_sprite_add_image_pack()
x	Horizontal position of the center (pixels from the center of the screen, Q16.16)
y	Vertical position of the center (pixels from the center of the screen, Q16.16)
z	Z index (depth, Q16.16)
half_width	Half of the width on the screen (pixels, Q16.16)
half_height	Half of the height on the screen (pixels, Q16.16)
angle	Angle in degree (clockwise on the screen)

jo_sprite_enable_clipping()

__jo_force_inline void jo_sprite_enable_clipping ( bool outside )

static

Activate sprite clipping for every sprite displayed after this call.

Parameters

outside

Clip everything inside clipping area

jo_sprite_enable_dark_filter()

__jo_force_inline void jo_sprite_enable_dark_filter ( void )

static

Activate dark filter for every sprite displayed after this call.

jo_sprite_enable_gouraud_shading()

__jo_force_inline void jo_sprite_enable_gouraud_shading ( void )

static

Activate Gouraud Shading for every sprite displayed after this call.

jo_sprite_enable_half_transparency()

__jo_force_inline void jo_sprite_enable_half_transparency ( void )

static

Activate half transparency for every sprite displayed after this call.

jo_sprite_enable_horizontal_flip()

__jo_force_inline void jo_sprite_enable_horizontal_flip ( void )

static

Activate horizontal flip for every sprite displayed after this call.

jo_sprite_enable_screen_doors_filter()

__jo_force_inline void jo_sprite_enable_screen_doors_filter ( void )

static

Activate screen doors filter for every sprite displayed after this call.

jo_sprite_enable_shadow_filter()

__jo_force_inline void jo_sprite_enable_shadow_filter ( void )

static

Activate shadow filter for every sprite displayed after this call.

jo_sprite_enable_vertical_flip()

__jo_force_inline void jo_sprite_enable_vertical_flip ( void )

static

Activate vertical flip for every sprite displayed after this call.

jo_sprite_free_all()

__jo_force_inline void jo_sprite_free_all ( void )

static

Free all sprites.

Warning

Don't use any sprites after this call or the game may crash unexpectedly

jo_sprite_free_from()

void jo_sprite_free_from

(

const int

sprite_id

)

Free all sprites from the given sprite_id.

Parameters

sprite_id

Sprite ID to replace

Warning

Don't use freed sprites after this call or the game may crash unexpectedly

jo_sprite_free_memory()

unsigned int jo_sprite_free_memory

(

void

)

Get the free sprite memory (VDP1 VRAM).

Returns

Free bytes for the next sprites

jo_sprite_get_height()

__jo_force_inline int jo_sprite_get_height ( const int sprite_id )

static

Get sprite height.

Parameters

sprite_id

Sprite Id returned by jo_sprite_add(), jo_sprite_add_tga() or jo_sprite_add_image_pack()

Returns

Sprite height

jo_sprite_get_pixel_color()

__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 )

static

Get a specific pixel color from image bytes.

Parameters

data	Bytes (raw image data)
x	Horizontal ccord in the image
y	Vertical ccord in the image
image_width	Image width (in pixels)

Warning

This method doesn't work for 8 bits image

jo_sprite_get_pixel_palette_index()

__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 )

static

Get a specific pixel palette index from image bytes.

Parameters

data	Bytes (raw image data)
x	Horizontal ccord in the image
y	Vertical ccord in the image
image_width	Image width (in pixels)

Warning

This method only works for 8 bits image

jo_sprite_get_raw_data()

__jo_force_inline void * jo_sprite_get_raw_data ( const int sprite_id )

static

Get sprite raw image contents.

Parameters

sprite_id

Sprite Id returned by jo_sprite_add(), jo_sprite_add_tga() or jo_sprite_add_image_pack()

Returns

Raw image contents

jo_sprite_get_width()

__jo_force_inline int jo_sprite_get_width ( const int sprite_id )

static

Get sprite width.

Parameters

sprite_id

Sprite Id returned by jo_sprite_add(), jo_sprite_add_tga() or jo_sprite_add_image_pack()

Returns

Sprite width

jo_sprite_is_pixel_transparent()

__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 )

static

Get if a specific pixel is transparent (JO_COLOR_Transparent) in image bytes.

Parameters

data	Bytes (raw image data)
x	Horizontal ccord in the image
y	Vertical ccord in the image

Returns

true if the pixel is transparent otherwise false

Parameters

image_width

Image width (in pixels)

Warning

This method doesn't work for 8 bits image

jo_sprite_name2id()

int jo_sprite_name2id

(

const char *const

filename

)

Retrive the Sprite Id from filename based on the four first character in the filename.

Parameters

filename

Filename (upper case and shorter as possible like "A.TEX")

Warning

Slow, use carefully

Returns

Sprite Id of the first image or -1 if not found

jo_sprite_replace()

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

Replace a sprite.

Parameters

img	Pointer to a image struct
sprite_id	Sprite ID to replace

Returns

sprite_id

jo_sprite_restore_sprite_scale()

__jo_force_inline void jo_sprite_restore_sprite_scale ( void )

static

Restore default scale for every sprite displayed after this call.

jo_sprite_set_additive_palette()

__jo_force_inline void jo_sprite_set_additive_palette ( int palette_id )

static

Change palette for every 8 bits sprite displayed after this call: their light is added to the image under them (see jo_enable_additive_sprites()).

Parameters

palette_id

Palette id from jo_create_palette()

jo_sprite_set_clipping_area()

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.

Parameters

x	Horizontal coord from top left corner
y	Vertical coord from top left corner
width	Width of the clipping rectangle
height	Height of the clipping rectangle
depth	Specifies depth up to which sprites get clipped

jo_sprite_set_gouraud_table()

__jo_force_inline void jo_sprite_set_gouraud_table ( const unsigned short table )

static

Gouraud table of the sprites displayed after this call with jo_sprite_enable_gouraud_shading() (instead of the last table of jo_set_gouraud_shading_colors(): the tables given by jo_3d_add_gouraud_tables() are kept from a frame to the next).

Parameters

table

Address / 8 of the table (see jo_3d_add_gouraud_tables()), 0: the last table of jo_set_gouraud_shading_colors()

jo_sprite_set_palette()

__jo_force_inline void jo_sprite_set_palette ( int palette_id )

static

Change palette for every 8 bits sprite displayed after this call.

Parameters

palette_id

Palette id from jo_create_palette()

jo_sprite_set_system_clipping_area()

void jo_sprite_set_system_clipping_area	(	const unsigned int	width,
		const unsigned int	height )

Set the VDP1 drawing area (system clipping).

Parameters

width	Width of the drawing area (JO_TV_WIDTH by default)
height	Height of the drawing area (JO_TV_HEIGHT by default)

Remarks

Useful to draw outside of the visible area of the frame buffer (512 pixels width)

jo_sprite_usage_percent()

int jo_sprite_usage_percent

(

void

)

Get sprite memory usage.

Returns

Sprite memory usage percent

Remarks

jo_printf(0, 0, "Sprite memory usage: %d%% ", jo_sprite_usage_percent());

Variable Documentation

__jo_sprite_attributes

jo_sprite_attributes __jo_sprite_attributes

extern

Current displayed sprite attribute (internal engine usage).

Warning

MC Hammer: don't touch this

__jo_sprite_def

jo_texture_definition __jo_sprite_def[JO_MAX_SPRITE]

extern

(internal engine usage)

Warning

MC Hammer: don't touch this

__jo_sprite_lut

unsigned short __jo_sprite_lut[JO_MAX_SPRITE]

extern

(internal engine usage) Color lookup table of a 16 colors texture (VRAM address / 8), 0: none

__jo_sprite_pic

jo_picture_definition __jo_sprite_pic[JO_MAX_SPRITE]

extern

(internal engine usage)

Warning

MC Hammer: don't touch this