MuPDF X.Y.Z

fitz/util.h

Index

enum

function

Util

function fz_new_display_list_from_page

fz_display_list *
fz_new_display_list_from_page (
        fz_context *ctx,
        fz_page *page
)

Create a display list.

Ownership of the display list is returned to the caller.

function fz_new_display_list_from_page_number

fz_display_list *
fz_new_display_list_from_page_number (
        fz_context *ctx,
        fz_document *doc,
        int number
)

function fz_new_display_list_from_page_contents

fz_display_list *
fz_new_display_list_from_page_contents (
        fz_context *ctx,
        fz_page *page
)

Create a display list from page contents (no annotations).

Ownership of the display list is returned to the caller.

function fz_new_pixmap_from_display_list

fz_pixmap *
fz_new_pixmap_from_display_list (
        fz_context *ctx,
        fz_display_list *list,
        fz_matrix ctm,
        fz_colorspace *cs,
        int alpha
)

Render the page to a pixmap using the transform and colorspace.

Ownership of the pixmap is returned to the caller.

function fz_new_pixmap_from_page

fz_pixmap *
fz_new_pixmap_from_page (
        fz_context *ctx,
        fz_page *page,
        fz_matrix ctm,
        fz_colorspace *cs,
        int alpha
)

function fz_new_pixmap_from_page_number

fz_pixmap *
fz_new_pixmap_from_page_number (
        fz_context *ctx,
        fz_document *doc,
        int number,
        fz_matrix ctm,
        fz_colorspace *cs,
        int alpha
)

function fz_new_pixmap_from_page_contents

fz_pixmap *
fz_new_pixmap_from_page_contents (
        fz_context *ctx,
        fz_page *page,
        fz_matrix ctm,
        fz_colorspace *cs,
        int alpha
)

Render the page contents without annotations.

Ownership of the pixmap is returned to the caller.

function fz_new_pixmap_from_display_list_with_separations

fz_pixmap *
fz_new_pixmap_from_display_list_with_separations (
        fz_context *ctx,
        fz_display_list *list,
        fz_matrix ctm,
        fz_colorspace *cs,
        fz_separations *seps,
        int alpha
)

Render the page contents with control over spot colors.

Ownership of the pixmap is returned to the caller.

function fz_new_pixmap_from_page_with_separations

fz_pixmap *
fz_new_pixmap_from_page_with_separations (
        fz_context *ctx,
        fz_page *page,
        fz_matrix ctm,
        fz_colorspace *cs,
        fz_separations *seps,
        int alpha
)

function fz_new_pixmap_from_page_number_with_separations

fz_pixmap *
fz_new_pixmap_from_page_number_with_separations (
        fz_context *ctx,
        fz_document *doc,
        int number,
        fz_matrix ctm,
        fz_colorspace *cs,
        fz_separations *seps,
        int alpha
)

function fz_new_pixmap_from_page_contents_with_separations

fz_pixmap *
fz_new_pixmap_from_page_contents_with_separations (
        fz_context *ctx,
        fz_page *page,
        fz_matrix ctm,
        fz_colorspace *cs,
        fz_separations *seps,
        int alpha
)

function fz_fill_pixmap_from_display_list

fz_pixmap *
fz_fill_pixmap_from_display_list (
        fz_context *ctx,
        fz_display_list *list,
        fz_matrix ctm,
        fz_pixmap *pix
)

function fz_new_stext_page_from_page_with_cookie

fz_stext_page *
fz_new_stext_page_from_page_with_cookie (
        fz_context *ctx,
        fz_page *page,
        const fz_stext_options *options,
        fz_cookie *cookie
)

Extract text from page.

Ownership of the fz_stext_page is returned to the caller.

function fz_new_stext_page_from_page

fz_stext_page *
fz_new_stext_page_from_page (
        fz_context *ctx,
        fz_page *page,
        const fz_stext_options *options
)

function fz_new_stext_page_from_page_number

fz_stext_page *
fz_new_stext_page_from_page_number (
        fz_context *ctx,
        fz_document *doc,
        int number,
        const fz_stext_options *options
)

function fz_new_stext_page_from_chapter_page_number

fz_stext_page *
fz_new_stext_page_from_chapter_page_number (
        fz_context *ctx,
        fz_document *doc,
        int chapter,
        int number,
        const fz_stext_options *options
)

