sh_entry_t Struct Reference

One shelf book, sourced from MRAM (baked) or the SD card, in either the .rabook or .epub format. More...

#include <sh_app.h>

Data Fields
bool	from_sd
	true: read ::sd_name from SD; false: use ::blob.
sh_book_fmt_t	fmt
	Container format (rabook / epub).
const uint8_t *	blob
	Baked RBKC bytes (MRAM), or NULL when SD.
uint32_t	blob_len
	Baked length, or SD file size in bytes.
const uint8_t *	thumb
	Pre-baked gray8 cover thumbnail, or NULL.
uint16_t	thumb_w
	Pre-baked thumbnail width.
uint16_t	thumb_h
	Pre-baked thumbnail height.
char	sd_name [k_sh_name_cap]
	SD file name, e.g.
char	title [k_sh_title_cap]
	Display title.
char	author [k_sh_author_cap]
	Display author.

Detailed Description

One shelf book, sourced from MRAM (baked) or the SD card, in either the .rabook or .epub format.

The reader/TOC/cover screens are backend-agnostic: sh_book.c opens the right parser by ::fmt and exposes a uniform chapter/cover API.

Since

0.1.0

Definition at line 141 of file sh_app.h.

Field Documentation

author

char sh_entry_t::author[k_sh_author_cap]

Display author.

Definition at line 151 of file sh_app.h.

Referenced by sh_book_capture_meta(), sh_cover_render(), sh_sd_listdir_cb(), and sh_seed_baked().

blob

const uint8_t* sh_entry_t::blob

Baked RBKC bytes (MRAM), or NULL when SD.

Definition at line 144 of file sh_app.h.

Referenced by sh_book_open_rabook(), sh_comic_open(), and sh_seed_baked().

blob_len

uint32_t sh_entry_t::blob_len

Baked length, or SD file size in bytes.

Definition at line 145 of file sh_app.h.

Referenced by sh_book_open_rabook(), sh_comic_open(), sh_sd_listdir_cb(), and sh_seed_baked().

fmt

sh_book_fmt_t sh_entry_t::fmt

Container format (rabook / epub).

Definition at line 143 of file sh_app.h.

Referenced by sh_book_open(), sh_comic_open(), and sh_sd_listdir_cb().

from_sd

bool sh_entry_t::from_sd

true: read ::sd_name from SD; false: use ::blob.

Definition at line 142 of file sh_app.h.

Referenced by sh_book_open(), sh_book_open_rabook(), sh_comic_open(), sh_cover_render(), sh_sd_listdir_cb(), sh_seed_baked(), and sh_shelf_build_thumbs().

sd_name

char sh_entry_t::sd_name[k_sh_name_cap]

SD file name, e.g.

"Meditations.rabook".

Definition at line 149 of file sh_app.h.

Referenced by sh_book_open(), sh_book_open_rabook(), sh_comic_open(), and sh_sd_listdir_cb().

thumb

const uint8_t* sh_entry_t::thumb

Pre-baked gray8 cover thumbnail, or NULL.

Definition at line 146 of file sh_app.h.

Referenced by sh_seed_baked(), and sh_shelf_build_thumbs().

thumb_h

uint16_t sh_entry_t::thumb_h

Pre-baked thumbnail height.

Definition at line 148 of file sh_app.h.

Referenced by sh_seed_baked(), and sh_shelf_build_thumbs().

thumb_w

uint16_t sh_entry_t::thumb_w

Pre-baked thumbnail width.

Definition at line 147 of file sh_app.h.

Referenced by sh_seed_baked(), and sh_shelf_build_thumbs().

title

char sh_entry_t::title[k_sh_title_cap]

Display title.

Definition at line 150 of file sh_app.h.

Referenced by sh_book_capture_meta(), sh_cover_render(), sh_sd_listdir_cb(), and sh_seed_baked().

---

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

• examples/ek_ra8d2/hil_needs_revalidation/ereader_shelf/inc/sh_app.h