ra8_rabook_comic_t Struct Reference

Mutable state for one image-sequence-to-RABOOK build. More...

#include <ra8_rabook_comic.h>

Collaboration diagram for ra8_rabook_comic_t:

Data Fields
ra8_rabook_ctx_t	builder
	Canonical table builder.
ra8_rabook_raster_workspace_t	raster
	Retained raster workspace.
ra8_rabook_image_read_fn	image_read
	Repeatable image-spool reader.
ra8_rabook_comic_write_at_fn	image_write
	Image-spool random writer.
void *	image_ctx
	Shared image-spool context.
uint8_t *	normalized
	One normalized page payload.
uint8_t *	stream_scratch
	Finalizer transfer scratch.
size_t	normalized_cap
	Normalized output capacity.
uint32_t	stream_scratch_cap
	Finalizer scratch capacity.
uint32_t	page_count
	Successfully appended pages.
uint16_t	max_image_edge
	Optional output edge clamp.
uint8_t	pixel_format
	Gray4 or gray8 output depth.
bool	active
	Build accepts more operations.

Detailed Description

Mutable state for one image-sequence-to-RABOOK build.

Initialize with ra8_rabook_comic_init and treat every field as private until ra8_rabook_comic_finish returns.

Invariant

page_count == builder.chapter_count == builder.image_count.

active is false after the first terminal failure or finish.

Since

0.1.0

Definition at line 102 of file ra8_rabook_comic.h.

Field Documentation

active

bool ra8_rabook_comic_t::active

Build accepts more operations.

Definition at line 115 of file ra8_rabook_comic.h.

Referenced by ra8_rabook_comic_add_page(), ra8_rabook_comic_finish(), and ra8_rabook_comic_init().

builder

ra8_rabook_ctx_t ra8_rabook_comic_t::builder

Canonical table builder.

Definition at line 103 of file ra8_rabook_comic.h.

Referenced by internal_append_chapter(), internal_set_metadata(), internal_store_image(), ra8_rabook_comic_add_page(), ra8_rabook_comic_finish(), and ra8_rabook_comic_init().

image_ctx

void* ra8_rabook_comic_t::image_ctx

Shared image-spool context.

Definition at line 107 of file ra8_rabook_comic.h.

Referenced by internal_store_image(), ra8_rabook_comic_finish(), and ra8_rabook_comic_init().

image_read

ra8_rabook_image_read_fn ra8_rabook_comic_t::image_read

Repeatable image-spool reader.

Definition at line 105 of file ra8_rabook_comic.h.

Referenced by ra8_rabook_comic_finish(), and ra8_rabook_comic_init().

image_write

ra8_rabook_comic_write_at_fn ra8_rabook_comic_t::image_write

Image-spool random writer.

Definition at line 106 of file ra8_rabook_comic.h.

Referenced by internal_store_image(), and ra8_rabook_comic_init().

max_image_edge

uint16_t ra8_rabook_comic_t::max_image_edge

Optional output edge clamp.

Definition at line 113 of file ra8_rabook_comic.h.

Referenced by ra8_rabook_comic_add_page(), and ra8_rabook_comic_init().

normalized

uint8_t* ra8_rabook_comic_t::normalized

One normalized page payload.

Definition at line 108 of file ra8_rabook_comic.h.

Referenced by internal_store_image(), ra8_rabook_comic_add_page(), and ra8_rabook_comic_init().

normalized_cap

size_t ra8_rabook_comic_t::normalized_cap

Normalized output capacity.

Definition at line 110 of file ra8_rabook_comic.h.

Referenced by ra8_rabook_comic_add_page(), and ra8_rabook_comic_init().

page_count

uint32_t ra8_rabook_comic_t::page_count

Successfully appended pages.

Definition at line 112 of file ra8_rabook_comic.h.

Referenced by ra8_rabook_comic_add_page(), and ra8_rabook_comic_finish().

pixel_format

uint8_t ra8_rabook_comic_t::pixel_format

Gray4 or gray8 output depth.

Definition at line 114 of file ra8_rabook_comic.h.

Referenced by ra8_rabook_comic_add_page(), and ra8_rabook_comic_init().

raster

ra8_rabook_raster_workspace_t ra8_rabook_comic_t::raster

Retained raster workspace.

Definition at line 104 of file ra8_rabook_comic.h.

Referenced by ra8_rabook_comic_add_page(), and ra8_rabook_comic_init().

stream_scratch

uint8_t* ra8_rabook_comic_t::stream_scratch

Finalizer transfer scratch.

Definition at line 109 of file ra8_rabook_comic.h.

Referenced by ra8_rabook_comic_finish(), and ra8_rabook_comic_init().

stream_scratch_cap

uint32_t ra8_rabook_comic_t::stream_scratch_cap

Finalizer scratch capacity.

Definition at line 111 of file ra8_rabook_comic.h.

Referenced by ra8_rabook_comic_finish(), and ra8_rabook_comic_init().

---

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

• apps/shared_libs/rabook_compile/inc/ra8_rabook_comic.h