function fz_new_stext_page_from_display_list

fz_stext_page *
fz_new_stext_page_from_display_list (
        fz_context *ctx,
        fz_display_list *list,
        const fz_stext_options *options
)

enum fz_text_flatten

enum fz_text_flatten
{
        /* ALL: Flatten the text completely. All gaps between words/
         * paragraphs/lines are expressed as a single space. */
        FZ_TEXT_FLATTEN_ALL = 0,

        /* KEEP_LINES: Keep line splits as \n. */
        FZ_TEXT_FLATTEN_KEEP_LINES = 1,

        /* KEEP_PARAGRAPHS: Keep paragraph splits. If used without
         * KEEP_LINES, paragraphs will appear as \n. If used with
         * KEEP_LINES, paragraphs will appear as \n\n. */
        FZ_TEXT_FLATTEN_KEEP_PARAGRAPHS = 2,

        /* KEEP_HYPHENS: Do not join hyphenated lines. */
        FZ_TEXT_FLATTEN_KEEP_HYPHENS = 4
}

Convert structured text into plain text.

function fz_new_buffer_from_flattened_stext_page

fz_buffer *
fz_new_buffer_from_flattened_stext_page (
        fz_context *ctx,
        fz_stext_page *text,
        fz_text_flatten flatten,
        fz_stext_position **map
)

Create a new buffer by flattening the text from an stext page.

function fz_new_buffer_from_stext_page

fz_buffer *
fz_new_buffer_from_stext_page (
        fz_context *ctx,
        fz_stext_page *text
)

Does the same as fz_new_buffer_from_flattened_stext_page(), with the options FZ_TEXT_FLATTEN_KEEP_PARAGRAPHS.

function fz_new_buffer_from_page

fz_buffer *
fz_new_buffer_from_page (
        fz_context *ctx,
        fz_page *page,
        const fz_stext_options *options
)

Convenience functions built on fz_new_buffer_from_stext_page.

function fz_new_buffer_from_page_number

fz_buffer *
fz_new_buffer_from_page_number (
        fz_context *ctx,
        fz_document *doc,
        int number,
        const fz_stext_options *options
)

function fz_new_buffer_from_display_list

fz_buffer *
fz_new_buffer_from_display_list (
        fz_context *ctx,
        fz_display_list *list,
        const fz_stext_options *options
)

function fz_new_buffer_from_flattened_page

fz_buffer *
fz_new_buffer_from_flattened_page (
        fz_context *ctx,
        fz_page *page,
        const fz_stext_options *options,
        fz_text_flatten flatten
)

Convenience functions built on fz_new_buffer_from_flattened_stext_page.

function fz_new_buffer_from_flattened_page_number

fz_buffer *
fz_new_buffer_from_flattened_page_number (
        fz_context *ctx,
        fz_document *doc,
        int number,
        const fz_stext_options *options,
        fz_text_flatten flatten
)

function fz_new_buffer_from_flattened_display_list

fz_buffer *
fz_new_buffer_from_flattened_display_list (
        fz_context *ctx,
        fz_display_list *list,
        const fz_stext_options *options,
        fz_text_flatten flatten
)

function fz_search_page

int
fz_search_page (
        fz_context *ctx,
        fz_page *page,
        const char *needle,
        int *hit_mark,
        fz_quad *hit_bbox,
        int hit_max
)

Search for the ‘needle’ text on the page. Record the hits in the hit_bbox array and return the number of hits. Will stop looking once it has filled hit_max rectangles.

function fz_search_page_number

int
fz_search_page_number (
        fz_context *ctx,
        fz_document *doc,
        int number,
        const char *needle,
        int *hit_mark,
        fz_quad *hit_bbox,
        int hit_max
)

function fz_search_chapter_page_number

int
fz_search_chapter_page_number (
        fz_context *ctx,
        fz_document *doc,
        int chapter,
        int page,
        const char *needle,
        int *hit_mark,
        fz_quad *hit_bbox,
        int hit_max
)

function fz_search_display_list

int
fz_search_display_list (
        fz_context *ctx,
        fz_display_list *list,
        const char *needle,
        int *hit_mark,
        fz_quad *hit_bbox,
        int hit_max
)

