ra8_viewer_reader_requirements_t Struct Reference

Exact immutable layout returned for one document. More...

#include <ra8_viewer_reader.h>

Data Fields
size_t	required_bytes
	Complete workspace extent.
size_t	required_alignment
	Required base-address alignment.
size_t	framebuffer_bytes
	Resident fixed RGB565 framebuffer.
size_t	dimensions_bytes
	Two resident per-tile dimension arrays.
size_t	cell_bytes
	One resident decoded JOF band.
size_t	scratch_bytes
	One bounded compressed-band staging area.
size_t	comic_pages_bytes
	Comic page-index storage, or zero.
size_t	comic_names_bytes
	Comic member-name arena, or zero.
size_t	comic_page_bytes
	Resident encoded-page storage, or zero.
size_t	comic_arena_bytes
	stb decode arena storage, or zero.
uint32_t	tile_count
	Number of viewport tiles in the strip.
uint32_t	engine
	ra8_viewer_reader_engine_t selection.
uint32_t	layout_version
	ABI guard consumed by bind.

Detailed Description

Exact immutable layout returned for one document.

Callers may inspect the public totals but must pass the complete object unchanged to ra8_viewer_reader_bind.

Definition at line 51 of file ra8_viewer_reader.h.

Field Documentation

cell_bytes

size_t ra8_viewer_reader_requirements_t::cell_bytes

One resident decoded JOF band.

Definition at line 56 of file ra8_viewer_reader.h.

Referenced by internal_engine_requirements_valid(), internal_require_jof(), and internal_take_jof().

comic_arena_bytes

size_t ra8_viewer_reader_requirements_t::comic_arena_bytes

stb decode arena storage, or zero.

Definition at line 61 of file ra8_viewer_reader.h.

Referenced by internal_engine_requirements_valid(), internal_require_comic(), and internal_take_comic().

comic_names_bytes

size_t ra8_viewer_reader_requirements_t::comic_names_bytes

Comic member-name arena, or zero.

Definition at line 59 of file ra8_viewer_reader.h.

Referenced by internal_engine_requirements_valid(), internal_require_comic(), and internal_take_comic().

comic_page_bytes

size_t ra8_viewer_reader_requirements_t::comic_page_bytes

Resident encoded-page storage, or zero.

Definition at line 60 of file ra8_viewer_reader.h.

Referenced by internal_engine_requirements_valid(), internal_require_comic(), and internal_take_comic().

comic_pages_bytes

size_t ra8_viewer_reader_requirements_t::comic_pages_bytes

Comic page-index storage, or zero.

Definition at line 58 of file ra8_viewer_reader.h.

Referenced by internal_engine_requirements_valid(), internal_require_comic(), and internal_take_comic().

dimensions_bytes

size_t ra8_viewer_reader_requirements_t::dimensions_bytes

Two resident per-tile dimension arrays.

Definition at line 55 of file ra8_viewer_reader.h.

Referenced by internal_layout(), internal_require_comic(), internal_require_jof(), internal_requirements_valid(), and ra8_viewer_reader_bind().

engine

uint32_t ra8_viewer_reader_requirements_t::engine

ra8_viewer_reader_engine_t selection.

Definition at line 63 of file ra8_viewer_reader.h.

Referenced by internal_engine_requirements_valid(), internal_layout(), internal_require_comic(), internal_require_jof(), and ra8_viewer_reader_bind().

framebuffer_bytes

size_t ra8_viewer_reader_requirements_t::framebuffer_bytes

Resident fixed RGB565 framebuffer.

Definition at line 54 of file ra8_viewer_reader.h.

Referenced by internal_layout(), internal_requirements_valid(), ra8_viewer_reader_bind(), and ra8_viewer_reader_requirements().

layout_version

uint32_t ra8_viewer_reader_requirements_t::layout_version

ABI guard consumed by bind.

Definition at line 64 of file ra8_viewer_reader.h.

Referenced by internal_requirements_valid(), and ra8_viewer_reader_requirements().

required_alignment

size_t ra8_viewer_reader_requirements_t::required_alignment

Required base-address alignment.

Definition at line 53 of file ra8_viewer_reader.h.

Referenced by internal_requirements_valid(), ra8_viewer_reader_bind(), and ra8_viewer_reader_requirements().

required_bytes

size_t ra8_viewer_reader_requirements_t::required_bytes

Complete workspace extent.

Definition at line 52 of file ra8_viewer_reader.h.

Referenced by internal_execute(), internal_requirements_valid(), ra8_viewer_reader_bind(), and ra8_viewer_reader_requirements().

scratch_bytes

size_t ra8_viewer_reader_requirements_t::scratch_bytes

One bounded compressed-band staging area.

Definition at line 57 of file ra8_viewer_reader.h.

Referenced by internal_engine_requirements_valid(), internal_require_jof(), and internal_take_jof().

tile_count

uint32_t ra8_viewer_reader_requirements_t::tile_count

Number of viewport tiles in the strip.

Definition at line 62 of file ra8_viewer_reader.h.

Referenced by internal_engine_requirements_valid(), internal_require_comic(), internal_require_jof(), internal_requirements_valid(), and ra8_viewer_reader_bind().

---

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

• tools/rabook_viewer/inc/ra8_viewer_reader.h