jof_info_t Struct Reference

Parsed + validated geometry of one JOF atlas. More...

#include <jof.h>

Data Fields
uint16_t	width
	Image width, pixels.
uint16_t	height
	Image height, pixels.
uint16_t	tile_w
	Tile width, pixels.
uint16_t	tile_h
	Tile height, pixels.
uint16_t	tile_cols
	Ceil(width / tile_w) tile columns.
uint16_t	tile_rows
	Ceil(height / tile_h) tile rows.
uint8_t	bpp
	Bytes per pixel (1, 3 or 4).
uint8_t	codec
	jof_codec_t member.
uint32_t	tile_count
	Total tiles (== cols * rows).
uint32_t	index_off
	Absolute byte offset of the tile index.
uint32_t	total_size
	Whole atlas byte length (footer included).

Detailed Description

Parsed + validated geometry of one JOF atlas.

Filled by jof_parse(); callers treat it as read-only after that. tile_cols/tile_rows are the ceil-division grid dimensions; index_off/total_size locate the tile index.

Invariant

tile_count == (uint32_t)tile_cols * tile_rows and index_off + tile_count * 8 + 16 == total_size once parsed.

See also

jof_parse()

Since

0.1.0

Definition at line 208 of file jof.h.

Field Documentation

bpp

uint8_t jof_info_t::bpp

Bytes per pixel (1, 3 or 4).

Definition at line 215 of file jof.h.

Referenced by cm_ct_hash_tiles(), internal_audit_tile(), internal_draw_band(), internal_finish(), internal_geometry(), internal_geometry(), internal_info(), internal_parse_hdr_fields(), internal_report(), internal_require_jof(), jof_audit_requirements(), jof_read_tile(), mg_reader_check_geometry(), and priv_viewer_open_jof().

codec

uint8_t jof_info_t::codec

jof_codec_t member.

Definition at line 216 of file jof.h.

Referenced by internal_decode_stream(), internal_finish(), internal_geometry(), internal_info(), internal_parse_hdr_fields(), internal_require_jof(), jof_audit_requirements(), and priv_viewer_open_jof().

height

uint16_t jof_info_t::height

Image height, pixels.

Definition at line 210 of file jof.h.

Referenced by cm_comic_tiled_selfcheck(), internal_bind(), internal_check_cross(), internal_dimensions(), internal_finish(), internal_geometry(), internal_info(), internal_open_selected(), internal_parse_hdr_fields(), internal_report(), internal_require_jof(), internal_seek(), jof_tile_dims(), mg_reader_bind(), mg_reader_check_geometry(), and priv_viewer_size_jof_tiles().

index_off

uint32_t jof_info_t::index_off

Absolute byte offset of the tile index.

Definition at line 218 of file jof.h.

Referenced by internal_audit_tile(), internal_check_cross(), internal_finish(), internal_geometry(), internal_index_entry(), and jof_audit().

tile_cols

uint16_t jof_info_t::tile_cols

Ceil(width / tile_w) tile columns.

Definition at line 213 of file jof.h.

Referenced by cm_ct_hash_tiles(), internal_audit_tile(), internal_check_cross(), internal_dimensions(), internal_finish(), internal_info(), jof_read_tile(), jof_tile_dims(), and mg_reader_bind().

tile_count

uint32_t jof_info_t::tile_count

Total tiles (== cols * rows).

Definition at line 217 of file jof.h.

Referenced by cm_comic_tiled_selfcheck(), internal_check_cross(), internal_finish(), internal_geometry(), internal_geometry(), internal_info(), internal_report(), internal_verify_jof(), jof_audit(), jof_audit_requirements(), and ra8_fmt_jof_inspect_stream().

tile_h

uint16_t jof_info_t::tile_h

Tile height, pixels.

Definition at line 212 of file jof.h.

Referenced by internal_bind(), internal_check_cross(), internal_dimensions(), internal_finish(), internal_geometry(), internal_info(), internal_parse_hdr_fields(), internal_report(), internal_require_jof(), jof_audit_requirements(), jof_tile_dims(), mg_reader_bind(), mg_reader_check_geometry(), and priv_viewer_open_jof().

tile_rows

uint16_t jof_info_t::tile_rows

Ceil(height / tile_h) tile rows.

Definition at line 214 of file jof.h.

Referenced by cm_ct_hash_tiles(), internal_bind(), internal_check_cross(), internal_compare(), internal_dimensions(), internal_finish(), internal_info(), internal_preflight(), jof_tile_dims(), and mg_reader_bind().

tile_w

uint16_t jof_info_t::tile_w

Tile width, pixels.

Definition at line 211 of file jof.h.

Referenced by internal_check_cross(), internal_dimensions(), internal_finish(), internal_geometry(), internal_info(), internal_parse_hdr_fields(), internal_require_jof(), jof_audit_requirements(), jof_tile_dims(), longstrip_open(), mg_reader_bind(), mg_reader_check_geometry(), and priv_viewer_open_jof().

total_size

uint32_t jof_info_t::total_size

Whole atlas byte length (footer included).

Definition at line 219 of file jof.h.

Referenced by internal_accept(), internal_check_cross(), internal_finish(), internal_geometry(), internal_produce(), and internal_report().

width

uint16_t jof_info_t::width

Image width, pixels.

Definition at line 209 of file jof.h.

Referenced by cm_comic_tiled_selfcheck(), internal_bind(), internal_check_cross(), internal_dimensions(), internal_finish(), internal_geometry(), internal_geometry(), internal_info(), internal_parse_hdr_fields(), internal_preflight(), internal_report(), internal_seek(), internal_wire(), jof_tile_dims(), longstrip_open(), mg_reader_bind(), mg_reader_check_geometry(), priv_viewer_render_jof(), and priv_viewer_size_jof_tiles().

---

The documentation for this struct was generated from the following file:

• apps/shared_libs/jof/inc/jof.h