function fz_match_page

int
fz_match_page (
        fz_context *ctx,
        fz_page *page,
        const char *needle,
        int *hit_mark,
        fz_quad *hit_bbox,
        int hit_max,
        fz_search_options options
)

function fz_match_page_number

int
fz_match_page_number (
        fz_context *ctx,
        fz_document *doc,
        int number,
        const char *needle,
        int *hit_mark,
        fz_quad *hit_bbox,
        int hit_max,
        fz_search_options options
)

function fz_match_chapter_page_number

int
fz_match_chapter_page_number (
        fz_context *ctx,
        fz_document *doc,
        int chapter,
        int page,
        const char *needle,
        int *hit_mark,
        fz_quad *hit_bbox,
        int hit_max,
        fz_search_options options
)

function fz_match_display_list

int
fz_match_display_list (
        fz_context *ctx,
        fz_display_list *list,
        const char *needle,
        int *hit_mark,
        fz_quad *hit_bbox,
        int hit_max,
        fz_search_options options
)

function fz_search_page_cb

int
fz_search_page_cb (
        fz_context *ctx,
        fz_page *page,
        const char *needle,
        fz_search_callback_fn *cb,
        void *opaque
)

Search for the ‘needle’ text on the page.

function fz_search_page_number_cb

int
fz_search_page_number_cb (
        fz_context *ctx,
        fz_document *doc,
        int number,
        const char *needle,
        fz_search_callback_fn *cb,
        void *opaque
)

function fz_search_chapter_page_number_cb

int
fz_search_chapter_page_number_cb (
        fz_context *ctx,
        fz_document *doc,
        int chapter,
        int page,
        const char *needle,
        fz_search_callback_fn *cb,
        void *opaque
)

function fz_search_display_list_cb

int
fz_search_display_list_cb (
        fz_context *ctx,
        fz_display_list *list,
        const char *needle,
        fz_search_callback_fn *cb,
        void *opaque
)

function fz_match_page_cb

int
fz_match_page_cb (
        fz_context *ctx,
        fz_page *page,
        const char *needle,
        fz_match_callback_fn *cb,
        void *opaque,
        fz_search_options options
)

function fz_match_page_number_cb

int
fz_match_page_number_cb (
        fz_context *ctx,
        fz_document *doc,
        int number,
        const char *needle,
        fz_match_callback_fn *cb,
        void *opaque,
        fz_search_options options
)

function fz_match_chapter_page_number_cb

int
fz_match_chapter_page_number_cb (
        fz_context *ctx,
        fz_document *doc,
        int chapter,
        int page,
        const char *needle,
        fz_match_callback_fn *cb,
        void *opaque,
        fz_search_options options
)

function fz_match_display_list_cb

int
fz_match_display_list_cb (
        fz_context *ctx,
        fz_display_list *list,
        const char *needle,
        fz_match_callback_fn *cb,
        void *opaque,
        fz_search_options options
)

function fz_new_display_list_from_svg

fz_display_list *
fz_new_display_list_from_svg (
        fz_context *ctx,
        fz_buffer *buf,
        const char *base_uri,
        fz_archive *dir,
        float *w,
        float *h
)

Parse an SVG document into a display-list.

function fz_new_image_from_svg

fz_image *
fz_new_image_from_svg (
        fz_context *ctx,
        fz_buffer *buf,
        const char *base_uri,
        fz_archive *dir
)

Create a scalable image from an SVG document.

function fz_new_display_list_from_svg_xml

fz_display_list *
fz_new_display_list_from_svg_xml (
        fz_context *ctx,
        fz_xml_doc *xmldoc,
        fz_xml *xml,
        const char *base_uri,
        fz_archive *dir,
        float *w,
        float *h
)

Parse an SVG document into a display-list.

function fz_new_image_from_svg_xml

fz_image *
fz_new_image_from_svg_xml (
        fz_context *ctx,
        fz_xml_doc *xmldoc,
        fz_xml *xml,
        const char *base_uri,
        fz_archive *dir
)

Create a scalable image from an SVG document.

function fz_write_image_as_data_uri

void
fz_write_image_as_data_uri (
        fz_context *ctx,
        fz_output *out,
        fz_image *image
)

Write image as a data URI (for HTML and SVG output).

function fz_write_pixmap_as_data_uri

void
fz_write_pixmap_as_data_uri (
        fz_context *ctx,
        fz_output *out,
        fz_pixmap *pixmap
)

function fz_append_image_as_data_uri

void
fz_append_image_as_data_uri (
        fz_context *ctx,
        fz_buffer *out,
        fz_image *image
)

function fz_append_pixmap_as_data_uri

void
fz_append_pixmap_as_data_uri (
        fz_context *ctx,
        fz_buffer *out,
        fz_pixmap *pixmap
)

function fz_new_xhtml_document_from_document

fz_document *
fz_new_xhtml_document_from_document (
        fz_context *ctx,
        fz_document *old_doc,
        const fz_stext_options *opts
)

Use text extraction to convert the input document into XHTML, then open the result as a new document that can be reflowed.

function fz_new_buffer_from_page_with_format

fz_buffer *
fz_new_buffer_from_page_with_format (
        fz_context *ctx,
        fz_page *page,
        const char *format,
        const char *options,
        fz_matrix transform,
        fz_cookie *cookie
)

Returns an fz_buffer containing a page after conversion to specified format.

page:
The page to convert. format, options:
Passed to fz_new_document_writer_with_output() internally. transform, cookie:
Passed to fz_run_page() internally.

function fz_new_pixmap_from_page_number_culling_text

fz_pixmap *
fz_new_pixmap_from_page_number_culling_text (
        fz_context *ctx,
        fz_document *doc,
        int number,
        fz_matrix ctm,
        fz_colorspace *cs,
        int alpha,
        int n,
        const fz_rect *rects
)

Returns a page rendered with text from the given rectangles culled.

function fz_new_pixmap_from_page_culling_text

fz_pixmap *
fz_new_pixmap_from_page_culling_text (
        fz_context *ctx,
        fz_page *page,
        fz_matrix ctm,
        fz_colorspace *cs,
        int alpha,
        int n,
        const fz_rect *rects
)

function fz_new_pixmap_from_display_list_culling_text

fz_pixmap *
fz_new_pixmap_from_display_list_culling_text (
        fz_context *ctx,
        fz_display_list *list,
        fz_matrix ctm,
        fz_colorspace *cs,
        int alpha,
        int n,
        const fz_rect *rects
)

function fz_new_pixmap_from_culled_page_number

fz_pixmap *
fz_new_pixmap_from_culled_page_number (
        fz_context *ctx,
        fz_document *doc,
        int number,
        fz_matrix ctm,
        fz_colorspace *cs,
        int alpha,
        const fz_culling_options *opts
)

function fz_new_pixmap_from_culled_page

fz_pixmap *
fz_new_pixmap_from_culled_page (
        fz_context *ctx,
        fz_page *page,
        fz_matrix ctm,
        fz_colorspace *cs,
        int alpha,
        const fz_culling_options *opts
)

function fz_new_pixmap_from_culled_display_list

fz_pixmap *
fz_new_pixmap_from_culled_display_list (
        fz_context *ctx,
        fz_display_list *list,
        fz_matrix ctm,
        fz_colorspace *cs,
        int alpha,
        const fz_culling_options *opts
)

function fz_new_pixmap_from_page_number_culling_text_etc

fz_pixmap *
fz_new_pixmap_from_page_number_culling_text_etc (
        fz_context *ctx,
        fz_document *doc,
        int number,
        fz_matrix ctm,
        fz_colorspace *cs,
        int alpha,
        int n,
        const fz_rect *rects,
        float borders
)

function fz_new_pixmap_from_page_culling_text_etc

fz_pixmap *
fz_new_pixmap_from_page_culling_text_etc (
        fz_context *ctx,
        fz_page *page,
        fz_matrix ctm,
        fz_colorspace *cs,
        int alpha,
        int n,
        const fz_rect *rects,
        float borders
)

function fz_new_pixmap_from_display_list_culling_text_etc

fz_pixmap *
fz_new_pixmap_from_display_list_culling_text_etc (
        fz_context *ctx,
        fz_display_list *list,
        fz_matrix ctm,
        fz_colorspace *cs,
        int alpha,
        int n,
        const fz_rect *rects,
        float borders
)