| | |
- FzBitmap_fz_bitmap_details_outparams_fn(self)
- Helper for out-params of class method fz_bitmap::ll_fz_bitmap_details() [fz_bitmap_details()].
- FzBuffer_fz_buffer_extract_outparams_fn(self)
- Helper for out-params of class method fz_buffer::ll_fz_buffer_extract() [fz_buffer_extract()].
- FzBuffer_fz_buffer_storage_outparams_fn(self)
- Helper for out-params of class method fz_buffer::ll_fz_buffer_storage() [fz_buffer_storage()].
- FzBuffer_fz_new_display_list_from_svg_outparams_fn(self, base_uri, zip)
- Helper for out-params of class method fz_buffer::ll_fz_new_display_list_from_svg() [fz_new_display_list_from_svg()].
- FzColorspace_fz_clamp_color_outparams_fn(self, in_)
- Helper for out-params of class method fz_colorspace::ll_fz_clamp_color() [fz_clamp_color()].
- FzColorspace_fz_convert_color_outparams_fn(self, sv, params)
- Helper for out-params of class method fz_colorspace::ll_fz_convert_color() [fz_convert_color()].
- FzColorspace_fz_convert_separation_colors_outparams_fn(self, src_color, dst_seps, color_params)
- Helper for out-params of class method fz_colorspace::ll_fz_convert_separation_colors() [fz_convert_separation_colors()].
- FzCompressedBuffer_fz_open_image_decomp_stream_from_buffer_outparams_fn(self)
- Helper for out-params of class method fz_compressed_buffer::ll_fz_open_image_decomp_stream_from_buffer() [fz_open_image_decomp_stream_from_buffer()].
- FzDisplayList_fz_search_display_list_outparams_fn(self, needle, hit_bbox, hit_max)
- Helper for out-params of class method fz_display_list::ll_fz_search_display_list() [fz_search_display_list()].
- FzDocumentWriter__init__0 = __init__(self, *args)
- *Overload 1:*
== Constructors. Constructor using `fz_new_document_writer_of_size()`.
Internal function to allocate a
block for a derived document_writer structure, with the base
structure's function pointers populated correctly, and the extra
space zero initialised.
|
*Overload 2:*
Constructor using `fz_new_document_writer_with_buffer()`.
|
*Overload 3:*
Constructor using `fz_new_jpeg_pixmap_writer()`.
|
*Overload 4:*
Constructor using `fz_new_pixmap_writer()`.
|
*Overload 5:*
Constructor using one of:
fz_new_cbz_writer()
fz_new_docx_writer()
fz_new_odt_writer()
fz_new_pam_pixmap_writer()
fz_new_pbm_pixmap_writer()
fz_new_pcl_writer()
fz_new_pclm_writer()
fz_new_pdf_writer()
fz_new_pdfocr_writer()
fz_new_pgm_pixmap_writer()
fz_new_pkm_pixmap_writer()
fz_new_png_pixmap_writer()
fz_new_pnm_pixmap_writer()
fz_new_ppm_pixmap_writer()
fz_new_ps_writer()
fz_new_pwg_writer()
fz_new_svg_writer()
|
*Overload 6:*
Constructor using one of:
fz_new_cbz_writer_with_output()
fz_new_docx_writer_with_output()
fz_new_odt_writer_with_output()
fz_new_pcl_writer_with_output()
fz_new_pclm_writer_with_output()
fz_new_pdf_writer_with_output()
fz_new_pdfocr_writer_with_output()
fz_new_ps_writer_with_output()
fz_new_pwg_writer_with_output()
This constructor takes ownership of <out> -
out.m_internal is set to NULL after this constructor
returns so <out> must not be used again.
|
*Overload 7:*
Constructor using one of:
fz_new_document_writer()
fz_new_text_writer()
|
*Overload 8:*
Constructor using fz_new_document_writer_with_output().
This constructor takes ownership of <out> -
out.m_internal is set to NULL after this constructor
returns so <out> must not be used again.
|
*Overload 9:*
Constructor using fz_new_text_writer_with_output().
This constructor takes ownership of <out> -
out.m_internal is set to NULL after this constructor
returns so <out> must not be used again.
|
*Overload 10:*
Default constructor, sets `m_internal` to null.
|
*Overload 11:*
Constructor using raw copy of pre-existing `::fz_document_writer`.
- FzDocumentWriter__init__1(self, *args)
- FzDocument_fz_resolve_link_outparams_fn(self, uri)
- Helper for out-params of class method fz_document::ll_fz_resolve_link() [fz_resolve_link()].
- FzDocument_fz_search_chapter_page_number_outparams_fn(self, chapter, page, needle, hit_bbox, hit_max)
- Helper for out-params of class method fz_document::ll_fz_search_chapter_page_number() [fz_search_chapter_page_number()].
- FzDocument_fz_search_page_number_outparams_fn(self, number, needle, hit_bbox, hit_max)
- Helper for out-params of class method fz_document::ll_fz_search_page_number() [fz_search_page_number()].
- FzFont_fz_encode_character_with_fallback_outparams_fn(self, unicode, script, language)
- Helper for out-params of class method fz_font::ll_fz_encode_character_with_fallback() [fz_encode_character_with_fallback()].
- FzImage_fz_get_pixmap_from_image_outparams_fn(self, subarea, ctm)
- Helper for out-params of class method fz_image::ll_fz_get_pixmap_from_image() [fz_get_pixmap_from_image()].
- FzImage_fz_image_resolution_outparams_fn(self)
- Helper for out-params of class method fz_image::ll_fz_image_resolution() [fz_image_resolution()].
- FzOutput_fz_new_svg_device_with_id_outparams_fn(self, page_width, page_height, text_format, reuse_images)
- Helper for out-params of class method fz_output::ll_fz_new_svg_device_with_id() [fz_new_svg_device_with_id()].
- FzPage_fz_page_presentation_outparams_fn(self, transition)
- Helper for out-params of class method fz_page::ll_fz_page_presentation() [fz_page_presentation()].
- FzPage_fz_search_page_outparams_fn(self, needle, hit_bbox, hit_max)
- Helper for out-params of class method fz_page::ll_fz_search_page() [fz_search_page()].
- FzPixmap_fz_fill_pixmap_with_color_outparams_fn(self, colorspace, color_params)
- Helper for out-params of class method fz_pixmap::ll_fz_fill_pixmap_with_color() [fz_fill_pixmap_with_color()].
- FzSeparations_fz_separation_equivalent_outparams_fn(self, idx, dst_cs, prf, color_params)
- Helper for out-params of class method fz_separations::ll_fz_separation_equivalent() [fz_separation_equivalent()].
- FzShade_fz_paint_shade_outparams_fn(self, override_cs, ctm, dest, color_params, bbox, eop)
- Helper for out-params of class method fz_shade::ll_fz_paint_shade() [fz_paint_shade()].
- FzStextPage_fz_search_stext_page_outparams_fn(self, needle, hit_bbox, hit_max)
- Helper for out-params of class method fz_stext_page::ll_fz_search_stext_page() [fz_search_stext_page()].
- FzStream_fz_decomp_image_from_stream_outparams_fn(self, image, subarea, indexed, l2factor)
- Helper for out-params of class method fz_stream::ll_fz_decomp_image_from_stream() [fz_decomp_image_from_stream()].
- FzStream_fz_open_image_decomp_stream_outparams_fn(self, arg_1)
- Helper for out-params of class method fz_stream::ll_fz_open_image_decomp_stream() [fz_open_image_decomp_stream()].
- FzStream_fz_read_best_outparams_fn(self, initial, worst_case)
- Helper for out-params of class method fz_stream::ll_fz_read_best() [fz_read_best()].
- FzXml_fz_dom_get_attribute_outparams_fn(self, i)
- Helper for out-params of class method fz_xml::ll_fz_dom_get_attribute() [fz_dom_get_attribute()].
- FzXml_fz_new_display_list_from_svg_xml_outparams_fn(self, xmldoc, base_uri, zip)
- Helper for out-params of class method fz_xml::ll_fz_new_display_list_from_svg_xml() [fz_new_display_list_from_svg_xml()].
- Memento_addBacktraceLimitFnname(fnname)
- Memento_adjustRef(blk, adjust)
- Memento_blockInfo(blk)
- Memento_breakAt(arg1)
- Memento_breakOnFree(a)
- Memento_breakOnRealloc(a)
- Memento_breakpoint()
- Memento_bt()
- Memento_calloc(arg1, arg2)
- Memento_check()
- Memento_checkAllMemory()
- Memento_checkBlock(arg1)
- Memento_checkBytePointerOrNull(blk)
- Memento_checkIntPointerOrNull(blk)
- Memento_checkPointerOrNull(blk)
- Memento_checkShortPointerOrNull(blk)
- Memento_dropByteRef(blk)
- Memento_dropIntRef(blk)
- Memento_dropRef(blk)
- Memento_dropShortRef(blk)
- Memento_failAt(arg1)
- Memento_failThisEvent()
- Memento_fin()
- Memento_find(a)
- Memento_free(arg1)
- Memento_getBlockNum(arg1)
- Memento_info(addr)
- Memento_label(arg1, arg2)
- Memento_listBlockInfo()
- Memento_listBlocks()
- Memento_listNewBlocks()
- Memento_listPhasedBlocks()
- Memento_malloc(s)
- Memento_paranoidAt(arg1)
- Memento_realloc(arg1, s)
- Memento_reference(blk)
- Memento_sequence()
- Memento_setAtexitFin(atexitfin)
- Memento_setIgnoreNewDelete(ignore)
- Memento_setMax(arg1)
- Memento_setParanoia(arg1)
- Memento_setVerbose(arg1)
- Memento_squeezing()
- Memento_startLeaking()
- Memento_stats()
- Memento_stopLeaking()
- Memento_strdup(arg1)
- Memento_takeByteRef(blk)
- Memento_takeIntRef(blk)
- Memento_takeRef(blk)
- Memento_takeShortRef(blk)
- Memento_tick()
- PdfAnnot_pdf_annot_MK_BC_outparams_fn(self, color)
- Helper for out-params of class method pdf_annot::ll_pdf_annot_MK_BC() [pdf_annot_MK_BC()].
- PdfAnnot_pdf_annot_MK_BG_outparams_fn(self, color)
- Helper for out-params of class method pdf_annot::ll_pdf_annot_MK_BG() [pdf_annot_MK_BG()].
- PdfAnnot_pdf_annot_color_outparams_fn(self, color)
- Helper for out-params of class method pdf_annot::ll_pdf_annot_color() [pdf_annot_color()].
- PdfAnnot_pdf_annot_default_appearance_outparams_fn(self, color)
- Helper for out-params of class method pdf_annot::ll_pdf_annot_default_appearance() [pdf_annot_default_appearance()].
- PdfAnnot_pdf_annot_interior_color_outparams_fn(self, color)
- Helper for out-params of class method pdf_annot::ll_pdf_annot_interior_color() [pdf_annot_interior_color()].
- PdfAnnot_pdf_annot_line_ending_styles_outparams_fn(self)
- Helper for out-params of class method pdf_annot::ll_pdf_annot_line_ending_styles() [pdf_annot_line_ending_styles()].
- PdfAnnot_pdf_edit_text_field_value_outparams_fn(self, value, change)
- Helper for out-params of class method pdf_annot::ll_pdf_edit_text_field_value() [pdf_edit_text_field_value()].
- PdfCmap_pdf_decode_cmap_outparams_fn(self, s, e)
- Helper for out-params of class method pdf_cmap::ll_pdf_decode_cmap() [pdf_decode_cmap()].
- PdfCmap_pdf_lookup_cmap_full_outparams_fn(self, cpt)
- Helper for out-params of class method pdf_cmap::ll_pdf_lookup_cmap_full() [pdf_lookup_cmap_full()].
- PdfCmap_pdf_map_one_to_many_outparams_fn(self, one, len)
- Helper for out-params of class method pdf_cmap::ll_pdf_map_one_to_many() [pdf_map_one_to_many()].
- PdfDocument_pdf_field_event_validate_outparams_fn(self, field, value)
- Helper for out-params of class method pdf_document::ll_pdf_field_event_validate() [pdf_field_event_validate()].
- PdfDocument_pdf_load_to_unicode_outparams_fn(self, font, collection, cmapstm)
- Helper for out-params of class method pdf_document::ll_pdf_load_to_unicode() [pdf_load_to_unicode()].
- PdfDocument_pdf_page_write_outparams_fn(self, mediabox)
- Helper for out-params of class method pdf_document::ll_pdf_page_write() [pdf_page_write()].
- PdfDocument_pdf_parse_ind_obj_outparams_fn(self, f)
- Helper for out-params of class method pdf_document::ll_pdf_parse_ind_obj() [pdf_parse_ind_obj()].
- PdfDocument_pdf_parse_journal_obj_outparams_fn(self, stm)
- Helper for out-params of class method pdf_document::ll_pdf_parse_journal_obj() [pdf_parse_journal_obj()].
- PdfDocument_pdf_repair_obj_outparams_fn(self, buf)
- Helper for out-params of class method pdf_document::ll_pdf_repair_obj() [pdf_repair_obj()].
- PdfDocument_pdf_resolve_link_outparams_fn(self, uri)
- Helper for out-params of class method pdf_document::ll_pdf_resolve_link() [pdf_resolve_link()].
- PdfDocument_pdf_signature_contents_outparams_fn(self, signature)
- Helper for out-params of class method pdf_document::ll_pdf_signature_contents() [pdf_signature_contents()].
- PdfDocument_pdf_undoredo_state_outparams_fn(self)
- Helper for out-params of class method pdf_document::ll_pdf_undoredo_state() [pdf_undoredo_state()].
- PdfFunction_pdf_eval_function_outparams_fn(self, in_, inlen, outlen)
- Helper for out-params of class method pdf_function::ll_pdf_eval_function() [pdf_eval_function()].
- PdfJs_pdf_js_event_result_validate_outparams_fn(self)
- Helper for out-params of class method pdf_js::ll_pdf_js_event_result_validate() [pdf_js_event_result_validate()].
- PdfJs_pdf_js_execute_outparams_fn(self, name, code)
- Helper for out-params of class method pdf_js::ll_pdf_js_execute() [pdf_js_execute()].
- PdfObj_pdf_array_get_string_outparams_fn(self, index)
- Helper for out-params of class method pdf_obj::ll_pdf_array_get_string() [pdf_array_get_string()].
- PdfObj_pdf_dict_get_string_outparams_fn(self)
- Helper for out-params of class method pdf_obj::ll_pdf_dict_get_string() [pdf_dict_get_string()].
- PdfObj_pdf_obj_memo_outparams_fn(self, bit)
- Helper for out-params of class method pdf_obj::ll_pdf_obj_memo() [pdf_obj_memo()].
- PdfObj_pdf_to_string_outparams_fn(self)
- Helper for out-params of class method pdf_obj::ll_pdf_to_string() [pdf_to_string()].
- PdfObj_pdf_walk_tree_outparams_fn(self, arrive, leave, arg)
- Helper for out-params of class method pdf_obj::ll_pdf_walk_tree() [pdf_walk_tree()].
- PdfPage_pdf_page_presentation_outparams_fn(self, transition)
- Helper for out-params of class method pdf_page::ll_pdf_page_presentation() [pdf_page_presentation()].
- PdfProcessor_pdf_process_contents_outparams_fn(self, doc, obj, res, cookie)
- Helper for out-params of class method pdf_processor::ll_pdf_process_contents() [pdf_process_contents()].
- Pixmap_set_alpha_helper(balen, n, data_len, zero_out, data, pix, premultiply, bground, colors, bgcolor)
- bytes_getitem(ary, index)
- bytes_setitem(ary, index, value)
- cdata(ptr, nelements=1)
- copy_pint(value)
- delete_bytes(ary)
- delete_floats(ary)
- delete_pint(obj)
- exception_info(exception_or_traceback=None, limit=None, file=None, chain=True, outer=True, show_exception_type=True, _filelinefn=True)
- Shows an exception and/or backtrace.
Alternative to `traceback.*` functions that print/return information about
exceptions and backtraces, such as:
* `traceback.format_exc()`
* `traceback.format_exception()`
* `traceback.print_exc()`
* `traceback.print_exception()`
Install as system default with:
`sys.excepthook = lambda type_, exception, traceback: jlib.exception_info( exception)`
Returns `None`, or the generated text if `file` is 'return'.
Args:
exception_or_traceback:
`None`, a `BaseException`, a `types.TracebackType` (typically from
an exception's `.__traceback__` member) or an `inspect.FrameInfo`.
If `None` we use current exception from `sys.exc_info()` if set,
otherwise the current backtrace from `inspect.stack()`.
limit:
As in `traceback.*` functions: `None` to show all frames, positive
to show last `limit` frames, negative to exclude outermost `-limit`
frames. Zero to not show any backtraces.
file:
As in `traceback.*` functions: file-like object to which we write
output, or `sys.stderr` if `None`. Special value 'return' makes us
return our output as a string.
chain:
As in `traceback.*` functions: if true (the default) we show
chained exceptions as described in PEP-3134. Special value
'because' reverses the usual ordering, showing higher-level
exceptions first and joining with 'Because:' text.
outer:
If true (the default) we also show an exception's outer frames
above the `catch` block (see next section for details). We
use `outer=false` internally for chained exceptions to avoid
duplication.
show_exception_type:
Controls whether exception text is prefixed by
`f'{type(exception)}: '`. If callable we only include this prefix
if `show_exception_type(exception)` is true. Otherwise if true (the
default) we include the prefix for all exceptions (this mimcs the
behaviour of `traceback.*` functions). Otherwise we exclude the
prefix for all exceptions.
_filelinefn:
Internal only; makes us omit file:line: information to allow simple
doctest comparison with expected output.
Differences from `traceback.*` functions:
Frames are displayed as one line in the form::
<file>:<line>:<function>: <text>
Filenames are displayed as relative to the current directory if
applicable.
Inclusion of outer frames:
Unlike `traceback.*` functions, stack traces for exceptions include
outer stack frames above the point at which an exception was caught
- i.e. frames from the top-level <module> or thread creation to the
catch block. [Search for 'sys.exc_info backtrace incomplete' for
more details.]
We separate the two parts of the backtrace using a marker line
'^except raise:' where '^except' points upwards to the frame that
caught the exception and 'raise:' refers downwards to the frame
that raised the exception.
So the backtrace for an exception looks like this::
<file>:<line>:<fn>: <text> [in root module.]
... [... other frames]
<file>:<line>:<fn>: <text> [in except: block where exception was caught.]
^except raise: [marker line]
<file>:<line>:<fn>: <text> [in try: block.]
... [... other frames]
<file>:<line>:<fn>: <text> [where the exception was raised.]
Examples:
In these examples we use `file=sys.stdout` so we can check the output
with `doctest`, and set `_filelinefn=0` so that the output can be
matched easily. We also use `+ELLIPSIS` and `...` to match arbitrary
outer frames from the doctest code itself.
Basic handling of an exception:
>>> def c():
... raise Exception( 'c() failed')
>>> def b():
... try:
... c()
... except Exception as e:
... exception_info( e, file=sys.stdout, _filelinefn=0)
>>> def a():
... b()
>>> a() # doctest: +REPORT_UDIFF +ELLIPSIS
Traceback (most recent call last):
...
a(): b()
b(): exception_info( e, file=sys.stdout, _filelinefn=0)
^except raise:
b(): c()
c(): raise Exception( 'c() failed')
Exception: c() failed
Handling of chained exceptions:
>>> def e():
... raise Exception( 'e(): deliberate error')
>>> def d():
... e()
>>> def c():
... try:
... d()
... except Exception as e:
... raise Exception( 'c: d() failed') from e
>>> def b():
... try:
... c()
... except Exception as e:
... exception_info( file=sys.stdout, chain=g_chain, _filelinefn=0)
>>> def a():
... b()
With `chain=True` (the default), we output low-level exceptions
first, matching the behaviour of `traceback.*` functions:
>>> g_chain = True
>>> a() # doctest: +REPORT_UDIFF +ELLIPSIS
Traceback (most recent call last):
c(): d()
d(): e()
e(): raise Exception( 'e(): deliberate error')
Exception: e(): deliberate error
<BLANKLINE>
The above exception was the direct cause of the following exception:
Traceback (most recent call last):
...
<module>(): a() # doctest: +REPORT_UDIFF +ELLIPSIS
a(): b()
b(): exception_info( file=sys.stdout, chain=g_chain, _filelinefn=0)
^except raise:
b(): c()
c(): raise Exception( 'c: d() failed') from e
Exception: c: d() failed
With `chain='because'`, we output high-level exceptions first:
>>> g_chain = 'because'
>>> a() # doctest: +REPORT_UDIFF +ELLIPSIS
Traceback (most recent call last):
...
<module>(): a() # doctest: +REPORT_UDIFF +ELLIPSIS
a(): b()
b(): exception_info( file=sys.stdout, chain=g_chain, _filelinefn=0)
^except raise:
b(): c()
c(): raise Exception( 'c: d() failed') from e
Exception: c: d() failed
<BLANKLINE>
Because:
Traceback (most recent call last):
c(): d()
d(): e()
e(): raise Exception( 'e(): deliberate error')
Exception: e(): deliberate error
Show current backtrace by passing `exception_or_traceback=None`:
>>> def c():
... exception_info( None, file=sys.stdout, _filelinefn=0)
>>> def b():
... return c()
>>> def a():
... return b()
>>> a() # doctest: +REPORT_UDIFF +ELLIPSIS
Traceback (most recent call last):
...
<module>(): a() # doctest: +REPORT_UDIFF +ELLIPSIS
a(): return b()
b(): return c()
c(): exception_info( None, file=sys.stdout, _filelinefn=0)
Show an exception's `.__traceback__` backtrace:
>>> def c():
... raise Exception( 'foo') # raise
>>> def b():
... return c() # call c
>>> def a():
... try:
... b() # call b
... except Exception as e:
... exception_info( e.__traceback__, file=sys.stdout, _filelinefn=0)
>>> a() # doctest: +REPORT_UDIFF +ELLIPSIS
Traceback (most recent call last):
...
a(): b() # call b
b(): return c() # call c
c(): raise Exception( 'foo') # raise
- floats_getitem(ary, index)
- floats_setitem(ary, index, value)
- fz_aa_level()
- Class-aware wrapper for `::fz_aa_level()`.
Get the number of bits of antialiasing we are
using (for graphics). Between 0 and 8.
- fz_abs(f)
- Class-aware wrapper for `::fz_abs()`.
Some standard math functions, done as static inlines for speed.
People with compilers that do not adequately implement inline
may like to reimplement these using macros.
- fz_absi(i)
- Class-aware wrapper for `::fz_absi()`.
- fz_add_layout_char(block, x, w, p)
- Class-aware wrapper for `::fz_add_layout_char()`.
Add a new char to the line at the end of the layout block.
- fz_add_layout_line(block, x, y, h, p)
- Class-aware wrapper for `::fz_add_layout_line()`.
Add a new line to the end of the layout block.
- fz_add_separation(sep, name, cs, cs_channel)
- Class-aware wrapper for `::fz_add_separation()`.
Add a separation (null terminated name, colorspace)
- fz_add_separation_equivalents(sep, rgba, cmyk, name)
- Class-aware wrapper for `::fz_add_separation_equivalents()`.
Add a separation with equivalents (null terminated name,
colorspace)
(old, deprecated)
- fz_adjust_rect_for_stroke(rect, stroke, ctm)
- Class-aware wrapper for `::fz_adjust_rect_for_stroke()`.
Given a rectangle (assumed to be the bounding box for a path),
expand it to allow for the expansion of the bbox that would be
seen by stroking the path with the given stroke state and
transform.
- fz_advance_glyph(font, glyph, wmode)
- Class-aware wrapper for `::fz_advance_glyph()`.
Return the advance for a given glyph.
font: The font to look for the glyph in.
glyph: The glyph to find the advance for.
wmode: 1 for vertical mode, 0 for horizontal.
Returns the advance for the glyph.
- fz_aes_crypt_cbc(ctx, mode, length, iv, input, output)
- Class-aware wrapper for `::fz_aes_crypt_cbc()`.
AES block processing. Encrypts or Decrypts (according to mode,
which must match what was initially set up) length bytes (which
must be a multiple of 16), using (and modifying) the insertion
vector iv, reading from input, and writing to output.
Never throws an exception.
- fz_aes_setkey_dec(ctx, key, keysize)
- Class-aware wrapper for `::fz_aes_setkey_dec()`.
AES decryption intialisation. Fills in the supplied context
and prepares for decryption using the given key.
Returns non-zero for error (key size other than 128/192/256).
Never throws an exception.
- fz_aes_setkey_enc(ctx, key, keysize)
- Class-aware wrapper for `::fz_aes_setkey_enc()`.
AES encryption intialisation. Fills in the supplied context
and prepares for encryption using the given key.
Returns non-zero for error (key size other than 128/192/256).
Never throws an exception.
- fz_alpha_from_gray(gray)
- Class-aware wrapper for `::fz_alpha_from_gray()`.
- fz_append_base64(out, data, size, newline)
- Class-aware wrapper for `::fz_append_base64()`.
Write a base64 encoded data block, optionally with periodic newlines.
- fz_append_base64_buffer(out, data, newline)
- Class-aware wrapper for `::fz_append_base64_buffer()`.
Append a base64 encoded fz_buffer, optionally with periodic newlines.
- fz_append_bits(buf, value, count)
- Class-aware wrapper for `::fz_append_bits()`.
- fz_append_bits_pad(buf)
- Class-aware wrapper for `::fz_append_bits_pad()`.
- fz_append_buffer(destination, source)
- Class-aware wrapper for `::fz_append_buffer()`.
Append the contents of the source buffer onto the end of the
destination buffer, extending automatically as required.
Ownership of buffers does not change.
- fz_append_byte(buf, c)
- Class-aware wrapper for `::fz_append_byte()`.
- fz_append_data(buf, data, len)
- Class-aware wrapper for `::fz_append_data()`.
fz_append_*: Append data to a buffer.
The buffer will automatically grow as required.
- fz_append_image_as_data_uri(out, image)
- Class-aware wrapper for `::fz_append_image_as_data_uri()`.
- fz_append_int16_be(buf, x)
- Class-aware wrapper for `::fz_append_int16_be()`.
- fz_append_int16_le(buf, x)
- Class-aware wrapper for `::fz_append_int16_le()`.
- fz_append_int32_be(buf, x)
- Class-aware wrapper for `::fz_append_int32_be()`.
- fz_append_int32_le(buf, x)
- Class-aware wrapper for `::fz_append_int32_le()`.
- fz_append_pdf_string(buffer, text)
- Class-aware wrapper for `::fz_append_pdf_string()`.
fz_append_pdf_string: Append a string with PDF syntax quotes and
escapes.
The buffer will automatically grow as required.
- fz_append_pixmap_as_data_uri(out, pixmap)
- Class-aware wrapper for `::fz_append_pixmap_as_data_uri()`.
- fz_append_rune(buf, c)
- Class-aware wrapper for `::fz_append_rune()`.
- fz_append_string(buf, data)
- Class-aware wrapper for `::fz_append_string()`.
- fz_arc4_encrypt(state, dest, src, len)
- Class-aware wrapper for `::fz_arc4_encrypt()`.
RC4 block encrypt operation; encrypt src into dst (both of
length len) updating the RC4 state as we go.
Never throws an exception.
- fz_arc4_final(state)
- Class-aware wrapper for `::fz_arc4_final()`.
RC4 finalization. Zero the context.
Never throws an exception.
- fz_arc4_init(state, key, len)
- Class-aware wrapper for `::fz_arc4_init()`.
RC4 initialization. Begins an RC4 operation, writing a new
context.
Never throws an exception.
- fz_archive_format(arch)
- Class-aware wrapper for `::fz_archive_format()`.
Return a pointer to a string describing the format of the
archive.
The lifetime of the string is unspecified (in current
implementations the string will persist until the archive
is closed, but this is not guaranteed).
- fz_atof(s)
- Class-aware wrapper for `::fz_atof()`.
Range checking atof
- fz_atoi(s)
- Class-aware wrapper for `::fz_atoi()`.
atoi that copes with NULL
- fz_atoi64(s)
- Class-aware wrapper for `::fz_atoi64()`.
64bit atoi that copes with NULL
- fz_authenticate_password(doc, password)
- Class-aware wrapper for `::fz_authenticate_password()`.
Test if the given password can decrypt the document.
password: The password string to be checked. Some document
specifications do not specify any particular text encoding, so
neither do we.
Returns 0 for failure to authenticate, non-zero for success.
For PDF documents, further information can be given by examining
the bits in the return code.
Bit 0 => No password required
Bit 1 => User password authenticated
Bit 2 => Owner password authenticated
- fz_available(stm, max)
- Class-aware wrapper for `::fz_available()`.
Ask how many bytes are available immediately from
a given stream.
stm: The stream to read from.
max: A hint for the underlying stream; the maximum number of
bytes that we are sure we will want to read. If you do not know
this number, give 1.
Returns the number of bytes immediately available between the
read and write pointers. This number is guaranteed only to be 0
if we have hit EOF. The number of bytes returned here need have
no relation to max (could be larger, could be smaller).
- fz_base_colorspace(cs)
- Class-aware wrapper for `::fz_base_colorspace()`.
Get the 'base' colorspace for a colorspace.
For indexed colorspaces, this is the colorspace the index
decodes into. For all other colorspaces, it is the colorspace
itself.
The returned colorspace is 'borrowed' (i.e. no additional
references are taken or dropped).
- fz_basename(path)
- Class-aware wrapper for `::fz_basename()`.
Find the filename component in a path.
- fz_begin_group(dev, area, cs, isolated, knockout, blendmode, alpha)
- Class-aware wrapper for `::fz_begin_group()`.
- fz_begin_layer(dev, layer_name)
- Class-aware wrapper for `::fz_begin_layer()`.
- fz_begin_mask(dev, area, luminosity, colorspace, bc, color_params)
- Class-aware wrapper for `::fz_begin_mask()`.
- fz_begin_metatext(dev, meta, text)
- Class-aware wrapper for `::fz_begin_metatext()`.
- fz_begin_page(wri, mediabox)
- Class-aware wrapper for `::fz_begin_page()`.
Called to start the process of writing a page to
a document.
mediabox: page size rectangle in points.
Returns a borrowed fz_device to write page contents to. This
should be kept if required, and only dropped if it was kept.
- fz_begin_structure(dev, standard, raw, uid)
- Class-aware wrapper for `::fz_begin_structure()`.
- fz_begin_tile(dev, area, view, xstep, ystep, ctm)
- Class-aware wrapper for `::fz_begin_tile()`.
- fz_begin_tile_id(dev, area, view, xstep, ystep, ctm, id)
- Class-aware wrapper for `::fz_begin_tile_id()`.
- fz_bidi_fragment_text = fz_bidi_fragment_text_outparams_fn(text, textlen, callback, arg, flags)
- Class-aware helper for out-params of fz_bidi_fragment_text() [fz_bidi_fragment_text()].
- fz_bidi_fragment_text_outparams_fn(text, textlen, callback, arg, flags)
- Class-aware helper for out-params of fz_bidi_fragment_text() [fz_bidi_fragment_text()].
- fz_bitmap_details = fz_bitmap_details_outparams_fn(bitmap)
- Class-aware helper for out-params of fz_bitmap_details() [fz_bitmap_details()].
- fz_bitmap_details_outparams_fn(bitmap)
- Class-aware helper for out-params of fz_bitmap_details() [fz_bitmap_details()].
- fz_blendmode_name(blendmode)
- Class-aware wrapper for `::fz_blendmode_name()`.
Map from enumeration to blend mode string.
The string is static, with arbitrary lifespan.
- fz_bound_display_list(list)
- Class-aware wrapper for `::fz_bound_display_list()`.
Return the bounding box of the page recorded in a display list.
- fz_bound_glyph(font, gid, trm)
- Class-aware wrapper for `::fz_bound_glyph()`.
Return a bbox for a given glyph in a font.
font: The font to look for the glyph in.
gid: The glyph to bound.
trm: The matrix to apply to the glyph before bounding.
Returns rectangle by value containing the bounds of the given
glyph.
- fz_bound_page(page)
- Class-aware wrapper for `::fz_bound_page()`.
Determine the size of a page at 72 dpi.
- fz_bound_page_box(page, box)
- Class-aware wrapper for `::fz_bound_page_box()`.
- fz_bound_path(path, stroke, ctm)
- Class-aware wrapper for `::fz_bound_path()`.
Return a bounding rectangle for a path.
path: The path to bound.
stroke: If NULL, the bounding rectangle given is for
the filled path. If non-NULL the bounding rectangle
given is for the path stroked with the given attributes.
ctm: The matrix to apply to the path during stroking.
r: Pointer to a fz_rect which will be used to hold
the result.
Returns r, updated to contain the bounding rectangle.
- fz_bound_shade(shade, ctm)
- Class-aware wrapper for `::fz_bound_shade()`.
Bound a given shading.
shade: The shade to bound.
ctm: The transform to apply to the shade before bounding.
r: Pointer to storage to put the bounds in.
Returns r, updated to contain the bounds for the shading.
- fz_bound_text(text, stroke, ctm)
- Class-aware wrapper for `::fz_bound_text()`.
Find the bounds of a given text object.
text: The text object to find the bounds of.
stroke: Pointer to the stroke attributes (for stroked
text), or NULL (for filled text).
ctm: The matrix in use.
r: pointer to storage for the bounds.
Returns a pointer to r, which is updated to contain the
bounding box for the text object.
- fz_box_type_from_string(name)
- Class-aware wrapper for `::fz_box_type_from_string()`.
- fz_buffer_extract(buffer)
- Returns buffer data as a Python bytes instance, leaving the
buffer empty.
- fz_buffer_extract_copy(buffer)
- Returns buffer data as a Python bytes instance, leaving the
buffer unchanged.
- fz_buffer_extract_outparams_fn(buf)
- Class-aware helper for out-params of fz_buffer_extract() [fz_buffer_extract()].
- fz_buffer_storage = fz_buffer_storage_outparams_fn(buf)
- Class-aware helper for out-params of fz_buffer_storage() [fz_buffer_storage()].
- fz_buffer_storage_memoryview(buffer, writable=False)
- Returns a read-only or writable Python `memoryview` onto
`fz_buffer` data. This relies on `buffer` existing and
not changing size while the `memoryview` is used.
- fz_buffer_storage_outparams_fn(buf)
- Class-aware helper for out-params of fz_buffer_storage() [fz_buffer_storage()].
- fz_calloc(count, size)
- Class-aware wrapper for `::fz_calloc()`.
Allocate array of memory of count entries of size bytes.
Clears the memory to zero.
Throws exception in the event of failure to allocate.
- fz_calloc_no_throw(count, size)
- Class-aware wrapper for `::fz_calloc_no_throw()`.
fz_calloc equivalent that returns NULL rather than throwing
exceptions.
- fz_caught()
- Class-aware wrapper for `::fz_caught()`.
Within an fz_catch() block, retrieve the error code for
the current exception.
This assumes no intervening use of fz_try/fz_catch.
- fz_caught_message()
- Class-aware wrapper for `::fz_caught_message()`.
Within an fz_catch() block, retrieve the formatted message
string for the current exception.
This assumes no intervening use of fz_try/fz_catch.
- fz_chartorune = fz_chartorune_outparams_fn(str)
- Class-aware helper for out-params of fz_chartorune() [fz_chartorune()].
- fz_chartorune_outparams_fn(str)
- Class-aware helper for out-params of fz_chartorune() [fz_chartorune()].
- fz_clamp(x, min, max)
- Class-aware wrapper for `::fz_clamp()`.
- fz_clamp64(x, min, max)
- Class-aware wrapper for `::fz_clamp64()`.
- fz_clamp_color = fz_clamp_color_outparams_fn(cs, in_)
- Class-aware helper for out-params of fz_clamp_color() [fz_clamp_color()].
- fz_clamp_color_outparams_fn(cs, in_)
- Class-aware helper for out-params of fz_clamp_color() [fz_clamp_color()].
- fz_clamp_location(doc, loc)
- Class-aware wrapper for `::fz_clamp_location()`.
Clamps a location into valid chapter/page range. (First clamps
the chapter into range, then the page into range).
- fz_clampd(x, min, max)
- Class-aware wrapper for `::fz_clampd()`.
- fz_clampi(x, min, max)
- Class-aware wrapper for `::fz_clampi()`.
- fz_clampp(x, min, max)
- Class-aware wrapper for `::fz_clampp()`.
- fz_cleanname(name)
- Class-aware wrapper for `::fz_cleanname()`.
rewrite path to the shortest string that names the same path.
Eliminates multiple and trailing slashes, interprets "." and
"..". Overwrites the string in place.
- fz_clear_bitmap(bit)
- Class-aware wrapper for `::fz_clear_bitmap()`.
Set the entire bitmap to 0.
Never throws exceptions.
- fz_clear_buffer(buf)
- Class-aware wrapper for `::fz_clear_buffer()`.
Empties the buffer. Storage is not freed, but is held ready
to be reused as the buffer is refilled.
Never throws exceptions.
- fz_clear_pixmap(pix)
- Class-aware wrapper for `::fz_clear_pixmap()`.
Sets all components (including alpha) of
all pixels in a pixmap to 0.
pix: The pixmap to clear.
- fz_clear_pixmap_rect_with_value(pix, value, r)
- Class-aware wrapper for `::fz_clear_pixmap_rect_with_value()`.
Clears a subrect of a pixmap with the given value.
pix: The pixmap to clear.
value: Values in the range 0 to 255 are valid. Each component
sample for each pixel in the pixmap will be set to this value,
while alpha will always be set to 255 (non-transparent).
r: the rectangle.
- fz_clear_pixmap_with_value(pix, value)
- Class-aware wrapper for `::fz_clear_pixmap_with_value()`.
Clears a pixmap with the given value.
pix: The pixmap to clear.
value: Values in the range 0 to 255 are valid. Each component
sample for each pixel in the pixmap will be set to this value,
while alpha will always be set to 255 (non-transparent).
This function is horrible, and should be removed from the
API and replaced with a less magic one.
- fz_clip_image_mask(dev, image, ctm, scissor)
- Class-aware wrapper for `::fz_clip_image_mask()`.
- fz_clip_path(dev, path, even_odd, ctm, scissor)
- Class-aware wrapper for `::fz_clip_path()`.
- fz_clip_stroke_path(dev, path, stroke, ctm, scissor)
- Class-aware wrapper for `::fz_clip_stroke_path()`.
- fz_clip_stroke_text(dev, text, stroke, ctm, scissor)
- Class-aware wrapper for `::fz_clip_stroke_text()`.
- fz_clip_text(dev, text, ctm, scissor)
- Class-aware wrapper for `::fz_clip_text()`.
- fz_clone_buffer(buf)
- Class-aware wrapper for `::fz_clone_buffer()`.
Make a new buffer, containing a copy of the data used in
the original.
- fz_clone_default_colorspaces(base)
- Class-aware wrapper for `::fz_clone_default_colorspaces()`.
Returns a reference to a newly cloned default colorspaces
structure.
The new clone may safely be altered without fear of race
conditions as the caller is the only reference holder.
- fz_clone_path(path)
- Class-aware wrapper for `::fz_clone_path()`.
Clone the data for a path.
This is used in preference to fz_keep_path when a whole
new copy of a path is required, rather than just a shared
pointer. This probably indicates that the path is about to
be modified.
path: path to clone.
Throws exceptions on failure to allocate.
- fz_clone_pixmap(old)
- Class-aware wrapper for `::fz_clone_pixmap()`.
Clone a pixmap, copying the pixels and associated data to new
storage.
The reference count of 'old' is unchanged.
- fz_clone_pixmap_area_with_different_seps(src, bbox, dcs, seps, color_params, default_cs)
- Class-aware wrapper for `::fz_clone_pixmap_area_with_different_seps()`.
- fz_clone_separations_for_overprint(seps)
- Class-aware wrapper for `::fz_clone_separations_for_overprint()`.
Return a separations object with all the spots in the input
separations object that are set to composite, reset to be
enabled. If there ARE no spots in the object, this returns
NULL. If the object already has all its spots enabled, then
just returns another handle on the same object.
- fz_clone_stroke_state(stroke)
- Class-aware wrapper for `::fz_clone_stroke_state()`.
Create an identical stroke_state structure and return a
reference to it.
stroke: The stroke state reference to clone.
Exceptions may be thrown in the event of a failure to
allocate.
- fz_close_band_writer(writer)
- Class-aware wrapper for `::fz_close_band_writer()`.
Finishes up the output and closes the band writer. After this
call no more headers or bands may be written.
- fz_close_device(dev)
- Class-aware wrapper for `::fz_close_device()`.
Signal the end of input, and flush any buffered output.
This is NOT called implicitly on fz_drop_device. This
may throw exceptions.
- fz_close_document_writer(wri)
- Class-aware wrapper for `::fz_close_document_writer()`.
Called to end the process of writing
pages to a document.
This writes any file level trailers required. After this
completes successfully the file is up to date and complete.
- fz_close_output(arg_0)
- Class-aware wrapper for `::fz_close_output()`.
Flush pending output and close an output stream.
- fz_close_zip_writer(zip)
- Class-aware wrapper for `::fz_close_zip_writer()`.
Close the zip file for writing.
This flushes any pending data to the file. This can throw
exceptions.
- fz_closepath(path)
- Class-aware wrapper for `::fz_closepath()`.
Close the current subpath.
path: The path to modify.
Throws exceptions on failure to allocate, attempting to modify
a packed path, and illegal path closes (i.e. closing a non open
path).
- fz_colorspace_colorant(cs, n)
- Class-aware wrapper for `::fz_colorspace_colorant()`.
Retrieve a the name for a colorant.
Returns a pointer with the same lifespan as the colorspace.
- fz_colorspace_device_n_has_cmyk(cs)
- Class-aware wrapper for `::fz_colorspace_device_n_has_cmyk()`.
True if DeviceN color space has cyan magenta yellow or black as
one of its colorants.
- fz_colorspace_device_n_has_only_cmyk(cs)
- Class-aware wrapper for `::fz_colorspace_device_n_has_only_cmyk()`.
True if DeviceN color space has only colorants from the CMYK set.
- fz_colorspace_is_cmyk(cs)
- Class-aware wrapper for `::fz_colorspace_is_cmyk()`.
- fz_colorspace_is_device(cs)
- Class-aware wrapper for `::fz_colorspace_is_device()`.
- fz_colorspace_is_device_cmyk(cs)
- Class-aware wrapper for `::fz_colorspace_is_device_cmyk()`.
- fz_colorspace_is_device_gray(cs)
- Class-aware wrapper for `::fz_colorspace_is_device_gray()`.
- fz_colorspace_is_device_n(cs)
- Class-aware wrapper for `::fz_colorspace_is_device_n()`.
- fz_colorspace_is_gray(cs)
- Class-aware wrapper for `::fz_colorspace_is_gray()`.
Tests for particular types of colorspaces
- fz_colorspace_is_indexed(cs)
- Class-aware wrapper for `::fz_colorspace_is_indexed()`.
- fz_colorspace_is_lab(cs)
- Class-aware wrapper for `::fz_colorspace_is_lab()`.
- fz_colorspace_is_lab_icc(cs)
- Class-aware wrapper for `::fz_colorspace_is_lab_icc()`.
- fz_colorspace_is_rgb(cs)
- Class-aware wrapper for `::fz_colorspace_is_rgb()`.
- fz_colorspace_is_subtractive(cs)
- Class-aware wrapper for `::fz_colorspace_is_subtractive()`.
True for CMYK, Separation and DeviceN colorspaces.
- fz_colorspace_n(cs)
- Class-aware wrapper for `::fz_colorspace_n()`.
Query the number of colorants in a colorspace.
- fz_colorspace_name(cs)
- Class-aware wrapper for `::fz_colorspace_name()`.
Query the name of a colorspace.
The returned string has the same lifespan as the colorspace
does. Caller should not free it.
- fz_colorspace_name_colorant(cs, n, name)
- Class-aware wrapper for `::fz_colorspace_name_colorant()`.
Assign a name for a given colorant in a colorspace.
Used while initially setting up a colorspace. The string is
copied into local storage, so need not be retained by the
caller.
- fz_colorspace_type(cs)
- Class-aware wrapper for `::fz_colorspace_type()`.
Query the type of colorspace.
- fz_compare_separations(sep1, sep2)
- Class-aware wrapper for `::fz_compare_separations()`.
Compare 2 separations structures (or NULLs).
Return 0 if identical, non-zero if not identical.
- fz_compress_ccitt_fax_g3(data, columns, rows, stride)
- Class-aware wrapper for `::fz_compress_ccitt_fax_g3()`.
Compress bitmap data as CCITT Group 3 1D fax image.
Creates a stream assuming the default PDF parameters,
except the number of columns.
- fz_compress_ccitt_fax_g4(data, columns, rows, stride)
- Class-aware wrapper for `::fz_compress_ccitt_fax_g4()`.
Compress bitmap data as CCITT Group 4 2D fax image.
Creates a stream assuming the default PDF parameters, except
K=-1 and the number of columns.
- fz_compressed_buffer_size(buffer)
- Class-aware wrapper for `::fz_compressed_buffer_size()`.
Return the storage size used for a buffer and its data.
Used in implementing store handling.
Never throws exceptions.
- fz_compressed_image_type(image)
- Class-aware wrapper for `::fz_compressed_image_type()`.
Return the type of a compressed image.
Any non-compressed image will have the type returned as UNKNOWN.
- fz_concat(left, right)
- Class-aware wrapper for `::fz_concat()`.
Multiply two matrices.
The order of the two matrices are important since matrix
multiplication is not commutative.
Returns result.
- fz_contains_rect(a, b)
- Class-aware wrapper for `::fz_contains_rect()`.
Test rectangle inclusion.
Return true if a entirely contains b.
- fz_convert_color(ss, sv, ds, is_, params)
- Python version of fz_convert_color().
`sv` should be a float or list of 1-4 floats or a SWIG
representation of a float*.
Returns (dv0, dv1, dv2, dv3).
- fz_convert_color_outparams_fn(ss, sv, ds, is_, params)
- Class-aware helper for out-params of fz_convert_color() [fz_convert_color()].
- fz_convert_indexed_pixmap_to_base(src)
- Class-aware wrapper for `::fz_convert_indexed_pixmap_to_base()`.
Convert pixmap from indexed to base colorspace.
This creates a new bitmap containing the converted pixmap data.
- fz_convert_pixmap(pix, cs_des, prf, default_cs, color_params, keep_alpha)
- Class-aware wrapper for `::fz_convert_pixmap()`.
Convert an existing pixmap to a desired
colorspace. Other properties of the pixmap, such as resolution
and position are copied to the converted pixmap.
pix: The pixmap to convert.
default_cs: If NULL pix->colorspace is used. It is possible that
the data may need to be interpreted as one of the color spaces
in default_cs.
cs_des: Desired colorspace, may be NULL to denote alpha-only.
prf: Proofing color space through which we need to convert.
color_params: Parameters that may be used in conversion (e.g.
ri).
keep_alpha: If 0 any alpha component is removed, otherwise
alpha is kept if present in the pixmap.
- fz_convert_separation_colors = fz_convert_separation_colors_outparams_fn(src_cs, src_color, dst_seps, dst_cs, color_params)
- Class-aware helper for out-params of fz_convert_separation_colors() [fz_convert_separation_colors()].
- fz_convert_separation_colors_outparams_fn(src_cs, src_color, dst_seps, dst_cs, color_params)
- Class-aware helper for out-params of fz_convert_separation_colors() [fz_convert_separation_colors()].
- fz_convert_separation_pixmap_to_base(src)
- Class-aware wrapper for `::fz_convert_separation_pixmap_to_base()`.
Convert pixmap from DeviceN/Separation to base colorspace.
This creates a new bitmap containing the converted pixmap data.
- fz_copy_option(val, dest, maxlen)
- Class-aware wrapper for `::fz_copy_option()`.
Copy an option (val) into a destination buffer (dest), of maxlen
bytes.
Returns the number of bytes (including terminator) that did not
fit. If val is maxlen or greater bytes in size, it will be left
unterminated.
- fz_copy_rectangle(page, area, crlf)
- Class-aware wrapper for `::fz_copy_rectangle()`.
Return a newly allocated UTF-8 string with the text for a given
selection rectangle.
crlf: If true, write "\r\n" style line endings (otherwise "\n"
only).
- fz_copy_selection(page, a, b, crlf)
- Class-aware wrapper for `::fz_copy_selection()`.
Return a newly allocated UTF-8 string with the text for a given
selection.
crlf: If true, write "\r\n" style line endings (otherwise "\n"
only).
- fz_count_active_separations(seps)
- Class-aware wrapper for `::fz_count_active_separations()`.
Return the number of active separations.
- fz_count_archive_entries(arch)
- Class-aware wrapper for `::fz_count_archive_entries()`.
Number of entries in archive.
Will always return a value >= 0.
May throw an exception if this type of archive cannot count the
entries (such as a directory).
- fz_count_chapter_pages(doc, chapter)
- Class-aware wrapper for `::fz_count_chapter_pages()`.
Return the number of pages in a chapter.
May return 0.
- fz_count_chapters(doc)
- Class-aware wrapper for `::fz_count_chapters()`.
Return the number of chapters in the document.
At least 1.
- fz_count_pages(doc)
- Class-aware wrapper for `::fz_count_pages()`.
Return the number of pages in document
May return 0 for documents with no pages.
- fz_count_separations(sep)
- Class-aware wrapper for `::fz_count_separations()`.
- fz_create_link(page, bbox, uri)
- Class-aware wrapper for `::fz_create_link()`.
Create a new link on a page.
- fz_currentpoint(path)
- Class-aware wrapper for `::fz_currentpoint()`.
Return the current point that a path has
reached or (0,0) if empty.
path: path to return the current point of.
- fz_curveto(path, x0, y0, x1, y1, x2, y2)
- Class-aware wrapper for `::fz_curveto()`.
Append a 'curveto' command to an open path. (For a
cubic bezier).
path: The path to modify.
x0, y0: The coordinates of the first control point for the
curve.
x1, y1: The coordinates of the second control point for the
curve.
x2, y2: The end coordinates for the curve.
Throws exceptions on failure to allocate, or attempting to
modify a packed path.
- fz_curvetov(path, x1, y1, x2, y2)
- Class-aware wrapper for `::fz_curvetov()`.
Append a 'curvetov' command to an open path. (For a
cubic bezier with the first control coordinate equal to
the start point).
path: The path to modify.
x1, y1: The coordinates of the second control point for the
curve.
x2, y2: The end coordinates for the curve.
Throws exceptions on failure to allocate, or attempting to
modify a packed path.
- fz_curvetoy(path, x0, y0, x2, y2)
- Class-aware wrapper for `::fz_curvetoy()`.
Append a 'curvetoy' command to an open path. (For a
cubic bezier with the second control coordinate equal to
the end point).
path: The path to modify.
x0, y0: The coordinates of the first control point for the
curve.
x2, y2: The end coordinates for the curve (and the second
control coordinate).
Throws exceptions on failure to allocate, or attempting to
modify a packed path.
- fz_debug_store(out)
- Class-aware wrapper for `::fz_debug_store()`.
Output debugging information for the current state of the store
to the given output channel.
- fz_debug_xml(item, level)
- Class-aware wrapper for `::fz_debug_xml()`.
Pretty-print an XML tree to stdout.
- fz_decode_tile(pix, decode)
- Class-aware wrapper for `::fz_decode_tile()`.
- fz_decode_uri(s)
- Class-aware wrapper for `::fz_decode_uri()`.
Return a new string representing the unencoded version of the given URI.
This decodes all escape sequences except those that would result in a reserved
character that are part of the URI syntax (; / ? : @ & = + $ , #).
- fz_decode_uri_component(s)
- Class-aware wrapper for `::fz_decode_uri_component()`.
Return a new string representing the unencoded version of the given URI component.
This decodes all escape sequences!
- fz_decomp_image_from_stream = fz_decomp_image_from_stream_outparams_fn(stm, image, subarea, indexed, l2factor)
- Class-aware helper for out-params of fz_decomp_image_from_stream() [fz_decomp_image_from_stream()].
- fz_decomp_image_from_stream_outparams_fn(stm, image, subarea, indexed, l2factor)
- Class-aware helper for out-params of fz_decomp_image_from_stream() [fz_decomp_image_from_stream()].
- fz_decouple_type3_font(font, t3doc)
- Class-aware wrapper for `::fz_decouple_type3_font()`.
- fz_default_cmyk(default_cs)
- Class-aware wrapper for `::fz_default_cmyk()`.
- fz_default_error_callback(user, message)
- Class-aware wrapper for `::fz_default_error_callback()`.
FIXME: Better not to expose fz_default_error_callback, and
fz_default_warning callback and to allow 'NULL' to be used
int fz_set_xxxx_callback to mean "defaults".
FIXME: Do we need/want functions like
fz_error_callback(ctx, message) to allow callers to inject
stuff into the error/warning streams?
The default error callback. Declared publicly just so that the
error callback can be set back to this after it has been
overridden.
- fz_default_gray(default_cs)
- Class-aware wrapper for `::fz_default_gray()`.
Retrieve default colorspaces (typically page local).
If default_cs is non NULL, the default is retrieved from there,
otherwise the global default is retrieved.
These return borrowed references that should not be dropped,
unless they are kept first.
- fz_default_halftone(num_comps)
- Class-aware wrapper for `::fz_default_halftone()`.
Create a 'default' halftone structure
for the given number of components.
num_comps: The number of components to use.
Returns a simple default halftone. The default halftone uses
the same halftone tile for each plane, which may not be ideal
for all purposes.
- fz_default_output_intent(default_cs)
- Class-aware wrapper for `::fz_default_output_intent()`.
- fz_default_rgb(default_cs)
- Class-aware wrapper for `::fz_default_rgb()`.
- fz_default_warning_callback(user, message)
- Class-aware wrapper for `::fz_default_warning_callback()`.
The default warning callback. Declared publicly just so that
the warning callback can be set back to this after it has been
overridden.
- fz_defer_reap_end()
- Class-aware wrapper for `::fz_defer_reap_end()`.
Decrement the defer reap count.
If the defer reap count returns to 0, and the store
has reapable objects in, a reap pass will begin.
Call this at the end of a process during which you
potentially might drop many reapable objects.
It is vital that every fz_defer_reap_start is matched
by a fz_defer_reap_end call.
- fz_defer_reap_start()
- Class-aware wrapper for `::fz_defer_reap_start()`.
Increment the defer reap count.
No reap operations will take place (except for those
triggered by an immediate failed malloc) until the
defer reap count returns to 0.
Call this at the start of a process during which you
potentially might drop many reapable objects.
It is vital that every fz_defer_reap_start is matched
by a fz_defer_reap_end call.
- fz_deflate = fz_deflate_outparams_fn(dest, source, source_length, level)
- Class-aware helper for out-params of fz_deflate() [fz_deflate()].
- fz_deflate_bound(size)
- Class-aware wrapper for `::fz_deflate_bound()`.
Returns the upper bound on the
size of flated data of length size.
- fz_deflate_outparams_fn(dest, source, source_length, level)
- Class-aware helper for out-params of fz_deflate() [fz_deflate()].
- fz_delete_link(page, link)
- Class-aware wrapper for `::fz_delete_link()`.
Delete an existing link on a page.
- fz_detach_xml(node)
- Class-aware wrapper for `::fz_detach_xml()`.
Detach a node from the tree, unlinking it from its parent,
and setting the document root to the node.
- fz_device_bgr()
- Class-aware wrapper for `::fz_device_bgr()`.
- fz_device_cmyk()
- Class-aware wrapper for `::fz_device_cmyk()`.
- fz_device_current_scissor(dev)
- Class-aware wrapper for `::fz_device_current_scissor()`.
Find current scissor region as tracked by the device.
- fz_device_gray()
- Class-aware wrapper for `::fz_device_gray()`.
Retrieve global default colorspaces.
These return borrowed references that should not be dropped,
unless they are kept first.
- fz_device_lab()
- Class-aware wrapper for `::fz_device_lab()`.
- fz_device_rgb()
- Class-aware wrapper for `::fz_device_rgb()`.
- fz_dirname(dir, path, dirsize)
- Class-aware wrapper for `::fz_dirname()`.
extract the directory component from a path.
- fz_disable_device_hints(dev, hints)
- Class-aware wrapper for `::fz_disable_device_hints()`.
Disable (clear) hint bits within the hint bitfield for a device.
- fz_disable_icc()
- Class-aware wrapper for `::fz_disable_icc()`.
Disable icc profile based operation.
- fz_display_list_is_empty(list)
- Class-aware wrapper for `::fz_display_list_is_empty()`.
Check for a display list being empty
list: The list to check.
Returns true if empty, false otherwise.
- fz_div255(c, a)
- Class-aware wrapper for `::fz_div255()`.
Undo alpha premultiplication.
- fz_do_always()
- Class-aware wrapper for `::fz_do_always()`.
- fz_do_catch()
- Class-aware wrapper for `::fz_do_catch()`.
- fz_do_try()
- Class-aware wrapper for `::fz_do_try()`.
- fz_document_output_intent(doc)
- Class-aware wrapper for `::fz_document_output_intent()`.
Find the output intent colorspace if the document has defined
one.
Returns a borrowed reference that should not be dropped, unless
it is kept first.
- fz_document_supports_accelerator(doc)
- Class-aware wrapper for `::fz_document_supports_accelerator()`.
Query if the document supports the saving of accelerator data.
- fz_document_writer_device(writer)
- Class-aware wrapper for `::fz_document_writer_device()`.
- fz_dom_add_attribute(elt, att, value)
- Class-aware wrapper for `::fz_dom_add_attribute()`.
Add an attribute to an element.
Ownership of att and value remain with the caller.
- fz_dom_append_child(parent, child)
- Class-aware wrapper for `::fz_dom_append_child()`.
Insert an element as the last child of a parent, unlinking the
child from its current position if required.
- fz_dom_attribute(elt, att)
- Class-aware wrapper for `::fz_dom_attribute()`.
Retrieve the value of a given attribute from a given element.
Returns a borrowed pointer to the value or NULL if not found.
- fz_dom_body(dom)
- Class-aware wrapper for `::fz_dom_body()`.
Return a borrowed reference for the 'body' element of
the given DOM.
- fz_dom_clone(elt)
- Class-aware wrapper for `::fz_dom_clone()`.
Clone an element (and its children).
A borrowed reference to the clone is returned. The clone is not
yet linked into the DOM.
- fz_dom_create_element(dom, tag)
- Class-aware wrapper for `::fz_dom_create_element()`.
Create an element of a given tag type for the given DOM.
The element is not linked into the DOM yet.
- fz_dom_create_text_node(dom, text)
- Class-aware wrapper for `::fz_dom_create_text_node()`.
Create a text node for the given DOM.
The element is not linked into the DOM yet.
- fz_dom_document_element(dom)
- Class-aware wrapper for `::fz_dom_document_element()`.
Return a borrowed reference for the document (the top
level element) of the DOM.
- fz_dom_find(elt, tag, att, match)
- Class-aware wrapper for `::fz_dom_find()`.
Find the first element matching the requirements in a depth first traversal from elt.
The tagname must match tag, unless tag is NULL, when all tag names are considered to match.
If att is NULL, then all tags match.
Otherwise:
If match is NULL, then only nodes that have an att attribute match.
If match is non-NULL, then only nodes that have an att attribute that matches match match.
Returns NULL (if no match found), or a borrowed reference to the first matching element.
- fz_dom_find_next(elt, tag, att, match)
- Class-aware wrapper for `::fz_dom_find_next()`.
Find the next element matching the requirements.
- fz_dom_first_child(elt)
- Class-aware wrapper for `::fz_dom_first_child()`.
Return a borrowed reference to the first child of a node,
or NULL if there isn't one.
- fz_dom_get_attribute = fz_dom_get_attribute_outparams_fn(elt, i)
- Class-aware helper for out-params of fz_dom_get_attribute() [fz_dom_get_attribute()].
- fz_dom_get_attribute_outparams_fn(elt, i)
- Class-aware helper for out-params of fz_dom_get_attribute() [fz_dom_get_attribute()].
- fz_dom_insert_after(node, new_elt)
- Class-aware wrapper for `::fz_dom_insert_after()`.
Insert an element (new_elt), after another element (node),
unlinking the new_elt from its current position if required.
- fz_dom_insert_before(node, new_elt)
- Class-aware wrapper for `::fz_dom_insert_before()`.
Insert an element (new_elt), before another element (node),
unlinking the new_elt from its current position if required.
- fz_dom_next(elt)
- Class-aware wrapper for `::fz_dom_next()`.
Return a borrowed reference to the next sibling of a node,
or NULL if there isn't one.
- fz_dom_parent(elt)
- Class-aware wrapper for `::fz_dom_parent()`.
Return a borrowed reference to the parent of a node,
or NULL if there isn't one.
- fz_dom_previous(elt)
- Class-aware wrapper for `::fz_dom_previous()`.
Return a borrowed reference to the previous sibling of a node,
or NULL if there isn't one.
- fz_dom_remove(elt)
- Class-aware wrapper for `::fz_dom_remove()`.
Remove an element from the DOM. The element can be added back elsewhere
if required.
No reference counting changes for the element.
- fz_dom_remove_attribute(elt, att)
- Class-aware wrapper for `::fz_dom_remove_attribute()`.
Remove an attribute from an element.
- fz_draw_story(story, dev, ctm)
- Class-aware wrapper for `::fz_draw_story()`.
- fz_dump_glyph_cache_stats(out)
- Class-aware wrapper for `::fz_dump_glyph_cache_stats()`.
Dump debug statistics for the glyph cache.
- fz_duplicate_glyph_names_from_unicode(unicode)
- Class-aware wrapper for `::fz_duplicate_glyph_names_from_unicode()`.
- fz_empty_store()
- Class-aware wrapper for `::fz_empty_store()`.
Evict every item from the store.
- fz_enable_device_hints(dev, hints)
- Class-aware wrapper for `::fz_enable_device_hints()`.
Enable (set) hint bits within the hint bitfield for a device.
- fz_enable_icc()
- Class-aware wrapper for `::fz_enable_icc()`.
Enable icc profile based operation.
- fz_encode_character(font, unicode)
- Class-aware wrapper for `::fz_encode_character()`.
Find the glyph id for a given unicode
character within a font.
font: The font to look for the unicode character in.
unicode: The unicode character to encode.
Returns the glyph id for the given unicode value, or 0 if
unknown.
- fz_encode_character_by_glyph_name(font, glyphname)
- Class-aware wrapper for `::fz_encode_character_by_glyph_name()`.
Encode character.
Either by direct lookup of glyphname within a font, or, failing
that, by mapping glyphname to unicode and thence to the glyph
index within the given font.
Returns zero for type3 fonts.
- fz_encode_character_sc(font, unicode)
- Class-aware wrapper for `::fz_encode_character_sc()`.
Encode character, preferring small-caps variant if available.
font: The font to look for the unicode character in.
unicode: The unicode character to encode.
Returns the glyph id for the given unicode value, or 0 if
unknown.
- fz_encode_character_with_fallback = fz_encode_character_with_fallback_outparams_fn(font, unicode, script, language)
- Class-aware helper for out-params of fz_encode_character_with_fallback() [fz_encode_character_with_fallback()].
- fz_encode_character_with_fallback_outparams_fn(font, unicode, script, language)
- Class-aware helper for out-params of fz_encode_character_with_fallback() [fz_encode_character_with_fallback()].
- fz_encode_uri(s)
- Class-aware wrapper for `::fz_encode_uri()`.
Return a new string representing the provided string encoded as a URI.
- fz_encode_uri_component(s)
- Class-aware wrapper for `::fz_encode_uri_component()`.
Return a new string representing the provided string encoded as an URI component.
This also encodes the special reserved characters (; / ? : @ & = + $ , #).
- fz_encode_uri_pathname(s)
- Class-aware wrapper for `::fz_encode_uri_pathname()`.
Return a new string representing the provided string encoded as an URI path name.
This also encodes the special reserved characters except /.
- fz_end_group(dev)
- Class-aware wrapper for `::fz_end_group()`.
- fz_end_layer(dev)
- Class-aware wrapper for `::fz_end_layer()`.
- fz_end_mask(dev)
- Class-aware wrapper for `::fz_end_mask()`.
- fz_end_metatext(dev)
- Class-aware wrapper for `::fz_end_metatext()`.
- fz_end_page(wri)
- Class-aware wrapper for `::fz_end_page()`.
Called to end the process of writing a page to a
document.
- fz_end_structure(dev)
- Class-aware wrapper for `::fz_end_structure()`.
- fz_end_throw_on_repair()
- Class-aware wrapper for `::fz_end_throw_on_repair()`.
- fz_end_tile(dev)
- Class-aware wrapper for `::fz_end_tile()`.
- fz_error_callback = fz_error_callback_outparams_fn()
- Class-aware helper for out-params of fz_error_callback() [fz_error_callback()].
- fz_error_callback_outparams_fn()
- Class-aware helper for out-params of fz_error_callback() [fz_error_callback()].
- fz_expand_irect(a, expand)
- Class-aware wrapper for `::fz_expand_irect()`.
- fz_expand_rect(b, expand)
- Class-aware wrapper for `::fz_expand_rect()`.
Expand a bbox by a given amount in all directions.
- fz_extract_ttf_from_ttc(font)
- Class-aware wrapper for `::fz_extract_ttf_from_ttc()`.
- fz_file_exists(path)
- Class-aware wrapper for `::fz_file_exists()`.
Return true if the named file exists and is readable.
- fz_fill_image(dev, image, ctm, alpha, color_params)
- Class-aware wrapper for `::fz_fill_image()`.
- fz_fill_image_mask(dev, image, ctm, colorspace, color, alpha, color_params)
- Class-aware wrapper for `::fz_fill_image_mask()`.
- fz_fill_path(dev, path, even_odd, ctm, colorspace, color, alpha, color_params)
- Class-aware wrapper for `::fz_fill_path()`.
Device calls; graphics primitives and containers.
- fz_fill_pixmap_from_display_list(list, ctm, pix)
- Class-aware wrapper for `::fz_fill_pixmap_from_display_list()`.
- fz_fill_pixmap_with_color = fz_fill_pixmap_with_color_outparams_fn(pix, colorspace, color_params)
- Class-aware helper for out-params of fz_fill_pixmap_with_color() [fz_fill_pixmap_with_color()].
- fz_fill_pixmap_with_color_outparams_fn(pix, colorspace, color_params)
- Class-aware helper for out-params of fz_fill_pixmap_with_color() [fz_fill_pixmap_with_color()].
- fz_fill_shade(dev, shade, ctm, alpha, color_params)
- Class-aware wrapper for `::fz_fill_shade()`.
- fz_fill_text(dev, text, ctm, colorspace, color, alpha, color_params)
- Python version of fz_fill_text() taking list/tuple for `color`.
- fz_filter_store(fn, arg, type)
- Class-aware wrapper for `::fz_filter_store()`.
Filter every element in the store with a matching type with the
given function.
If the function returns 1 for an element, drop the element.
- fz_find_item(drop, key, type)
- Class-aware wrapper for `::fz_find_item()`.
Find an item within the store.
drop: The function used to free the value (to ensure we get a
value of the correct type).
key: The key used to index the item.
type: Functions used to manipulate the key.
Returns NULL for not found, otherwise returns a pointer to the
value indexed by key to which a reference has been taken.
- fz_flush_output(out)
- Class-aware wrapper for `::fz_flush_output()`.
Flush unwritten data.
- fz_flush_warnings()
- Class-aware wrapper for `::fz_flush_warnings()`.
Flush any repeated warnings.
Repeated warnings are buffered, counted and eventually printed
along with the number of repetitions. Call fz_flush_warnings
to force printing of the latest buffered warning and the
number of repetitions, for example to make sure that all
warnings are printed before exiting an application.
- fz_font_ascender(font)
- Class-aware wrapper for `::fz_font_ascender()`.
Retrieve font ascender in ems.
- fz_font_bbox(font)
- Class-aware wrapper for `::fz_font_bbox()`.
Retrieve the font bbox.
font: The font to query.
Returns the font bbox by value; it is valid only if
fz_font_flags(font)->invalid_bbox is zero.
- fz_font_descender(font)
- Class-aware wrapper for `::fz_font_descender()`.
Retrieve font descender in ems.
- fz_font_digest(font, digest)
- Class-aware wrapper for `::fz_font_digest()`.
Retrieve the MD5 digest for the font's data.
- fz_font_ft_face(font)
- Class-aware wrapper for `::fz_font_ft_face()`.
Retrieve the FT_Face handle
for the font.
font: The font to query
Returns the FT_Face handle for the font, or NULL
if not a freetype handled font. (Cast to void *
to avoid nasty header exposure).
- fz_font_is_bold(font)
- Class-aware wrapper for `::fz_font_is_bold()`.
Query whether the font flags say that this font is bold.
- fz_font_is_italic(font)
- Class-aware wrapper for `::fz_font_is_italic()`.
Query whether the font flags say that this font is italic.
- fz_font_is_monospaced(font)
- Class-aware wrapper for `::fz_font_is_monospaced()`.
Query whether the font flags say that this font is monospaced.
- fz_font_is_serif(font)
- Class-aware wrapper for `::fz_font_is_serif()`.
Query whether the font flags say that this font is serif.
- fz_font_name(font)
- Class-aware wrapper for `::fz_font_name()`.
Retrieve a pointer to the name of the font.
font: The font to query.
Returns a pointer to an internal copy of the font name.
Will never be NULL, but may be the empty string.
- fz_font_t3_procs(font)
- Class-aware wrapper for `::fz_font_t3_procs()`.
Retrieve the Type3 procs
for a font.
font: The font to query
Returns the t3_procs pointer. Will be NULL for a
non type-3 font.
- fz_format_link_uri(doc, dest)
- Class-aware wrapper for `::fz_format_link_uri()`.
Format an internal link to a page number, location, and possible viewing parameters,
suitable for use with fz_create_link.
Returns a newly allocated string that the caller must free.
- fz_format_output_path = ll_fz_format_output_path(format, page)
- # Provide native python implementation of format_output_path() (->
# fz_format_output_path).
- fz_free(p)
- Class-aware wrapper for `::fz_free()`.
Free a previously allocated block of memory.
fz_free(ctx, NULL) does nothing.
Never throws exceptions.
- fz_gamma_pixmap(pix, gamma)
- Class-aware wrapper for `::fz_gamma_pixmap()`.
Apply gamma correction to a pixmap. All components
of all pixels are modified (except alpha, which is unchanged).
gamma: The gamma value to apply; 1.0 for no change.
- fz_generate_transition(tpix, opix, npix, time, trans)
- Class-aware wrapper for `::fz_generate_transition()`.
Generate a frame of a transition.
tpix: Target pixmap
opix: Old pixmap
npix: New pixmap
time: Position within the transition (0 to 256)
trans: Transition details
Returns 1 if successfully generated a frame.
Note: Pixmaps must include alpha.
- fz_get_glyph_name(font, glyph, buf, size)
- Class-aware wrapper for `::fz_get_glyph_name()`.
Find the name of a glyph
font: The font to look for the glyph in.
glyph: The glyph id to look for.
buf: Pointer to a buffer for the name to be inserted into.
size: The size of the buffer.
If a font contains a name table, then the name of the glyph
will be returned in the supplied buffer. Otherwise a name
is synthesised. The name will be truncated to fit in
the buffer.
- fz_get_pixmap_from_image = fz_get_pixmap_from_image_outparams_fn(image, subarea, ctm)
- Class-aware helper for out-params of fz_get_pixmap_from_image() [fz_get_pixmap_from_image()].
- fz_get_pixmap_from_image_outparams_fn(image, subarea, ctm)
- Class-aware helper for out-params of fz_get_pixmap_from_image() [fz_get_pixmap_from_image()].
- fz_get_unscaled_pixmap_from_image(image)
- Class-aware wrapper for `::fz_get_unscaled_pixmap_from_image()`.
Calls fz_get_pixmap_from_image() with ctm, subarea, w and h all set to NULL.
- fz_getopt = fz_getopt_outparams_fn(nargc, ostr)
- Class-aware helper for out-params of fz_getopt() [fz_getopt()].
- fz_getopt_outparams_fn(nargc, ostr)
- Class-aware helper for out-params of fz_getopt() [fz_getopt()].
- fz_glyph_bbox(glyph)
- Class-aware wrapper for `::fz_glyph_bbox()`.
Return the bounding box of the glyph in pixels.
- fz_glyph_bbox_no_ctx(src)
- Class-aware wrapper for `::fz_glyph_bbox_no_ctx()`.
- fz_glyph_cacheable(font, gid)
- Class-aware wrapper for `::fz_glyph_cacheable()`.
Determine if a given glyph in a font
is cacheable. Certain glyphs in a type 3 font cannot safely
be cached, as their appearance depends on the enclosing
graphic state.
font: The font to look for the glyph in.
gif: The glyph to query.
Returns non-zero if cacheable, 0 if not.
- fz_glyph_height(glyph)
- Class-aware wrapper for `::fz_glyph_height()`.
Return the height of the glyph in pixels.
- fz_glyph_name_from_unicode_sc(unicode)
- Class-aware wrapper for `::fz_glyph_name_from_unicode_sc()`.
- fz_glyph_width(glyph)
- Class-aware wrapper for `::fz_glyph_width()`.
Return the width of the glyph in pixels.
- fz_graphics_aa_level()
- Class-aware wrapper for `::fz_graphics_aa_level()`.
Get the number of bits of antialiasing we are
using for graphics. Between 0 and 8.
- fz_graphics_min_line_width()
- Class-aware wrapper for `::fz_graphics_min_line_width()`.
Get the minimum line width to be
used for stroked lines.
min_line_width: The minimum line width to use (in pixels).
- fz_gridfit_matrix(as_tiled, m)
- Class-aware wrapper for `::fz_gridfit_matrix()`.
Grid fit a matrix.
as_tiled = 0 => adjust the matrix so that the image of the unit
square completely covers any pixel that was touched by the
image of the unit square under the original matrix.
as_tiled = 1 => adjust the matrix so that the corners of the
image of the unit square align with the closest integer corner
of the image of the unit square under the original matrix.
- fz_grisu = fz_grisu_outparams_fn(f, s)
- Class-aware helper for out-params of fz_grisu() [fz_grisu()].
- fz_grisu_outparams_fn(f, s)
- Class-aware helper for out-params of fz_grisu() [fz_grisu()].
- fz_grow_buffer(buf)
- Class-aware wrapper for `::fz_grow_buffer()`.
Make some space within a buffer (i.e. ensure that
capacity > size).
- fz_has_archive_entry(arch, name)
- Class-aware wrapper for `::fz_has_archive_entry()`.
Check if entry by given name exists.
If named entry does not exist 0 will be returned, if it does
exist 1 is returned.
name: Entry name to look for, this must be an exact match to
the entry name in the archive.
- fz_has_option = fz_has_option_outparams_fn(opts, key)
- Class-aware helper for out-params of fz_has_option() [fz_has_option()].
- fz_has_option_outparams_fn(opts, key)
- Class-aware helper for out-params of fz_has_option() [fz_has_option()].
- fz_has_permission(doc, p)
- Class-aware wrapper for `::fz_has_permission()`.
Check permission flags on document.
- fz_hash_filter(table, state, callback)
- Class-aware wrapper for `::fz_hash_filter()`.
Iterate over the entries in a hash table, removing all the ones where callback returns true.
Does NOT free the value of the entry, so the caller is expected to take care of this.
- fz_hash_find(table, key)
- Class-aware wrapper for `::fz_hash_find()`.
Search for a matching hash within the table, and return the
associated value.
- fz_hash_for_each(table, state, callback)
- Class-aware wrapper for `::fz_hash_for_each()`.
Iterate over the entries in a hash table.
- fz_hash_insert(table, key, val)
- Class-aware wrapper for `::fz_hash_insert()`.
Insert a new key/value pair into the hash table.
If an existing entry with the same key is found, no change is
made to the hash table, and a pointer to the existing value is
returned.
If no existing entry with the same key is found, ownership of
val passes in, key is copied, and NULL is returned.
- fz_hash_remove(table, key)
- Class-aware wrapper for `::fz_hash_remove()`.
Remove the entry for a given key.
The value is NOT freed, so the caller is expected to take care
of this.
- fz_hb_lock()
- Class-aware wrapper for `::fz_hb_lock()`.
Lock against Harfbuzz being called
simultaneously in several threads. This reuses
FZ_LOCK_FREETYPE.
- fz_hb_unlock()
- Class-aware wrapper for `::fz_hb_unlock()`.
Unlock after a Harfbuzz call. This reuses
FZ_LOCK_FREETYPE.
- fz_highlight_selection(page, a, b, quads, max_quads)
- Class-aware wrapper for `::fz_highlight_selection()`.
Return a list of quads to highlight lines inside the selection
points.
- fz_highlight_selection2(page, a, b, max_quads)
- Class-aware wrapper for `::fz_highlight_selection2()`.
C++ alternative to fz_highlight_selection() that returns quads in a
std::vector.
- fz_ignore_text(dev, text, ctm)
- Class-aware wrapper for `::fz_ignore_text()`.
- fz_image_orientation(image)
- Class-aware wrapper for `::fz_image_orientation()`.
Request the natural orientation of an image.
This is for images (such as JPEG) that can contain internal
specifications of rotation/flips. This is ignored by all the
internal decode/rendering routines, but can be used by callers
(such as the image document handler) to respect such
specifications.
The values used by MuPDF are as follows, with the equivalent
Exif specifications given for information:
0: Undefined
1: 0 degree ccw rotation. (Exif = 1)
2: 90 degree ccw rotation. (Exif = 8)
3: 180 degree ccw rotation. (Exif = 3)
4: 270 degree ccw rotation. (Exif = 6)
5: flip on X. (Exif = 2)
6: flip on X, then rotate ccw by 90 degrees. (Exif = 5)
7: flip on X, then rotate ccw by 180 degrees. (Exif = 4)
8: flip on X, then rotate ccw by 270 degrees. (Exif = 7)
- fz_image_orientation_matrix(image)
- Class-aware wrapper for `::fz_image_orientation_matrix()`.
- fz_image_resolution = fz_image_resolution_outparams_fn(image)
- Class-aware helper for out-params of fz_image_resolution() [fz_image_resolution()].
- fz_image_resolution_outparams_fn(image)
- Class-aware helper for out-params of fz_image_resolution() [fz_image_resolution()].
- fz_image_size(im)
- Class-aware wrapper for `::fz_image_size()`.
Return the size of the storage used by an image.
- fz_image_type_name(type)
- Class-aware wrapper for `::fz_image_type_name()`.
Map from FZ_IMAGE_* value to string.
The returned string is static and therefore must not be freed.
- fz_include_point_in_rect(r, p)
- Class-aware wrapper for `::fz_include_point_in_rect()`.
Expand a bbox to include a given point.
To create a rectangle that encompasses a sequence of points, the
rectangle must first be set to be the empty rectangle at one of
the points before including the others.
- fz_install_load_system_font_funcs(f, f_cjk, f_fallback)
- Class-aware wrapper for `::fz_install_load_system_font_funcs()`.
Install functions to allow MuPDF to request fonts from the
system.
Only one set of hooks can be in use at a time.
- fz_intersect_irect(a, b)
- Class-aware wrapper for `::fz_intersect_irect()`.
Compute intersection of two bounding boxes.
Similar to fz_intersect_rect but operates on two bounding
boxes instead of two rectangles.
- fz_intersect_rect(a, b)
- Class-aware wrapper for `::fz_intersect_rect()`.
Compute intersection of two rectangles.
Given two rectangles, update the first to be the smallest
axis-aligned rectangle that covers the area covered by both
given rectangles. If either rectangle is empty then the
intersection is also empty. If either rectangle is infinite
then the intersection is simply the non-infinite rectangle.
Should both rectangles be infinite, then the intersection is
also infinite.
- fz_invert_bitmap(bmp)
- Class-aware wrapper for `::fz_invert_bitmap()`.
Invert bitmap.
Never throws exceptions.
- fz_invert_matrix(matrix)
- Class-aware wrapper for `::fz_invert_matrix()`.
Create an inverse matrix.
inverse: Place to store inverse matrix.
matrix: Matrix to invert. A degenerate matrix, where the
determinant is equal to zero, can not be inverted and the
original matrix is returned instead.
Returns inverse.
- fz_invert_pixmap(pix)
- Class-aware wrapper for `::fz_invert_pixmap()`.
Invert all the pixels in a pixmap. All components (process and
spots) of all pixels are inverted (except alpha, which is
unchanged).
- fz_invert_pixmap_alpha(pix)
- Class-aware wrapper for `::fz_invert_pixmap_alpha()`.
Invert the alpha fo all the pixels in a pixmap.
- fz_invert_pixmap_luminance(pix)
- Class-aware wrapper for `::fz_invert_pixmap_luminance()`.
Transform the pixels in a pixmap so that luminance of each
pixel is inverted, and the chrominance remains unchanged (as
much as accuracy allows).
All components of all pixels are inverted (except alpha, which
is unchanged). Only supports Grey and RGB bitmaps.
- fz_invert_pixmap_raw(pix)
- Class-aware wrapper for `::fz_invert_pixmap_raw()`.
Invert all the pixels in a non-premultiplied pixmap in a
very naive manner.
- fz_invert_pixmap_rect(image, rect)
- Class-aware wrapper for `::fz_invert_pixmap_rect()`.
Invert all the pixels in a given rectangle of a (premultiplied)
pixmap. All components of all pixels in the rectangle are
inverted (except alpha, which is unchanged).
- fz_irect_from_rect(rect)
- Class-aware wrapper for `::fz_irect_from_rect()`.
Convert a rect into the minimal bounding box
that covers the rectangle.
Coordinates in a bounding box are integers, so rounding of the
rects coordinates takes place. The top left corner is rounded
upwards and left while the bottom right corner is rounded
downwards and to the right.
- fz_irect_height(r)
- Class-aware wrapper for `::fz_irect_height()`.
Return the height of an irect. Invalid irects return 0.
- fz_irect_width(r)
- Class-aware wrapper for `::fz_irect_width()`.
Return the width of an irect. Invalid irects return 0.
- fz_is_directory(path)
- Class-aware wrapper for `::fz_is_directory()`.
Determine if a given path is a directory.
- fz_is_document_reflowable(doc)
- Class-aware wrapper for `::fz_is_document_reflowable()`.
Is the document reflowable.
Returns 1 to indicate reflowable documents, otherwise 0.
- fz_is_empty_irect(r)
- Class-aware wrapper for `::fz_is_empty_irect()`.
- fz_is_empty_rect(r)
- Class-aware wrapper for `::fz_is_empty_rect()`.
Check if rectangle is empty.
An empty rectangle is defined as one whose area is zero.
All invalid rectangles are empty.
- fz_is_eof(stm)
- Class-aware wrapper for `::fz_is_eof()`.
Query if the stream has reached EOF (during normal bytewise
reading).
See fz_is_eof_bits for the equivalent function for bitwise
reading.
- fz_is_eof_bits(stm)
- Class-aware wrapper for `::fz_is_eof_bits()`.
Query if the stream has reached EOF (during bitwise
reading).
See fz_is_eof for the equivalent function for bytewise
reading.
- fz_is_external_link(uri)
- Class-aware wrapper for `::fz_is_external_link()`.
Query whether a link is external to a document (determined by
uri containing a ':', intended to match with '://' which
separates the scheme from the scheme specific parts in URIs).
- fz_is_identity(m)
- Class-aware wrapper for `::fz_is_identity()`.
- fz_is_infinite_irect(r)
- Class-aware wrapper for `::fz_is_infinite_irect()`.
Check if an integer rectangle
is infinite.
- fz_is_infinite_rect(r)
- Class-aware wrapper for `::fz_is_infinite_rect()`.
Check if rectangle is infinite.
- fz_is_page_range(s)
- Class-aware wrapper for `::fz_is_page_range()`.
Check and parse string into page ranges:
,?(-?+|N)(-(-?+|N))?/
- fz_is_pixmap_monochrome(pixmap)
- Class-aware wrapper for `::fz_is_pixmap_monochrome()`.
Check if the pixmap is a 1-channel image containing samples with
only values 0 and 255
- fz_is_point_inside_irect(x, y, r)
- Class-aware wrapper for `::fz_is_point_inside_irect()`.
Inclusion test for irects. (Rect is assumed to be open, i.e.
top right corner is not included).
- fz_is_point_inside_quad(p, q)
- Class-aware wrapper for `::fz_is_point_inside_quad()`.
Inclusion test for quads.
- fz_is_point_inside_rect(p, r)
- Class-aware wrapper for `::fz_is_point_inside_rect()`.
Inclusion test for rects. (Rect is assumed to be open, i.e.
top right corner is not included).
- fz_is_pow2(a)
- Class-aware wrapper for `::fz_is_pow2()`.
- fz_is_quad_inside_quad(needle, haystack)
- Class-aware wrapper for `::fz_is_quad_inside_quad()`.
Inclusion test for quad in quad.
This may break down if quads are not 'well formed'.
- fz_is_quad_intersecting_quad(a, b)
- Class-aware wrapper for `::fz_is_quad_intersecting_quad()`.
Intersection test for quads.
This may break down if quads are not 'well formed'.
- fz_is_rectilinear(m)
- Class-aware wrapper for `::fz_is_rectilinear()`.
Check if a transformation is rectilinear.
Rectilinear means that no shearing is present and that any
rotations present are a multiple of 90 degrees. Usually this
is used to make sure that axis-aligned rectangles before the
transformation are still axis-aligned rectangles afterwards.
- fz_is_tar_archive(file)
- Class-aware wrapper for `::fz_is_tar_archive()`.
Detect if stream object is a tar achieve.
Assumes that the stream object is seekable.
- fz_is_valid_blend_colorspace(cs)
- Class-aware wrapper for `::fz_is_valid_blend_colorspace()`.
Check to see that a colorspace is appropriate to be used as
a blending space (i.e. only grey, rgb or cmyk).
- fz_is_valid_irect(r)
- Class-aware wrapper for `::fz_is_valid_irect()`.
Check if an integer rectangle is valid.
- fz_is_valid_rect(r)
- Class-aware wrapper for `::fz_is_valid_rect()`.
Check if rectangle is valid.
- fz_is_zip_archive(file)
- Class-aware wrapper for `::fz_is_zip_archive()`.
Detect if stream object is a zip archive.
Assumes that the stream object is seekable.
- fz_iso8859_1_from_unicode(u)
- Class-aware wrapper for `::fz_iso8859_1_from_unicode()`.
- fz_iso8859_7_from_unicode(u)
- Class-aware wrapper for `::fz_iso8859_7_from_unicode()`.
- fz_jbig2_globals_data(globals)
- Class-aware wrapper for `::fz_jbig2_globals_data()`.
Return buffer containing jbig2 globals data stream.
- fz_koi8u_from_unicode(u)
- Class-aware wrapper for `::fz_koi8u_from_unicode()`.
- fz_last_page(doc)
- Class-aware wrapper for `::fz_last_page()`.
Function to get the location for the last page in the document.
Using this can be far more efficient in some cases than calling
fz_count_pages and using the page number.
- fz_layout_document(doc, w, h, em)
- Class-aware wrapper for `::fz_layout_document()`.
Layout reflowable document types.
w, h: Page size in points.
em: Default font size in points.
- fz_lineto(path, x, y)
- Class-aware wrapper for `::fz_lineto()`.
Append a 'lineto' command to an open path.
path: The path to modify.
x, y: The coordinate to line to.
Throws exceptions on failure to allocate, or attempting to
modify a packed path.
- fz_list_archive_entry(arch, idx)
- Class-aware wrapper for `::fz_list_archive_entry()`.
Get listed name of entry position idx.
idx: Must be a value >= 0 < return value from
fz_count_archive_entries. If not in range NULL will be
returned.
May throw an exception if this type of archive cannot list the
entries (such as a directory).
- fz_load_bmp_subimage(buf, len, subimage)
- Class-aware wrapper for `::fz_load_bmp_subimage()`.
- fz_load_bmp_subimage_count(buf, len)
- Class-aware wrapper for `::fz_load_bmp_subimage_count()`.
- fz_load_chapter_page(doc, chapter, page)
- Class-aware wrapper for `::fz_load_chapter_page()`.
Load a page.
After fz_load_page is it possible to retrieve the size of the
page using fz_bound_page, or to render the page using
fz_run_page_*. Free the page by calling fz_drop_page.
chapter: chapter number, 0 is the first chapter of the document.
number: page number, 0 is the first page of the chapter.
- fz_load_fallback_font(script, language, serif, bold, italic)
- Class-aware wrapper for `::fz_load_fallback_font()`.
Try to load a fallback font for the
given combination of font attributes. Whether a font is
present or not will depend on the configuration in which
MuPDF is built.
script: The script desired (e.g. UCDN_SCRIPT_KATAKANA).
language: The language desired (e.g. FZ_LANG_ja).
serif: 1 if serif desired, 0 otherwise.
bold: 1 if bold desired, 0 otherwise.
italic: 1 if italic desired, 0 otherwise.
Returns a new font handle, or NULL if not available.
- fz_load_jbig2_globals(buf)
- Class-aware wrapper for `::fz_load_jbig2_globals()`.
Create a jbig2 globals record from a buffer.
Immutable once created.
- fz_load_jbig2_subimage(buf, len, subimage)
- Class-aware wrapper for `::fz_load_jbig2_subimage()`.
- fz_load_jbig2_subimage_count(buf, len)
- Class-aware wrapper for `::fz_load_jbig2_subimage_count()`.
- fz_load_jpx(data, size, cs)
- Class-aware wrapper for `::fz_load_jpx()`.
Exposed for PDF.
- fz_load_links(page)
- Class-aware wrapper for `::fz_load_links()`.
Load the list of links for a page.
Returns a linked list of all the links on the page, each with
its clickable region and link destination. Each link is
reference counted so drop and free the list of links by
calling fz_drop_link on the pointer return from fz_load_links.
page: Page obtained from fz_load_page.
- fz_load_outline(doc)
- Class-aware wrapper for `::fz_load_outline()`.
Load the hierarchical document outline.
Should be freed by fz_drop_outline.
- fz_load_outline_from_iterator(iter)
- Class-aware wrapper for `::fz_load_outline_from_iterator()`.
Routine to implement the old Structure based API from an iterator.
- fz_load_page(doc, number)
- Class-aware wrapper for `::fz_load_page()`.
Load a given page number from a document. This may be much less
efficient than loading by location (chapter+page) for some
document types.
- fz_load_pnm_subimage(buf, len, subimage)
- Class-aware wrapper for `::fz_load_pnm_subimage()`.
- fz_load_pnm_subimage_count(buf, len)
- Class-aware wrapper for `::fz_load_pnm_subimage_count()`.
- fz_load_system_cjk_font(name, ordering, serif)
- Class-aware wrapper for `::fz_load_system_cjk_font()`.
Attempt to load a given font from
the system.
name: The name of the desired font.
ordering: The ordering to load the font from (e.g. FZ_ADOBE_KOREA)
serif: 1 if serif desired, 0 otherwise.
Returns a new font handle, or NULL if no matching font was found
(or on error).
- fz_load_system_font(name, bold, italic, needs_exact_metrics)
- Class-aware wrapper for `::fz_load_system_font()`.
Attempt to load a given font from the system.
name: The name of the desired font.
bold: 1 if bold desired, 0 otherwise.
italic: 1 if italic desired, 0 otherwise.
needs_exact_metrics: 1 if an exact metrical match is required,
0 otherwise.
Returns a new font handle, or NULL if no matching font was found
(or on error).
- fz_load_tiff_subimage(buf, len, subimage)
- Class-aware wrapper for `::fz_load_tiff_subimage()`.
- fz_load_tiff_subimage_count(buf, len)
- Class-aware wrapper for `::fz_load_tiff_subimage_count()`.
Exposed for CBZ.
- fz_location_from_page_number(doc, number)
- Class-aware wrapper for `::fz_location_from_page_number()`.
Converts from page number to chapter+page. This may cause many
chapters to be laid out in order to calculate the number of
pages within those chapters.
- fz_lock(lock)
- Class-aware wrapper for `::fz_lock()`.
Lock one of the user supplied mutexes.
- fz_log_error(str)
- Class-aware wrapper for `::fz_log_error()`.
Log a (preformatted) string to the registered
error stream (stderr by default).
- fz_lookup_base14_font = fz_lookup_base14_font_outparams_fn(name)
- Class-aware helper for out-params of fz_lookup_base14_font() [fz_lookup_base14_font()].
- fz_lookup_base14_font_outparams_fn(name)
- Class-aware helper for out-params of fz_lookup_base14_font() [fz_lookup_base14_font()].
- fz_lookup_blendmode(name)
- Class-aware wrapper for `::fz_lookup_blendmode()`.
Map from (case sensitive) blend mode string to enumeration.
- fz_lookup_bookmark(doc, mark)
- Class-aware wrapper for `::fz_lookup_bookmark()`.
Find a bookmark and return its page number.
- fz_lookup_bookmark2(doc, mark)
- fz_lookup_builtin_font = fz_lookup_builtin_font_outparams_fn(name, bold, italic)
- Class-aware helper for out-params of fz_lookup_builtin_font() [fz_lookup_builtin_font()].
- fz_lookup_builtin_font_outparams_fn(name, bold, italic)
- Class-aware helper for out-params of fz_lookup_builtin_font() [fz_lookup_builtin_font()].
- fz_lookup_cjk_font = fz_lookup_cjk_font_outparams_fn(ordering)
- Class-aware helper for out-params of fz_lookup_cjk_font() [fz_lookup_cjk_font()].
- fz_lookup_cjk_font_by_language = fz_lookup_cjk_font_by_language_outparams_fn(lang)
- Class-aware helper for out-params of fz_lookup_cjk_font_by_language() [fz_lookup_cjk_font_by_language()].
- fz_lookup_cjk_font_by_language_outparams_fn(lang)
- Class-aware helper for out-params of fz_lookup_cjk_font_by_language() [fz_lookup_cjk_font_by_language()].
- fz_lookup_cjk_font_outparams_fn(ordering)
- Class-aware helper for out-params of fz_lookup_cjk_font() [fz_lookup_cjk_font()].
- fz_lookup_cjk_ordering_by_language(name)
- Class-aware wrapper for `::fz_lookup_cjk_ordering_by_language()`.
Return the matching FZ_ADOBE_* ordering
for the given language tag, such as "zh-Hant", "zh-Hans", "ja", or "ko".
- fz_lookup_image_type(type)
- Class-aware wrapper for `::fz_lookup_image_type()`.
Map from (case sensitive) image type string to FZ_IMAGE_*
type value.
- fz_lookup_metadata(document, key)
- Like fz_lookup_metadata2() but returns None on error
instead of raising exception.
- fz_lookup_metadata2(doc, key)
- Class-aware wrapper for `::fz_lookup_metadata2()`.
C++ alternative to `fz_lookup_metadata()` that returns a `std::string`
or calls `fz_throw()` if not found.
- fz_lookup_noto_emoji_font = fz_lookup_noto_emoji_font_outparams_fn()
- Class-aware helper for out-params of fz_lookup_noto_emoji_font() [fz_lookup_noto_emoji_font()].
- fz_lookup_noto_emoji_font_outparams_fn()
- Class-aware helper for out-params of fz_lookup_noto_emoji_font() [fz_lookup_noto_emoji_font()].
- fz_lookup_noto_font = fz_lookup_noto_font_outparams_fn(script, lang)
- Class-aware helper for out-params of fz_lookup_noto_font() [fz_lookup_noto_font()].
- fz_lookup_noto_font_outparams_fn(script, lang)
- Class-aware helper for out-params of fz_lookup_noto_font() [fz_lookup_noto_font()].
- fz_lookup_noto_math_font = fz_lookup_noto_math_font_outparams_fn()
- Class-aware helper for out-params of fz_lookup_noto_math_font() [fz_lookup_noto_math_font()].
- fz_lookup_noto_math_font_outparams_fn()
- Class-aware helper for out-params of fz_lookup_noto_math_font() [fz_lookup_noto_math_font()].
- fz_lookup_noto_music_font = fz_lookup_noto_music_font_outparams_fn()
- Class-aware helper for out-params of fz_lookup_noto_music_font() [fz_lookup_noto_music_font()].
- fz_lookup_noto_music_font_outparams_fn()
- Class-aware helper for out-params of fz_lookup_noto_music_font() [fz_lookup_noto_music_font()].
- fz_lookup_noto_symbol1_font = fz_lookup_noto_symbol1_font_outparams_fn()
- Class-aware helper for out-params of fz_lookup_noto_symbol1_font() [fz_lookup_noto_symbol1_font()].
- fz_lookup_noto_symbol1_font_outparams_fn()
- Class-aware helper for out-params of fz_lookup_noto_symbol1_font() [fz_lookup_noto_symbol1_font()].
- fz_lookup_noto_symbol2_font = fz_lookup_noto_symbol2_font_outparams_fn()
- Class-aware helper for out-params of fz_lookup_noto_symbol2_font() [fz_lookup_noto_symbol2_font()].
- fz_lookup_noto_symbol2_font_outparams_fn()
- Class-aware helper for out-params of fz_lookup_noto_symbol2_font() [fz_lookup_noto_symbol2_font()].
- fz_lookup_rendering_intent(name)
- Class-aware wrapper for `::fz_lookup_rendering_intent()`.
Map from (case sensitive) rendering intent string to enumeration
value.
- fz_make_bookmark(doc, loc)
- Class-aware wrapper for `::fz_make_bookmark()`.
Create a bookmark for the given page, which can be used to find
the same location after the document has been laid out with
different parameters.
- fz_make_irect(x0, y0, x1, y1)
- Class-aware wrapper for `::fz_make_irect()`.
- fz_make_location(chapter, page)
- Class-aware wrapper for `::fz_make_location()`.
Simple constructor for fz_locations.
- fz_make_matrix(a, b, c, d, e, f)
- Class-aware wrapper for `::fz_make_matrix()`.
- fz_make_point(x, y)
- Class-aware wrapper for `::fz_make_point()`.
- fz_make_quad(ul_x, ul_y, ur_x, ur_y, ll_x, ll_y, lr_x, lr_y)
- Class-aware wrapper for `::fz_make_quad()`.
Inline convenience construction function.
- fz_make_rect(x0, y0, x1, y1)
- Class-aware wrapper for `::fz_make_rect()`.
- fz_malloc(size)
- Class-aware wrapper for `::fz_malloc()`.
Allocate uninitialized memory of a given size.
Does NOT clear the memory!
May return NULL for size = 0.
Throws exception in the event of failure to allocate.
- fz_malloc_no_throw(size)
- Class-aware wrapper for `::fz_malloc_no_throw()`.
fz_malloc equivalent that returns NULL rather than throwing
exceptions.
- fz_matrix_expansion(m)
- Class-aware wrapper for `::fz_matrix_expansion()`.
Calculate average scaling factor of matrix.
- fz_matrix_max_expansion(m)
- Class-aware wrapper for `::fz_matrix_max_expansion()`.
Find the largest expansion performed by this matrix.
(i.e. max(abs(m.a),abs(m.b),abs(m.c),abs(m.d))
- fz_max(a, b)
- Class-aware wrapper for `::fz_max()`.
- fz_maxi(a, b)
- Class-aware wrapper for `::fz_maxi()`.
- fz_maxi64(a, b)
- Class-aware wrapper for `::fz_maxi64()`.
- fz_maxz(a, b)
- Class-aware wrapper for `::fz_maxz()`.
- fz_md5_buffer(buffer, digest)
- Class-aware wrapper for `::fz_md5_buffer()`.
Create an MD5 digest from buffer contents.
Never throws exceptions.
- fz_md5_final(state, digest)
- Class-aware wrapper for `::fz_md5_final()`.
MD5 finalization. Ends an MD5 message-digest operation, writing
the message digest and zeroizing the context.
Never throws an exception.
- fz_md5_final2(md5)
- Class-aware wrapper for `::fz_md5_final2()`.
C++ alternative to fz_md5_final() that returns the digest by value.
- fz_md5_init(state)
- Class-aware wrapper for `::fz_md5_init()`.
MD5 initialization. Begins an MD5 operation, writing a new
context.
Never throws an exception.
- fz_md5_pixmap(pixmap, digest)
- Class-aware wrapper for `::fz_md5_pixmap()`.
- fz_md5_pixmap2(pixmap)
- Class-aware wrapper for `::fz_md5_pixmap2()`.
C++ alternative to `fz_md5_pixmap()` that returns the digest by value.
- fz_md5_update(state, input, inlen)
- Class-aware wrapper for `::fz_md5_update()`.
MD5 block update operation. Continues an MD5 message-digest
operation, processing another message block, and updating the
context.
Never throws an exception.
- fz_md5_update_int64(state, i)
- Class-aware wrapper for `::fz_md5_update_int64()`.
MD5 block update operation. Continues an MD5 message-digest
operation, processing an int64, and updating the context.
Never throws an exception.
- fz_measure_string(user_font, trm, s, wmode, bidi_level, markup_dir, language)
- Class-aware wrapper for `::fz_measure_string()`.
Measure the advance width of a UTF8 string should it be added to a text object.
This uses the same layout algorithms as fz_show_string, and can be used
to calculate text alignment adjustments.
- fz_memmem(haystack, haystacklen, needle, needlelen)
- Class-aware wrapper for `::fz_memmem()`.
Find the start of the first occurrence of the substring needle in haystack.
- fz_memrnd(block, len)
- Class-aware wrapper for `::fz_memrnd()`.
Fill block with len bytes of pseudo-randomness.
- fz_memrnd2(length)
- fz_min(a, b)
- Class-aware wrapper for `::fz_min()`.
- fz_mini(a, b)
- Class-aware wrapper for `::fz_mini()`.
- fz_mini64(a, b)
- Class-aware wrapper for `::fz_mini64()`.
- fz_minz(a, b)
- Class-aware wrapper for `::fz_minz()`.
- fz_morph_error(fromcode, tocode)
- Class-aware wrapper for `::fz_morph_error()`.
Called within a catch block this modifies the current
exception's code. If it's of type 'fromcode' it is
modified to 'tocode'. Typically used for 'downgrading'
exception severity.
- fz_mount_multi_archive(arch_, sub, path)
- Class-aware wrapper for `::fz_mount_multi_archive()`.
Add an archive to the set of archives handled by a multi
archive.
If path is NULL, then the archive contents will appear at the
top level, otherwise, the archives contents will appear prefixed
by path.
- fz_moveto(path, x, y)
- Class-aware wrapper for `::fz_moveto()`.
Append a 'moveto' command to a path.
This 'opens' a path.
path: The path to modify.
x, y: The coordinate to move to.
Throws exceptions on failure to allocate, or attempting to
modify a packed path.
- fz_mul255(a, b)
- Class-aware wrapper for `::fz_mul255()`.
Multiply scaled two integers in the 0..255 range
- fz_needs_password(doc)
- Class-aware wrapper for `::fz_needs_password()`.
Check if a document is encrypted with a
non-blank password.
- fz_new_archive_of_size(file, size)
- Class-aware wrapper for `::fz_new_archive_of_size()`.
- fz_new_base14_font(name)
- Class-aware wrapper for `::fz_new_base14_font()`.
Create a new font from one of the built-in fonts.
- fz_new_bbox_device(rectp)
- Class-aware wrapper for `::fz_new_bbox_device()`.
Create a device to compute the bounding
box of all marks on a page.
The returned bounding box will be the union of all bounding
boxes of all objects on a page.
- fz_new_bitmap(w, h, n, xres, yres)
- Class-aware wrapper for `::fz_new_bitmap()`.
Create a new bitmap.
w, h: Width and Height for the bitmap
n: Number of color components (assumed to be a divisor of 8)
xres, yres: X and Y resolutions (in pixels per inch).
Returns pointer to created bitmap structure. The bitmap
data is uninitialised.
- fz_new_bitmap_from_pixmap(pix, ht)
- Class-aware wrapper for `::fz_new_bitmap_from_pixmap()`.
Make a bitmap from a pixmap and a halftone.
pix: The pixmap to generate from. Currently must be a single
color component with no alpha.
ht: The halftone to use. NULL implies the default halftone.
Returns the resultant bitmap. Throws exceptions in the case of
failure to allocate.
- fz_new_bitmap_from_pixmap_band(pix, ht, band_start)
- Class-aware wrapper for `::fz_new_bitmap_from_pixmap_band()`.
Make a bitmap from a pixmap and a
halftone, allowing for the position of the pixmap within an
overall banded rendering.
pix: The pixmap to generate from. Currently must be a single
color component with no alpha.
ht: The halftone to use. NULL implies the default halftone.
band_start: Vertical offset within the overall banded rendering
(in pixels)
Returns the resultant bitmap. Throws exceptions in the case of
failure to allocate.
- fz_new_buffer(capacity)
- Class-aware wrapper for `::fz_new_buffer()`.
- fz_new_buffer_from_base64(data, size)
- Class-aware wrapper for `::fz_new_buffer_from_base64()`.
Create a new buffer with data decoded from a base64 input string.
- fz_new_buffer_from_copied_data(data)
- Returns FzBuffer containing copy of `data`, which should be
a `bytes` or similar Python buffer instance.
- fz_new_buffer_from_data(data, size)
- Class-aware wrapper for `::fz_new_buffer_from_data()`.
Create a new buffer with existing data.
data: Pointer to existing data.
size: Size of existing data.
Takes ownership of data. Does not make a copy. Calls fz_free on
the data when the buffer is deallocated. Do not use 'data' after
passing to this function.
Returns pointer to new buffer. Throws exception on allocation
failure.
- fz_new_buffer_from_display_list(list, options)
- Class-aware wrapper for `::fz_new_buffer_from_display_list()`.
- fz_new_buffer_from_image_as_jpeg(image, color_params, quality, invert_cmyk)
- Class-aware wrapper for `::fz_new_buffer_from_image_as_jpeg()`.
- fz_new_buffer_from_image_as_pam(image, color_params)
- Class-aware wrapper for `::fz_new_buffer_from_image_as_pam()`.
- fz_new_buffer_from_image_as_png(image, color_params)
- Class-aware wrapper for `::fz_new_buffer_from_image_as_png()`.
Reencode a given image as a PNG into a buffer.
Ownership of the buffer is returned.
- fz_new_buffer_from_image_as_pnm(image, color_params)
- Class-aware wrapper for `::fz_new_buffer_from_image_as_pnm()`.
- fz_new_buffer_from_image_as_psd(image, color_params)
- Class-aware wrapper for `::fz_new_buffer_from_image_as_psd()`.
- fz_new_buffer_from_page(page, options)
- Class-aware wrapper for `::fz_new_buffer_from_page()`.
- fz_new_buffer_from_page_number(doc, number, options)
- Class-aware wrapper for `::fz_new_buffer_from_page_number()`.
- fz_new_buffer_from_page_with_format(page, format, options, transform, cookie)
- Class-aware wrapper for `::fz_new_buffer_from_page_with_format()`.
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.
- fz_new_buffer_from_pixmap_as_jpeg(pixmap, color_params, quality, invert_cmyk)
- Class-aware wrapper for `::fz_new_buffer_from_pixmap_as_jpeg()`.
- fz_new_buffer_from_pixmap_as_pam(pixmap, color_params)
- Class-aware wrapper for `::fz_new_buffer_from_pixmap_as_pam()`.
- fz_new_buffer_from_pixmap_as_png(pixmap, color_params)
- Class-aware wrapper for `::fz_new_buffer_from_pixmap_as_png()`.
Reencode a given pixmap as a PNG into a buffer.
Ownership of the buffer is returned.
- fz_new_buffer_from_pixmap_as_pnm(pixmap, color_params)
- Class-aware wrapper for `::fz_new_buffer_from_pixmap_as_pnm()`.
- fz_new_buffer_from_pixmap_as_psd(pix, color_params)
- Class-aware wrapper for `::fz_new_buffer_from_pixmap_as_psd()`.
- fz_new_buffer_from_shared_data(data, size)
- Class-aware wrapper for `::fz_new_buffer_from_shared_data()`.
Like fz_new_buffer, but does not take ownership.
- fz_new_buffer_from_stext_page(text)
- Class-aware wrapper for `::fz_new_buffer_from_stext_page()`.
Convert structured text into plain text.
- fz_new_builtin_font(name, is_bold, is_italic)
- Class-aware wrapper for `::fz_new_builtin_font()`.
- fz_new_cal_gray_colorspace(wp, bp, gamma)
- Class-aware wrapper for `::fz_new_cal_gray_colorspace()`.
Create a calibrated gray colorspace.
The returned reference should be dropped when it is finished
with.
Colorspaces are immutable once created.
- fz_new_cal_rgb_colorspace(wp, bp, gamma, matrix)
- Class-aware wrapper for `::fz_new_cal_rgb_colorspace()`.
Create a calibrated rgb colorspace.
The returned reference should be dropped when it is finished
with.
Colorspaces are immutable once created.
- fz_new_cjk_font(ordering)
- Class-aware wrapper for `::fz_new_cjk_font()`.
- fz_new_colorspace(type, flags, n, name)
- Class-aware wrapper for `::fz_new_colorspace()`.
Creates a new colorspace instance and returns a reference.
No internal checking is done that the colorspace type (e.g.
CMYK) matches with the flags (e.g. FZ_COLORSPACE_HAS_CMYK) or
colorant count (n) or name.
The reference should be dropped when it is finished with.
Colorspaces are immutable once created (with the exception of
setting up colorant names for separation spaces).
- fz_new_default_colorspaces()
- Class-aware wrapper for `::fz_new_default_colorspaces()`.
Create a new default colorspace structure with values inherited
from the context, and return a reference to it.
These can be overridden using fz_set_default_xxxx.
These should not be overridden while more than one caller has
the reference for fear of race conditions.
The caller should drop this reference once finished with it.
- fz_new_deflated_data = fz_new_deflated_data_outparams_fn(source, source_length, level)
- Class-aware helper for out-params of fz_new_deflated_data() [fz_new_deflated_data()].
- fz_new_deflated_data_from_buffer = fz_new_deflated_data_from_buffer_outparams_fn(buffer, level)
- Class-aware helper for out-params of fz_new_deflated_data_from_buffer() [fz_new_deflated_data_from_buffer()].
- fz_new_deflated_data_from_buffer_outparams_fn(buffer, level)
- Class-aware helper for out-params of fz_new_deflated_data_from_buffer() [fz_new_deflated_data_from_buffer()].
- fz_new_deflated_data_outparams_fn(source, source_length, level)
- Class-aware helper for out-params of fz_new_deflated_data() [fz_new_deflated_data()].
- fz_new_device_of_size(size)
- Class-aware wrapper for `::fz_new_device_of_size()`.
Devices are created by calls to device implementations, for
instance: foo_new_device(). These will be implemented by calling
fz_new_derived_device(ctx, foo_device) where foo_device is a
structure "derived from" fz_device, for instance
typedef struct { fz_device base; ...extras...} foo_device;
- fz_new_display_list(mediabox)
- Class-aware wrapper for `::fz_new_display_list()`.
Create an empty display list.
A display list contains drawing commands (text, images, etc.).
Use fz_new_list_device for populating the list.
mediabox: Bounds of the page (in points) represented by the
display list.
- fz_new_display_list_from_page(page)
- Class-aware wrapper for `::fz_new_display_list_from_page()`.
Create a display list.
Ownership of the display list is returned to the caller.
- fz_new_display_list_from_page_contents(page)
- Class-aware wrapper for `::fz_new_display_list_from_page_contents()`.
Create a display list from page contents (no annotations).
Ownership of the display list is returned to the caller.
- fz_new_display_list_from_page_number(doc, number)
- Class-aware wrapper for `::fz_new_display_list_from_page_number()`.
- fz_new_display_list_from_svg = fz_new_display_list_from_svg_outparams_fn(buf, base_uri, zip)
- Class-aware helper for out-params of fz_new_display_list_from_svg() [fz_new_display_list_from_svg()].
- fz_new_display_list_from_svg_outparams_fn(buf, base_uri, zip)
- Class-aware helper for out-params of fz_new_display_list_from_svg() [fz_new_display_list_from_svg()].
- fz_new_display_list_from_svg_xml = fz_new_display_list_from_svg_xml_outparams_fn(xmldoc, xml, base_uri, zip)
- Class-aware helper for out-params of fz_new_display_list_from_svg_xml() [fz_new_display_list_from_svg_xml()].
- fz_new_display_list_from_svg_xml_outparams_fn(xmldoc, xml, base_uri, zip)
- Class-aware helper for out-params of fz_new_display_list_from_svg_xml() [fz_new_display_list_from_svg_xml()].
- fz_new_document_of_size(size)
- Class-aware wrapper for `::fz_new_document_of_size()`.
New documents are typically created by calls like
foo_new_document(fz_context *ctx, ...). These work by
deriving a new document type from fz_document, for instance:
typedef struct { fz_document base; ...extras... } foo_document;
These are allocated by calling
fz_new_derived_document(ctx, foo_document)
- fz_new_draw_device(transform, dest)
- Class-aware wrapper for `::fz_new_draw_device()`.
Create a device to draw on a pixmap.
dest: Target pixmap for the draw device. See fz_new_pixmap*
for how to obtain a pixmap. The pixmap is not cleared by the
draw device, see fz_clear_pixmap* for how to clear it prior to
calling fz_new_draw_device. Free the device by calling
fz_drop_device.
transform: Transform from user space in points to device space
in pixels.
- fz_new_draw_device_type3(transform, dest)
- Class-aware wrapper for `::fz_new_draw_device_type3()`.
- fz_new_draw_device_with_bbox(transform, dest, clip)
- Class-aware wrapper for `::fz_new_draw_device_with_bbox()`.
Create a device to draw on a pixmap.
dest: Target pixmap for the draw device. See fz_new_pixmap*
for how to obtain a pixmap. The pixmap is not cleared by the
draw device, see fz_clear_pixmap* for how to clear it prior to
calling fz_new_draw_device. Free the device by calling
fz_drop_device.
transform: Transform from user space in points to device space
in pixels.
clip: Bounding box to restrict any marking operations of the
draw device.
- fz_new_draw_device_with_bbox_proof(transform, dest, clip, cs)
- Class-aware wrapper for `::fz_new_draw_device_with_bbox_proof()`.
Create a device to draw on a pixmap.
dest: Target pixmap for the draw device. See fz_new_pixmap*
for how to obtain a pixmap. The pixmap is not cleared by the
draw device, see fz_clear_pixmap* for how to clear it prior to
calling fz_new_draw_device. Free the device by calling
fz_drop_device.
transform: Transform from user space in points to device space
in pixels.
clip: Bounding box to restrict any marking operations of the
draw device.
proof_cs: Color space to render to prior to mapping to color
space defined by pixmap.
- fz_new_draw_device_with_options = fz_new_draw_device_with_options_outparams_fn(options, mediabox)
- Class-aware helper for out-params of fz_new_draw_device_with_options() [fz_new_draw_device_with_options()].
- fz_new_draw_device_with_options_outparams_fn(options, mediabox)
- Class-aware helper for out-params of fz_new_draw_device_with_options() [fz_new_draw_device_with_options()].
- fz_new_draw_device_with_proof(transform, dest, proof_cs)
- Class-aware wrapper for `::fz_new_draw_device_with_proof()`.
Create a device to draw on a pixmap.
dest: Target pixmap for the draw device. See fz_new_pixmap*
for how to obtain a pixmap. The pixmap is not cleared by the
draw device, see fz_clear_pixmap* for how to clear it prior to
calling fz_new_draw_device. Free the device by calling
fz_drop_device.
transform: Transform from user space in points to device space
in pixels.
proof_cs: Intermediate color space to map though when mapping to
color space defined by pixmap.
- fz_new_font_from_buffer(name, buffer, index, use_glyph_bbox)
- Class-aware wrapper for `::fz_new_font_from_buffer()`.
Create a new font from a font file in a fz_buffer.
Fonts created in this way, will be eligible for embedding by default.
name: Name of font (leave NULL to use name from font).
buffer: Buffer to load from.
index: Which font from the file to load (0 for default).
use_glyph_box: 1 if we should use the glyph bbox, 0 otherwise.
Returns new font handle, or throws exception on error.
- fz_new_font_from_file(name, path, index, use_glyph_bbox)
- Class-aware wrapper for `::fz_new_font_from_file()`.
Create a new font from a font file.
Fonts created in this way, will be eligible for embedding by default.
name: Name of font (leave NULL to use name from font).
path: File path to load from.
index: Which font from the file to load (0 for default).
use_glyph_box: 1 if we should use the glyph bbox, 0 otherwise.
Returns new font handle, or throws exception on error.
- fz_new_font_from_memory(name, data, len, index, use_glyph_bbox)
- Class-aware wrapper for `::fz_new_font_from_memory()`.
Create a new font from a font file in memory.
Fonts created in this way, will be eligible for embedding by default.
name: Name of font (leave NULL to use name from font).
data: Pointer to the font file data.
len: Length of the font file data.
index: Which font from the file to load (0 for default).
use_glyph_box: 1 if we should use the glyph bbox, 0 otherwise.
Returns new font handle, or throws exception on error.
- fz_new_icc_colorspace(type, flags, name, buf)
- Class-aware wrapper for `::fz_new_icc_colorspace()`.
Create a colorspace from an ICC profile supplied in buf.
Limited checking is done to ensure that the colorspace type is
appropriate for the supplied ICC profile.
An additional reference is taken to buf, which will be dropped
on destruction. Ownership is NOT passed in.
The returned reference should be dropped when it is finished
with.
Colorspaces are immutable once created.
- fz_new_image_from_buffer(buffer)
- Class-aware wrapper for `::fz_new_image_from_buffer()`.
Create a new image from a
buffer of data, inferring its type from the format
of the data.
- fz_new_image_from_compressed_buffer = fz_new_image_from_compressed_buffer_outparams_fn(w, h, bpc, colorspace, xres, yres, interpolate, imagemask, buffer, mask)
- Class-aware helper for out-params of fz_new_image_from_compressed_buffer() [fz_new_image_from_compressed_buffer()].
- fz_new_image_from_compressed_buffer_outparams_fn(w, h, bpc, colorspace, xres, yres, interpolate, imagemask, buffer, mask)
- Class-aware helper for out-params of fz_new_image_from_compressed_buffer() [fz_new_image_from_compressed_buffer()].
- fz_new_image_from_display_list(w, h, list)
- Class-aware wrapper for `::fz_new_image_from_display_list()`.
Create a new image from a display list.
w, h: The conceptual width/height of the image.
transform: The matrix that needs to be applied to the given
list to make it render to the unit square.
list: The display list.
- fz_new_image_from_file(path)
- Class-aware wrapper for `::fz_new_image_from_file()`.
Create a new image from the contents
of a file, inferring its type from the format of the
data.
- fz_new_image_from_pixmap(pixmap, mask)
- Class-aware wrapper for `::fz_new_image_from_pixmap()`.
Create an image from the given
pixmap.
pixmap: The pixmap to base the image upon. A new reference
to this is taken.
mask: NULL, or another image to use as a mask for this one.
A new reference is taken to this image. Supplying a masked
image as a mask to another image is illegal!
- fz_new_image_from_svg(buf, base_uri, zip)
- Class-aware wrapper for `::fz_new_image_from_svg()`.
Create a scalable image from an SVG document.
- fz_new_image_from_svg_xml(xmldoc, xml, base_uri, zip)
- Class-aware wrapper for `::fz_new_image_from_svg_xml()`.
Create a scalable image from an SVG document.
- fz_new_image_of_size = fz_new_image_of_size_outparams_fn(w, h, bpc, colorspace, xres, yres, interpolate, imagemask, mask, size, get_pixmap, get_size, drop)
- Class-aware helper for out-params of fz_new_image_of_size() [fz_new_image_of_size()].
- fz_new_image_of_size_outparams_fn(w, h, bpc, colorspace, xres, yres, interpolate, imagemask, mask, size, get_pixmap, get_size, drop)
- Class-aware helper for out-params of fz_new_image_of_size() [fz_new_image_of_size()].
- fz_new_indexed_colorspace(base, high, lookup)
- Class-aware wrapper for `::fz_new_indexed_colorspace()`.
Create an indexed colorspace.
The supplied lookup table is high palette entries long. Each
entry is n bytes long, where n is given by the number of
colorants in the base colorspace, one byte per colorant.
Ownership of lookup is passed it; it will be freed on
destruction, so must be heap allocated.
The colorspace will keep an additional reference to the base
colorspace that will be dropped on destruction.
The returned reference should be dropped when it is finished
with.
Colorspaces are immutable once created.
- fz_new_link_of_size(size, rect, uri)
- Class-aware wrapper for `::fz_new_link_of_size()`.
Create a new link record.
next is set to NULL with the expectation that the caller will
handle the linked list setup. Internal function.
Different document types will be implemented by deriving from
fz_link. This macro allocates such derived structures, and
initialises the base sections.
- fz_new_list_device(list)
- Class-aware wrapper for `::fz_new_list_device()`.
Create a rendering device for a display list.
When the device is rendering a page it will populate the
display list with drawing commands (text, images, etc.). The
display list can later be reused to render a page many times
without having to re-interpret the page from the document file
for each rendering. Once the device is no longer needed, free
it with fz_drop_device.
list: A display list that the list device takes a reference to.
- fz_new_multi_archive()
- Class-aware wrapper for `::fz_new_multi_archive()`.
Create a new multi archive (initially empty).
- fz_new_ocr_device(target, ctm, mediabox, with_list, language, datadir, progress, progress_arg)
- Class-aware wrapper for `::fz_new_ocr_device()`.
Create a device to OCR the text on the page.
Renders the page internally to a bitmap that is then OCRd. Text
is then forwarded onto the target device.
target: The target device to receive the OCRd text.
ctm: The transform to apply to the mediabox to get the size for
the rendered page image. Also used to calculate the resolution
for the page image. In general, this will be the same as the CTM
that you pass to fz_run_page (or fz_run_display_list) to feed
this device.
mediabox: The mediabox (in points). Combined with the CTM to get
the bounds of the pixmap used internally for the rendered page
image.
with_list: If with_list is false, then all non-text operations
are forwarded instantly to the target device. This results in
the target device seeing all NON-text operations, followed by
all the text operations (derived from OCR).
If with_list is true, then all the marking operations are
collated into a display list which is then replayed to the
target device at the end.
language: NULL (for "eng"), or a pointer to a string to describe
the languages/scripts that should be used for OCR (e.g.
"eng,ara").
datadir: NULL (for ""), or a pointer to a path string otherwise
provided to Tesseract in the TESSDATA_PREFIX environment variable.
progress: NULL, or function to be called periodically to indicate
progress. Return 0 to continue, or 1 to cancel. progress_arg is
returned as the void *. The int is a value between 0 and 100 to
indicate progress.
progress_arg: A void * value to be parrotted back to the progress
function.
- fz_new_outline()
- Class-aware wrapper for `::fz_new_outline()`.
Create a new outline entry with zeroed fields for the caller
to fill in.
- fz_new_page_of_size(size, doc)
- Class-aware wrapper for `::fz_new_page_of_size()`.
Different document types will be implemented by deriving from
fz_page. This macro allocates such derived structures, and
initialises the base sections.
- fz_new_path()
- Class-aware wrapper for `::fz_new_path()`.
Create a new (empty) path structure.
- fz_new_pixmap(cs, w, h, seps, alpha)
- Class-aware wrapper for `::fz_new_pixmap()`.
Create a new pixmap, with its origin at (0,0)
cs: The colorspace to use for the pixmap, or NULL for an alpha
plane/mask.
w: The width of the pixmap (in pixels)
h: The height of the pixmap (in pixels)
seps: Details of separations.
alpha: 0 for no alpha, 1 for alpha.
Returns a pointer to the new pixmap. Throws exception on failure
to allocate.
- fz_new_pixmap_from_alpha_channel(src)
- Class-aware wrapper for `::fz_new_pixmap_from_alpha_channel()`.
- fz_new_pixmap_from_color_and_mask(color, mask)
- Class-aware wrapper for `::fz_new_pixmap_from_color_and_mask()`.
- fz_new_pixmap_from_display_list(list, ctm, cs, alpha)
- Class-aware wrapper for `::fz_new_pixmap_from_display_list()`.
Render the page to a pixmap using the transform and colorspace.
Ownership of the pixmap is returned to the caller.
- fz_new_pixmap_from_display_list_with_separations(list, ctm, cs, seps, alpha)
- Class-aware wrapper for `::fz_new_pixmap_from_display_list_with_separations()`.
Render the page contents with control over spot colors.
Ownership of the pixmap is returned to the caller.
- fz_new_pixmap_from_page(page, ctm, cs, alpha)
- Class-aware wrapper for `::fz_new_pixmap_from_page()`.
- fz_new_pixmap_from_page_contents(page, ctm, cs, alpha)
- Class-aware wrapper for `::fz_new_pixmap_from_page_contents()`.
Render the page contents without annotations.
Ownership of the pixmap is returned to the caller.
- fz_new_pixmap_from_page_contents_with_separations(page, ctm, cs, seps, alpha)
- Class-aware wrapper for `::fz_new_pixmap_from_page_contents_with_separations()`.
- fz_new_pixmap_from_page_number(doc, number, ctm, cs, alpha)
- Class-aware wrapper for `::fz_new_pixmap_from_page_number()`.
- fz_new_pixmap_from_page_number_with_separations(doc, number, ctm, cs, seps, alpha)
- Class-aware wrapper for `::fz_new_pixmap_from_page_number_with_separations()`.
- fz_new_pixmap_from_page_with_separations(page, ctm, cs, seps, alpha)
- Class-aware wrapper for `::fz_new_pixmap_from_page_with_separations()`.
- fz_new_pixmap_from_pixmap(pixmap, rect)
- Class-aware wrapper for `::fz_new_pixmap_from_pixmap()`.
Create a new pixmap that represents a subarea of the specified
pixmap. A reference is taken to this pixmap that will be dropped
on destruction.
The supplied rectangle must be wholly contained within the
original pixmap.
Returns a pointer to the new pixmap. Throws exception on failure
to allocate.
- fz_new_pixmap_with_bbox(colorspace, bbox, seps, alpha)
- Class-aware wrapper for `::fz_new_pixmap_with_bbox()`.
Create a pixmap of a given size, location and pixel format.
The bounding box specifies the size of the created pixmap and
where it will be located. The colorspace determines the number
of components per pixel. Alpha is always present. Pixmaps are
reference counted, so drop references using fz_drop_pixmap.
colorspace: Colorspace format used for the created pixmap. The
pixmap will keep a reference to the colorspace.
bbox: Bounding box specifying location/size of created pixmap.
seps: Details of separations.
alpha: 0 for no alpha, 1 for alpha.
Returns a pointer to the new pixmap. Throws exception on failure
to allocate.
- fz_new_pixmap_with_bbox_and_data(colorspace, rect, seps, alpha, samples)
- Class-aware wrapper for `::fz_new_pixmap_with_bbox_and_data()`.
Create a pixmap of a given size, location and pixel format,
using the supplied data block.
The bounding box specifies the size of the created pixmap and
where it will be located. The colorspace determines the number
of components per pixel. Alpha is always present. Pixmaps are
reference counted, so drop references using fz_drop_pixmap.
colorspace: Colorspace format used for the created pixmap. The
pixmap will keep a reference to the colorspace.
rect: Bounding box specifying location/size of created pixmap.
seps: Details of separations.
alpha: Number of alpha planes (0 or 1).
samples: The data block to keep the samples in.
Returns a pointer to the new pixmap. Throws exception on failure
to allocate.
- fz_new_pixmap_with_data(colorspace, w, h, seps, alpha, stride, samples)
- Class-aware wrapper for `::fz_new_pixmap_with_data()`.
Create a new pixmap, with its origin at
(0,0) using the supplied data block.
cs: The colorspace to use for the pixmap, or NULL for an alpha
plane/mask.
w: The width of the pixmap (in pixels)
h: The height of the pixmap (in pixels)
seps: Details of separations.
alpha: 0 for no alpha, 1 for alpha.
stride: The byte offset from the pixel data in a row to the
pixel data in the next row.
samples: The data block to keep the samples in.
Returns a pointer to the new pixmap. Throws exception on failure to
allocate.
- fz_new_separations(controllable)
- Class-aware wrapper for `::fz_new_separations()`.
Create a new separations structure (initially empty)
- fz_new_stext_device(page, options)
- Class-aware wrapper for `::fz_new_stext_device()`.
Create a device to extract the text on a page.
Gather the text on a page into blocks and lines.
The reading order is taken from the order the text is drawn in
the source file, so may not be accurate.
page: The text page to which content should be added. This will
usually be a newly created (empty) text page, but it can be one
containing data already (for example when merging multiple
pages, or watermarking).
options: Options to configure the stext device.
- fz_new_store_context(max)
- Class-aware wrapper for `::fz_new_store_context()`.
Create a new store inside the context
max: The maximum size (in bytes) that the store is allowed to
grow to. FZ_STORE_UNLIMITED means no limit.
- fz_new_stream(state, next, drop)
- Class-aware wrapper for `::fz_new_stream()`.
Create a new stream object with the given
internal state and function pointers.
state: Internal state (opaque to everything but implementation).
next: Should provide the next set of bytes (up to max) of stream
data. Return the number of bytes read, or EOF when there is no
more data.
drop: Should clean up and free the internal state. May not
throw exceptions.
- fz_new_stroke_state()
- Class-aware wrapper for `::fz_new_stroke_state()`.
Create a new (empty) stroke state structure (with no dash
data) and return a reference to it.
Throws exception on failure to allocate.
- fz_new_stroke_state_with_dash_len(len)
- Class-aware wrapper for `::fz_new_stroke_state_with_dash_len()`.
Create a new (empty) stroke state structure, with room for
dash data of the given length, and return a reference to it.
len: The number of dash elements to allow room for.
Throws exception on failure to allocate.
- fz_new_svg_device(out, page_width, page_height, text_format, reuse_images)
- Class-aware wrapper for `::fz_new_svg_device()`.
Create a device that outputs (single page) SVG files to
the given output stream.
Equivalent to fz_new_svg_device_with_id passing id = NULL.
- fz_new_svg_device_with_id = fz_new_svg_device_with_id_outparams_fn(out, page_width, page_height, text_format, reuse_images)
- Class-aware helper for out-params of fz_new_svg_device_with_id() [fz_new_svg_device_with_id()].
- fz_new_svg_device_with_id_outparams_fn(out, page_width, page_height, text_format, reuse_images)
- Class-aware helper for out-params of fz_new_svg_device_with_id() [fz_new_svg_device_with_id()].
- fz_new_test_device = fz_new_test_device_outparams_fn(threshold, options, passthrough)
- Class-aware helper for out-params of fz_new_test_device() [fz_new_test_device()].
- fz_new_test_device_outparams_fn(threshold, options, passthrough)
- Class-aware helper for out-params of fz_new_test_device() [fz_new_test_device()].
- fz_new_text()
- Class-aware wrapper for `::fz_new_text()`.
Create a new empty fz_text object.
Throws exception on failure to allocate.
- fz_new_trace_device(out)
- Class-aware wrapper for `::fz_new_trace_device()`.
Create a device to print a debug trace of all device calls.
- fz_new_tree_archive(tree)
- Class-aware wrapper for `::fz_new_tree_archive()`.
Create an archive that holds named buffers.
tree can either be a preformed tree with fz_buffers as values,
or it can be NULL for an empty tree.
- fz_new_type3_font(name, matrix)
- Class-aware wrapper for `::fz_new_type3_font()`.
Create a new (empty) type3 font.
name: Name of font (or NULL).
matrix: Font matrix.
Returns a new font handle, or throws exception on
allocation failure.
- fz_new_xhtml_document_from_document(old_doc, opts)
- Class-aware wrapper for `::fz_new_xhtml_document_from_document()`.
Use text extraction to convert the input document into XHTML,
then open the result as a new document that can be reflowed.
- fz_new_xmltext_device(out)
- Class-aware wrapper for `::fz_new_xmltext_device()`.
Create a device to output raw information.
- fz_next_page(doc, loc)
- Class-aware wrapper for `::fz_next_page()`.
Function to get the location of the next page (allowing for the
end of chapters etc). If at the end of the document, returns the
current location.
- fz_normalize_vector(p)
- Class-aware wrapper for `::fz_normalize_vector()`.
Normalize a vector to length one.
- fz_open_a85d(chain)
- Class-aware wrapper for `::fz_open_a85d()`.
a85d filter performs ASCII 85 Decoding of data read
from the chained filter.
- fz_open_accelerated_document(filename, accel)
- Class-aware wrapper for `::fz_open_accelerated_document()`.
Open a document file and read its basic structure so pages and
objects can be located. MuPDF will try to repair broken
documents (without actually changing the file contents).
The returned fz_document is used when calling most other
document related functions.
filename: a path to a file as it would be given to open(2).
- fz_open_accelerated_document_with_stream(magic, stream, accel)
- Class-aware wrapper for `::fz_open_accelerated_document_with_stream()`.
Open a document using the specified stream object rather than
opening a file on disk.
magic: a string used to detect document type; either a file name
or mime-type.
- fz_open_aesd(chain, key, keylen)
- Class-aware wrapper for `::fz_open_aesd()`.
aesd filter performs AES decoding of data read from the chained
filter using the supplied key.
- fz_open_ahxd(chain)
- Class-aware wrapper for `::fz_open_ahxd()`.
ahxd filter performs ASCII Hex decoding of data read
from the chained filter.
- fz_open_arc4(chain, key, keylen)
- Class-aware wrapper for `::fz_open_arc4()`.
arc4 filter performs RC4 decoding of data read from the chained
filter using the supplied key.
- fz_open_archive(filename)
- Class-aware wrapper for `::fz_open_archive()`.
Open a zip or tar archive
Open a file and identify its archive type based on the archive
signature contained inside.
filename: a path to a file as it would be given to open(2).
- fz_open_archive_entry(arch, name)
- Class-aware wrapper for `::fz_open_archive_entry()`.
Opens an archive entry as a stream.
name: Entry name to look for, this must be an exact match to
the entry name in the archive.
Throws an exception if a matching entry cannot be found.
- fz_open_archive_with_stream(file)
- Class-aware wrapper for `::fz_open_archive_with_stream()`.
Open zip or tar archive stream.
Open an archive using a seekable stream object rather than
opening a file or directory on disk.
- fz_open_buffer(buf)
- Class-aware wrapper for `::fz_open_buffer()`.
Open a buffer as a stream.
buf: The buffer to open. Ownership of the buffer is NOT passed
in (this function takes its own reference).
Returns pointer to newly created stream. May throw exceptions on
failure to allocate.
- fz_open_compressed_buffer(arg_0)
- Class-aware wrapper for `::fz_open_compressed_buffer()`.
Open a stream to read the decompressed version of a buffer.
- fz_open_concat(max, pad)
- Class-aware wrapper for `::fz_open_concat()`.
Concat filter concatenates several streams into one.
- fz_open_dctd(chain, color_transform, invert_cmyk, l2factor, jpegtables)
- Class-aware wrapper for `::fz_open_dctd()`.
dctd filter performs DCT (JPEG) decoding of data read
from the chained filter.
color_transform implements the PDF color_transform option
use -1 for default behavior
use 0 to disable YUV-RGB / YCCK-CMYK transforms
use 1 to enable YUV-RGB / YCCK-CMYK transforms
invert_cmyk implements the necessary inversion for Photoshop CMYK images
use 0 if embedded in PDF
use 1 if not embedded in PDF
For subsampling on decode, set l2factor to the log2 of the
reduction required (therefore 0 = full size decode).
jpegtables is an optional stream from which the JPEG tables
can be read. Use NULL if not required.
- fz_open_directory(path)
- Class-aware wrapper for `::fz_open_directory()`.
Open a directory as if it was an archive.
A special case where a directory is opened as if it was an
archive.
Note that for directories it is not possible to retrieve the
number of entries or list the entries. It is however possible
to check if the archive has a particular entry.
path: a path to a directory as it would be given to opendir(3).
- fz_open_document(filename)
- Class-aware wrapper for `::fz_open_document()`.
Open a document file and read its basic structure so pages and
objects can be located. MuPDF will try to repair broken
documents (without actually changing the file contents).
The returned fz_document is used when calling most other
document related functions.
filename: a path to a file as it would be given to open(2).
- fz_open_document_with_buffer(magic, buffer)
- Class-aware wrapper for `::fz_open_document_with_buffer()`.
Open a document using a buffer rather than opening a file on disk.
- fz_open_document_with_stream(magic, stream)
- Class-aware wrapper for `::fz_open_document_with_stream()`.
Open a document using the specified stream object rather than
opening a file on disk.
magic: a string used to detect document type; either a file name
or mime-type.
- fz_open_endstream_filter(chain, len, offset)
- Class-aware wrapper for `::fz_open_endstream_filter()`.
The endstream filter reads a PDF substream, and starts to look
for an 'endstream' token after the specified length.
- fz_open_faxd(chain, k, end_of_line, encoded_byte_align, columns, rows, end_of_block, black_is_1)
- Class-aware wrapper for `::fz_open_faxd()`.
faxd filter performs FAX decoding of data read from
the chained filter.
k: see fax specification (fax default is 0).
end_of_line: whether we expect end of line markers (fax default
is 0).
encoded_byte_align: whether we align to bytes after each line
(fax default is 0).
columns: how many columns in the image (fax default is 1728).
rows: 0 for unspecified or the number of rows of data to expect.
end_of_block: whether we expect end of block markers (fax
default is 1).
black_is_1: determines the polarity of the image (fax default is
0).
- fz_open_file(filename)
- Class-aware wrapper for `::fz_open_file()`.
Open the named file and wrap it in a stream.
filename: Path to a file. On non-Windows machines the filename
should be exactly as it would be passed to fopen(2). On Windows
machines, the path should be UTF-8 encoded so that non-ASCII
characters can be represented. Other platforms do the encoding
as standard anyway (and in most cases, particularly for MacOS
and Linux, the encoding they use is UTF-8 anyway).
- fz_open_file_ptr_no_close(file)
- Class-aware wrapper for `::fz_open_file_ptr_no_close()`.
Create a stream from a FILE * that will not be closed
when the stream is dropped.
- fz_open_flated(chain, window_bits)
- Class-aware wrapper for `::fz_open_flated()`.
flated filter performs LZ77 decoding (inflating) of data read
from the chained filter.
window_bits: How large a decompression window to use. Typically
15. A negative number, -n, means to use n bits, but to expect
raw data with no header.
- fz_open_image_decomp_stream = fz_open_image_decomp_stream_outparams_fn(arg_0, arg_1)
- Class-aware helper for out-params of fz_open_image_decomp_stream() [fz_open_image_decomp_stream()].
- fz_open_image_decomp_stream_from_buffer = fz_open_image_decomp_stream_from_buffer_outparams_fn(arg_0)
- Class-aware helper for out-params of fz_open_image_decomp_stream_from_buffer() [fz_open_image_decomp_stream_from_buffer()].
- fz_open_image_decomp_stream_from_buffer_outparams_fn(arg_0)
- Class-aware helper for out-params of fz_open_image_decomp_stream_from_buffer() [fz_open_image_decomp_stream_from_buffer()].
- fz_open_image_decomp_stream_outparams_fn(arg_0, arg_1)
- Class-aware helper for out-params of fz_open_image_decomp_stream() [fz_open_image_decomp_stream()].
- fz_open_jbig2d(chain, globals, embedded)
- Class-aware wrapper for `::fz_open_jbig2d()`.
Open a filter that performs jbig2 decompression on the chained
stream, using the optional globals record.
- fz_open_leecher(chain, buf)
- Class-aware wrapper for `::fz_open_leecher()`.
Attach a filter to a stream that will store any
characters read from the stream into the supplied buffer.
chain: The underlying stream to leech from.
buf: The buffer into which the read data should be appended.
The buffer will be resized as required.
Returns pointer to newly created stream. May throw exceptions on
failure to allocate.
- fz_open_lzwd(chain, early_change, min_bits, reverse_bits, old_tiff)
- Class-aware wrapper for `::fz_open_lzwd()`.
lzwd filter performs LZW decoding of data read from the chained
filter.
early_change: (Default 1) specifies whether to change codes 1
bit early.
min_bits: (Default 9) specifies the minimum number of bits to
use.
reverse_bits: (Default 0) allows for compatibility with gif and
old style tiffs (1).
old_tiff: (Default 0) allows for different handling of the clear
code, as found in old style tiffs.
- fz_open_memory(data, len)
- Class-aware wrapper for `::fz_open_memory()`.
Open a block of memory as a stream.
data: Pointer to start of data block. Ownership of the data
block is NOT passed in.
len: Number of bytes in data block.
Returns pointer to newly created stream. May throw exceptions on
failure to allocate.
- fz_open_null_filter(chain, len, offset)
- Class-aware wrapper for `::fz_open_null_filter()`.
The null filter reads a specified amount of data from the
substream.
- fz_open_predict(chain, predictor, columns, colors, bpc)
- Class-aware wrapper for `::fz_open_predict()`.
predict filter performs pixel prediction on data read from
the chained filter.
predictor: 1 = copy, 2 = tiff, other = inline PNG predictor
columns: width of image in pixels
colors: number of components.
bpc: bits per component (typically 8)
- fz_open_range_filter(chain, ranges, nranges)
- Class-aware wrapper for `::fz_open_range_filter()`.
The range filter copies data from specified ranges of the
chained stream.
- fz_open_reflowed_document(underdoc, opts)
- Class-aware wrapper for `::fz_open_reflowed_document()`.
- fz_open_rld(chain)
- Class-aware wrapper for `::fz_open_rld()`.
rld filter performs Run Length Decoding of data read
from the chained filter.
- fz_open_sgilog16(chain, w)
- Class-aware wrapper for `::fz_open_sgilog16()`.
SGI Log 16bit (greyscale) decode from the chained filter.
Decodes lines of w pixels to 8bpp greyscale.
- fz_open_sgilog24(chain, w)
- Class-aware wrapper for `::fz_open_sgilog24()`.
SGI Log 24bit (LUV) decode from the chained filter.
Decodes lines of w pixels to 8bpc rgb.
- fz_open_sgilog32(chain, w)
- Class-aware wrapper for `::fz_open_sgilog32()`.
SGI Log 32bit (LUV) decode from the chained filter.
Decodes lines of w pixels to 8bpc rgb.
- fz_open_tar_archive(filename)
- Class-aware wrapper for `::fz_open_tar_archive()`.
Open a tar archive file.
An exception is throw if the file is not a tar archive as
indicated by the presence of a tar signature.
filename: a path to a tar archive file as it would be given to
open(2).
- fz_open_tar_archive_with_stream(file)
- Class-aware wrapper for `::fz_open_tar_archive_with_stream()`.
Open a tar archive stream.
Open an archive using a seekable stream object rather than
opening a file or directory on disk.
An exception is throw if the stream is not a tar archive as
indicated by the presence of a tar signature.
- fz_open_thunder(chain, w)
- Class-aware wrapper for `::fz_open_thunder()`.
4bit greyscale Thunderscan decoding from the chained filter.
Decodes lines of w pixels to 8bpp greyscale.
- fz_open_zip_archive(path)
- Class-aware wrapper for `::fz_open_zip_archive()`.
Open a zip archive file.
An exception is throw if the file is not a zip archive as
indicated by the presence of a zip signature.
filename: a path to a zip archive file as it would be given to
open(2).
- fz_open_zip_archive_with_stream(file)
- Class-aware wrapper for `::fz_open_zip_archive_with_stream()`.
Open a zip archive stream.
Open an archive using a seekable stream object rather than
opening a file or directory on disk.
An exception is throw if the stream is not a zip archive as
indicated by the presence of a zip signature.
- fz_option_eq(a, b)
- Class-aware wrapper for `::fz_option_eq()`.
Check to see if an option, a, from a string matches a reference
option, b.
(i.e. a could be 'foo' or 'foo,bar...' etc, but b can only be
'foo'.)
- fz_outline_glyph(font, gid, ctm)
- Class-aware wrapper for `::fz_outline_glyph()`.
Look a glyph up from a font, and return the outline of the
glyph using the given transform.
The caller owns the returned path, and so is responsible for
ensuring that it eventually gets dropped.
- fz_outline_iterator_delete(iter)
- Class-aware wrapper for `::fz_outline_iterator_delete()`.
Delete the current item.
This implicitly moves us to the 'next' item, and the return code is as for fz_outline_iterator_next.
- fz_outline_iterator_down(iter)
- Class-aware wrapper for `::fz_outline_iterator_down()`.
- fz_outline_iterator_item(iter)
- Class-aware wrapper for `::fz_outline_iterator_item()`.
Call to get the current outline item.
Can return NULL. The item is only valid until the next call.
- fz_outline_iterator_next(iter)
- Class-aware wrapper for `::fz_outline_iterator_next()`.
Calls to move the iterator position.
A negative return value means we could not move as requested. Otherwise:
0 = the final position has a valid item.
1 = not a valid item, but we can insert an item here.
- fz_outline_iterator_prev(iter)
- Class-aware wrapper for `::fz_outline_iterator_prev()`.
- fz_outline_iterator_up(iter)
- Class-aware wrapper for `::fz_outline_iterator_up()`.
- fz_output_accelerator(doc, accel)
- Class-aware wrapper for `::fz_output_accelerator()`.
Output accelerator data for the document to a given output
stream.
- fz_output_supports_stream(out)
- Class-aware wrapper for `::fz_output_supports_stream()`.
Query whether a given fz_output supports fz_stream_from_output.
- fz_pack_path(pack, path)
- Class-aware wrapper for `::fz_pack_path()`.
Pack a path into the given block.
To minimise the size of paths, this function allows them to be
packed into a buffer with other information. Paths can be used
interchangeably regardless of how they are packed.
pack: Pointer to a block of data to pack the path into. Should
be aligned by the caller to the same alignment as required for
a fz_path pointer.
path: The path to pack.
Returns the number of bytes within the block used. Callers can
access the packed path data by casting the value of pack on
entry to be a fz_path *.
Throws exceptions on failure to allocate.
Implementation details: Paths can be 'unpacked', 'flat', or
'open'. Standard paths, as created are 'unpacked'. Paths
will be packed as 'flat', unless they are too large
(where large indicates that they exceed some private
implementation defined limits, currently including having
more than 256 coordinates or commands).
Large paths are 'open' packed as a header into the given block,
plus pointers to other data blocks.
Users should not have to care about whether paths are 'open'
or 'flat' packed. Simply pack a path (if required), and then
forget about the details.
- fz_packed_path_size(path)
- Class-aware wrapper for `::fz_packed_path_size()`.
Return the number of bytes required to pack a path.
- fz_page_label(page, buf, size)
- Class-aware wrapper for `::fz_page_label()`.
Get page label for a given page.
- fz_page_number_from_location(doc, loc)
- Class-aware wrapper for `::fz_page_number_from_location()`.
Converts from chapter+page to page number. This may cause many
chapters to be laid out in order to calculate the number of
pages within those chapters.
- fz_page_presentation = fz_page_presentation_outparams_fn(page, transition)
- Class-aware helper for out-params of fz_page_presentation() [fz_page_presentation()].
- fz_page_presentation_outparams_fn(page, transition)
- Class-aware helper for out-params of fz_page_presentation() [fz_page_presentation()].
- fz_page_separations(page)
- Class-aware wrapper for `::fz_page_separations()`.
Get the separations details for a page.
This will be NULL, unless the format specifically supports
separations (such as PDF files). May be NULL even
so, if there are no separations on a page.
Returns a reference that must be dropped.
- fz_page_uses_overprint(page)
- Class-aware wrapper for `::fz_page_uses_overprint()`.
Query if a given page requires overprint.
- fz_paint_shade = fz_paint_shade_outparams_fn(shade, override_cs, ctm, dest, color_params, bbox, eop)
- Class-aware helper for out-params of fz_paint_shade() [fz_paint_shade()].
- fz_paint_shade_outparams_fn(shade, override_cs, ctm, dest, color_params, bbox, eop)
- Class-aware helper for out-params of fz_paint_shade() [fz_paint_shade()].
- fz_parse_page_range = ll_fz_parse_page_range(s, n)
- fz_parse_page_range_outparams_fn(s, n)
- Class-aware helper for out-params of fz_parse_page_range() [fz_parse_page_range()].
- fz_parse_pdfocr_options(opts, args)
- Class-aware wrapper for `::fz_parse_pdfocr_options()`.
Parse PDFOCR options.
Currently defined options and values are as follows:
compression=none: No compression
compression=flate: Flate compression
strip-height=n: Strip height (default 16)
ocr-language=<lang>: OCR Language (default eng)
ocr-datadir=<datadir>: OCR data path (default rely on TESSDATA_PREFIX)
- fz_parse_stext_options(opts, string)
- Class-aware wrapper for `::fz_parse_stext_options()`.
Parse stext device options from a comma separated key-value
string.
- fz_parse_xml(buf, preserve_white)
- Class-aware wrapper for `::fz_parse_xml()`.
Parse the contents of buffer into a tree of xml nodes.
preserve_white: whether to keep or delete all-whitespace nodes.
- fz_parse_xml_archive_entry(arch, filename, preserve_white)
- Class-aware wrapper for `::fz_parse_xml_archive_entry()`.
Parse the contents of an archive entry into a tree of xml nodes.
preserve_white: whether to keep or delete all-whitespace nodes.
- fz_parse_xml_from_html5(buf)
- Class-aware wrapper for `::fz_parse_xml_from_html5()`.
Parse the contents of a buffer into a tree of XML nodes,
using the HTML5 parsing algorithm.
- fz_parse_xml_stream(stream, preserve_white)
- Class-aware wrapper for `::fz_parse_xml_stream()`.
Parse the contents of buffer into a tree of xml nodes.
preserve_white: whether to keep or delete all-whitespace nodes.
- fz_pcl_preset(opts, preset)
- Class-aware wrapper for `::fz_pcl_preset()`.
Initialize PCL option struct for a given preset.
Currently defined presets include:
generic Generic PCL printer
ljet4 HP DeskJet
dj500 HP DeskJet 500
fs600 Kyocera FS-600
lj HP LaserJet, HP LaserJet Plus
lj2 HP LaserJet IIp, HP LaserJet IId
lj3 HP LaserJet III
lj3d HP LaserJet IIId
lj4 HP LaserJet 4
lj4pl HP LaserJet 4 PL
lj4d HP LaserJet 4d
lp2563b HP 2563B line printer
oce9050 Oce 9050 Line printer
- fz_pdfocr_band_writer_set_progress(writer, progress_fn, progress_arg)
- Class-aware wrapper for `::fz_pdfocr_band_writer_set_progress()`.
Set the progress callback for a pdfocr bandwriter.
- fz_pdfocr_writer_set_progress(writer, progress, arg_2)
- Class-aware wrapper for `::fz_pdfocr_writer_set_progress()`.
- fz_peek_byte(stm)
- Class-aware wrapper for `::fz_peek_byte()`.
Peek at the next byte in a stream.
stm: The stream to peek at.
Returns -1 for EOF, or the next byte that will be read.
- fz_pixmap_alpha(pix)
- Class-aware wrapper for `::fz_pixmap_alpha()`.
Return the number of alpha planes in a pixmap.
Returns the number of alphas. Does not throw exceptions.
- fz_pixmap_bbox(pix)
- Class-aware wrapper for `::fz_pixmap_bbox()`.
Return the bounding box for a pixmap.
- fz_pixmap_colorants(pix)
- Class-aware wrapper for `::fz_pixmap_colorants()`.
Return the number of colorants in a pixmap.
Returns the number of colorants (components, less any spots and
alpha).
- fz_pixmap_colorspace(pix)
- Class-aware wrapper for `::fz_pixmap_colorspace()`.
Return the colorspace of a pixmap
Returns colorspace.
- fz_pixmap_components(pix)
- Class-aware wrapper for `::fz_pixmap_components()`.
Return the number of components in a pixmap.
Returns the number of components (including spots and alpha).
- fz_pixmap_height(pix)
- Class-aware wrapper for `::fz_pixmap_height()`.
Return the height of the pixmap in pixels.
- fz_pixmap_image_tile(cimg)
- Class-aware wrapper for `::fz_pixmap_image_tile()`.
Retrieve the underlying fz_pixmap for an image.
Returns a pointer to the underlying fz_pixmap for an image,
or NULL if this image is not based upon an fz_pixmap.
No reference is returned. Lifespan is limited to that of
the image itself. If required, use fz_keep_pixmap to take
a reference to keep it longer.
- fz_pixmap_samples(pix)
- Class-aware wrapper for `::fz_pixmap_samples()`.
Returns a pointer to the pixel data of a pixmap.
Returns the pointer.
- fz_pixmap_samples_int(pixmap)
- Class-aware wrapper for `::fz_pixmap_samples_int()`.
- fz_pixmap_samples_memoryview(pixmap)
- Returns a writable Python `memoryview` for a `FzPixmap`.
- fz_pixmap_spots(pix)
- Class-aware wrapper for `::fz_pixmap_spots()`.
Return the number of spots in a pixmap.
Returns the number of spots (components, less colorants and
alpha). Does not throw exceptions.
- fz_pixmap_stride(pix)
- Class-aware wrapper for `::fz_pixmap_stride()`.
Return the number of bytes in a row in the pixmap.
- fz_pixmap_width(pix)
- Class-aware wrapper for `::fz_pixmap_width()`.
Return the width of the pixmap in pixels.
- fz_pixmap_x(pix)
- Class-aware wrapper for `::fz_pixmap_x()`.
Return the x value of the pixmap in pixels.
- fz_pixmap_y(pix)
- Class-aware wrapper for `::fz_pixmap_y()`.
Return the y value of the pixmap in pixels.
- fz_place_story(story, where, filled)
- Class-aware wrapper for `::fz_place_story()`.
- fz_pool_alloc(pool, size)
- Class-aware wrapper for `::fz_pool_alloc()`.
Allocate a block of size bytes from the pool.
- fz_pool_size(pool)
- Class-aware wrapper for `::fz_pool_size()`.
The current size of the pool.
The number of bytes of storage currently allocated to the pool.
This is the total of the storage used for the blocks making
up the pool, rather then total of the allocated blocks so far,
so it will increase in 'lumps'.
from the pool, then the pool size may still be X
- fz_pool_strdup(pool, s)
- Class-aware wrapper for `::fz_pool_strdup()`.
strdup equivalent allocating from the pool.
- fz_pop_clip(dev)
- Class-aware wrapper for `::fz_pop_clip()`.
- fz_post_scale(m, sx, sy)
- Class-aware wrapper for `::fz_post_scale()`.
Scale a matrix by postmultiplication.
m: Pointer to the matrix to scale
sx, sy: Scaling factors along the X- and Y-axes. A scaling
factor of 1.0 will not cause any scaling along the relevant
axis.
Returns m (updated).
- fz_pre_rotate(m, degrees)
- Class-aware wrapper for `::fz_pre_rotate()`.
Rotate a transformation by premultiplying.
The premultiplied matrix is of the form
[ cos(deg) sin(deg) -sin(deg) cos(deg) 0 0 ].
m: Pointer to matrix to premultiply.
degrees: Degrees of counter clockwise rotation. Values less
than zero and greater than 360 are handled as expected.
Returns m (updated).
- fz_pre_scale(m, sx, sy)
- Class-aware wrapper for `::fz_pre_scale()`.
Scale a matrix by premultiplication.
m: Pointer to the matrix to scale
sx, sy: Scaling factors along the X- and Y-axes. A scaling
factor of 1.0 will not cause any scaling along the relevant
axis.
Returns m (updated).
- fz_pre_shear(m, sx, sy)
- Class-aware wrapper for `::fz_pre_shear()`.
Premultiply a matrix with a shearing matrix.
The shearing matrix is of the form [ 1 sy sx 1 0 0 ].
m: pointer to matrix to premultiply
sx, sy: Shearing factors. A shearing factor of 0.0 will not
cause any shearing along the relevant axis.
Returns m (updated).
- fz_pre_translate(m, tx, ty)
- Class-aware wrapper for `::fz_pre_translate()`.
Translate a matrix by premultiplication.
m: The matrix to translate
tx, ty: Translation distances along the X- and Y-axes. A
translation of 0 will not cause any translation along the
relevant axis.
Returns m.
- fz_prepare_t3_glyph(font, gid)
- Class-aware wrapper for `::fz_prepare_t3_glyph()`.
Force a type3 font to cache the displaylist for a given glyph
id.
This caching can involve reading the underlying file, so must
happen ahead of time, so we aren't suddenly forced to read the
file while playing a displaylist back.
- fz_previous_page(doc, loc)
- Class-aware wrapper for `::fz_previous_page()`.
Function to get the location of the previous page (allowing for
the end of chapters etc). If already at the start of the
document, returns the current page.
- fz_print_stext_header_as_html(out)
- Class-aware wrapper for `::fz_print_stext_header_as_html()`.
- fz_print_stext_header_as_xhtml(out)
- Class-aware wrapper for `::fz_print_stext_header_as_xhtml()`.
- fz_print_stext_page_as_html(out, page, id)
- Class-aware wrapper for `::fz_print_stext_page_as_html()`.
Output structured text to a file in HTML (visual) format.
- fz_print_stext_page_as_json(out, page, scale)
- Class-aware wrapper for `::fz_print_stext_page_as_json()`.
Output structured text to a file in JSON format.
- fz_print_stext_page_as_text(out, page)
- Class-aware wrapper for `::fz_print_stext_page_as_text()`.
Output structured text to a file in plain-text UTF-8 format.
- fz_print_stext_page_as_xhtml(out, page, id)
- Class-aware wrapper for `::fz_print_stext_page_as_xhtml()`.
Output structured text to a file in XHTML (semantic) format.
- fz_print_stext_page_as_xml(out, page, id)
- Class-aware wrapper for `::fz_print_stext_page_as_xml()`.
Output structured text to a file in XML format.
- fz_print_stext_trailer_as_html(out)
- Class-aware wrapper for `::fz_print_stext_trailer_as_html()`.
- fz_print_stext_trailer_as_xhtml(out)
- Class-aware wrapper for `::fz_print_stext_trailer_as_xhtml()`.
- fz_process_opened_pages(doc, process_openend_page, state)
- Class-aware wrapper for `::fz_process_opened_pages()`.
Iterates over all opened pages of the document, calling the
provided callback for each page for processing. If the callback
returns non-NULL then the iteration stops and that value is returned
to the called of fz_process_opened_pages().
The state pointer provided to fz_process_opened_pages() is
passed on to the callback but is owned by the caller.
Returns the first non-NULL value returned by the callback,
or NULL if the callback returned NULL for all opened pages.
- fz_process_shade(shade, ctm, scissor, prepare, process, process_arg)
- Class-aware wrapper for `::fz_process_shade()`.
Process a shade, using supplied callback functions. This
decomposes the shading to a mesh (even ones that are not
natively meshes, such as linear or radial shadings), and
processes triangles from those meshes.
shade: The shade to process.
ctm: The transform to use
prepare: Callback function to 'prepare' each vertex.
This function is passed an array of floats, and populates
a fz_vertex structure.
process: This function is passed 3 pointers to vertex
structures, and actually performs the processing (typically
filling the area between the vertexes).
process_arg: An opaque argument passed through from caller
to callback functions.
- fz_purge_glyph_cache()
- Class-aware wrapper for `::fz_purge_glyph_cache()`.
Purge all the glyphs from the cache.
- fz_quad_from_rect(r)
- Class-aware wrapper for `::fz_quad_from_rect()`.
Convert a rect to a quad (losslessly).
- fz_quadto(path, x0, y0, x1, y1)
- Class-aware wrapper for `::fz_quadto()`.
Append a 'quadto' command to an open path. (For a
quadratic bezier).
path: The path to modify.
x0, y0: The control coordinates for the quadratic curve.
x1, y1: The end coordinates for the quadratic curve.
Throws exceptions on failure to allocate, or attempting to
modify a packed path.
- fz_read(stm, data, len)
- Class-aware wrapper for `::fz_read()`.
Read from a stream into a given data block.
stm: The stream to read from.
data: The data block to read into.
len: The length of the data block (in bytes).
Returns the number of bytes read. May throw exceptions.
- fz_read_all(stm, initial)
- Class-aware wrapper for `::fz_read_all()`.
Read all of a stream into a buffer.
stm: The stream to read from
initial: Suggested initial size for the buffer.
Returns a buffer created from reading from the stream. May throw
exceptions on failure to allocate.
- fz_read_archive_entry(arch, name)
- Class-aware wrapper for `::fz_read_archive_entry()`.
Reads all bytes in an archive entry
into a buffer.
name: Entry name to look for, this must be an exact match to
the entry name in the archive.
Throws an exception if a matching entry cannot be found.
- fz_read_best = fz_read_best_outparams_fn(stm, initial, worst_case)
- Class-aware helper for out-params of fz_read_best() [fz_read_best()].
- fz_read_best_outparams_fn(stm, initial, worst_case)
- Class-aware helper for out-params of fz_read_best() [fz_read_best()].
- fz_read_bits(stm, n)
- Class-aware wrapper for `::fz_read_bits()`.
Read the next n bits from a stream (assumed to
be packed most significant bit first).
stm: The stream to read from.
n: The number of bits to read, between 1 and 8*sizeof(int)
inclusive.
Returns -1 for EOF, or the required number of bits.
- fz_read_byte(stm)
- Class-aware wrapper for `::fz_read_byte()`.
Read the next byte from a stream.
stm: The stream t read from.
Returns -1 for end of stream, or the next byte. May
throw exceptions.
- fz_read_file(filename)
- Class-aware wrapper for `::fz_read_file()`.
Read all the contents of a file into a buffer.
- fz_read_float(stm)
- Class-aware wrapper for `::fz_read_float()`.
- fz_read_float_le(stm)
- Class-aware wrapper for `::fz_read_float_le()`.
- fz_read_int16(stm)
- Class-aware wrapper for `::fz_read_int16()`.
- fz_read_int16_le(stm)
- Class-aware wrapper for `::fz_read_int16_le()`.
- fz_read_int32(stm)
- Class-aware wrapper for `::fz_read_int32()`.
- fz_read_int32_le(stm)
- Class-aware wrapper for `::fz_read_int32_le()`.
- fz_read_int64(stm)
- Class-aware wrapper for `::fz_read_int64()`.
- fz_read_int64_le(stm)
- Class-aware wrapper for `::fz_read_int64_le()`.
- fz_read_line(stm, buf, max)
- Class-aware wrapper for `::fz_read_line()`.
Read a line from stream into the buffer until either a
terminating newline or EOF, which it replaces with a null byte
('').
Returns buf on success, and NULL when end of file occurs while
no characters have been read.
- fz_read_rbits(stm, n)
- Class-aware wrapper for `::fz_read_rbits()`.
Read the next n bits from a stream (assumed to
be packed least significant bit first).
stm: The stream to read from.
n: The number of bits to read, between 1 and 8*sizeof(int)
inclusive.
Returns (unsigned int)-1 for EOF, or the required number of bits.
- fz_read_string(stm, buffer, len)
- Class-aware wrapper for `::fz_read_string()`.
Read a null terminated string from the stream into
a buffer of a given length. The buffer will be null terminated.
Throws on failure (including the failure to fit the entire
string including the terminator into the buffer).
- fz_read_uint16(stm)
- Class-aware wrapper for `::fz_read_uint16()`.
fz_read_[u]int(16|24|32|64)(_le)?
Read a 16/32/64 bit signed/unsigned integer from stream,
in big or little-endian byte orders.
Throws an exception if EOF is encountered.
- fz_read_uint16_le(stm)
- Class-aware wrapper for `::fz_read_uint16_le()`.
- fz_read_uint24(stm)
- Class-aware wrapper for `::fz_read_uint24()`.
- fz_read_uint24_le(stm)
- Class-aware wrapper for `::fz_read_uint24_le()`.
- fz_read_uint32(stm)
- Class-aware wrapper for `::fz_read_uint32()`.
- fz_read_uint32_le(stm)
- Class-aware wrapper for `::fz_read_uint32_le()`.
- fz_read_uint64(stm)
- Class-aware wrapper for `::fz_read_uint64()`.
- fz_read_uint64_le(stm)
- Class-aware wrapper for `::fz_read_uint64_le()`.
- fz_realloc(p, size)
- Class-aware wrapper for `::fz_realloc()`.
Reallocates a block of memory to given size. Existing contents
up to min(old_size,new_size) are maintained. The rest of the
block is uninitialised.
fz_realloc(ctx, NULL, size) behaves like fz_malloc(ctx, size).
fz_realloc(ctx, p, 0); behaves like fz_free(ctx, p).
Throws exception in the event of failure to allocate.
- fz_realloc_no_throw(p, size)
- Class-aware wrapper for `::fz_realloc_no_throw()`.
fz_realloc equivalent that returns NULL rather than throwing
exceptions.
- fz_realpath(path, resolved_path)
- Class-aware wrapper for `::fz_realpath()`.
Resolve a path to an absolute file name.
The resolved path buffer must be of at least PATH_MAX size.
- fz_recognize_image_format(p)
- Class-aware wrapper for `::fz_recognize_image_format()`.
Recognise image format strings in the first 8 bytes from image
data.
- fz_rect_from_irect(bbox)
- Class-aware wrapper for `::fz_rect_from_irect()`.
Convert a bbox into a rect.
For our purposes, a rect can represent all the values we meet in
a bbox, so nothing can go wrong.
rect: A place to store the generated rectangle.
bbox: The bbox to convert.
Returns rect (updated).
- fz_rect_from_quad(q)
- Class-aware wrapper for `::fz_rect_from_quad()`.
Convert a quad to the smallest rect that covers it.
- fz_rectto(path, x0, y0, x1, y1)
- Class-aware wrapper for `::fz_rectto()`.
Append a 'rectto' command to an open path.
The rectangle is equivalent to:
moveto x0 y0
lineto x1 y0
lineto x1 y1
lineto x0 y1
closepath
path: The path to modify.
x0, y0: First corner of the rectangle.
x1, y1: Second corner of the rectangle.
Throws exceptions on failure to allocate, or attempting to
modify a packed path.
- fz_register_document_handler(handler)
- Class-aware wrapper for `::fz_register_document_handler()`.
Register a handler for a document type.
handler: The handler to register.
- fz_register_document_handlers()
- Class-aware wrapper for `::fz_register_document_handlers()`.
Register handlers
for all the standard document types supported in
this build.
- fz_remove_item(drop, key, type)
- Class-aware wrapper for `::fz_remove_item()`.
Remove an item from the store.
If an item indexed by the given key exists in the store, remove
it.
drop: The function used to free the value (to ensure we get a
value of the correct type).
key: The key used to find the item to remove.
type: Functions used to manipulate the key.
- fz_render_flags(dev, set, clear)
- Class-aware wrapper for `::fz_render_flags()`.
- fz_render_glyph_pixmap(font, gid, ctm, scissor, aa)
- Class-aware wrapper for `::fz_render_glyph_pixmap()`.
Create a pixmap containing a rendered glyph.
Lookup gid from font, clip it with scissor, and rendering it
with aa bits of antialiasing into a new pixmap.
The caller takes ownership of the pixmap and so must free it.
Note: This function is no longer used for normal rendering
operations, and is kept around just because we use it in the
app. It should be considered "at risk" of removal from the API.
- fz_render_t3_glyph_direct(dev, font, gid, trm, gstate, def_cs)
- Class-aware wrapper for `::fz_render_t3_glyph_direct()`.
Nasty PDF interpreter specific hernia, required to allow the
interpreter to replay glyphs from a type3 font directly into
the target device.
This is only used in exceptional circumstances (such as type3
glyphs that inherit current graphics state, or nested type3
glyphs).
- fz_rendering_intent_name(ri)
- Class-aware wrapper for `::fz_rendering_intent_name()`.
Map from enumerated rendering intent to string.
The returned string is static and therefore must not be freed.
- fz_reset_story(story)
- Class-aware wrapper for `::fz_reset_story()`.
- fz_resize_buffer(buf, capacity)
- Class-aware wrapper for `::fz_resize_buffer()`.
Ensure that a buffer has a given capacity,
truncating data if required.
capacity: The desired capacity for the buffer. If the current
size of the buffer contents is smaller than capacity, it is
truncated.
- fz_resolve_link = fz_resolve_link_outparams_fn(doc, uri)
- Class-aware helper for out-params of fz_resolve_link() [fz_resolve_link()].
- fz_resolve_link_outparams_fn(doc, uri)
- Class-aware helper for out-params of fz_resolve_link() [fz_resolve_link()].
- fz_rethrow()
- Class-aware wrapper for `::fz_rethrow()`.
- fz_rethrow_if(errcode)
- Class-aware wrapper for `::fz_rethrow_if()`.
Within an fz_catch() block, rethrow the current exception
if the errcode of the current exception matches.
This assumes no intervening use of fz_try/fz_catch.
- fz_rotate(degrees)
- Class-aware wrapper for `::fz_rotate()`.
Create a rotation matrix.
The returned matrix is of the form
[ cos(deg) sin(deg) -sin(deg) cos(deg) 0 0 ].
m: Pointer to place to store matrix
degrees: Degrees of counter clockwise rotation. Values less
than zero and greater than 360 are handled as expected.
Returns m.
- fz_round_rect(rect)
- Class-aware wrapper for `::fz_round_rect()`.
Round rectangle coordinates.
Coordinates in a bounding box are integers, so rounding of the
rects coordinates takes place. The top left corner is rounded
upwards and left while the bottom right corner is rounded
downwards and to the right.
This differs from fz_irect_from_rect, in that fz_irect_from_rect
slavishly follows the numbers (i.e any slight over/under
calculations can cause whole extra pixels to be added).
fz_round_rect allows for a small amount of rounding error when
calculating the bbox.
- fz_run_display_list(list, dev, ctm, scissor, cookie)
- Class-aware wrapper for `::fz_run_display_list()`.
(Re)-run a display list through a device.
list: A display list, created by fz_new_display_list and
populated with objects from a page by running fz_run_page on a
device obtained from fz_new_list_device.
ctm: Transform to apply to display list contents. May include
for example scaling and rotation, see fz_scale, fz_rotate and
fz_concat. Set to fz_identity if no transformation is desired.
scissor: Only the part of the contents of the display list
visible within this area will be considered when the list is
run through the device. This does not imply for tile objects
contained in the display list.
cookie: Communication mechanism between caller and library
running the page. Intended for multi-threaded applications,
while single-threaded applications set cookie to NULL. The
caller may abort an ongoing page run. Cookie also communicates
progress information back to the caller. The fields inside
cookie are continually updated while the page is being run.
- fz_run_page(page, dev, transform, cookie)
- Class-aware wrapper for `::fz_run_page()`.
Run a page through a device.
page: Page obtained from fz_load_page.
dev: Device obtained from fz_new_*_device.
transform: Transform to apply to page. May include for example
scaling and rotation, see fz_scale, fz_rotate and fz_concat.
Set to fz_identity if no transformation is desired.
cookie: Communication mechanism between caller and library
rendering the page. Intended for multi-threaded applications,
while single-threaded applications set cookie to NULL. The
caller may abort an ongoing rendering of a page. Cookie also
communicates progress information back to the caller. The
fields inside cookie are continually updated while the page is
rendering.
- fz_run_page_annots(page, dev, transform, cookie)
- Class-aware wrapper for `::fz_run_page_annots()`.
Run the annotations on a page through a device.
- fz_run_page_contents(page, dev, transform, cookie)
- Class-aware wrapper for `::fz_run_page_contents()`.
Run a page through a device. Just the main
page content, without the annotations, if any.
page: Page obtained from fz_load_page.
dev: Device obtained from fz_new_*_device.
transform: Transform to apply to page. May include for example
scaling and rotation, see fz_scale, fz_rotate and fz_concat.
Set to fz_identity if no transformation is desired.
cookie: Communication mechanism between caller and library
rendering the page. Intended for multi-threaded applications,
while single-threaded applications set cookie to NULL. The
caller may abort an ongoing rendering of a page. Cookie also
communicates progress information back to the caller. The
fields inside cookie are continually updated while the page is
rendering.
- fz_run_page_widgets(page, dev, transform, cookie)
- Class-aware wrapper for `::fz_run_page_widgets()`.
Run the widgets on a page through a device.
- fz_run_t3_glyph(font, gid, trm, dev)
- Class-aware wrapper for `::fz_run_t3_glyph()`.
Run a glyph from a Type3 font to
a given device.
font: The font to find the glyph in.
gid: The glyph to run.
trm: The transform to apply.
dev: The device to render onto.
- fz_runeidx(str, p)
- Class-aware wrapper for `::fz_runeidx()`.
Compute the index of a rune in a string.
str: Pointer to beginning of a string.
p: Pointer to a char in str.
Returns the index of the rune pointed to by p in str.
- fz_runelen(rune)
- Class-aware wrapper for `::fz_runelen()`.
Count how many chars are required to represent a rune.
rune: The rune to encode.
Returns the number of bytes required to represent this run in
UTF8.
- fz_runeptr(str, idx)
- Class-aware wrapper for `::fz_runeptr()`.
Obtain a pointer to the char representing the rune
at a given index.
str: Pointer to beginning of a string.
idx: Index of a rune to return a char pointer to.
Returns a pointer to the char where the desired rune starts,
or NULL if the string ends before the index is reached.
- fz_runetochar(str, rune)
- Class-aware wrapper for `::fz_runetochar()`.
UTF8 encode a rune to a sequence of chars.
str: Pointer to a place to put the UTF8 encoded character.
rune: Pointer to a 'rune'.
Returns the number of bytes the rune took to output.
- fz_runetochar2(rune)
- fz_samples_get(pixmap, offset)
- Class-aware wrapper for `::fz_samples_get()`.
Provides simple (but slow) access to pixmap data from Python and C#.
- fz_samples_set(pixmap, offset, value)
- Class-aware wrapper for `::fz_samples_set()`.
Provides simple (but slow) write access to pixmap data from Python and
C#.
- fz_save_accelerator(doc, accel)
- Class-aware wrapper for `::fz_save_accelerator()`.
Save accelerator data for the document to a given file.
- fz_save_bitmap_as_pbm(bitmap, filename)
- Class-aware wrapper for `::fz_save_bitmap_as_pbm()`.
Save a bitmap as a pbm.
- fz_save_bitmap_as_pcl(bitmap, filename, append, pcl)
- Class-aware wrapper for `::fz_save_bitmap_as_pcl()`.
Save a bitmap as mono PCL.
- fz_save_bitmap_as_pkm(bitmap, filename)
- Class-aware wrapper for `::fz_save_bitmap_as_pkm()`.
Save a CMYK bitmap as a pkm.
- fz_save_bitmap_as_pwg(bitmap, filename, append, pwg)
- Class-aware wrapper for `::fz_save_bitmap_as_pwg()`.
Save a bitmap as a PWG.
- fz_save_buffer(buf, filename)
- Class-aware wrapper for `::fz_save_buffer()`.
Save the contents of a buffer to a file.
- fz_save_pixmap_as_jpeg(pixmap, filename, quality)
- Class-aware wrapper for `::fz_save_pixmap_as_jpeg()`.
Save a pixmap as a JPEG.
- fz_save_pixmap_as_pam(pixmap, filename)
- Class-aware wrapper for `::fz_save_pixmap_as_pam()`.
Save a pixmap as a pnm (greyscale, rgb or cmyk, with or without
alpha).
- fz_save_pixmap_as_pbm(pixmap, filename)
- Class-aware wrapper for `::fz_save_pixmap_as_pbm()`.
Save a pixmap as a pbm. (Performing halftoning).
- fz_save_pixmap_as_pcl(pixmap, filename, append, pcl)
- Class-aware wrapper for `::fz_save_pixmap_as_pcl()`.
Save an (RGB) pixmap as color PCL.
- fz_save_pixmap_as_pclm(pixmap, filename, append, options)
- Class-aware wrapper for `::fz_save_pixmap_as_pclm()`.
Save a (Greyscale or RGB) pixmap as pclm.
- fz_save_pixmap_as_pdfocr(pixmap, filename, append, options)
- Class-aware wrapper for `::fz_save_pixmap_as_pdfocr()`.
Save a (Greyscale or RGB) pixmap as pdfocr.
- fz_save_pixmap_as_pkm(pixmap, filename)
- Class-aware wrapper for `::fz_save_pixmap_as_pkm()`.
Save a CMYK pixmap as a pkm. (Performing halftoning).
- fz_save_pixmap_as_png(pixmap, filename)
- Class-aware wrapper for `::fz_save_pixmap_as_png()`.
Save a (Greyscale or RGB) pixmap as a png.
- fz_save_pixmap_as_pnm(pixmap, filename)
- Class-aware wrapper for `::fz_save_pixmap_as_pnm()`.
Save a pixmap as a pnm (greyscale or rgb, no alpha).
- fz_save_pixmap_as_ps(pixmap, filename, append)
- Class-aware wrapper for `::fz_save_pixmap_as_ps()`.
Save a (gray, rgb, or cmyk, no alpha) pixmap out as postscript.
- fz_save_pixmap_as_psd(pixmap, filename)
- Class-aware wrapper for `::fz_save_pixmap_as_psd()`.
Save a pixmap as a PSD file.
- fz_save_pixmap_as_pwg(pixmap, filename, append, pwg)
- Class-aware wrapper for `::fz_save_pixmap_as_pwg()`.
Save a pixmap as a PWG.
- fz_scale(sx, sy)
- Class-aware wrapper for `::fz_scale()`.
Create a scaling matrix.
The returned matrix is of the form [ sx 0 0 sy 0 0 ].
m: Pointer to the matrix to populate
sx, sy: Scaling factors along the X- and Y-axes. A scaling
factor of 1.0 will not cause any scaling along the relevant
axis.
Returns m.
- fz_search_chapter_page_number = fz_search_chapter_page_number_outparams_fn(doc, chapter, page, needle, hit_bbox, hit_max)
- Class-aware helper for out-params of fz_search_chapter_page_number() [fz_search_chapter_page_number()].
- fz_search_chapter_page_number_outparams_fn(doc, chapter, page, needle, hit_bbox, hit_max)
- Class-aware helper for out-params of fz_search_chapter_page_number() [fz_search_chapter_page_number()].
- fz_search_display_list = fz_search_display_list_outparams_fn(list, needle, hit_bbox, hit_max)
- Class-aware helper for out-params of fz_search_display_list() [fz_search_display_list()].
- fz_search_display_list_outparams_fn(list, needle, hit_bbox, hit_max)
- Class-aware helper for out-params of fz_search_display_list() [fz_search_display_list()].
- fz_search_page = fz_search_page_outparams_fn(page, needle, hit_bbox, hit_max)
- Class-aware helper for out-params of fz_search_page() [fz_search_page()].
- fz_search_page2(doc, number, needle, hit_max)
- Class-aware wrapper for `::fz_search_page2()`.
C++ alternative to fz_search_page() that returns information in a std::vector.
- fz_search_page_number = fz_search_page_number_outparams_fn(doc, number, needle, hit_bbox, hit_max)
- Class-aware helper for out-params of fz_search_page_number() [fz_search_page_number()].
- fz_search_page_number_outparams_fn(doc, number, needle, hit_bbox, hit_max)
- Class-aware helper for out-params of fz_search_page_number() [fz_search_page_number()].
- fz_search_page_outparams_fn(page, needle, hit_bbox, hit_max)
- Class-aware helper for out-params of fz_search_page() [fz_search_page()].
- fz_search_stext_page = fz_search_stext_page_outparams_fn(text, needle, hit_bbox, hit_max)
- Class-aware helper for out-params of fz_search_stext_page() [fz_search_stext_page()].
- fz_search_stext_page_outparams_fn(text, needle, hit_bbox, hit_max)
- Class-aware helper for out-params of fz_search_stext_page() [fz_search_stext_page()].
- fz_seek(stm, offset, whence)
- Class-aware wrapper for `::fz_seek()`.
Seek within a stream.
stm: The stream to seek within.
offset: The offset to seek to.
whence: From where the offset is measured (see fseek).
SEEK_SET - start of stream.
SEEK_CUR - current position.
SEEK_END - end of stream.
- fz_seek_output(out, off, whence)
- Class-aware wrapper for `::fz_seek_output()`.
Seek to the specified file position.
See fseek for arguments.
Throw an error on unseekable outputs.
- fz_separation_current_behavior(sep, separation)
- Class-aware wrapper for `::fz_separation_current_behavior()`.
Test for the current behavior of a separation.
- fz_separation_equivalent = fz_separation_equivalent_outparams_fn(seps, idx, dst_cs, prf, color_params)
- Class-aware helper for out-params of fz_separation_equivalent() [fz_separation_equivalent()].
- fz_separation_equivalent_outparams_fn(seps, idx, dst_cs, prf, color_params)
- Class-aware helper for out-params of fz_separation_equivalent() [fz_separation_equivalent()].
- fz_separation_name(sep, separation)
- Class-aware wrapper for `::fz_separation_name()`.
- fz_set_aa_level(bits)
- Class-aware wrapper for `::fz_set_aa_level()`.
Set the number of bits of antialiasing we should
use (for both text and graphics).
bits: The number of bits of antialiasing to use (values are
clamped to within the 0 to 8 range).
- fz_set_compressed_image_buffer(cimg, buf)
- Class-aware wrapper for `::fz_set_compressed_image_buffer()`.
- fz_set_default_cmyk(default_cs, cs)
- Class-aware wrapper for `::fz_set_default_cmyk()`.
- fz_set_default_colorspaces(dev, default_cs)
- Class-aware wrapper for `::fz_set_default_colorspaces()`.
- fz_set_default_gray(default_cs, cs)
- Class-aware wrapper for `::fz_set_default_gray()`.
Set new defaults within the default colorspace structure.
New references are taken to the new default, and references to
the old defaults dropped.
Never throws exceptions.
- fz_set_default_output_intent(default_cs, cs)
- Class-aware wrapper for `::fz_set_default_output_intent()`.
- fz_set_default_rgb(default_cs, cs)
- Class-aware wrapper for `::fz_set_default_rgb()`.
- fz_set_error_callback(printfn)
- fz_set_font_bbox(font, xmin, ymin, xmax, ymax)
- Class-aware wrapper for `::fz_set_font_bbox()`.
Set the font bbox.
font: The font to set the bbox for.
xmin, ymin, xmax, ymax: The bounding box.
- fz_set_font_embedding(font, embed)
- Class-aware wrapper for `::fz_set_font_embedding()`.
Control whether a given font should be embedded or not when writing.
- fz_set_graphics_aa_level(bits)
- Class-aware wrapper for `::fz_set_graphics_aa_level()`.
Set the number of bits of antialiasing we
should use for graphics.
bits: The number of bits of antialiasing to use (values are
clamped to within the 0 to 8 range).
- fz_set_graphics_min_line_width(min_line_width)
- Class-aware wrapper for `::fz_set_graphics_min_line_width()`.
Set the minimum line width to be
used for stroked lines.
min_line_width: The minimum line width to use (in pixels).
- fz_set_link_rect(link, rect)
- Class-aware wrapper for `::fz_set_link_rect()`.
- fz_set_link_uri(link, uri)
- Class-aware wrapper for `::fz_set_link_uri()`.
- fz_set_metadata(doc, key, value)
- Class-aware wrapper for `::fz_set_metadata()`.
- fz_set_pixmap_image_tile(cimg, pix)
- Class-aware wrapper for `::fz_set_pixmap_image_tile()`.
- fz_set_pixmap_resolution(pix, xres, yres)
- Class-aware wrapper for `::fz_set_pixmap_resolution()`.
Set the pixels per inch resolution of the pixmap.
- fz_set_separation_behavior(sep, separation, behavior)
- Class-aware wrapper for `::fz_set_separation_behavior()`.
Control the rendering of a given separation.
- fz_set_stddbg(out)
- Class-aware wrapper for `::fz_set_stddbg()`.
Set the output stream to be used for fz_stddbg. Set to NULL to
reset to default (stderr).
- fz_set_text_aa_level(bits)
- Class-aware wrapper for `::fz_set_text_aa_level()`.
Set the number of bits of antialiasing we
should use for text.
bits: The number of bits of antialiasing to use (values are
clamped to within the 0 to 8 range).
- fz_set_use_document_css(use)
- Class-aware wrapper for `::fz_set_use_document_css()`.
Toggle whether to respect document styles in HTML and EPUB.
- fz_set_user_context(user)
- Class-aware wrapper for `::fz_set_user_context()`.
Set the user field in the context.
NULL initially, this field can be set to any opaque value
required by the user. It is copied on clones.
- fz_set_user_css(text)
- Class-aware wrapper for `::fz_set_user_css()`.
Set the user stylesheet source text for use with HTML and EPUB.
- fz_set_warning_callback(printfn)
- fz_sha256_final(state, digest)
- Class-aware wrapper for `::fz_sha256_final()`.
MD5 finalization. Ends an MD5 message-digest operation, writing
the message digest and zeroizing the context.
Never throws an exception.
- fz_sha256_init(state)
- Class-aware wrapper for `::fz_sha256_init()`.
SHA256 initialization. Begins an SHA256 operation, initialising
the supplied context.
Never throws an exception.
- fz_sha256_update(state, input, inlen)
- Class-aware wrapper for `::fz_sha256_update()`.
SHA256 block update operation. Continues an SHA256 message-
digest operation, processing another message block, and updating
the context.
Never throws an exception.
- fz_sha384_final(state, digest)
- Class-aware wrapper for `::fz_sha384_final()`.
SHA384 finalization. Ends an SHA384 message-digest operation,
writing the message digest and zeroizing the context.
Never throws an exception.
- fz_sha384_init(state)
- Class-aware wrapper for `::fz_sha384_init()`.
SHA384 initialization. Begins an SHA384 operation, initialising
the supplied context.
Never throws an exception.
- fz_sha384_update(state, input, inlen)
- Class-aware wrapper for `::fz_sha384_update()`.
SHA384 block update operation. Continues an SHA384 message-
digest operation, processing another message block, and updating
the context.
Never throws an exception.
- fz_sha512_final(state, digest)
- Class-aware wrapper for `::fz_sha512_final()`.
SHA512 finalization. Ends an SHA512 message-digest operation,
writing the message digest and zeroizing the context.
Never throws an exception.
- fz_sha512_init(state)
- Class-aware wrapper for `::fz_sha512_init()`.
SHA512 initialization. Begins an SHA512 operation, initialising
the supplied context.
Never throws an exception.
- fz_sha512_update(state, input, inlen)
- Class-aware wrapper for `::fz_sha512_update()`.
SHA512 block update operation. Continues an SHA512 message-
digest operation, processing another message block, and updating
the context.
Never throws an exception.
- fz_shear(sx, sy)
- Class-aware wrapper for `::fz_shear()`.
Create a shearing matrix.
The returned matrix is of the form [ 1 sy sx 1 0 0 ].
m: pointer to place to store returned matrix
sx, sy: Shearing factors. A shearing factor of 0.0 will not
cause any shearing along the relevant axis.
Returns m.
- fz_show_glyph(text, font, trm, glyph, unicode, wmode, bidi_level, markup_dir, language)
- Class-aware wrapper for `::fz_show_glyph()`.
Add a glyph/unicode value to a text object.
text: Text object to add to.
font: The font the glyph should be added in.
trm: The transform to use for the glyph.
glyph: The glyph id to add.
unicode: The unicode character for the glyph.
wmode: 1 for vertical mode, 0 for horizontal.
bidi_level: The bidirectional level for this glyph.
markup_dir: The direction of the text as specified in the
markup.
language: The language in use (if known, 0 otherwise)
(e.g. FZ_LANG_zh_Hans).
Throws exception on failure to allocate.
- fz_show_string(text, font, trm, s, wmode, bidi_level, markup_dir, language)
- Class-aware wrapper for `::fz_show_string()`.
Add a UTF8 string to a text object.
text: Text object to add to.
font: The font the string should be added in.
trm: The transform to use.
s: The utf-8 string to add.
wmode: 1 for vertical mode, 0 for horizontal.
bidi_level: The bidirectional level for this glyph.
markup_dir: The direction of the text as specified in the markup.
language: The language in use (if known, 0 otherwise)
(e.g. FZ_LANG_zh_Hans).
Returns the transform updated with the advance width of the
string.
- fz_shrink_store(percent)
- Class-aware wrapper for `::fz_shrink_store()`.
Evict items from the store until the total size of
the objects in the store is reduced to a given percentage of its
current size.
percent: %age of current size to reduce the store to.
Returns non zero if we managed to free enough memory, zero
otherwise.
- fz_skip(stm, len)
- Class-aware wrapper for `::fz_skip()`.
Read from a stream discarding data.
stm: The stream to read from.
len: The number of bytes to read.
Returns the number of bytes read. May throw exceptions.
- fz_skip_space(stm)
- Class-aware wrapper for `::fz_skip_space()`.
Skip over whitespace (bytes <= 32) in a stream.
- fz_skip_string(stm, str)
- Class-aware wrapper for `::fz_skip_string()`.
Skip over a given string in a stream. Return 0 if successfully
skipped, non-zero otherwise. As many characters will be skipped
over as matched in the string.
- fz_slice_buffer(buf, start, end)
- Class-aware wrapper for `::fz_slice_buffer()`.
Create a new buffer with a (subset of) the data from the buffer.
start: if >= 0, offset from start of buffer, if < 0 offset from end of buffer.
end: if >= 0, offset from start of buffer, if < 0 offset from end of buffer.
- fz_snap_selection(page, ap, bp, mode)
- Class-aware wrapper for `::fz_snap_selection()`.
- fz_start_throw_on_repair()
- Class-aware wrapper for `::fz_start_throw_on_repair()`.
- fz_stat_ctime(path)
- Class-aware wrapper for `::fz_stat_ctime()`.
- fz_stat_mtime(path)
- Class-aware wrapper for `::fz_stat_mtime()`.
- fz_store_item(key, val, itemsize, type)
- Class-aware wrapper for `::fz_store_item()`.
Add an item to the store.
Add an item into the store, returning NULL for success. If an
item with the same key is found in the store, then our item will
not be inserted, and the function will return a pointer to that
value instead. This function takes its own reference to val, as
required (i.e. the caller maintains ownership of its own
reference).
key: The key used to index the item.
val: The value to store.
itemsize: The size in bytes of the value (as counted towards the
store size).
type: Functions used to manipulate the key.
- fz_store_scavenge = fz_store_scavenge_outparams_fn(size)
- Class-aware helper for out-params of fz_store_scavenge() [fz_store_scavenge()].
- fz_store_scavenge_external = fz_store_scavenge_external_outparams_fn(size)
- Class-aware helper for out-params of fz_store_scavenge_external() [fz_store_scavenge_external()].
- fz_store_scavenge_external_outparams_fn(size)
- Class-aware helper for out-params of fz_store_scavenge_external() [fz_store_scavenge_external()].
- fz_store_scavenge_outparams_fn(size)
- Class-aware helper for out-params of fz_store_scavenge() [fz_store_scavenge()].
- fz_story_document(story)
- Class-aware wrapper for `::fz_story_document()`.
- fz_story_positions(story, python_callback)
- fz_story_warnings(story)
- Class-aware wrapper for `::fz_story_warnings()`.
- fz_strcasecmp(a, b)
- Class-aware wrapper for `::fz_strcasecmp()`.
Case insensitive (ASCII only) string comparison.
- fz_strdup(s)
- Class-aware wrapper for `::fz_strdup()`.
Portable strdup implementation, using fz allocators.
- fz_stream_from_output(arg_0)
- Class-aware wrapper for `::fz_stream_from_output()`.
Obtain the fz_output in the form of a fz_stream.
This allows data to be read back from some forms of fz_output
object. When finished reading, the fz_stream should be released
by calling fz_drop_stream. Until the fz_stream is dropped, no
further operations should be performed on the fz_output object.
- fz_string_from_box_type(box)
- Class-aware wrapper for `::fz_string_from_box_type()`.
- fz_string_from_buffer(buf)
- Class-aware wrapper for `::fz_string_from_buffer()`.
Ensure that a buffer's data ends in a
0 byte, and return a pointer to it.
- fz_string_from_text_language(str, lang)
- Class-aware wrapper for `::fz_string_from_text_language()`.
Recover ISO 639 (639-{1,2,3,5}) language specification
strings losslessly from a 15 bit fz_text_language code.
No validation is carried out. See note above.
- fz_strlcat(dst, src, n)
- Class-aware wrapper for `::fz_strlcat()`.
Concatenate 2 strings, with a maximum length.
dst: pointer to first string in a buffer of n bytes.
src: pointer to string to concatenate.
n: Size (in bytes) of buffer that dst is in.
Returns the real length that a concatenated dst + src would have
been (not including terminator).
- fz_strlcpy(dst, src, n)
- Class-aware wrapper for `::fz_strlcpy()`.
Copy at most n-1 chars of a string into a destination
buffer with null termination, returning the real length of the
initial string (excluding terminator).
dst: Destination buffer, at least n bytes long.
src: C string (non-NULL).
n: Size of dst buffer in bytes.
Returns the length (excluding terminator) of src.
- fz_strncasecmp(a, b, n)
- Class-aware wrapper for `::fz_strncasecmp()`.
- fz_strnlen(s, maxlen)
- Class-aware wrapper for `::fz_strnlen()`.
Return strlen(s), if that is less than maxlen, or maxlen if
there is no null byte ('') among the first maxlen bytes.
- fz_stroke_path(dev, path, stroke, ctm, colorspace, color, alpha, color_params)
- Class-aware wrapper for `::fz_stroke_path()`.
- fz_stroke_text(dev, text, stroke, ctm, colorspace, color, alpha, color_params)
- Class-aware wrapper for `::fz_stroke_text()`.
- fz_strsep = fz_strsep_outparams_fn(delim)
- Class-aware helper for out-params of fz_strsep() [fz_strsep()].
- fz_strsep_outparams_fn(delim)
- Class-aware helper for out-params of fz_strsep() [fz_strsep()].
- fz_strtof = fz_strtof_outparams_fn(s)
- Class-aware helper for out-params of fz_strtof() [fz_strtof()].
- fz_strtof_outparams_fn(s)
- Class-aware helper for out-params of fz_strtof() [fz_strtof()].
- fz_structure_from_string(str)
- Class-aware wrapper for `::fz_structure_from_string()`.
- fz_structure_to_string(type)
- Class-aware wrapper for `::fz_structure_to_string()`.
- fz_subpixel_adjust(ctm, subpix_ctm, qe, qf)
- Class-aware wrapper for `::fz_subpixel_adjust()`.
Perform subpixel quantisation and adjustment on a glyph matrix.
ctm: On entry, the desired 'ideal' transformation for a glyph.
On exit, adjusted to a (very similar) transformation quantised
for subpixel caching.
subpix_ctm: Initialised by the routine to the transform that
should be used to render the glyph.
qe, qf: which subpixel position we quantised to.
Returns: the size of the glyph.
Note: This is currently only exposed for use in our app. It
should be considered "at risk" of removal from the API.
- fz_sync_bits(stm)
- Class-aware wrapper for `::fz_sync_bits()`.
Called after reading bits to tell the stream
that we are about to return to reading bytewise. Resyncs
the stream to whole byte boundaries.
- fz_tell(stm)
- Class-aware wrapper for `::fz_tell()`.
return the current reading position within a stream
- fz_tell_output(out)
- Class-aware wrapper for `::fz_tell_output()`.
Return the current file position.
Throw an error on untellable outputs.
- fz_terminate_buffer(buf)
- Class-aware wrapper for `::fz_terminate_buffer()`.
Zero-terminate buffer in order to use as a C string.
This byte is invisible and does not affect the length of the
buffer as returned by fz_buffer_storage. The zero byte is
written *after* the data, and subsequent writes will overwrite
the terminating byte.
Subsequent changes to the size of the buffer (such as by
fz_buffer_trim, fz_buffer_grow, fz_resize_buffer, etc) may
invalidate this.
- fz_text_aa_level()
- Class-aware wrapper for `::fz_text_aa_level()`.
Get the number of bits of antialiasing we are
using for text. Between 0 and 8.
- fz_text_language_from_string(str)
- Class-aware wrapper for `::fz_text_language_from_string()`.
Convert ISO 639 (639-{1,2,3,5}) language specification
strings losslessly to a 15 bit fz_text_language code.
No validation is carried out. Obviously invalid (out
of spec) codes will be mapped to FZ_LANG_UNSET, but
well-formed (but undefined) codes will be blithely
accepted.
- fz_tint_pixmap(pix, black, white)
- Class-aware wrapper for `::fz_tint_pixmap()`.
Tint all the pixels in an RGB, BGR, or Gray pixmap.
black: Map black to this hexadecimal RGB color.
white: Map white to this hexadecimal RGB color.
- fz_tolower(c)
- Class-aware wrapper for `::fz_tolower()`.
Unicode aware tolower and toupper functions.
- fz_toupper(c)
- Class-aware wrapper for `::fz_toupper()`.
- fz_transform_page(mediabox, resolution, rotate)
- Class-aware wrapper for `::fz_transform_page()`.
Create transform matrix to draw page
at a given resolution and rotation. Adjusts the scaling
factors so that the page covers whole number of
pixels and adjust the page origin to be at 0,0.
- fz_transform_path(path, transform)
- Class-aware wrapper for `::fz_transform_path()`.
Transform a path by a given
matrix.
path: The path to modify (must not be a packed path).
transform: The transform to apply.
Throws exceptions if the path is packed, or on failure
to allocate.
- fz_transform_point(point, m)
- Class-aware wrapper for `::fz_transform_point()`.
Apply a transformation to a point.
transform: Transformation matrix to apply. See fz_concat,
fz_scale, fz_rotate and fz_translate for how to create a
matrix.
point: Pointer to point to update.
Returns transform (unchanged).
- fz_transform_point_xy(x, y, m)
- Class-aware wrapper for `::fz_transform_point_xy()`.
- fz_transform_quad(q, m)
- Class-aware wrapper for `::fz_transform_quad()`.
Transform a quad by a matrix.
- fz_transform_rect(rect, m)
- Class-aware wrapper for `::fz_transform_rect()`.
Apply a transform to a rectangle.
After the four corner points of the axis-aligned rectangle
have been transformed it may not longer be axis-aligned. So a
new axis-aligned rectangle is created covering at least the
area of the transformed rectangle.
transform: Transformation matrix to apply. See fz_concat,
fz_scale and fz_rotate for how to create a matrix.
rect: Rectangle to be transformed. The two special cases
fz_empty_rect and fz_infinite_rect, may be used but are
returned unchanged as expected.
- fz_transform_vector(vector, m)
- Class-aware wrapper for `::fz_transform_vector()`.
Apply a transformation to a vector.
transform: Transformation matrix to apply. See fz_concat,
fz_scale and fz_rotate for how to create a matrix. Any
translation will be ignored.
vector: Pointer to vector to update.
- fz_translate(tx, ty)
- Class-aware wrapper for `::fz_translate()`.
Create a translation matrix.
The returned matrix is of the form [ 1 0 0 1 tx ty ].
m: A place to store the created matrix.
tx, ty: Translation distances along the X- and Y-axes. A
translation of 0 will not cause any translation along the
relevant axis.
Returns m.
- fz_translate_irect(a, xoff, yoff)
- Class-aware wrapper for `::fz_translate_irect()`.
- fz_translate_rect(a, xoff, yoff)
- Class-aware wrapper for `::fz_translate_rect()`.
Translate bounding box.
Translate a bbox by a given x and y offset. Allows for overflow.
- fz_tree_archive_add_buffer(arch_, name, buf)
- Class-aware wrapper for `::fz_tree_archive_add_buffer()`.
Add a named buffer to an existing tree archive.
The tree will take a new reference to the buffer. Ownership
is not transferred.
- fz_tree_archive_add_data(arch_, name, data, size)
- Class-aware wrapper for `::fz_tree_archive_add_data()`.
Add a named block of data to an existing tree archive.
The data will be copied into a buffer, and so the caller
may free it as soon as this returns.
- fz_tree_lookup(node, key)
- Class-aware wrapper for `::fz_tree_lookup()`.
Look for the value of a node in the tree with the given key.
Simple pointer equivalence is used for key.
Returns NULL for no match.
- fz_trim_buffer(buf)
- Class-aware wrapper for `::fz_trim_buffer()`.
Trim wasted capacity from a buffer by resizing internal memory.
- fz_trim_path(path)
- Class-aware wrapper for `::fz_trim_path()`.
Minimise the internal storage used by a path.
As paths are constructed, the internal buffers
grow. To avoid repeated reallocations they
grow with some spare space. Once a path has
been fully constructed, this call allows the
excess space to be trimmed.
- fz_truncate_output(arg_0)
- Class-aware wrapper for `::fz_truncate_output()`.
Truncate the output at the current position.
This allows output streams which have seeked back from the end
of their storage to be truncated at the current point.
- fz_try_invert_matrix(inv, src)
- Class-aware wrapper for `::fz_try_invert_matrix()`.
Attempt to create an inverse matrix.
inverse: Place to store inverse matrix.
matrix: Matrix to invert. A degenerate matrix, where the
determinant is equal to zero, can not be inverted.
Returns 1 if matrix is degenerate (singular), or 0 otherwise.
- fz_try_open_archive_entry(arch, name)
- Class-aware wrapper for `::fz_try_open_archive_entry()`.
Opens an archive entry as a stream.
Returns NULL if a matching entry cannot be found, otherwise
behaves exactly as fz_open_archive_entry.
- fz_try_open_archive_with_stream(file)
- Class-aware wrapper for `::fz_try_open_archive_with_stream()`.
Open zip or tar archive stream.
Does the same as fz_open_archive_with_stream, but will not throw
an error in the event of failing to recognise the format. Will
still throw errors in other cases though!
- fz_try_open_file(name)
- Class-aware wrapper for `::fz_try_open_file()`.
Open the named file and wrap it in a stream.
Does the same as fz_open_file, but in the event the file
does not open, it will return NULL rather than throw an
exception.
- fz_try_parse_xml_archive_entry(arch, filename, preserve_white)
- Class-aware wrapper for `::fz_try_parse_xml_archive_entry()`.
Try and parse the contents of an archive entry into a tree of xml nodes.
preserve_white: whether to keep or delete all-whitespace nodes.
Will return NULL if the archive entry can't be found. Otherwise behaves
the same as fz_parse_xml_archive_entry. May throw exceptions.
- fz_try_read_archive_entry(arch, name)
- Class-aware wrapper for `::fz_try_read_archive_entry()`.
Reads all bytes in an archive entry
into a buffer.
name: Entry name to look for, this must be an exact match to
the entry name in the archive.
Returns NULL if a matching entry cannot be found. Otherwise behaves
the same as fz_read_archive_entry. Exceptions may be thrown.
- fz_try_read_file(filename)
- Class-aware wrapper for `::fz_try_read_file()`.
Read all the contents of a file into a buffer.
Returns NULL if the file does not exist, otherwise
behaves exactly as fz_read_file.
- fz_tune_image_decode(image_decode, arg)
- Class-aware wrapper for `::fz_tune_image_decode()`.
Set the tuning function to use for
image decode.
image_decode: Function to use.
arg: Opaque argument to be passed to tuning function.
- fz_tune_image_scale(image_scale, arg)
- Class-aware wrapper for `::fz_tune_image_scale()`.
Set the tuning function to use for
image scaling.
image_scale: Function to use.
arg: Opaque argument to be passed to tuning function.
- fz_unicode_from_glyph_name(name)
- Class-aware wrapper for `::fz_unicode_from_glyph_name()`.
- fz_unicode_from_glyph_name_strict(name)
- Class-aware wrapper for `::fz_unicode_from_glyph_name_strict()`.
- fz_union_rect(a, b)
- Class-aware wrapper for `::fz_union_rect()`.
Compute union of two rectangles.
Given two rectangles, update the first to be the smallest
axis-aligned rectangle that encompasses both given rectangles.
If either rectangle is infinite then the union is also infinite.
If either rectangle is empty then the union is simply the
non-empty rectangle. Should both rectangles be empty, then the
union is also empty.
- fz_unlock(lock)
- Class-aware wrapper for `::fz_unlock()`.
Unlock one of the user supplied mutexes.
- fz_unpack_stream(src, depth, w, h, n, indexed, pad, skip)
- Class-aware wrapper for `::fz_unpack_stream()`.
- fz_unread_byte(stm)
- Class-aware wrapper for `::fz_unread_byte()`.
Unread the single last byte successfully
read from a stream. Do not call this without having
successfully read a byte.
stm: The stream to operate upon.
- fz_unshare_stroke_state(shared)
- Class-aware wrapper for `::fz_unshare_stroke_state()`.
Given a reference to a (possibly) shared stroke_state structure,
return a reference to an equivalent stroke_state structure
that is guaranteed to be unshared (i.e. one that can
safely be modified).
shared: The reference to a (possibly) shared structure
to unshare. Ownership of this reference is passed in
to this function, even in the case of exceptions being
thrown.
Exceptions may be thrown in the event of failure to
allocate if required.
- fz_unshare_stroke_state_with_dash_len(shared, len)
- Class-aware wrapper for `::fz_unshare_stroke_state_with_dash_len()`.
Given a reference to a (possibly) shared stroke_state structure,
return a reference to a stroke_state structure (with room for a
given amount of dash data) that is guaranteed to be unshared
(i.e. one that can safely be modified).
shared: The reference to a (possibly) shared structure
to unshare. Ownership of this reference is passed in
to this function, even in the case of exceptions being
thrown.
Exceptions may be thrown in the event of failure to
allocate if required.
- fz_urldecode(url)
- Class-aware wrapper for `::fz_urldecode()`.
Like fz_decode_uri_component but in-place.
- fz_use_document_css()
- Class-aware wrapper for `::fz_use_document_css()`.
Return whether to respect document styles in HTML and EPUB.
- fz_user_context()
- Class-aware wrapper for `::fz_user_context()`.
Read the user field from the context.
- fz_user_css()
- Class-aware wrapper for `::fz_user_css()`.
Get the user stylesheet source text.
- fz_utflen(s)
- Class-aware wrapper for `::fz_utflen()`.
Count how many runes the UTF-8 encoded string
consists of.
s: The UTF-8 encoded, NUL-terminated text string.
Returns the number of runes in the string.
- fz_var_imp(arg_0)
- Class-aware wrapper for `::fz_var_imp()`.
- fz_walk_path(path, walker, arg)
- Class-aware wrapper for `::fz_walk_path()`.
Walk the segments of a path, calling the
appropriate callback function from a given set for each
segment of the path.
path: The path to walk.
walker: The set of callback functions to use. The first
4 callback pointers in the set must be non-NULL. The
subsequent ones can either be supplied, or can be left
as NULL, in which case the top 4 functions will be
called as appropriate to simulate them.
arg: An opaque argument passed in to each callback.
Exceptions will only be thrown if the underlying callback
functions throw them.
- fz_warn = ll_fz_warn(text)
- fz_warning_callback = fz_warning_callback_outparams_fn()
- Class-aware helper for out-params of fz_warning_callback() [fz_warning_callback()].
- fz_warning_callback_outparams_fn()
- Class-aware helper for out-params of fz_warning_callback() [fz_warning_callback()].
- fz_warp_pixmap(src, points, width, height)
- Class-aware wrapper for `::fz_warp_pixmap()`.
- fz_windows_1250_from_unicode(u)
- Class-aware wrapper for `::fz_windows_1250_from_unicode()`.
- fz_windows_1251_from_unicode(u)
- Class-aware wrapper for `::fz_windows_1251_from_unicode()`.
- fz_windows_1252_from_unicode(u)
- Class-aware wrapper for `::fz_windows_1252_from_unicode()`.
- fz_write_band(writer, stride, band_height, samples)
- Class-aware wrapper for `::fz_write_band()`.
Cause a band writer to write the next band
of data for an image.
stride: The byte offset from the first byte of the data
for a pixel to the first byte of the data for the same pixel
on the row below.
band_height: The number of lines in this band.
samples: Pointer to first byte of the data.
- fz_write_base64(out, data, size, newline)
- Class-aware wrapper for `::fz_write_base64()`.
Write a base64 encoded data block, optionally with periodic
newlines.
- fz_write_base64_buffer(out, data, newline)
- Class-aware wrapper for `::fz_write_base64_buffer()`.
Write a base64 encoded fz_buffer, optionally with periodic
newlines.
- fz_write_bitmap_as_pbm(out, bitmap)
- Class-aware wrapper for `::fz_write_bitmap_as_pbm()`.
Write a bitmap as a pbm.
- fz_write_bitmap_as_pcl(out, bitmap, pcl)
- Class-aware wrapper for `::fz_write_bitmap_as_pcl()`.
Write a bitmap as mono PCL.
- fz_write_bitmap_as_pkm(out, bitmap)
- Class-aware wrapper for `::fz_write_bitmap_as_pkm()`.
Write a CMYK bitmap as a pkm.
- fz_write_bitmap_as_pwg(out, bitmap, pwg)
- Class-aware wrapper for `::fz_write_bitmap_as_pwg()`.
Write a bitmap as a PWG.
- fz_write_bitmap_as_pwg_page(out, bitmap, pwg)
- Class-aware wrapper for `::fz_write_bitmap_as_pwg_page()`.
Write a bitmap as a PWG page.
Caller should provide a file header by calling
fz_write_pwg_file_header, but can then write several pages to
the same file.
- fz_write_bits(out, data, num_bits)
- Class-aware wrapper for `::fz_write_bits()`.
Write num_bits of data to the end of the output stream, assumed to be packed
most significant bits first.
- fz_write_bits_sync(out)
- Class-aware wrapper for `::fz_write_bits_sync()`.
Sync to byte boundary after writing bits.
- fz_write_buffer(out, data)
- Class-aware wrapper for `::fz_write_buffer()`.
- fz_write_byte(out, x)
- Class-aware wrapper for `::fz_write_byte()`.
- fz_write_char(out, x)
- Class-aware wrapper for `::fz_write_char()`.
- fz_write_data(out, data, size)
- Class-aware wrapper for `::fz_write_data()`.
Write data to output.
data: Pointer to data to write.
size: Size of data to write in bytes.
- fz_write_document(wri, doc)
- Class-aware wrapper for `::fz_write_document()`.
Convenience function to feed all the pages of a document to
fz_begin_page/fz_run_page/fz_end_page.
- fz_write_float_be(out, f)
- Class-aware wrapper for `::fz_write_float_be()`.
- fz_write_float_le(out, f)
- Class-aware wrapper for `::fz_write_float_le()`.
- fz_write_header(writer, w, h, n, alpha, xres, yres, pagenum, cs, seps)
- Class-aware wrapper for `::fz_write_header()`.
Cause a band writer to write the header for
a banded image with the given properties/dimensions etc. This
also configures the bandwriter for the format of the data to be
passed in future calls.
w, h: Width and Height of the entire page.
n: Number of components (including spots and alphas).
alpha: Number of alpha components.
xres, yres: X and Y resolutions in dpi.
cs: Colorspace (NULL for bitmaps)
seps: Separation details (or NULL).
- fz_write_image_as_data_uri(out, image)
- Class-aware wrapper for `::fz_write_image_as_data_uri()`.
Write image as a data URI (for HTML and SVG output).
- fz_write_int16_be(out, x)
- Class-aware wrapper for `::fz_write_int16_be()`.
- fz_write_int16_le(out, x)
- Class-aware wrapper for `::fz_write_int16_le()`.
- fz_write_int32_be(out, x)
- Class-aware wrapper for `::fz_write_int32_be()`.
Write different sized data to an output stream.
- fz_write_int32_le(out, x)
- Class-aware wrapper for `::fz_write_int32_le()`.
- fz_write_pixmap_as_data_uri(out, pixmap)
- Class-aware wrapper for `::fz_write_pixmap_as_data_uri()`.
- fz_write_pixmap_as_pam(out, pixmap)
- Class-aware wrapper for `::fz_write_pixmap_as_pam()`.
Write a pixmap as a pnm (greyscale, rgb or cmyk, with or without
alpha).
- fz_write_pixmap_as_pcl(out, pixmap, pcl)
- Class-aware wrapper for `::fz_write_pixmap_as_pcl()`.
Write an (RGB) pixmap as color PCL.
- fz_write_pixmap_as_pclm(out, pixmap, options)
- Class-aware wrapper for `::fz_write_pixmap_as_pclm()`.
Write a (Greyscale or RGB) pixmap as pclm.
- fz_write_pixmap_as_pdfocr(out, pixmap, options)
- Class-aware wrapper for `::fz_write_pixmap_as_pdfocr()`.
Write a (Greyscale or RGB) pixmap as pdfocr.
- fz_write_pixmap_as_png(out, pixmap)
- Class-aware wrapper for `::fz_write_pixmap_as_png()`.
Write a (Greyscale or RGB) pixmap as a png.
- fz_write_pixmap_as_pnm(out, pixmap)
- Class-aware wrapper for `::fz_write_pixmap_as_pnm()`.
Write a pixmap as a pnm (greyscale or rgb, no alpha).
- fz_write_pixmap_as_ps(out, pixmap)
- Class-aware wrapper for `::fz_write_pixmap_as_ps()`.
Write a (gray, rgb, or cmyk, no alpha) pixmap out as postscript.
- fz_write_pixmap_as_psd(out, pixmap)
- Class-aware wrapper for `::fz_write_pixmap_as_psd()`.
Write a pixmap as a PSD file.
- fz_write_pixmap_as_pwg(out, pixmap, pwg)
- Class-aware wrapper for `::fz_write_pixmap_as_pwg()`.
Write a pixmap as a PWG.
- fz_write_pixmap_as_pwg_page(out, pixmap, pwg)
- Class-aware wrapper for `::fz_write_pixmap_as_pwg_page()`.
Write a pixmap as a PWG page.
Caller should provide a file header by calling
fz_write_pwg_file_header, but can then write several pages to
the same file.
- fz_write_ps_file_header(out)
- Class-aware wrapper for `::fz_write_ps_file_header()`.
Write the file level header for ps band writer output.
- fz_write_ps_file_trailer(out, pages)
- Class-aware wrapper for `::fz_write_ps_file_trailer()`.
Write the file level trailer for ps band writer output.
- fz_write_pwg_file_header(out)
- Class-aware wrapper for `::fz_write_pwg_file_header()`.
Output the file header to a pwg stream, ready for pages to follow it.
- fz_write_rune(out, rune)
- Class-aware wrapper for `::fz_write_rune()`.
Write a UTF-8 encoded unicode character.
- fz_write_stabilized_story(writer, user_css, em, contentfn, contentfn_ref, rectfn, rectfn_ref, pagefn, pagefn_ref, archive)
- Class-aware wrapper for `::fz_write_stabilized_story()`.
- fz_write_story(writer, story, rectfn, rectfn_ref, positionfn, positionfn_ref, pagefn, pagefn_ref)
- Class-aware wrapper for `::fz_write_story()`.
- fz_write_string(out, s)
- Class-aware wrapper for `::fz_write_string()`.
Write a string. Does not write zero terminator.
- fz_write_uint16_be(out, x)
- Class-aware wrapper for `::fz_write_uint16_be()`.
- fz_write_uint16_le(out, x)
- Class-aware wrapper for `::fz_write_uint16_le()`.
- fz_write_uint32_be(out, x)
- Class-aware wrapper for `::fz_write_uint32_be()`.
- fz_write_uint32_le(out, x)
- Class-aware wrapper for `::fz_write_uint32_le()`.
- fz_write_zip_entry(zip, name, buf, compress)
- Class-aware wrapper for `::fz_write_zip_entry()`.
Given a buffer of data, (optionally) compress it, and add it to
the zip file with the given name.
- fz_xml_add_att(pool, node, key, val)
- Class-aware wrapper for `::fz_xml_add_att()`.
Add an attribute to an XML node.
- fz_xml_att(item, att)
- Class-aware wrapper for `::fz_xml_att()`.
Return the value of an attribute of an XML node.
NULL if the attribute doesn't exist.
- fz_xml_att_alt(item, one, two)
- Class-aware wrapper for `::fz_xml_att_alt()`.
Return the value of an attribute of an XML node.
If the first attribute doesn't exist, try the second.
NULL if neither attribute exists.
- fz_xml_att_eq(item, name, match)
- Class-aware wrapper for `::fz_xml_att_eq()`.
Check for a matching attribute on an XML node.
If the node has the requested attribute (name), and the value
matches (match) then return 1. Otherwise, 0.
- fz_xml_down(item)
- Class-aware wrapper for `::fz_xml_down()`.
Return first child of XML node.
- fz_xml_find(item, tag)
- Class-aware wrapper for `::fz_xml_find()`.
Search the siblings of XML nodes starting with item looking for
the first with the given tag.
Return NULL if none found.
- fz_xml_find_dfs(item, tag, att, match)
- Class-aware wrapper for `::fz_xml_find_dfs()`.
Perform a depth first search from item, returning the first
child that matches the given tag (or any tag if tag is NULL),
with the given attribute (if att is non NULL), that matches
match (if match is non NULL).
- fz_xml_find_dfs_top(item, tag, att, match, top)
- Class-aware wrapper for `::fz_xml_find_dfs_top()`.
Perform a depth first search from item, returning the first
child that matches the given tag (or any tag if tag is NULL),
with the given attribute (if att is non NULL), that matches
match (if match is non NULL). The search stops if it ever
reaches the top of the tree, or the declared 'top' item.
- fz_xml_find_down(item, tag)
- Class-aware wrapper for `::fz_xml_find_down()`.
Search the siblings of XML nodes starting with the first child
of item looking for the first with the given tag.
Return NULL if none found.
- fz_xml_find_down_match(item, tag, att, match)
- Class-aware wrapper for `::fz_xml_find_down_match()`.
Search the siblings of XML nodes starting with the first child
of item looking for the first with the given tag (or any tag if
tag is NULL), and with a matching attribute.
Return NULL if none found.
- fz_xml_find_match(item, tag, att, match)
- Class-aware wrapper for `::fz_xml_find_match()`.
Search the siblings of XML nodes starting with item looking for
the first with the given tag (or any tag if tag is NULL), and
with a matching attribute.
Return NULL if none found.
- fz_xml_find_next(item, tag)
- Class-aware wrapper for `::fz_xml_find_next()`.
Search the siblings of XML nodes starting with the first sibling
of item looking for the first with the given tag.
Return NULL if none found.
- fz_xml_find_next_dfs(item, tag, att, match)
- Class-aware wrapper for `::fz_xml_find_next_dfs()`.
Perform a depth first search onwards from item, returning the first
child that matches the given tag (or any tag if tag is NULL),
with the given attribute (if att is non NULL), that matches
match (if match is non NULL).
- fz_xml_find_next_dfs_top(item, tag, att, match, top)
- Class-aware wrapper for `::fz_xml_find_next_dfs_top()`.
Perform a depth first search onwards from item, returning the first
child that matches the given tag (or any tag if tag is NULL),
with the given attribute (if att is non NULL), that matches
match (if match is non NULL). The search stops if it ever reaches
the top of the tree, or the declared 'top' item.
- fz_xml_find_next_match(item, tag, att, match)
- Class-aware wrapper for `::fz_xml_find_next_match()`.
Search the siblings of XML nodes starting with the first sibling
of item looking for the first with the given tag (or any tag if tag
is NULL), and with a matching attribute.
Return NULL if none found.
- fz_xml_is_tag(item, name)
- Class-aware wrapper for `::fz_xml_is_tag()`.
Return true if the tag name matches.
- fz_xml_next(item)
- Class-aware wrapper for `::fz_xml_next()`.
Return next sibling of XML node.
- fz_xml_prev(item)
- Class-aware wrapper for `::fz_xml_prev()`.
Return previous sibling of XML node.
- fz_xml_root(xml)
- Class-aware wrapper for `::fz_xml_root()`.
Return the topmost XML node of a document.
- fz_xml_tag(item)
- Class-aware wrapper for `::fz_xml_tag()`.
Return tag of XML node. Return NULL for text nodes.
- fz_xml_text(item)
- Class-aware wrapper for `::fz_xml_text()`.
Return the text content of an XML node.
Return NULL if the node is a tag.
- fz_xml_up(item)
- Class-aware wrapper for `::fz_xml_up()`.
Return parent of XML node.
- internal_context_get()
- Internal use only. Returns `fz_context*` for use by current thread.
- internal_env_flag(name)
- Internal use only. Looks at environmental variable <name>; returns 0 if unset else int value.
- internal_env_flag_check_unset(if_, name)
- Internal use only. Looks at environmental variable <name>; returns 0 if unset else int value.
- internal_throw_exception(ctx)
- Throw exception appropriate for error in `ctx`.
- ll_fz_aa_level()
- Low-level wrapper for `::fz_aa_level()`.
Get the number of bits of antialiasing we are
using (for graphics). Between 0 and 8.
- ll_fz_abs(f)
- Low-level wrapper for `::fz_abs()`.
Some standard math functions, done as static inlines for speed.
People with compilers that do not adequately implement inline
may like to reimplement these using macros.
- ll_fz_absi(i)
- Low-level wrapper for `::fz_absi()`.
- ll_fz_add_layout_char(block, x, w, p)
- Low-level wrapper for `::fz_add_layout_char()`.
Add a new char to the line at the end of the layout block.
- ll_fz_add_layout_line(block, x, y, h, p)
- Low-level wrapper for `::fz_add_layout_line()`.
Add a new line to the end of the layout block.
- ll_fz_add_separation(sep, name, cs, cs_channel)
- Low-level wrapper for `::fz_add_separation()`.
Add a separation (null terminated name, colorspace)
- ll_fz_add_separation_equivalents(sep, rgba, cmyk, name)
- Low-level wrapper for `::fz_add_separation_equivalents()`.
Add a separation with equivalents (null terminated name,
colorspace)
(old, deprecated)
- ll_fz_adjust_rect_for_stroke(rect, stroke, ctm)
- Low-level wrapper for `::fz_adjust_rect_for_stroke()`.
Given a rectangle (assumed to be the bounding box for a path),
expand it to allow for the expansion of the bbox that would be
seen by stroking the path with the given stroke state and
transform.
- ll_fz_advance_glyph(font, glyph, wmode)
- Low-level wrapper for `::fz_advance_glyph()`.
Return the advance for a given glyph.
font: The font to look for the glyph in.
glyph: The glyph to find the advance for.
wmode: 1 for vertical mode, 0 for horizontal.
Returns the advance for the glyph.
- ll_fz_aes_crypt_cbc(ctx, mode, length, iv, input, output)
- Low-level wrapper for `::fz_aes_crypt_cbc()`.
AES block processing. Encrypts or Decrypts (according to mode,
which must match what was initially set up) length bytes (which
must be a multiple of 16), using (and modifying) the insertion
vector iv, reading from input, and writing to output.
Never throws an exception.
- ll_fz_aes_setkey_dec(ctx, key, keysize)
- Low-level wrapper for `::fz_aes_setkey_dec()`.
AES decryption intialisation. Fills in the supplied context
and prepares for decryption using the given key.
Returns non-zero for error (key size other than 128/192/256).
Never throws an exception.
- ll_fz_aes_setkey_enc(ctx, key, keysize)
- Low-level wrapper for `::fz_aes_setkey_enc()`.
AES encryption intialisation. Fills in the supplied context
and prepares for encryption using the given key.
Returns non-zero for error (key size other than 128/192/256).
Never throws an exception.
- ll_fz_alpha_from_gray(gray)
- Low-level wrapper for `::fz_alpha_from_gray()`.
- ll_fz_append_base64(out, data, size, newline)
- Low-level wrapper for `::fz_append_base64()`.
Write a base64 encoded data block, optionally with periodic newlines.
- ll_fz_append_base64_buffer(out, data, newline)
- Low-level wrapper for `::fz_append_base64_buffer()`.
Append a base64 encoded fz_buffer, optionally with periodic newlines.
- ll_fz_append_bits(buf, value, count)
- Low-level wrapper for `::fz_append_bits()`.
- ll_fz_append_bits_pad(buf)
- Low-level wrapper for `::fz_append_bits_pad()`.
- ll_fz_append_buffer(destination, source)
- Low-level wrapper for `::fz_append_buffer()`.
Append the contents of the source buffer onto the end of the
destination buffer, extending automatically as required.
Ownership of buffers does not change.
- ll_fz_append_byte(buf, c)
- Low-level wrapper for `::fz_append_byte()`.
- ll_fz_append_data(buf, data, len)
- Low-level wrapper for `::fz_append_data()`.
fz_append_*: Append data to a buffer.
The buffer will automatically grow as required.
- ll_fz_append_image_as_data_uri(out, image)
- Low-level wrapper for `::fz_append_image_as_data_uri()`.
- ll_fz_append_int16_be(buf, x)
- Low-level wrapper for `::fz_append_int16_be()`.
- ll_fz_append_int16_le(buf, x)
- Low-level wrapper for `::fz_append_int16_le()`.
- ll_fz_append_int32_be(buf, x)
- Low-level wrapper for `::fz_append_int32_be()`.
- ll_fz_append_int32_le(buf, x)
- Low-level wrapper for `::fz_append_int32_le()`.
- ll_fz_append_pdf_string(buffer, text)
- Low-level wrapper for `::fz_append_pdf_string()`.
fz_append_pdf_string: Append a string with PDF syntax quotes and
escapes.
The buffer will automatically grow as required.
- ll_fz_append_pixmap_as_data_uri(out, pixmap)
- Low-level wrapper for `::fz_append_pixmap_as_data_uri()`.
- ll_fz_append_rune(buf, c)
- Low-level wrapper for `::fz_append_rune()`.
- ll_fz_append_string(buf, data)
- Low-level wrapper for `::fz_append_string()`.
- ll_fz_arc4_encrypt(state, dest, src, len)
- Low-level wrapper for `::fz_arc4_encrypt()`.
RC4 block encrypt operation; encrypt src into dst (both of
length len) updating the RC4 state as we go.
Never throws an exception.
- ll_fz_arc4_final(state)
- Low-level wrapper for `::fz_arc4_final()`.
RC4 finalization. Zero the context.
Never throws an exception.
- ll_fz_arc4_init(state, key, len)
- Low-level wrapper for `::fz_arc4_init()`.
RC4 initialization. Begins an RC4 operation, writing a new
context.
Never throws an exception.
- ll_fz_archive_format(arch)
- Low-level wrapper for `::fz_archive_format()`.
Return a pointer to a string describing the format of the
archive.
The lifetime of the string is unspecified (in current
implementations the string will persist until the archive
is closed, but this is not guaranteed).
- ll_fz_atof(s)
- Low-level wrapper for `::fz_atof()`.
Range checking atof
- ll_fz_atoi(s)
- Low-level wrapper for `::fz_atoi()`.
atoi that copes with NULL
- ll_fz_atoi64(s)
- Low-level wrapper for `::fz_atoi64()`.
64bit atoi that copes with NULL
- ll_fz_authenticate_password(doc, password)
- Low-level wrapper for `::fz_authenticate_password()`.
Test if the given password can decrypt the document.
password: The password string to be checked. Some document
specifications do not specify any particular text encoding, so
neither do we.
Returns 0 for failure to authenticate, non-zero for success.
For PDF documents, further information can be given by examining
the bits in the return code.
Bit 0 => No password required
Bit 1 => User password authenticated
Bit 2 => Owner password authenticated
- ll_fz_available(stm, max)
- Low-level wrapper for `::fz_available()`.
Ask how many bytes are available immediately from
a given stream.
stm: The stream to read from.
max: A hint for the underlying stream; the maximum number of
bytes that we are sure we will want to read. If you do not know
this number, give 1.
Returns the number of bytes immediately available between the
read and write pointers. This number is guaranteed only to be 0
if we have hit EOF. The number of bytes returned here need have
no relation to max (could be larger, could be smaller).
- ll_fz_base_colorspace(cs)
- Low-level wrapper for `::fz_base_colorspace()`.
Get the 'base' colorspace for a colorspace.
For indexed colorspaces, this is the colorspace the index
decodes into. For all other colorspaces, it is the colorspace
itself.
The returned colorspace is 'borrowed' (i.e. no additional
references are taken or dropped).
- ll_fz_basename(path)
- Low-level wrapper for `::fz_basename()`.
Find the filename component in a path.
- ll_fz_begin_group(dev, area, cs, isolated, knockout, blendmode, alpha)
- Low-level wrapper for `::fz_begin_group()`.
- ll_fz_begin_layer(dev, layer_name)
- Low-level wrapper for `::fz_begin_layer()`.
- ll_fz_begin_mask(dev, area, luminosity, colorspace, bc, color_params)
- Low-level wrapper for `::fz_begin_mask()`.
- ll_fz_begin_metatext(dev, meta, text)
- Low-level wrapper for `::fz_begin_metatext()`.
- ll_fz_begin_page(wri, mediabox)
- Low-level wrapper for `::fz_begin_page()`.
Called to start the process of writing a page to
a document.
mediabox: page size rectangle in points.
Returns a borrowed fz_device to write page contents to. This
should be kept if required, and only dropped if it was kept.
- ll_fz_begin_structure(dev, standard, raw, uid)
- Low-level wrapper for `::fz_begin_structure()`.
- ll_fz_begin_tile(dev, area, view, xstep, ystep, ctm)
- Low-level wrapper for `::fz_begin_tile()`.
- ll_fz_begin_tile_id(dev, area, view, xstep, ystep, ctm, id)
- Low-level wrapper for `::fz_begin_tile_id()`.
- ll_fz_bidi_fragment_text(text, textlen, callback, arg, flags)
- Wrapper for out-params of fz_bidi_fragment_text().
Returns: ::fz_bidi_direction baseDir
- ll_fz_bidi_fragment_text_outparams_fn(text, textlen, callback, arg, flags, outparams)
- ll_fz_bitmap_details(bitmap)
- Wrapper for out-params of fz_bitmap_details().
Returns: int w, int h, int n, int stride
- ll_fz_bitmap_details_outparams_fn(bitmap, outparams)
- ll_fz_blendmode_name(blendmode)
- Low-level wrapper for `::fz_blendmode_name()`.
Map from enumeration to blend mode string.
The string is static, with arbitrary lifespan.
- ll_fz_bound_display_list(list)
- Low-level wrapper for `::fz_bound_display_list()`.
Return the bounding box of the page recorded in a display list.
- ll_fz_bound_glyph(font, gid, trm)
- Low-level wrapper for `::fz_bound_glyph()`.
Return a bbox for a given glyph in a font.
font: The font to look for the glyph in.
gid: The glyph to bound.
trm: The matrix to apply to the glyph before bounding.
Returns rectangle by value containing the bounds of the given
glyph.
- ll_fz_bound_page(page)
- Low-level wrapper for `::fz_bound_page()`.
Determine the size of a page at 72 dpi.
- ll_fz_bound_page_box(page, box)
- Low-level wrapper for `::fz_bound_page_box()`.
- ll_fz_bound_path(path, stroke, ctm)
- Low-level wrapper for `::fz_bound_path()`.
Return a bounding rectangle for a path.
path: The path to bound.
stroke: If NULL, the bounding rectangle given is for
the filled path. If non-NULL the bounding rectangle
given is for the path stroked with the given attributes.
ctm: The matrix to apply to the path during stroking.
r: Pointer to a fz_rect which will be used to hold
the result.
Returns r, updated to contain the bounding rectangle.
- ll_fz_bound_shade(shade, ctm)
- Low-level wrapper for `::fz_bound_shade()`.
Bound a given shading.
shade: The shade to bound.
ctm: The transform to apply to the shade before bounding.
r: Pointer to storage to put the bounds in.
Returns r, updated to contain the bounds for the shading.
- ll_fz_bound_text(text, stroke, ctm)
- Low-level wrapper for `::fz_bound_text()`.
Find the bounds of a given text object.
text: The text object to find the bounds of.
stroke: Pointer to the stroke attributes (for stroked
text), or NULL (for filled text).
ctm: The matrix in use.
r: pointer to storage for the bounds.
Returns a pointer to r, which is updated to contain the
bounding box for the text object.
- ll_fz_box_type_from_string(name)
- Low-level wrapper for `::fz_box_type_from_string()`.
- ll_fz_buffer_extract(buffer)
- Returns buffer data as a Python bytes instance, leaving the
buffer empty.
- ll_fz_buffer_extract_copy(buffer)
- Returns buffer data as a Python bytes instance, leaving the
buffer unchanged.
- ll_fz_buffer_extract_outparams_fn(buf, outparams)
- ll_fz_buffer_storage(buf)
- Wrapper for out-params of fz_buffer_storage().
Returns: size_t, unsigned char *datap
- ll_fz_buffer_storage_memoryview(buffer, writable)
- ll_fz_buffer_storage_outparams_fn(buf, outparams)
- ll_fz_buffer_to_bytes_internal(buffer, clear)
- ll_fz_calloc(count, size)
- Low-level wrapper for `::fz_calloc()`.
Allocate array of memory of count entries of size bytes.
Clears the memory to zero.
Throws exception in the event of failure to allocate.
- ll_fz_calloc_no_throw(count, size)
- Low-level wrapper for `::fz_calloc_no_throw()`.
fz_calloc equivalent that returns NULL rather than throwing
exceptions.
- ll_fz_caught()
- Low-level wrapper for `::fz_caught()`.
Within an fz_catch() block, retrieve the error code for
the current exception.
This assumes no intervening use of fz_try/fz_catch.
- ll_fz_caught_message()
- Low-level wrapper for `::fz_caught_message()`.
Within an fz_catch() block, retrieve the formatted message
string for the current exception.
This assumes no intervening use of fz_try/fz_catch.
- ll_fz_chartorune(str)
- Wrapper for out-params of fz_chartorune().
Returns: int, int rune
- ll_fz_chartorune_outparams_fn(str, outparams)
- ll_fz_clamp(x, min, max)
- Low-level wrapper for `::fz_clamp()`.
- ll_fz_clamp64(x, min, max)
- Low-level wrapper for `::fz_clamp64()`.
- ll_fz_clamp_color(cs, in_)
- Wrapper for out-params of fz_clamp_color().
Returns: float out
- ll_fz_clamp_color_outparams_fn(cs, _in, outparams)
- ll_fz_clamp_location(doc, loc)
- Low-level wrapper for `::fz_clamp_location()`.
Clamps a location into valid chapter/page range. (First clamps
the chapter into range, then the page into range).
- ll_fz_clampd(x, min, max)
- Low-level wrapper for `::fz_clampd()`.
- ll_fz_clampi(x, min, max)
- Low-level wrapper for `::fz_clampi()`.
- ll_fz_clampp(x, min, max)
- Low-level wrapper for `::fz_clampp()`.
- ll_fz_cleanname(name)
- Low-level wrapper for `::fz_cleanname()`.
rewrite path to the shortest string that names the same path.
Eliminates multiple and trailing slashes, interprets "." and
"..". Overwrites the string in place.
- ll_fz_clear_bitmap(bit)
- Low-level wrapper for `::fz_clear_bitmap()`.
Set the entire bitmap to 0.
Never throws exceptions.
- ll_fz_clear_buffer(buf)
- Low-level wrapper for `::fz_clear_buffer()`.
Empties the buffer. Storage is not freed, but is held ready
to be reused as the buffer is refilled.
Never throws exceptions.
- ll_fz_clear_pixmap(pix)
- Low-level wrapper for `::fz_clear_pixmap()`.
Sets all components (including alpha) of
all pixels in a pixmap to 0.
pix: The pixmap to clear.
- ll_fz_clear_pixmap_rect_with_value(pix, value, r)
- Low-level wrapper for `::fz_clear_pixmap_rect_with_value()`.
Clears a subrect of a pixmap with the given value.
pix: The pixmap to clear.
value: Values in the range 0 to 255 are valid. Each component
sample for each pixel in the pixmap will be set to this value,
while alpha will always be set to 255 (non-transparent).
r: the rectangle.
- ll_fz_clear_pixmap_with_value(pix, value)
- Low-level wrapper for `::fz_clear_pixmap_with_value()`.
Clears a pixmap with the given value.
pix: The pixmap to clear.
value: Values in the range 0 to 255 are valid. Each component
sample for each pixel in the pixmap will be set to this value,
while alpha will always be set to 255 (non-transparent).
This function is horrible, and should be removed from the
API and replaced with a less magic one.
- ll_fz_clip_image_mask(dev, image, ctm, scissor)
- Low-level wrapper for `::fz_clip_image_mask()`.
- ll_fz_clip_path(dev, path, even_odd, ctm, scissor)
- Low-level wrapper for `::fz_clip_path()`.
- ll_fz_clip_stroke_path(dev, path, stroke, ctm, scissor)
- Low-level wrapper for `::fz_clip_stroke_path()`.
- ll_fz_clip_stroke_text(dev, text, stroke, ctm, scissor)
- Low-level wrapper for `::fz_clip_stroke_text()`.
- ll_fz_clip_text(dev, text, ctm, scissor)
- Low-level wrapper for `::fz_clip_text()`.
- ll_fz_clone_buffer(buf)
- Low-level wrapper for `::fz_clone_buffer()`.
Make a new buffer, containing a copy of the data used in
the original.
- ll_fz_clone_context()
- Low-level wrapper for `::fz_clone_context()`.
Make a clone of an existing context.
This function is meant to be used in multi-threaded
applications where each thread requires its own context, yet
parts of the global state, for example caching, are shared.
ctx: Context obtained from fz_new_context to make a copy of.
ctx must have had locks and lock/functions setup when created.
The two contexts will share the memory allocator, resource
store, locks and lock/unlock functions. They will each have
their own exception stacks though.
May return NULL.
- ll_fz_clone_default_colorspaces(base)
- Low-level wrapper for `::fz_clone_default_colorspaces()`.
Returns a reference to a newly cloned default colorspaces
structure.
The new clone may safely be altered without fear of race
conditions as the caller is the only reference holder.
- ll_fz_clone_path(path)
- Low-level wrapper for `::fz_clone_path()`.
Clone the data for a path.
This is used in preference to fz_keep_path when a whole
new copy of a path is required, rather than just a shared
pointer. This probably indicates that the path is about to
be modified.
path: path to clone.
Throws exceptions on failure to allocate.
- ll_fz_clone_pixmap(old)
- Low-level wrapper for `::fz_clone_pixmap()`.
Clone a pixmap, copying the pixels and associated data to new
storage.
The reference count of 'old' is unchanged.
- ll_fz_clone_pixmap_area_with_different_seps(src, bbox, dcs, seps, color_params, default_cs)
- Low-level wrapper for `::fz_clone_pixmap_area_with_different_seps()`.
- ll_fz_clone_separations_for_overprint(seps)
- Low-level wrapper for `::fz_clone_separations_for_overprint()`.
Return a separations object with all the spots in the input
separations object that are set to composite, reset to be
enabled. If there ARE no spots in the object, this returns
NULL. If the object already has all its spots enabled, then
just returns another handle on the same object.
- ll_fz_clone_stroke_state(stroke)
- Low-level wrapper for `::fz_clone_stroke_state()`.
Create an identical stroke_state structure and return a
reference to it.
stroke: The stroke state reference to clone.
Exceptions may be thrown in the event of a failure to
allocate.
- ll_fz_close_band_writer(writer)
- Low-level wrapper for `::fz_close_band_writer()`.
Finishes up the output and closes the band writer. After this
call no more headers or bands may be written.
- ll_fz_close_device(dev)
- Low-level wrapper for `::fz_close_device()`.
Signal the end of input, and flush any buffered output.
This is NOT called implicitly on fz_drop_device. This
may throw exceptions.
- ll_fz_close_document_writer(wri)
- Low-level wrapper for `::fz_close_document_writer()`.
Called to end the process of writing
pages to a document.
This writes any file level trailers required. After this
completes successfully the file is up to date and complete.
- ll_fz_close_output(arg_1)
- Low-level wrapper for `::fz_close_output()`.
Flush pending output and close an output stream.
- ll_fz_close_zip_writer(zip)
- Low-level wrapper for `::fz_close_zip_writer()`.
Close the zip file for writing.
This flushes any pending data to the file. This can throw
exceptions.
- ll_fz_closepath(path)
- Low-level wrapper for `::fz_closepath()`.
Close the current subpath.
path: The path to modify.
Throws exceptions on failure to allocate, attempting to modify
a packed path, and illegal path closes (i.e. closing a non open
path).
- ll_fz_colorspace_colorant(cs, n)
- Low-level wrapper for `::fz_colorspace_colorant()`.
Retrieve a the name for a colorant.
Returns a pointer with the same lifespan as the colorspace.
- ll_fz_colorspace_device_n_has_cmyk(cs)
- Low-level wrapper for `::fz_colorspace_device_n_has_cmyk()`.
True if DeviceN color space has cyan magenta yellow or black as
one of its colorants.
- ll_fz_colorspace_device_n_has_only_cmyk(cs)
- Low-level wrapper for `::fz_colorspace_device_n_has_only_cmyk()`.
True if DeviceN color space has only colorants from the CMYK set.
- ll_fz_colorspace_is_cmyk(cs)
- Low-level wrapper for `::fz_colorspace_is_cmyk()`.
- ll_fz_colorspace_is_device(cs)
- Low-level wrapper for `::fz_colorspace_is_device()`.
- ll_fz_colorspace_is_device_cmyk(cs)
- Low-level wrapper for `::fz_colorspace_is_device_cmyk()`.
- ll_fz_colorspace_is_device_gray(cs)
- Low-level wrapper for `::fz_colorspace_is_device_gray()`.
- ll_fz_colorspace_is_device_n(cs)
- Low-level wrapper for `::fz_colorspace_is_device_n()`.
- ll_fz_colorspace_is_gray(cs)
- Low-level wrapper for `::fz_colorspace_is_gray()`.
Tests for particular types of colorspaces
- ll_fz_colorspace_is_indexed(cs)
- Low-level wrapper for `::fz_colorspace_is_indexed()`.
- ll_fz_colorspace_is_lab(cs)
- Low-level wrapper for `::fz_colorspace_is_lab()`.
- ll_fz_colorspace_is_lab_icc(cs)
- Low-level wrapper for `::fz_colorspace_is_lab_icc()`.
- ll_fz_colorspace_is_rgb(cs)
- Low-level wrapper for `::fz_colorspace_is_rgb()`.
- ll_fz_colorspace_is_subtractive(cs)
- Low-level wrapper for `::fz_colorspace_is_subtractive()`.
True for CMYK, Separation and DeviceN colorspaces.
- ll_fz_colorspace_n(cs)
- Low-level wrapper for `::fz_colorspace_n()`.
Query the number of colorants in a colorspace.
- ll_fz_colorspace_name(cs)
- Low-level wrapper for `::fz_colorspace_name()`.
Query the name of a colorspace.
The returned string has the same lifespan as the colorspace
does. Caller should not free it.
- ll_fz_colorspace_name_colorant(cs, n, name)
- Low-level wrapper for `::fz_colorspace_name_colorant()`.
Assign a name for a given colorant in a colorspace.
Used while initially setting up a colorspace. The string is
copied into local storage, so need not be retained by the
caller.
- ll_fz_colorspace_type(cs)
- Low-level wrapper for `::fz_colorspace_type()`.
Query the type of colorspace.
- ll_fz_compare_separations(sep1, sep2)
- Low-level wrapper for `::fz_compare_separations()`.
Compare 2 separations structures (or NULLs).
Return 0 if identical, non-zero if not identical.
- ll_fz_compress_ccitt_fax_g3(data, columns, rows, stride)
- Low-level wrapper for `::fz_compress_ccitt_fax_g3()`.
Compress bitmap data as CCITT Group 3 1D fax image.
Creates a stream assuming the default PDF parameters,
except the number of columns.
- ll_fz_compress_ccitt_fax_g4(data, columns, rows, stride)
- Low-level wrapper for `::fz_compress_ccitt_fax_g4()`.
Compress bitmap data as CCITT Group 4 2D fax image.
Creates a stream assuming the default PDF parameters, except
K=-1 and the number of columns.
- ll_fz_compressed_buffer_size(buffer)
- Low-level wrapper for `::fz_compressed_buffer_size()`.
Return the storage size used for a buffer and its data.
Used in implementing store handling.
Never throws exceptions.
- ll_fz_compressed_image_buffer(image)
- Low-level wrapper for `::fz_compressed_image_buffer()`.
Retrieve the underlying compressed data for an image.
Returns a pointer to the underlying data buffer for an image,
or NULL if this image is not based upon a compressed data
buffer.
This is not a reference counted structure, so no reference is
returned. Lifespan is limited to that of the image itself.
- ll_fz_compressed_image_type(image)
- Low-level wrapper for `::fz_compressed_image_type()`.
Return the type of a compressed image.
Any non-compressed image will have the type returned as UNKNOWN.
- ll_fz_concat(left, right)
- Low-level wrapper for `::fz_concat()`.
Multiply two matrices.
The order of the two matrices are important since matrix
multiplication is not commutative.
Returns result.
- ll_fz_concat_push_drop(concat, chain)
- Low-level wrapper for `::fz_concat_push_drop()`.
Add a chained stream to the end of the concatenate filter.
Ownership of chain is passed in.
- ll_fz_contains_rect(a, b)
- Low-level wrapper for `::fz_contains_rect()`.
Test rectangle inclusion.
Return true if a entirely contains b.
- ll_fz_convert_color(ss, sv, ds, is_, params)
- Low-level Python version of fz_convert_color().
`sv` should be a float or list of 1-4 floats or a SWIG
representation of a float*.
Returns (dv0, dv1, dv2, dv3).
- ll_fz_convert_color2(*args)
- ll_fz_convert_color_outparams_fn(ss, sv, ds, _is, params, outparams)
- ll_fz_convert_indexed_pixmap_to_base(src)
- Low-level wrapper for `::fz_convert_indexed_pixmap_to_base()`.
Convert pixmap from indexed to base colorspace.
This creates a new bitmap containing the converted pixmap data.
- ll_fz_convert_pixmap(pix, cs_des, prf, default_cs, color_params, keep_alpha)
- Low-level wrapper for `::fz_convert_pixmap()`.
Convert an existing pixmap to a desired
colorspace. Other properties of the pixmap, such as resolution
and position are copied to the converted pixmap.
pix: The pixmap to convert.
default_cs: If NULL pix->colorspace is used. It is possible that
the data may need to be interpreted as one of the color spaces
in default_cs.
cs_des: Desired colorspace, may be NULL to denote alpha-only.
prf: Proofing color space through which we need to convert.
color_params: Parameters that may be used in conversion (e.g.
ri).
keep_alpha: If 0 any alpha component is removed, otherwise
alpha is kept if present in the pixmap.
- ll_fz_convert_separation_colors(src_cs, src_color, dst_seps, dst_cs, color_params)
- Wrapper for out-params of fz_convert_separation_colors().
Returns: float dst_color
- ll_fz_convert_separation_colors_outparams_fn(src_cs, src_color, dst_seps, dst_cs, color_params, outparams)
- ll_fz_convert_separation_pixmap_to_base(src)
- Low-level wrapper for `::fz_convert_separation_pixmap_to_base()`.
Convert pixmap from DeviceN/Separation to base colorspace.
This creates a new bitmap containing the converted pixmap data.
- ll_fz_copy_option(val, dest, maxlen)
- Low-level wrapper for `::fz_copy_option()`.
Copy an option (val) into a destination buffer (dest), of maxlen
bytes.
Returns the number of bytes (including terminator) that did not
fit. If val is maxlen or greater bytes in size, it will be left
unterminated.
- ll_fz_copy_rectangle(page, area, crlf)
- Low-level wrapper for `::fz_copy_rectangle()`.
Return a newly allocated UTF-8 string with the text for a given
selection rectangle.
crlf: If true, write "\r\n" style line endings (otherwise "\n"
only).
- ll_fz_copy_selection(page, a, b, crlf)
- Low-level wrapper for `::fz_copy_selection()`.
Return a newly allocated UTF-8 string with the text for a given
selection.
crlf: If true, write "\r\n" style line endings (otherwise "\n"
only).
- ll_fz_count_active_separations(seps)
- Low-level wrapper for `::fz_count_active_separations()`.
Return the number of active separations.
- ll_fz_count_archive_entries(arch)
- Low-level wrapper for `::fz_count_archive_entries()`.
Number of entries in archive.
Will always return a value >= 0.
May throw an exception if this type of archive cannot count the
entries (such as a directory).
- ll_fz_count_chapter_pages(doc, chapter)
- Low-level wrapper for `::fz_count_chapter_pages()`.
Return the number of pages in a chapter.
May return 0.
- ll_fz_count_chapters(doc)
- Low-level wrapper for `::fz_count_chapters()`.
Return the number of chapters in the document.
At least 1.
- ll_fz_count_pages(doc)
- Low-level wrapper for `::fz_count_pages()`.
Return the number of pages in document
May return 0 for documents with no pages.
- ll_fz_count_separations(sep)
- Low-level wrapper for `::fz_count_separations()`.
- ll_fz_create_link(page, bbox, uri)
- Low-level wrapper for `::fz_create_link()`.
Create a new link on a page.
- ll_fz_currentpoint(path)
- Low-level wrapper for `::fz_currentpoint()`.
Return the current point that a path has
reached or (0,0) if empty.
path: path to return the current point of.
- ll_fz_curveto(path, x0, y0, x1, y1, x2, y2)
- Low-level wrapper for `::fz_curveto()`.
Append a 'curveto' command to an open path. (For a
cubic bezier).
path: The path to modify.
x0, y0: The coordinates of the first control point for the
curve.
x1, y1: The coordinates of the second control point for the
curve.
x2, y2: The end coordinates for the curve.
Throws exceptions on failure to allocate, or attempting to
modify a packed path.
- ll_fz_curvetov(path, x1, y1, x2, y2)
- Low-level wrapper for `::fz_curvetov()`.
Append a 'curvetov' command to an open path. (For a
cubic bezier with the first control coordinate equal to
the start point).
path: The path to modify.
x1, y1: The coordinates of the second control point for the
curve.
x2, y2: The end coordinates for the curve.
Throws exceptions on failure to allocate, or attempting to
modify a packed path.
- ll_fz_curvetoy(path, x0, y0, x2, y2)
- Low-level wrapper for `::fz_curvetoy()`.
Append a 'curvetoy' command to an open path. (For a
cubic bezier with the second control coordinate equal to
the end point).
path: The path to modify.
x0, y0: The coordinates of the first control point for the
curve.
x2, y2: The end coordinates for the curve (and the second
control coordinate).
Throws exceptions on failure to allocate, or attempting to
modify a packed path.
- ll_fz_debug_store(out)
- Low-level wrapper for `::fz_debug_store()`.
Output debugging information for the current state of the store
to the given output channel.
- ll_fz_debug_xml(item, level)
- Low-level wrapper for `::fz_debug_xml()`.
Pretty-print an XML tree to stdout.
- ll_fz_decode_tile(pix, decode)
- Low-level wrapper for `::fz_decode_tile()`.
- ll_fz_decode_uri(s)
- Low-level wrapper for `::fz_decode_uri()`.
Return a new string representing the unencoded version of the given URI.
This decodes all escape sequences except those that would result in a reserved
character that are part of the URI syntax (; / ? : @ & = + $ , #).
- ll_fz_decode_uri_component(s)
- Low-level wrapper for `::fz_decode_uri_component()`.
Return a new string representing the unencoded version of the given URI component.
This decodes all escape sequences!
- ll_fz_decomp_image_from_stream(stm, image, subarea, indexed, l2factor)
- Wrapper for out-params of fz_decomp_image_from_stream().
Returns: fz_pixmap *, int l2extra
- ll_fz_decomp_image_from_stream_outparams_fn(stm, image, subarea, indexed, l2factor, outparams)
- ll_fz_decouple_type3_font(font, t3doc)
- Low-level wrapper for `::fz_decouple_type3_font()`.
- ll_fz_default_cmyk(default_cs)
- Low-level wrapper for `::fz_default_cmyk()`.
- ll_fz_default_error_callback(user, message)
- Low-level wrapper for `::fz_default_error_callback()`.
FIXME: Better not to expose fz_default_error_callback, and
fz_default_warning callback and to allow 'NULL' to be used
int fz_set_xxxx_callback to mean "defaults".
FIXME: Do we need/want functions like
fz_error_callback(ctx, message) to allow callers to inject
stuff into the error/warning streams?
The default error callback. Declared publicly just so that the
error callback can be set back to this after it has been
overridden.
- ll_fz_default_gray(default_cs)
- Low-level wrapper for `::fz_default_gray()`.
Retrieve default colorspaces (typically page local).
If default_cs is non NULL, the default is retrieved from there,
otherwise the global default is retrieved.
These return borrowed references that should not be dropped,
unless they are kept first.
- ll_fz_default_halftone(num_comps)
- Low-level wrapper for `::fz_default_halftone()`.
Create a 'default' halftone structure
for the given number of components.
num_comps: The number of components to use.
Returns a simple default halftone. The default halftone uses
the same halftone tile for each plane, which may not be ideal
for all purposes.
- ll_fz_default_output_intent(default_cs)
- Low-level wrapper for `::fz_default_output_intent()`.
- ll_fz_default_rgb(default_cs)
- Low-level wrapper for `::fz_default_rgb()`.
- ll_fz_default_warning_callback(user, message)
- Low-level wrapper for `::fz_default_warning_callback()`.
The default warning callback. Declared publicly just so that
the warning callback can be set back to this after it has been
overridden.
- ll_fz_defer_reap_end()
- Low-level wrapper for `::fz_defer_reap_end()`.
Decrement the defer reap count.
If the defer reap count returns to 0, and the store
has reapable objects in, a reap pass will begin.
Call this at the end of a process during which you
potentially might drop many reapable objects.
It is vital that every fz_defer_reap_start is matched
by a fz_defer_reap_end call.
- ll_fz_defer_reap_start()
- Low-level wrapper for `::fz_defer_reap_start()`.
Increment the defer reap count.
No reap operations will take place (except for those
triggered by an immediate failed malloc) until the
defer reap count returns to 0.
Call this at the start of a process during which you
potentially might drop many reapable objects.
It is vital that every fz_defer_reap_start is matched
by a fz_defer_reap_end call.
- ll_fz_deflate(dest, source, source_length, level)
- Wrapper for out-params of fz_deflate().
Returns: size_t compressed_length
- ll_fz_deflate_bound(size)
- Low-level wrapper for `::fz_deflate_bound()`.
Returns the upper bound on the
size of flated data of length size.
- ll_fz_deflate_outparams_fn(dest, source, source_length, level, outparams)
- ll_fz_delete_link(page, link)
- Low-level wrapper for `::fz_delete_link()`.
Delete an existing link on a page.
- ll_fz_detach_xml(node)
- Low-level wrapper for `::fz_detach_xml()`.
Detach a node from the tree, unlinking it from its parent,
and setting the document root to the node.
- ll_fz_device_bgr()
- Low-level wrapper for `::fz_device_bgr()`.
- ll_fz_device_cmyk()
- Low-level wrapper for `::fz_device_cmyk()`.
- ll_fz_device_current_scissor(dev)
- Low-level wrapper for `::fz_device_current_scissor()`.
Find current scissor region as tracked by the device.
- ll_fz_device_gray()
- Low-level wrapper for `::fz_device_gray()`.
Retrieve global default colorspaces.
These return borrowed references that should not be dropped,
unless they are kept first.
- ll_fz_device_lab()
- Low-level wrapper for `::fz_device_lab()`.
- ll_fz_device_rgb()
- Low-level wrapper for `::fz_device_rgb()`.
- ll_fz_dirname(dir, path, dirsize)
- Low-level wrapper for `::fz_dirname()`.
extract the directory component from a path.
- ll_fz_disable_device_hints(dev, hints)
- Low-level wrapper for `::fz_disable_device_hints()`.
Disable (clear) hint bits within the hint bitfield for a device.
- ll_fz_disable_icc()
- Low-level wrapper for `::fz_disable_icc()`.
Disable icc profile based operation.
- ll_fz_display_list_is_empty(list)
- Low-level wrapper for `::fz_display_list_is_empty()`.
Check for a display list being empty
list: The list to check.
Returns true if empty, false otherwise.
- ll_fz_div255(c, a)
- Low-level wrapper for `::fz_div255()`.
Undo alpha premultiplication.
- ll_fz_do_always()
- Low-level wrapper for `::fz_do_always()`.
- ll_fz_do_catch()
- Low-level wrapper for `::fz_do_catch()`.
- ll_fz_do_try()
- Low-level wrapper for `::fz_do_try()`.
- ll_fz_document_open_accel_fn_call(fn, filename, accel)
- ll_fz_document_open_accel_with_stream_fn_call(fn, stream, accel)
- ll_fz_document_open_fn_call(fn, filename)
- ll_fz_document_open_with_stream_fn_call(fn, stream)
- ll_fz_document_output_intent(doc)
- Low-level wrapper for `::fz_document_output_intent()`.
Find the output intent colorspace if the document has defined
one.
Returns a borrowed reference that should not be dropped, unless
it is kept first.
- ll_fz_document_supports_accelerator(doc)
- Low-level wrapper for `::fz_document_supports_accelerator()`.
Query if the document supports the saving of accelerator data.
- ll_fz_document_writer_device(writer)
- Low-level wrapper for `::fz_document_writer_device()`.
- ll_fz_dom_add_attribute(elt, att, value)
- Low-level wrapper for `::fz_dom_add_attribute()`.
Add an attribute to an element.
Ownership of att and value remain with the caller.
- ll_fz_dom_append_child(parent, child)
- Low-level wrapper for `::fz_dom_append_child()`.
Insert an element as the last child of a parent, unlinking the
child from its current position if required.
- ll_fz_dom_attribute(elt, att)
- Low-level wrapper for `::fz_dom_attribute()`.
Retrieve the value of a given attribute from a given element.
Returns a borrowed pointer to the value or NULL if not found.
- ll_fz_dom_body(dom)
- Low-level wrapper for `::fz_dom_body()`.
Return a borrowed reference for the 'body' element of
the given DOM.
- ll_fz_dom_clone(elt)
- Low-level wrapper for `::fz_dom_clone()`.
Clone an element (and its children).
A borrowed reference to the clone is returned. The clone is not
yet linked into the DOM.
- ll_fz_dom_create_element(dom, tag)
- Low-level wrapper for `::fz_dom_create_element()`.
Create an element of a given tag type for the given DOM.
The element is not linked into the DOM yet.
- ll_fz_dom_create_text_node(dom, text)
- Low-level wrapper for `::fz_dom_create_text_node()`.
Create a text node for the given DOM.
The element is not linked into the DOM yet.
- ll_fz_dom_document_element(dom)
- Low-level wrapper for `::fz_dom_document_element()`.
Return a borrowed reference for the document (the top
level element) of the DOM.
- ll_fz_dom_find(elt, tag, att, match)
- Low-level wrapper for `::fz_dom_find()`.
Find the first element matching the requirements in a depth first traversal from elt.
The tagname must match tag, unless tag is NULL, when all tag names are considered to match.
If att is NULL, then all tags match.
Otherwise:
If match is NULL, then only nodes that have an att attribute match.
If match is non-NULL, then only nodes that have an att attribute that matches match match.
Returns NULL (if no match found), or a borrowed reference to the first matching element.
- ll_fz_dom_find_next(elt, tag, att, match)
- Low-level wrapper for `::fz_dom_find_next()`.
Find the next element matching the requirements.
- ll_fz_dom_first_child(elt)
- Low-level wrapper for `::fz_dom_first_child()`.
Return a borrowed reference to the first child of a node,
or NULL if there isn't one.
- ll_fz_dom_get_attribute(elt, i)
- Wrapper for out-params of fz_dom_get_attribute().
Returns: const char *, const char *att
- ll_fz_dom_get_attribute_outparams_fn(elt, i, outparams)
- ll_fz_dom_insert_after(node, new_elt)
- Low-level wrapper for `::fz_dom_insert_after()`.
Insert an element (new_elt), after another element (node),
unlinking the new_elt from its current position if required.
- ll_fz_dom_insert_before(node, new_elt)
- Low-level wrapper for `::fz_dom_insert_before()`.
Insert an element (new_elt), before another element (node),
unlinking the new_elt from its current position if required.
- ll_fz_dom_next(elt)
- Low-level wrapper for `::fz_dom_next()`.
Return a borrowed reference to the next sibling of a node,
or NULL if there isn't one.
- ll_fz_dom_parent(elt)
- Low-level wrapper for `::fz_dom_parent()`.
Return a borrowed reference to the parent of a node,
or NULL if there isn't one.
- ll_fz_dom_previous(elt)
- Low-level wrapper for `::fz_dom_previous()`.
Return a borrowed reference to the previous sibling of a node,
or NULL if there isn't one.
- ll_fz_dom_remove(elt)
- Low-level wrapper for `::fz_dom_remove()`.
Remove an element from the DOM. The element can be added back elsewhere
if required.
No reference counting changes for the element.
- ll_fz_dom_remove_attribute(elt, att)
- Low-level wrapper for `::fz_dom_remove_attribute()`.
Remove an attribute from an element.
- ll_fz_draw_story(story, dev, ctm)
- Low-level wrapper for `::fz_draw_story()`.
- ll_fz_drop_archive(arch)
- Low-level wrapper for `::fz_drop_archive()`.
Drop a reference to an archive.
When the last reference is dropped, this closes and releases
any memory or filehandles associated with the archive.
- ll_fz_drop_band_writer(writer)
- Low-level wrapper for `::fz_drop_band_writer()`.
Drop the reference to the band writer, causing it to be
destroyed.
Never throws an exception.
- ll_fz_drop_bitmap(bit)
- Low-level wrapper for `::fz_drop_bitmap()`.
Drop a reference to the bitmap. When the reference count reaches
zero, the bitmap will be destroyed.
Never throws exceptions.
- ll_fz_drop_buffer(buf)
- Low-level wrapper for `::fz_drop_buffer()`.
Drop a reference to the buffer. When the reference count reaches
zero, the buffer is destroyed.
Never throws exceptions.
- ll_fz_drop_colorspace(colorspace)
- Low-level wrapper for `::fz_drop_colorspace()`.
Drops a reference to the colorspace.
When the reference count reaches zero, the colorspace is
destroyed.
- ll_fz_drop_colorspace_imp(cs_)
- Low-level wrapper for `::fz_drop_colorspace_imp()`.
- ll_fz_drop_compressed_buffer(buf)
- Low-level wrapper for `::fz_drop_compressed_buffer()`.
Drop a reference to a compressed buffer. Destroys the buffer
and frees any storage/other references held by it.
Never throws exceptions.
- ll_fz_drop_context()
- Low-level wrapper for `::fz_drop_context()`.
Free a context and its global state.
The context and all of its global state is freed, and any
buffered warnings are flushed (see fz_flush_warnings). If NULL
is passed in nothing will happen.
Must not be called for a context that is being used in an active
fz_try(), fz_always() or fz_catch() block.
- ll_fz_drop_default_colorspaces(default_cs)
- Low-level wrapper for `::fz_drop_default_colorspaces()`.
Drop a reference to the default colorspaces structure. When the
reference count reaches 0, the references it holds internally
to the underlying colorspaces will be dropped, and the structure
will be destroyed.
Never throws exceptions.
- ll_fz_drop_device(dev)
- Low-level wrapper for `::fz_drop_device()`.
Reduce the reference count on a device. When the reference count
reaches zero, the device and its resources will be freed.
Don't forget to call fz_close_device before dropping the device,
or you may get incomplete output!
Never throws exceptions.
- ll_fz_drop_display_list(list)
- Low-level wrapper for `::fz_drop_display_list()`.
Decrement the reference count for a display list. When the
reference count reaches zero, all the references in the display
list itself are dropped, and the display list is freed.
Never throws exceptions.
- ll_fz_drop_document(doc)
- Low-level wrapper for `::fz_drop_document()`.
Decrement the document reference count. When the reference
count reaches 0, the document and all it's references are
freed.
Never throws exceptions.
- ll_fz_drop_document_writer(wri)
- Low-level wrapper for `::fz_drop_document_writer()`.
Called to discard a fz_document_writer.
This may be called at any time during the process to release all
the resources owned by the writer.
Calling drop without having previously called close may leave
the file in an inconsistent state.
- ll_fz_drop_font(font)
- Low-level wrapper for `::fz_drop_font()`.
Drop a reference to a fz_font, destroying the
font when the last reference is dropped.
font: The font to drop a reference to.
- ll_fz_drop_glyph(pix)
- Low-level wrapper for `::fz_drop_glyph()`.
Drop a reference and free a glyph.
Decrement the reference count for the glyph. When no
references remain the glyph will be freed.
- ll_fz_drop_halftone(ht)
- Low-level wrapper for `::fz_drop_halftone()`.
Drop a reference to the halftone. When the reference count
reaches zero, the halftone is destroyed.
Never throws exceptions.
- ll_fz_drop_hash_table(table)
- Low-level wrapper for `::fz_drop_hash_table()`.
Destroy the hash table.
Values are dropped using the drop function.
- ll_fz_drop_image(image)
- Low-level wrapper for `::fz_drop_image()`.
Decrement the (normal) reference count for an image. When the
total (normal + key) reference count reaches zero, the image and
its resources are freed.
Never throws exceptions.
- ll_fz_drop_image_base(image)
- Low-level wrapper for `::fz_drop_image_base()`.
Internal destructor for the base image class members.
Exposed to allow derived image classes to be written.
- ll_fz_drop_image_imp(image)
- Low-level wrapper for `::fz_drop_image_imp()`.
Internal destructor exposed for fz_store integration.
- ll_fz_drop_image_store_key(image)
- Low-level wrapper for `::fz_drop_image_store_key()`.
Decrement the store key reference count for an image. When the
total (normal + key) reference count reaches zero, the image and
its resources are freed.
Never throws exceptions.
- ll_fz_drop_imp(p)
- Wrapper for out-params of fz_drop_imp().
Returns: int, int refs
- ll_fz_drop_imp16(p)
- Wrapper for out-params of fz_drop_imp16().
Returns: int, int16_t refs
- ll_fz_drop_imp16_outparams_fn(p, outparams)
- ll_fz_drop_imp8(p, refs)
- Low-level wrapper for `::fz_drop_imp8()`.
- ll_fz_drop_imp_outparams_fn(p, outparams)
- ll_fz_drop_jbig2_globals(globals)
- Low-level wrapper for `::fz_drop_jbig2_globals()`.
Decrement the reference count for a jbig2 globals record.
When the reference count hits zero, the record is freed.
Never throws an exception.
- ll_fz_drop_jbig2_globals_imp(globals)
- Low-level wrapper for `::fz_drop_jbig2_globals_imp()`.
Special jbig2 globals drop function for use in implementing
store support.
- ll_fz_drop_key_storable(arg_1)
- Low-level wrapper for `::fz_drop_key_storable()`.
Decrement the (normal) reference count for a storable object.
When the total reference count hits zero, the drop function for
that object is called to free the object.
Never throws exceptions.
- ll_fz_drop_key_storable_key(arg_1)
- Low-level wrapper for `::fz_drop_key_storable_key()`.
Decrement the (key) reference count for a storable object.
When the total reference count hits zero, the drop function for
that object is called to free the object.
Never throws exceptions.
- ll_fz_drop_layout(block)
- Low-level wrapper for `::fz_drop_layout()`.
Drop layout block. Free the pool, and linked blocks.
Never throws exceptions.
- ll_fz_drop_link(link)
- Low-level wrapper for `::fz_drop_link()`.
Decrement the reference count for a link. When the reference
count reaches zero, the link is destroyed.
When a link is freed, the reference for any linked link (next)
is dropped too, thus an entire linked list of fz_link's can be
freed by just dropping the head.
- ll_fz_drop_outline(outline)
- Low-level wrapper for `::fz_drop_outline()`.
Decrements the reference count. When the reference point
reaches zero, the outline is freed.
When freed, it will drop linked outline entries (next and down)
too, thus a whole outline structure can be dropped by dropping
the top entry.
Never throws exceptions.
- ll_fz_drop_outline_iterator(iter)
- Low-level wrapper for `::fz_drop_outline_iterator()`.
Drop the current iterator.
- ll_fz_drop_output(arg_1)
- Low-level wrapper for `::fz_drop_output()`.
Free an output stream. Don't forget to close it first!
- ll_fz_drop_page(page)
- Low-level wrapper for `::fz_drop_page()`.
Decrements the reference count for the page. When the reference
count hits 0, the page and its references are freed.
Never throws exceptions.
- ll_fz_drop_path(path)
- Low-level wrapper for `::fz_drop_path()`.
Decrement the reference count. When the reference count hits
zero, free the path.
All paths can be dropped, regardless of their packing type.
Packed paths do not own the blocks into which they are packed
so dropping them does not free those blocks.
Never throws exceptions.
- ll_fz_drop_pixmap(pix)
- Low-level wrapper for `::fz_drop_pixmap()`.
Decrement the reference count for the pixmap. When the
reference count hits 0, the pixmap is freed.
Never throws exceptions.
- ll_fz_drop_pool(pool)
- Low-level wrapper for `::fz_drop_pool()`.
Drop a pool, freeing and invalidating all storage returned from
the pool.
- ll_fz_drop_separations(sep)
- Low-level wrapper for `::fz_drop_separations()`.
Decrement the reference count for a separations structure.
When the reference count hits zero, the separations structure
is freed.
Never throws exceptions.
- ll_fz_drop_shade(shade)
- Low-level wrapper for `::fz_drop_shade()`.
Decrement the reference count for the shade structure. When
the reference count hits zero, the structure is freed.
Never throws exceptions.
- ll_fz_drop_shade_color_cache(cache)
- Low-level wrapper for `::fz_drop_shade_color_cache()`.
- ll_fz_drop_shade_imp(shade)
- Low-level wrapper for `::fz_drop_shade_imp()`.
Internal function to destroy a
shade. Only exposed for use with the fz_store.
shade: The reference to destroy.
- ll_fz_drop_stext_page(page)
- Low-level wrapper for `::fz_drop_stext_page()`.
- ll_fz_drop_storable(arg_1)
- Low-level wrapper for `::fz_drop_storable()`.
Decrement the reference count for a storable object. When the
reference count hits zero, the drop function for that object
is called to free the object.
Never throws exceptions.
- ll_fz_drop_store_context()
- Low-level wrapper for `::fz_drop_store_context()`.
Decrement the reference count for the store context. When the
reference count hits zero, the store context is freed.
Never throws exceptions.
- ll_fz_drop_story(story)
- Low-level wrapper for `::fz_drop_story()`.
- ll_fz_drop_stream(stm)
- Low-level wrapper for `::fz_drop_stream()`.
Decrements the reference count for a stream.
When the reference count for the stream hits zero, frees the
storage used for the fz_stream itself, and (usually)
releases the underlying resources that the stream is based upon
(depends on the method used to open the stream initially).
- ll_fz_drop_stroke_state(stroke)
- Low-level wrapper for `::fz_drop_stroke_state()`.
Drop a reference to a stroke state structure, destroying the
structure if it is the last reference.
- ll_fz_drop_text(text)
- Low-level wrapper for `::fz_drop_text()`.
Decrement the reference count for the text object. When the
reference count hits zero, the text object is freed.
Never throws exceptions.
- ll_fz_drop_tree(node, dropfunc)
- Low-level wrapper for `::fz_drop_tree()`.
Drop the tree.
The storage used by the tree is freed, and each value has
dropfunc called on it.
- ll_fz_drop_xml(xml)
- Low-level wrapper for `::fz_drop_xml()`.
Drop a reference to the XML. When the last reference is
dropped, the node and all its children and siblings will
be freed.
- ll_fz_drop_zip_writer(zip)
- Low-level wrapper for `::fz_drop_zip_writer()`.
Drop the reference to the zipfile.
In common with other 'drop' methods, this will never throw an
exception.
- ll_fz_dump_glyph_cache_stats(out)
- Low-level wrapper for `::fz_dump_glyph_cache_stats()`.
Dump debug statistics for the glyph cache.
- ll_fz_duplicate_glyph_names_from_unicode(unicode)
- Low-level wrapper for `::fz_duplicate_glyph_names_from_unicode()`.
- ll_fz_empty_store()
- Low-level wrapper for `::fz_empty_store()`.
Evict every item from the store.
- ll_fz_enable_device_hints(dev, hints)
- Low-level wrapper for `::fz_enable_device_hints()`.
Enable (set) hint bits within the hint bitfield for a device.
- ll_fz_enable_icc()
- Low-level wrapper for `::fz_enable_icc()`.
Enable icc profile based operation.
- ll_fz_encode_character(font, unicode)
- Low-level wrapper for `::fz_encode_character()`.
Find the glyph id for a given unicode
character within a font.
font: The font to look for the unicode character in.
unicode: The unicode character to encode.
Returns the glyph id for the given unicode value, or 0 if
unknown.
- ll_fz_encode_character_by_glyph_name(font, glyphname)
- Low-level wrapper for `::fz_encode_character_by_glyph_name()`.
Encode character.
Either by direct lookup of glyphname within a font, or, failing
that, by mapping glyphname to unicode and thence to the glyph
index within the given font.
Returns zero for type3 fonts.
- ll_fz_encode_character_sc(font, unicode)
- Low-level wrapper for `::fz_encode_character_sc()`.
Encode character, preferring small-caps variant if available.
font: The font to look for the unicode character in.
unicode: The unicode character to encode.
Returns the glyph id for the given unicode value, or 0 if
unknown.
- ll_fz_encode_character_with_fallback(font, unicode, script, language)
- Wrapper for out-params of fz_encode_character_with_fallback().
Returns: int, ::fz_font *out_font
- ll_fz_encode_character_with_fallback_outparams_fn(font, unicode, script, language, outparams)
- ll_fz_encode_uri(s)
- Low-level wrapper for `::fz_encode_uri()`.
Return a new string representing the provided string encoded as a URI.
- ll_fz_encode_uri_component(s)
- Low-level wrapper for `::fz_encode_uri_component()`.
Return a new string representing the provided string encoded as an URI component.
This also encodes the special reserved characters (; / ? : @ & = + $ , #).
- ll_fz_encode_uri_pathname(s)
- Low-level wrapper for `::fz_encode_uri_pathname()`.
Return a new string representing the provided string encoded as an URI path name.
This also encodes the special reserved characters except /.
- ll_fz_end_group(dev)
- Low-level wrapper for `::fz_end_group()`.
- ll_fz_end_layer(dev)
- Low-level wrapper for `::fz_end_layer()`.
- ll_fz_end_mask(dev)
- Low-level wrapper for `::fz_end_mask()`.
- ll_fz_end_metatext(dev)
- Low-level wrapper for `::fz_end_metatext()`.
- ll_fz_end_page(wri)
- Low-level wrapper for `::fz_end_page()`.
Called to end the process of writing a page to a
document.
- ll_fz_end_structure(dev)
- Low-level wrapper for `::fz_end_structure()`.
- ll_fz_end_throw_on_repair()
- Low-level wrapper for `::fz_end_throw_on_repair()`.
- ll_fz_end_tile(dev)
- Low-level wrapper for `::fz_end_tile()`.
- ll_fz_error_callback()
- Wrapper for out-params of fz_error_callback().
Returns: fz_error_cb *, void *user
- ll_fz_error_callback_outparams_fn(outparams)
- ll_fz_expand_irect(a, expand)
- Low-level wrapper for `::fz_expand_irect()`.
- ll_fz_expand_rect(b, expand)
- Low-level wrapper for `::fz_expand_rect()`.
Expand a bbox by a given amount in all directions.
- ll_fz_extract_ttf_from_ttc(font)
- Low-level wrapper for `::fz_extract_ttf_from_ttc()`.
- ll_fz_file_exists(path)
- Low-level wrapper for `::fz_file_exists()`.
Return true if the named file exists and is readable.
- ll_fz_fill_image(dev, image, ctm, alpha, color_params)
- Low-level wrapper for `::fz_fill_image()`.
- ll_fz_fill_image_mask(dev, image, ctm, colorspace, color, alpha, color_params)
- Low-level wrapper for `::fz_fill_image_mask()`.
- ll_fz_fill_path(dev, path, even_odd, ctm, colorspace, color, alpha, color_params)
- Low-level wrapper for `::fz_fill_path()`.
Device calls; graphics primitives and containers.
- ll_fz_fill_pixmap_from_display_list(list, ctm, pix)
- Low-level wrapper for `::fz_fill_pixmap_from_display_list()`.
- ll_fz_fill_pixmap_with_color(pix, colorspace, color_params)
- Wrapper for out-params of fz_fill_pixmap_with_color().
Returns: float color
- ll_fz_fill_pixmap_with_color_outparams_fn(pix, colorspace, color_params, outparams)
- ll_fz_fill_shade(dev, shade, ctm, alpha, color_params)
- Low-level wrapper for `::fz_fill_shade()`.
- ll_fz_fill_text(dev, text, ctm, colorspace, color, alpha, color_params)
- Low-level Python version of fz_fill_text() taking list/tuple for `color`.
- ll_fz_fill_text2(dev, text, ctm, colorspace, color0, color1, color2, color3, alpha, color_params)
- ll_fz_filter_store(fn, arg, type)
- Low-level wrapper for `::fz_filter_store()`.
Filter every element in the store with a matching type with the
given function.
If the function returns 1 for an element, drop the element.
- ll_fz_find_item(drop, key, type)
- Low-level wrapper for `::fz_find_item()`.
Find an item within the store.
drop: The function used to free the value (to ensure we get a
value of the correct type).
key: The key used to index the item.
type: Functions used to manipulate the key.
Returns NULL for not found, otherwise returns a pointer to the
value indexed by key to which a reference has been taken.
- ll_fz_flush_output(out)
- Low-level wrapper for `::fz_flush_output()`.
Flush unwritten data.
- ll_fz_flush_warnings()
- Low-level wrapper for `::fz_flush_warnings()`.
Flush any repeated warnings.
Repeated warnings are buffered, counted and eventually printed
along with the number of repetitions. Call fz_flush_warnings
to force printing of the latest buffered warning and the
number of repetitions, for example to make sure that all
warnings are printed before exiting an application.
- ll_fz_font_ascender(font)
- Low-level wrapper for `::fz_font_ascender()`.
Retrieve font ascender in ems.
- ll_fz_font_bbox(font)
- Low-level wrapper for `::fz_font_bbox()`.
Retrieve the font bbox.
font: The font to query.
Returns the font bbox by value; it is valid only if
fz_font_flags(font)->invalid_bbox is zero.
- ll_fz_font_descender(font)
- Low-level wrapper for `::fz_font_descender()`.
Retrieve font descender in ems.
- ll_fz_font_digest(font, digest)
- Low-level wrapper for `::fz_font_digest()`.
Retrieve the MD5 digest for the font's data.
- ll_fz_font_flags(font)
- Low-level wrapper for `::fz_font_flags()`.
Retrieve a pointer to the font flags
for a given font. These can then be updated as required.
font: The font to query
Returns a pointer to the flags structure (or NULL, if
the font is NULL).
- ll_fz_font_ft_face(font)
- Low-level wrapper for `::fz_font_ft_face()`.
Retrieve the FT_Face handle
for the font.
font: The font to query
Returns the FT_Face handle for the font, or NULL
if not a freetype handled font. (Cast to void *
to avoid nasty header exposure).
- ll_fz_font_is_bold(font)
- Low-level wrapper for `::fz_font_is_bold()`.
Query whether the font flags say that this font is bold.
- ll_fz_font_is_italic(font)
- Low-level wrapper for `::fz_font_is_italic()`.
Query whether the font flags say that this font is italic.
- ll_fz_font_is_monospaced(font)
- Low-level wrapper for `::fz_font_is_monospaced()`.
Query whether the font flags say that this font is monospaced.
- ll_fz_font_is_serif(font)
- Low-level wrapper for `::fz_font_is_serif()`.
Query whether the font flags say that this font is serif.
- ll_fz_font_name(font)
- Low-level wrapper for `::fz_font_name()`.
Retrieve a pointer to the name of the font.
font: The font to query.
Returns a pointer to an internal copy of the font name.
Will never be NULL, but may be the empty string.
- ll_fz_font_shaper_data(font)
- Low-level wrapper for `::fz_font_shaper_data()`.
Retrieve a pointer to the shaper data
structure for the given font.
font: The font to query.
Returns a pointer to the shaper data structure (or NULL if
font is NULL).
- ll_fz_font_t3_procs(font)
- Low-level wrapper for `::fz_font_t3_procs()`.
Retrieve the Type3 procs
for a font.
font: The font to query
Returns the t3_procs pointer. Will be NULL for a
non type-3 font.
- ll_fz_format_link_uri(doc, dest)
- Low-level wrapper for `::fz_format_link_uri()`.
Format an internal link to a page number, location, and possible viewing parameters,
suitable for use with fz_create_link.
Returns a newly allocated string that the caller must free.
- ll_fz_format_output_path(format, page)
- # Provide native python implementation of format_output_path() (->
# fz_format_output_path).
- ll_fz_free(p)
- Low-level wrapper for `::fz_free()`.
Free a previously allocated block of memory.
fz_free(ctx, NULL) does nothing.
Never throws exceptions.
- ll_fz_gamma_pixmap(pix, gamma)
- Low-level wrapper for `::fz_gamma_pixmap()`.
Apply gamma correction to a pixmap. All components
of all pixels are modified (except alpha, which is unchanged).
gamma: The gamma value to apply; 1.0 for no change.
- ll_fz_generate_transition(tpix, opix, npix, time, trans)
- Low-level wrapper for `::fz_generate_transition()`.
Generate a frame of a transition.
tpix: Target pixmap
opix: Old pixmap
npix: New pixmap
time: Position within the transition (0 to 256)
trans: Transition details
Returns 1 if successfully generated a frame.
Note: Pixmaps must include alpha.
- ll_fz_get_glyph_name(font, glyph, buf, size)
- Low-level wrapper for `::fz_get_glyph_name()`.
Find the name of a glyph
font: The font to look for the glyph in.
glyph: The glyph id to look for.
buf: Pointer to a buffer for the name to be inserted into.
size: The size of the buffer.
If a font contains a name table, then the name of the glyph
will be returned in the supplied buffer. Otherwise a name
is synthesised. The name will be truncated to fit in
the buffer.
- ll_fz_get_pixmap_from_image(image, subarea, ctm)
- Wrapper for out-params of fz_get_pixmap_from_image().
Returns: fz_pixmap *, int w, int h
- ll_fz_get_pixmap_from_image_outparams_fn(image, subarea, ctm, outparams)
- ll_fz_get_unscaled_pixmap_from_image(image)
- Low-level wrapper for `::fz_get_unscaled_pixmap_from_image()`.
Calls fz_get_pixmap_from_image() with ctm, subarea, w and h all set to NULL.
- ll_fz_getopt(nargc, ostr)
- Wrapper for out-params of fz_getopt().
Returns: int, char *nargv
- ll_fz_getopt_outparams_fn(nargc, ostr, outparams)
- ll_fz_glyph_bbox(glyph)
- Low-level wrapper for `::fz_glyph_bbox()`.
Return the bounding box of the glyph in pixels.
- ll_fz_glyph_bbox_no_ctx(src)
- Low-level wrapper for `::fz_glyph_bbox_no_ctx()`.
- ll_fz_glyph_cacheable(font, gid)
- Low-level wrapper for `::fz_glyph_cacheable()`.
Determine if a given glyph in a font
is cacheable. Certain glyphs in a type 3 font cannot safely
be cached, as their appearance depends on the enclosing
graphic state.
font: The font to look for the glyph in.
gif: The glyph to query.
Returns non-zero if cacheable, 0 if not.
- ll_fz_glyph_height(glyph)
- Low-level wrapper for `::fz_glyph_height()`.
Return the height of the glyph in pixels.
- ll_fz_glyph_name_from_unicode_sc(unicode)
- Low-level wrapper for `::fz_glyph_name_from_unicode_sc()`.
- ll_fz_glyph_width(glyph)
- Low-level wrapper for `::fz_glyph_width()`.
Return the width of the glyph in pixels.
- ll_fz_graphics_aa_level()
- Low-level wrapper for `::fz_graphics_aa_level()`.
Get the number of bits of antialiasing we are
using for graphics. Between 0 and 8.
- ll_fz_graphics_min_line_width()
- Low-level wrapper for `::fz_graphics_min_line_width()`.
Get the minimum line width to be
used for stroked lines.
min_line_width: The minimum line width to use (in pixels).
- ll_fz_gridfit_matrix(as_tiled, m)
- Low-level wrapper for `::fz_gridfit_matrix()`.
Grid fit a matrix.
as_tiled = 0 => adjust the matrix so that the image of the unit
square completely covers any pixel that was touched by the
image of the unit square under the original matrix.
as_tiled = 1 => adjust the matrix so that the corners of the
image of the unit square align with the closest integer corner
of the image of the unit square under the original matrix.
- ll_fz_grisu(f, s)
- Wrapper for out-params of fz_grisu().
Returns: int, int exp
- ll_fz_grisu_outparams_fn(f, s, outparams)
- ll_fz_grow_buffer(buf)
- Low-level wrapper for `::fz_grow_buffer()`.
Make some space within a buffer (i.e. ensure that
capacity > size).
- ll_fz_has_archive_entry(arch, name)
- Low-level wrapper for `::fz_has_archive_entry()`.
Check if entry by given name exists.
If named entry does not exist 0 will be returned, if it does
exist 1 is returned.
name: Entry name to look for, this must be an exact match to
the entry name in the archive.
- ll_fz_has_option(opts, key)
- Wrapper for out-params of fz_has_option().
Returns: int, const char *val
- ll_fz_has_option_outparams_fn(opts, key, outparams)
- ll_fz_has_permission(doc, p)
- Low-level wrapper for `::fz_has_permission()`.
Check permission flags on document.
- ll_fz_hash_filter(table, state, callback)
- Low-level wrapper for `::fz_hash_filter()`.
Iterate over the entries in a hash table, removing all the ones where callback returns true.
Does NOT free the value of the entry, so the caller is expected to take care of this.
- ll_fz_hash_find(table, key)
- Low-level wrapper for `::fz_hash_find()`.
Search for a matching hash within the table, and return the
associated value.
- ll_fz_hash_for_each(table, state, callback)
- Low-level wrapper for `::fz_hash_for_each()`.
Iterate over the entries in a hash table.
- ll_fz_hash_insert(table, key, val)
- Low-level wrapper for `::fz_hash_insert()`.
Insert a new key/value pair into the hash table.
If an existing entry with the same key is found, no change is
made to the hash table, and a pointer to the existing value is
returned.
If no existing entry with the same key is found, ownership of
val passes in, key is copied, and NULL is returned.
- ll_fz_hash_remove(table, key)
- Low-level wrapper for `::fz_hash_remove()`.
Remove the entry for a given key.
The value is NOT freed, so the caller is expected to take care
of this.
- ll_fz_hb_lock()
- Low-level wrapper for `::fz_hb_lock()`.
Lock against Harfbuzz being called
simultaneously in several threads. This reuses
FZ_LOCK_FREETYPE.
- ll_fz_hb_unlock()
- Low-level wrapper for `::fz_hb_unlock()`.
Unlock after a Harfbuzz call. This reuses
FZ_LOCK_FREETYPE.
- ll_fz_highlight_selection(page, a, b, quads, max_quads)
- Low-level wrapper for `::fz_highlight_selection()`.
Return a list of quads to highlight lines inside the selection
points.
- ll_fz_highlight_selection2(page, a, b, max_quads)
- Low-level wrapper for `::fz_highlight_selection2()`.
C++ alternative to fz_highlight_selection() that returns quads in a
std::vector.
- ll_fz_ignore_text(dev, text, ctm)
- Low-level wrapper for `::fz_ignore_text()`.
- ll_fz_image_orientation(image)
- Low-level wrapper for `::fz_image_orientation()`.
Request the natural orientation of an image.
This is for images (such as JPEG) that can contain internal
specifications of rotation/flips. This is ignored by all the
internal decode/rendering routines, but can be used by callers
(such as the image document handler) to respect such
specifications.
The values used by MuPDF are as follows, with the equivalent
Exif specifications given for information:
0: Undefined
1: 0 degree ccw rotation. (Exif = 1)
2: 90 degree ccw rotation. (Exif = 8)
3: 180 degree ccw rotation. (Exif = 3)
4: 270 degree ccw rotation. (Exif = 6)
5: flip on X. (Exif = 2)
6: flip on X, then rotate ccw by 90 degrees. (Exif = 5)
7: flip on X, then rotate ccw by 180 degrees. (Exif = 4)
8: flip on X, then rotate ccw by 270 degrees. (Exif = 7)
- ll_fz_image_orientation_matrix(image)
- Low-level wrapper for `::fz_image_orientation_matrix()`.
- ll_fz_image_resolution(image)
- Wrapper for out-params of fz_image_resolution().
Returns: int xres, int yres
- ll_fz_image_resolution_outparams_fn(image, outparams)
- ll_fz_image_size(im)
- Low-level wrapper for `::fz_image_size()`.
Return the size of the storage used by an image.
- ll_fz_image_type_name(type)
- Low-level wrapper for `::fz_image_type_name()`.
Map from FZ_IMAGE_* value to string.
The returned string is static and therefore must not be freed.
- ll_fz_include_point_in_rect(r, p)
- Low-level wrapper for `::fz_include_point_in_rect()`.
Expand a bbox to include a given point.
To create a rectangle that encompasses a sequence of points, the
rectangle must first be set to be the empty rectangle at one of
the points before including the others.
- ll_fz_install_load_system_font_funcs(f, f_cjk, f_fallback)
- Low-level wrapper for `::fz_install_load_system_font_funcs()`.
Install functions to allow MuPDF to request fonts from the
system.
Only one set of hooks can be in use at a time.
- ll_fz_intersect_irect(a, b)
- Low-level wrapper for `::fz_intersect_irect()`.
Compute intersection of two bounding boxes.
Similar to fz_intersect_rect but operates on two bounding
boxes instead of two rectangles.
- ll_fz_intersect_rect(a, b)
- Low-level wrapper for `::fz_intersect_rect()`.
Compute intersection of two rectangles.
Given two rectangles, update the first to be the smallest
axis-aligned rectangle that covers the area covered by both
given rectangles. If either rectangle is empty then the
intersection is also empty. If either rectangle is infinite
then the intersection is simply the non-infinite rectangle.
Should both rectangles be infinite, then the intersection is
also infinite.
- ll_fz_invert_bitmap(bmp)
- Low-level wrapper for `::fz_invert_bitmap()`.
Invert bitmap.
Never throws exceptions.
- ll_fz_invert_matrix(matrix)
- Low-level wrapper for `::fz_invert_matrix()`.
Create an inverse matrix.
inverse: Place to store inverse matrix.
matrix: Matrix to invert. A degenerate matrix, where the
determinant is equal to zero, can not be inverted and the
original matrix is returned instead.
Returns inverse.
- ll_fz_invert_pixmap(pix)
- Low-level wrapper for `::fz_invert_pixmap()`.
Invert all the pixels in a pixmap. All components (process and
spots) of all pixels are inverted (except alpha, which is
unchanged).
- ll_fz_invert_pixmap_alpha(pix)
- Low-level wrapper for `::fz_invert_pixmap_alpha()`.
Invert the alpha fo all the pixels in a pixmap.
- ll_fz_invert_pixmap_luminance(pix)
- Low-level wrapper for `::fz_invert_pixmap_luminance()`.
Transform the pixels in a pixmap so that luminance of each
pixel is inverted, and the chrominance remains unchanged (as
much as accuracy allows).
All components of all pixels are inverted (except alpha, which
is unchanged). Only supports Grey and RGB bitmaps.
- ll_fz_invert_pixmap_raw(pix)
- Low-level wrapper for `::fz_invert_pixmap_raw()`.
Invert all the pixels in a non-premultiplied pixmap in a
very naive manner.
- ll_fz_invert_pixmap_rect(image, rect)
- Low-level wrapper for `::fz_invert_pixmap_rect()`.
Invert all the pixels in a given rectangle of a (premultiplied)
pixmap. All components of all pixels in the rectangle are
inverted (except alpha, which is unchanged).
- ll_fz_irect_from_rect(rect)
- Low-level wrapper for `::fz_irect_from_rect()`.
Convert a rect into the minimal bounding box
that covers the rectangle.
Coordinates in a bounding box are integers, so rounding of the
rects coordinates takes place. The top left corner is rounded
upwards and left while the bottom right corner is rounded
downwards and to the right.
- ll_fz_irect_height(r)
- Low-level wrapper for `::fz_irect_height()`.
Return the height of an irect. Invalid irects return 0.
- ll_fz_irect_width(r)
- Low-level wrapper for `::fz_irect_width()`.
Return the width of an irect. Invalid irects return 0.
- ll_fz_is_directory(path)
- Low-level wrapper for `::fz_is_directory()`.
Determine if a given path is a directory.
- ll_fz_is_document_reflowable(doc)
- Low-level wrapper for `::fz_is_document_reflowable()`.
Is the document reflowable.
Returns 1 to indicate reflowable documents, otherwise 0.
- ll_fz_is_empty_irect(r)
- Low-level wrapper for `::fz_is_empty_irect()`.
- ll_fz_is_empty_rect(r)
- Low-level wrapper for `::fz_is_empty_rect()`.
Check if rectangle is empty.
An empty rectangle is defined as one whose area is zero.
All invalid rectangles are empty.
- ll_fz_is_eof(stm)
- Low-level wrapper for `::fz_is_eof()`.
Query if the stream has reached EOF (during normal bytewise
reading).
See fz_is_eof_bits for the equivalent function for bitwise
reading.
- ll_fz_is_eof_bits(stm)
- Low-level wrapper for `::fz_is_eof_bits()`.
Query if the stream has reached EOF (during bitwise
reading).
See fz_is_eof for the equivalent function for bytewise
reading.
- ll_fz_is_external_link(uri)
- Low-level wrapper for `::fz_is_external_link()`.
Query whether a link is external to a document (determined by
uri containing a ':', intended to match with '://' which
separates the scheme from the scheme specific parts in URIs).
- ll_fz_is_identity(m)
- Low-level wrapper for `::fz_is_identity()`.
- ll_fz_is_infinite_irect(r)
- Low-level wrapper for `::fz_is_infinite_irect()`.
Check if an integer rectangle
is infinite.
- ll_fz_is_infinite_rect(r)
- Low-level wrapper for `::fz_is_infinite_rect()`.
Check if rectangle is infinite.
- ll_fz_is_page_range(s)
- Low-level wrapper for `::fz_is_page_range()`.
Check and parse string into page ranges:
,?(-?+|N)(-(-?+|N))?/
- ll_fz_is_pixmap_monochrome(pixmap)
- Low-level wrapper for `::fz_is_pixmap_monochrome()`.
Check if the pixmap is a 1-channel image containing samples with
only values 0 and 255
- ll_fz_is_point_inside_irect(x, y, r)
- Low-level wrapper for `::fz_is_point_inside_irect()`.
Inclusion test for irects. (Rect is assumed to be open, i.e.
top right corner is not included).
- ll_fz_is_point_inside_quad(p, q)
- Low-level wrapper for `::fz_is_point_inside_quad()`.
Inclusion test for quads.
- ll_fz_is_point_inside_rect(p, r)
- Low-level wrapper for `::fz_is_point_inside_rect()`.
Inclusion test for rects. (Rect is assumed to be open, i.e.
top right corner is not included).
- ll_fz_is_pow2(a)
- Low-level wrapper for `::fz_is_pow2()`.
- ll_fz_is_quad_inside_quad(needle, haystack)
- Low-level wrapper for `::fz_is_quad_inside_quad()`.
Inclusion test for quad in quad.
This may break down if quads are not 'well formed'.
- ll_fz_is_quad_intersecting_quad(a, b)
- Low-level wrapper for `::fz_is_quad_intersecting_quad()`.
Intersection test for quads.
This may break down if quads are not 'well formed'.
- ll_fz_is_rectilinear(m)
- Low-level wrapper for `::fz_is_rectilinear()`.
Check if a transformation is rectilinear.
Rectilinear means that no shearing is present and that any
rotations present are a multiple of 90 degrees. Usually this
is used to make sure that axis-aligned rectangles before the
transformation are still axis-aligned rectangles afterwards.
- ll_fz_is_tar_archive(file)
- Low-level wrapper for `::fz_is_tar_archive()`.
Detect if stream object is a tar achieve.
Assumes that the stream object is seekable.
- ll_fz_is_valid_blend_colorspace(cs)
- Low-level wrapper for `::fz_is_valid_blend_colorspace()`.
Check to see that a colorspace is appropriate to be used as
a blending space (i.e. only grey, rgb or cmyk).
- ll_fz_is_valid_irect(r)
- Low-level wrapper for `::fz_is_valid_irect()`.
Check if an integer rectangle is valid.
- ll_fz_is_valid_rect(r)
- Low-level wrapper for `::fz_is_valid_rect()`.
Check if rectangle is valid.
- ll_fz_is_zip_archive(file)
- Low-level wrapper for `::fz_is_zip_archive()`.
Detect if stream object is a zip archive.
Assumes that the stream object is seekable.
- ll_fz_iso8859_1_from_unicode(u)
- Low-level wrapper for `::fz_iso8859_1_from_unicode()`.
- ll_fz_iso8859_7_from_unicode(u)
- Low-level wrapper for `::fz_iso8859_7_from_unicode()`.
- ll_fz_jbig2_globals_data(globals)
- Low-level wrapper for `::fz_jbig2_globals_data()`.
Return buffer containing jbig2 globals data stream.
- ll_fz_keep_archive(arch)
- Low-level wrapper for `::fz_keep_archive()`.
Keep a reference to an archive.
- ll_fz_keep_bitmap(bit)
- Low-level wrapper for `::fz_keep_bitmap()`.
Take an additional reference to the bitmap. The same pointer
is returned.
Never throws exceptions.
- ll_fz_keep_buffer(buf)
- Low-level wrapper for `::fz_keep_buffer()`.
Take an additional reference to the buffer. The same pointer
is returned.
Never throws exceptions.
- ll_fz_keep_colorspace(colorspace)
- Low-level wrapper for `::fz_keep_colorspace()`.
Increment the reference count for the colorspace.
Returns the same pointer. Never throws an exception.
- ll_fz_keep_default_colorspaces(default_cs)
- Low-level wrapper for `::fz_keep_default_colorspaces()`.
Keep an additional reference to the default colorspaces
structure.
Never throws exceptions.
- ll_fz_keep_device(dev)
- Low-level wrapper for `::fz_keep_device()`.
Increment the reference count for a device. Returns the same
pointer.
Never throws exceptions.
- ll_fz_keep_display_list(list)
- Low-level wrapper for `::fz_keep_display_list()`.
Increment the reference count for a display list. Returns the
same pointer.
Never throws exceptions.
- ll_fz_keep_document(doc)
- Low-level wrapper for `::fz_keep_document()`.
Increment the document reference count. The same pointer is
returned.
Never throws exceptions.
- ll_fz_keep_font(font)
- Low-level wrapper for `::fz_keep_font()`.
Add a reference to an existing fz_font.
font: The font to add a reference to.
Returns the same font.
- ll_fz_keep_glyph(pix)
- Low-level wrapper for `::fz_keep_glyph()`.
Take a reference to a glyph.
pix: The glyph to increment the reference for.
Returns pix.
- ll_fz_keep_halftone(half)
- Low-level wrapper for `::fz_keep_halftone()`.
Take an additional reference to the halftone. The same pointer
is returned.
Never throws exceptions.
- ll_fz_keep_image(image)
- Low-level wrapper for `::fz_keep_image()`.
Increment the (normal) reference count for an image. Returns the
same pointer.
Never throws exceptions.
- ll_fz_keep_image_store_key(image)
- Low-level wrapper for `::fz_keep_image_store_key()`.
Increment the store key reference for an image. Returns the same
pointer. (This is the count of references for an image held by
keys in the image store).
Never throws exceptions.
- ll_fz_keep_imp(p)
- Wrapper for out-params of fz_keep_imp().
Returns: void *, int refs
- ll_fz_keep_imp16(p)
- Wrapper for out-params of fz_keep_imp16().
Returns: void *, int16_t refs
- ll_fz_keep_imp16_outparams_fn(p, outparams)
- ll_fz_keep_imp8(p, refs)
- Low-level wrapper for `::fz_keep_imp8()`.
- ll_fz_keep_imp8_locked(p, refs)
- Low-level wrapper for `::fz_keep_imp8_locked()`.
- ll_fz_keep_imp_locked(p)
- Wrapper for out-params of fz_keep_imp_locked().
Returns: void *, int refs
- ll_fz_keep_imp_locked_outparams_fn(p, outparams)
- ll_fz_keep_imp_outparams_fn(p, outparams)
- ll_fz_keep_jbig2_globals(globals)
- Low-level wrapper for `::fz_keep_jbig2_globals()`.
Increment the reference count for a jbig2 globals record.
Never throws an exception.
- ll_fz_keep_key_storable(arg_1)
- Low-level wrapper for `::fz_keep_key_storable()`.
Increment the (normal) reference count for a key storable
object. Returns the same pointer.
Never throws exceptions.
- ll_fz_keep_key_storable_key(arg_1)
- Low-level wrapper for `::fz_keep_key_storable_key()`.
Increment the (key) reference count for a key storable
object. Returns the same pointer.
Never throws exceptions.
- ll_fz_keep_link(link)
- Low-level wrapper for `::fz_keep_link()`.
Increment the reference count for a link. The same pointer is
returned.
Never throws exceptions.
- ll_fz_keep_outline(outline)
- Low-level wrapper for `::fz_keep_outline()`.
Increment the reference count. Returns the same pointer.
Never throws exceptions.
- ll_fz_keep_page(page)
- Low-level wrapper for `::fz_keep_page()`.
Increment the reference count for the page. Returns the same
pointer.
Never throws exceptions.
- ll_fz_keep_page_locked(page)
- Low-level wrapper for `::fz_keep_page_locked()`.
Increment the reference count for the page. Returns the same
pointer. Must only be used when the alloc lock is already taken.
Never throws exceptions.
- ll_fz_keep_path(path)
- Low-level wrapper for `::fz_keep_path()`.
Increment the reference count. Returns the same pointer.
All paths can be kept, regardless of their packing type.
Never throws exceptions.
- ll_fz_keep_pixmap(pix)
- Low-level wrapper for `::fz_keep_pixmap()`.
Increment the reference count for the pixmap. The same pointer
is returned.
Never throws exceptions.
- ll_fz_keep_separations(sep)
- Low-level wrapper for `::fz_keep_separations()`.
Increment the reference count for a separations structure.
Returns the same pointer.
Never throws exceptions.
- ll_fz_keep_shade(shade)
- Low-level wrapper for `::fz_keep_shade()`.
Increment the reference count for the shade structure. The
same pointer is returned.
Never throws exceptions.
- ll_fz_keep_storable(arg_1)
- Low-level wrapper for `::fz_keep_storable()`.
Increment the reference count for a storable object.
Returns the same pointer.
Never throws exceptions.
- ll_fz_keep_store_context()
- Low-level wrapper for `::fz_keep_store_context()`.
Increment the reference count for the store context. Returns
the same pointer.
Never throws exceptions.
- ll_fz_keep_stream(stm)
- Low-level wrapper for `::fz_keep_stream()`.
Increments the reference count for a stream. Returns the same
pointer.
Never throws exceptions.
- ll_fz_keep_stroke_state(stroke)
- Low-level wrapper for `::fz_keep_stroke_state()`.
Take an additional reference to a stroke state structure.
No modifications should be carried out on a stroke
state to which more than one reference is held, as
this can cause race conditions.
- ll_fz_keep_text(text)
- Low-level wrapper for `::fz_keep_text()`.
Increment the reference count for the text object. The same
pointer is returned.
Never throws exceptions.
- ll_fz_keep_xml(xml)
- Low-level wrapper for `::fz_keep_xml()`.
Add a reference to the XML.
- ll_fz_koi8u_from_unicode(u)
- Low-level wrapper for `::fz_koi8u_from_unicode()`.
- ll_fz_last_page(doc)
- Low-level wrapper for `::fz_last_page()`.
Function to get the location for the last page in the document.
Using this can be far more efficient in some cases than calling
fz_count_pages and using the page number.
- ll_fz_layout_document(doc, w, h, em)
- Low-level wrapper for `::fz_layout_document()`.
Layout reflowable document types.
w, h: Page size in points.
em: Default font size in points.
- ll_fz_lineto(path, x, y)
- Low-level wrapper for `::fz_lineto()`.
Append a 'lineto' command to an open path.
path: The path to modify.
x, y: The coordinate to line to.
Throws exceptions on failure to allocate, or attempting to
modify a packed path.
- ll_fz_list_archive_entry(arch, idx)
- Low-level wrapper for `::fz_list_archive_entry()`.
Get listed name of entry position idx.
idx: Must be a value >= 0 < return value from
fz_count_archive_entries. If not in range NULL will be
returned.
May throw an exception if this type of archive cannot list the
entries (such as a directory).
- ll_fz_load_bmp_subimage(buf, len, subimage)
- Low-level wrapper for `::fz_load_bmp_subimage()`.
- ll_fz_load_bmp_subimage_count(buf, len)
- Low-level wrapper for `::fz_load_bmp_subimage_count()`.
- ll_fz_load_chapter_page(doc, chapter, page)
- Low-level wrapper for `::fz_load_chapter_page()`.
Load a page.
After fz_load_page is it possible to retrieve the size of the
page using fz_bound_page, or to render the page using
fz_run_page_*. Free the page by calling fz_drop_page.
chapter: chapter number, 0 is the first chapter of the document.
number: page number, 0 is the first page of the chapter.
- ll_fz_load_fallback_font(script, language, serif, bold, italic)
- Low-level wrapper for `::fz_load_fallback_font()`.
Try to load a fallback font for the
given combination of font attributes. Whether a font is
present or not will depend on the configuration in which
MuPDF is built.
script: The script desired (e.g. UCDN_SCRIPT_KATAKANA).
language: The language desired (e.g. FZ_LANG_ja).
serif: 1 if serif desired, 0 otherwise.
bold: 1 if bold desired, 0 otherwise.
italic: 1 if italic desired, 0 otherwise.
Returns a new font handle, or NULL if not available.
- ll_fz_load_jbig2_globals(buf)
- Low-level wrapper for `::fz_load_jbig2_globals()`.
Create a jbig2 globals record from a buffer.
Immutable once created.
- ll_fz_load_jbig2_subimage(buf, len, subimage)
- Low-level wrapper for `::fz_load_jbig2_subimage()`.
- ll_fz_load_jbig2_subimage_count(buf, len)
- Low-level wrapper for `::fz_load_jbig2_subimage_count()`.
- ll_fz_load_jpx(data, size, cs)
- Low-level wrapper for `::fz_load_jpx()`.
Exposed for PDF.
- ll_fz_load_links(page)
- Low-level wrapper for `::fz_load_links()`.
Load the list of links for a page.
Returns a linked list of all the links on the page, each with
its clickable region and link destination. Each link is
reference counted so drop and free the list of links by
calling fz_drop_link on the pointer return from fz_load_links.
page: Page obtained from fz_load_page.
- ll_fz_load_outline(doc)
- Low-level wrapper for `::fz_load_outline()`.
Load the hierarchical document outline.
Should be freed by fz_drop_outline.
- ll_fz_load_outline_from_iterator(iter)
- Low-level wrapper for `::fz_load_outline_from_iterator()`.
Routine to implement the old Structure based API from an iterator.
- ll_fz_load_page(doc, number)
- Low-level wrapper for `::fz_load_page()`.
Load a given page number from a document. This may be much less
efficient than loading by location (chapter+page) for some
document types.
- ll_fz_load_pnm_subimage(buf, len, subimage)
- Low-level wrapper for `::fz_load_pnm_subimage()`.
- ll_fz_load_pnm_subimage_count(buf, len)
- Low-level wrapper for `::fz_load_pnm_subimage_count()`.
- ll_fz_load_system_cjk_font(name, ordering, serif)
- Low-level wrapper for `::fz_load_system_cjk_font()`.
Attempt to load a given font from
the system.
name: The name of the desired font.
ordering: The ordering to load the font from (e.g. FZ_ADOBE_KOREA)
serif: 1 if serif desired, 0 otherwise.
Returns a new font handle, or NULL if no matching font was found
(or on error).
- ll_fz_load_system_font(name, bold, italic, needs_exact_metrics)
- Low-level wrapper for `::fz_load_system_font()`.
Attempt to load a given font from the system.
name: The name of the desired font.
bold: 1 if bold desired, 0 otherwise.
italic: 1 if italic desired, 0 otherwise.
needs_exact_metrics: 1 if an exact metrical match is required,
0 otherwise.
Returns a new font handle, or NULL if no matching font was found
(or on error).
- ll_fz_load_tiff_subimage(buf, len, subimage)
- Low-level wrapper for `::fz_load_tiff_subimage()`.
- ll_fz_load_tiff_subimage_count(buf, len)
- Low-level wrapper for `::fz_load_tiff_subimage_count()`.
Exposed for CBZ.
- ll_fz_location_from_page_number(doc, number)
- Low-level wrapper for `::fz_location_from_page_number()`.
Converts from page number to chapter+page. This may cause many
chapters to be laid out in order to calculate the number of
pages within those chapters.
- ll_fz_lock(lock)
- Low-level wrapper for `::fz_lock()`.
Lock one of the user supplied mutexes.
- ll_fz_log_error(str)
- Low-level wrapper for `::fz_log_error()`.
Log a (preformatted) string to the registered
error stream (stderr by default).
- ll_fz_lookup_base14_font(name)
- Wrapper for out-params of fz_lookup_base14_font().
Returns: const unsigned char *, int len
- ll_fz_lookup_base14_font_outparams_fn(name, outparams)
- ll_fz_lookup_blendmode(name)
- Low-level wrapper for `::fz_lookup_blendmode()`.
Map from (case sensitive) blend mode string to enumeration.
- ll_fz_lookup_bookmark(doc, mark)
- Low-level wrapper for `::fz_lookup_bookmark()`.
Find a bookmark and return its page number.
- ll_fz_lookup_bookmark2(doc, mark)
- ll_fz_lookup_builtin_font(name, bold, italic)
- Wrapper for out-params of fz_lookup_builtin_font().
Returns: const unsigned char *, int len
- ll_fz_lookup_builtin_font_outparams_fn(name, bold, italic, outparams)
- ll_fz_lookup_cjk_font(ordering)
- Wrapper for out-params of fz_lookup_cjk_font().
Returns: const unsigned char *, int len, int index
- ll_fz_lookup_cjk_font_by_language(lang)
- Wrapper for out-params of fz_lookup_cjk_font_by_language().
Returns: const unsigned char *, int len, int subfont
- ll_fz_lookup_cjk_font_by_language_outparams_fn(lang, outparams)
- ll_fz_lookup_cjk_font_outparams_fn(ordering, outparams)
- ll_fz_lookup_cjk_ordering_by_language(name)
- Low-level wrapper for `::fz_lookup_cjk_ordering_by_language()`.
Return the matching FZ_ADOBE_* ordering
for the given language tag, such as "zh-Hant", "zh-Hans", "ja", or "ko".
- ll_fz_lookup_image_type(type)
- Low-level wrapper for `::fz_lookup_image_type()`.
Map from (case sensitive) image type string to FZ_IMAGE_*
type value.
- ll_fz_lookup_metadata(doc, key, buf, size)
- Low-level wrapper for `::fz_lookup_metadata()`.
Retrieve document meta data strings.
doc: The document to query.
key: Which meta data key to retrieve...
Basic information:
'format' -- Document format and version.
'encryption' -- Description of the encryption used.
From the document information dictionary:
'info:Title'
'info:Author'
'info:Subject'
'info:Keywords'
'info:Creator'
'info:Producer'
'info:CreationDate'
'info:ModDate'
buf: The buffer to hold the results (a nul-terminated UTF-8
string).
size: Size of 'buf'.
Returns the number of bytes need to store the string plus terminator
(will be larger than 'size' if the output was truncated), or -1 if the
key is not recognized or found.
- ll_fz_lookup_metadata2(doc, key)
- Low-level wrapper for `::fz_lookup_metadata2()`.
C++ alternative to `fz_lookup_metadata()` that returns a `std::string`
or calls `fz_throw()` if not found.
- ll_fz_lookup_noto_emoji_font()
- Wrapper for out-params of fz_lookup_noto_emoji_font().
Returns: const unsigned char *, int len
- ll_fz_lookup_noto_emoji_font_outparams_fn(outparams)
- ll_fz_lookup_noto_font(script, lang)
- Wrapper for out-params of fz_lookup_noto_font().
Returns: const unsigned char *, int len, int subfont
- ll_fz_lookup_noto_font_outparams_fn(script, lang, outparams)
- ll_fz_lookup_noto_math_font()
- Wrapper for out-params of fz_lookup_noto_math_font().
Returns: const unsigned char *, int len
- ll_fz_lookup_noto_math_font_outparams_fn(outparams)
- ll_fz_lookup_noto_music_font()
- Wrapper for out-params of fz_lookup_noto_music_font().
Returns: const unsigned char *, int len
- ll_fz_lookup_noto_music_font_outparams_fn(outparams)
- ll_fz_lookup_noto_symbol1_font()
- Wrapper for out-params of fz_lookup_noto_symbol1_font().
Returns: const unsigned char *, int len
- ll_fz_lookup_noto_symbol1_font_outparams_fn(outparams)
- ll_fz_lookup_noto_symbol2_font()
- Wrapper for out-params of fz_lookup_noto_symbol2_font().
Returns: const unsigned char *, int len
- ll_fz_lookup_noto_symbol2_font_outparams_fn(outparams)
- ll_fz_lookup_rendering_intent(name)
- Low-level wrapper for `::fz_lookup_rendering_intent()`.
Map from (case sensitive) rendering intent string to enumeration
value.
- ll_fz_make_bookmark(doc, loc)
- Low-level wrapper for `::fz_make_bookmark()`.
Create a bookmark for the given page, which can be used to find
the same location after the document has been laid out with
different parameters.
- ll_fz_make_bookmark2(doc, loc)
- ll_fz_make_irect(x0, y0, x1, y1)
- Low-level wrapper for `::fz_make_irect()`.
- ll_fz_make_link_dest_none()
- Low-level wrapper for `::fz_make_link_dest_none()`.
- ll_fz_make_link_dest_xyz(chapter, page, x, y, z)
- Low-level wrapper for `::fz_make_link_dest_xyz()`.
- ll_fz_make_location(chapter, page)
- Low-level wrapper for `::fz_make_location()`.
Simple constructor for fz_locations.
- ll_fz_make_matrix(a, b, c, d, e, f)
- Low-level wrapper for `::fz_make_matrix()`.
- ll_fz_make_point(x, y)
- Low-level wrapper for `::fz_make_point()`.
- ll_fz_make_quad(ul_x, ul_y, ur_x, ur_y, ll_x, ll_y, lr_x, lr_y)
- Low-level wrapper for `::fz_make_quad()`.
Inline convenience construction function.
- ll_fz_make_rect(x0, y0, x1, y1)
- Low-level wrapper for `::fz_make_rect()`.
- ll_fz_malloc(size)
- Low-level wrapper for `::fz_malloc()`.
Allocate uninitialized memory of a given size.
Does NOT clear the memory!
May return NULL for size = 0.
Throws exception in the event of failure to allocate.
- ll_fz_malloc_no_throw(size)
- Low-level wrapper for `::fz_malloc_no_throw()`.
fz_malloc equivalent that returns NULL rather than throwing
exceptions.
- ll_fz_matrix_expansion(m)
- Low-level wrapper for `::fz_matrix_expansion()`.
Calculate average scaling factor of matrix.
- ll_fz_matrix_max_expansion(m)
- Low-level wrapper for `::fz_matrix_max_expansion()`.
Find the largest expansion performed by this matrix.
(i.e. max(abs(m.a),abs(m.b),abs(m.c),abs(m.d))
- ll_fz_max(a, b)
- Low-level wrapper for `::fz_max()`.
- ll_fz_maxi(a, b)
- Low-level wrapper for `::fz_maxi()`.
- ll_fz_maxi64(a, b)
- Low-level wrapper for `::fz_maxi64()`.
- ll_fz_maxz(a, b)
- Low-level wrapper for `::fz_maxz()`.
- ll_fz_md5_buffer(buffer, digest)
- Low-level wrapper for `::fz_md5_buffer()`.
Create an MD5 digest from buffer contents.
Never throws exceptions.
- ll_fz_md5_final(state, digest)
- Low-level wrapper for `::fz_md5_final()`.
MD5 finalization. Ends an MD5 message-digest operation, writing
the message digest and zeroizing the context.
Never throws an exception.
- ll_fz_md5_final2(md5)
- Low-level wrapper for `::fz_md5_final2()`.
C++ alternative to fz_md5_final() that returns the digest by value.
- ll_fz_md5_init(state)
- Low-level wrapper for `::fz_md5_init()`.
MD5 initialization. Begins an MD5 operation, writing a new
context.
Never throws an exception.
- ll_fz_md5_pixmap(pixmap, digest)
- Low-level wrapper for `::fz_md5_pixmap()`.
- ll_fz_md5_pixmap2(pixmap)
- Low-level wrapper for `::fz_md5_pixmap2()`.
C++ alternative to `fz_md5_pixmap()` that returns the digest by value.
- ll_fz_md5_update(state, input, inlen)
- Low-level wrapper for `::fz_md5_update()`.
MD5 block update operation. Continues an MD5 message-digest
operation, processing another message block, and updating the
context.
Never throws an exception.
- ll_fz_md5_update_int64(state, i)
- Low-level wrapper for `::fz_md5_update_int64()`.
MD5 block update operation. Continues an MD5 message-digest
operation, processing an int64, and updating the context.
Never throws an exception.
- ll_fz_measure_string(user_font, trm, s, wmode, bidi_level, markup_dir, language)
- Low-level wrapper for `::fz_measure_string()`.
Measure the advance width of a UTF8 string should it be added to a text object.
This uses the same layout algorithms as fz_show_string, and can be used
to calculate text alignment adjustments.
- ll_fz_memmem(haystack, haystacklen, needle, needlelen)
- Low-level wrapper for `::fz_memmem()`.
Find the start of the first occurrence of the substring needle in haystack.
- ll_fz_memrnd(block, len)
- Low-level wrapper for `::fz_memrnd()`.
Fill block with len bytes of pseudo-randomness.
- ll_fz_min(a, b)
- Low-level wrapper for `::fz_min()`.
- ll_fz_mini(a, b)
- Low-level wrapper for `::fz_mini()`.
- ll_fz_mini64(a, b)
- Low-level wrapper for `::fz_mini64()`.
- ll_fz_minz(a, b)
- Low-level wrapper for `::fz_minz()`.
- ll_fz_morph_error(fromcode, tocode)
- Low-level wrapper for `::fz_morph_error()`.
Called within a catch block this modifies the current
exception's code. If it's of type 'fromcode' it is
modified to 'tocode'. Typically used for 'downgrading'
exception severity.
- ll_fz_mount_multi_archive(arch_, sub, path)
- Low-level wrapper for `::fz_mount_multi_archive()`.
Add an archive to the set of archives handled by a multi
archive.
If path is NULL, then the archive contents will appear at the
top level, otherwise, the archives contents will appear prefixed
by path.
- ll_fz_moveto(path, x, y)
- Low-level wrapper for `::fz_moveto()`.
Append a 'moveto' command to a path.
This 'opens' a path.
path: The path to modify.
x, y: The coordinate to move to.
Throws exceptions on failure to allocate, or attempting to
modify a packed path.
- ll_fz_mul255(a, b)
- Low-level wrapper for `::fz_mul255()`.
Multiply scaled two integers in the 0..255 range
- ll_fz_needs_password(doc)
- Low-level wrapper for `::fz_needs_password()`.
Check if a document is encrypted with a
non-blank password.
- ll_fz_new_arc4_output(chain, key, keylen)
- Low-level wrapper for `::fz_new_arc4_output()`.
- ll_fz_new_archive_of_size(file, size)
- Low-level wrapper for `::fz_new_archive_of_size()`.
- ll_fz_new_ascii85_output(chain)
- Low-level wrapper for `::fz_new_ascii85_output()`.
- ll_fz_new_asciihex_output(chain)
- Low-level wrapper for `::fz_new_asciihex_output()`.
Compression and other filtering outputs.
These outputs write encoded data to another output. Create a
filter output with the destination, write to the filter, then
close and drop it when you're done. These can also be chained
together, for example to write ASCII Hex encoded, Deflate
compressed, and RC4 encrypted data to a buffer output.
Output streams don't use reference counting, so make sure to
close all of the filters in the reverse order of creation so
that data is flushed properly.
Accordingly, ownership of 'chain' is never passed into the
following functions, but remains with the caller, whose
responsibility it is to ensure they exist at least until
the returned fz_output is dropped.
- ll_fz_new_band_writer_of_size(size, out)
- Low-level wrapper for `::fz_new_band_writer_of_size()`.
- ll_fz_new_base14_font(name)
- Low-level wrapper for `::fz_new_base14_font()`.
Create a new font from one of the built-in fonts.
- ll_fz_new_bbox_device(rectp)
- Low-level wrapper for `::fz_new_bbox_device()`.
Create a device to compute the bounding
box of all marks on a page.
The returned bounding box will be the union of all bounding
boxes of all objects on a page.
- ll_fz_new_bitmap(w, h, n, xres, yres)
- Low-level wrapper for `::fz_new_bitmap()`.
Create a new bitmap.
w, h: Width and Height for the bitmap
n: Number of color components (assumed to be a divisor of 8)
xres, yres: X and Y resolutions (in pixels per inch).
Returns pointer to created bitmap structure. The bitmap
data is uninitialised.
- ll_fz_new_bitmap_from_pixmap(pix, ht)
- Low-level wrapper for `::fz_new_bitmap_from_pixmap()`.
Make a bitmap from a pixmap and a halftone.
pix: The pixmap to generate from. Currently must be a single
color component with no alpha.
ht: The halftone to use. NULL implies the default halftone.
Returns the resultant bitmap. Throws exceptions in the case of
failure to allocate.
- ll_fz_new_bitmap_from_pixmap_band(pix, ht, band_start)
- Low-level wrapper for `::fz_new_bitmap_from_pixmap_band()`.
Make a bitmap from a pixmap and a
halftone, allowing for the position of the pixmap within an
overall banded rendering.
pix: The pixmap to generate from. Currently must be a single
color component with no alpha.
ht: The halftone to use. NULL implies the default halftone.
band_start: Vertical offset within the overall banded rendering
(in pixels)
Returns the resultant bitmap. Throws exceptions in the case of
failure to allocate.
- ll_fz_new_buffer(capacity)
- Low-level wrapper for `::fz_new_buffer()`.
- ll_fz_new_buffer_from_base64(data, size)
- Low-level wrapper for `::fz_new_buffer_from_base64()`.
Create a new buffer with data decoded from a base64 input string.
- ll_fz_new_buffer_from_copied_data(data)
- Returns fz_buffer containing copy of `data`, which should
be a `bytes` or similar Python buffer instance.
- ll_fz_new_buffer_from_copied_data_orig = ll_fz_new_buffer_from_copied_data(data, size)
- Low-level wrapper for `::fz_new_buffer_from_copied_data()`.
Create a new buffer containing a copy of the passed data.
- ll_fz_new_buffer_from_data(data, size)
- Low-level wrapper for `::fz_new_buffer_from_data()`.
Create a new buffer with existing data.
data: Pointer to existing data.
size: Size of existing data.
Takes ownership of data. Does not make a copy. Calls fz_free on
the data when the buffer is deallocated. Do not use 'data' after
passing to this function.
Returns pointer to new buffer. Throws exception on allocation
failure.
- ll_fz_new_buffer_from_display_list(list, options)
- Low-level wrapper for `::fz_new_buffer_from_display_list()`.
- ll_fz_new_buffer_from_image_as_jpeg(image, color_params, quality, invert_cmyk)
- Low-level wrapper for `::fz_new_buffer_from_image_as_jpeg()`.
- ll_fz_new_buffer_from_image_as_pam(image, color_params)
- Low-level wrapper for `::fz_new_buffer_from_image_as_pam()`.
- ll_fz_new_buffer_from_image_as_png(image, color_params)
- Low-level wrapper for `::fz_new_buffer_from_image_as_png()`.
Reencode a given image as a PNG into a buffer.
Ownership of the buffer is returned.
- ll_fz_new_buffer_from_image_as_pnm(image, color_params)
- Low-level wrapper for `::fz_new_buffer_from_image_as_pnm()`.
- ll_fz_new_buffer_from_image_as_psd(image, color_params)
- Low-level wrapper for `::fz_new_buffer_from_image_as_psd()`.
- ll_fz_new_buffer_from_page(page, options)
- Low-level wrapper for `::fz_new_buffer_from_page()`.
- ll_fz_new_buffer_from_page_number(doc, number, options)
- Low-level wrapper for `::fz_new_buffer_from_page_number()`.
- ll_fz_new_buffer_from_page_with_format(page, format, options, transform, cookie)
- Low-level wrapper for `::fz_new_buffer_from_page_with_format()`.
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.
- ll_fz_new_buffer_from_pixmap_as_jpeg(pixmap, color_params, quality, invert_cmyk)
- Low-level wrapper for `::fz_new_buffer_from_pixmap_as_jpeg()`.
- ll_fz_new_buffer_from_pixmap_as_pam(pixmap, color_params)
- Low-level wrapper for `::fz_new_buffer_from_pixmap_as_pam()`.
- ll_fz_new_buffer_from_pixmap_as_png(pixmap, color_params)
- Low-level wrapper for `::fz_new_buffer_from_pixmap_as_png()`.
Reencode a given pixmap as a PNG into a buffer.
Ownership of the buffer is returned.
- ll_fz_new_buffer_from_pixmap_as_pnm(pixmap, color_params)
- Low-level wrapper for `::fz_new_buffer_from_pixmap_as_pnm()`.
- ll_fz_new_buffer_from_pixmap_as_psd(pix, color_params)
- Low-level wrapper for `::fz_new_buffer_from_pixmap_as_psd()`.
- ll_fz_new_buffer_from_shared_data(data, size)
- Low-level wrapper for `::fz_new_buffer_from_shared_data()`.
Like fz_new_buffer, but does not take ownership.
- ll_fz_new_buffer_from_stext_page(text)
- Low-level wrapper for `::fz_new_buffer_from_stext_page()`.
Convert structured text into plain text.
- ll_fz_new_builtin_font(name, is_bold, is_italic)
- Low-level wrapper for `::fz_new_builtin_font()`.
- ll_fz_new_cal_gray_colorspace(wp, bp, gamma)
- Low-level wrapper for `::fz_new_cal_gray_colorspace()`.
Create a calibrated gray colorspace.
The returned reference should be dropped when it is finished
with.
Colorspaces are immutable once created.
- ll_fz_new_cal_rgb_colorspace(wp, bp, gamma, matrix)
- Low-level wrapper for `::fz_new_cal_rgb_colorspace()`.
Create a calibrated rgb colorspace.
The returned reference should be dropped when it is finished
with.
Colorspaces are immutable once created.
- ll_fz_new_cbz_writer(path, options)
- Low-level wrapper for `::fz_new_cbz_writer()`.
- ll_fz_new_cbz_writer_with_output(out, options)
- Low-level wrapper for `::fz_new_cbz_writer_with_output()`.
- ll_fz_new_cjk_font(ordering)
- Low-level wrapper for `::fz_new_cjk_font()`.
- ll_fz_new_color_pcl_band_writer(out, options)
- Low-level wrapper for `::fz_new_color_pcl_band_writer()`.
Create a new band writer, outputing color pcl.
- ll_fz_new_colorspace(type, flags, n, name)
- Low-level wrapper for `::fz_new_colorspace()`.
Creates a new colorspace instance and returns a reference.
No internal checking is done that the colorspace type (e.g.
CMYK) matches with the flags (e.g. FZ_COLORSPACE_HAS_CMYK) or
colorant count (n) or name.
The reference should be dropped when it is finished with.
Colorspaces are immutable once created (with the exception of
setting up colorant names for separation spaces).
- ll_fz_new_compressed_buffer()
- Low-level wrapper for `::fz_new_compressed_buffer()`.
Create a new, UNKNOWN format, compressed_buffer;
- ll_fz_new_context_imp(alloc, locks, max_store, version)
- Low-level wrapper for `::fz_new_context_imp()`.
- ll_fz_new_default_colorspaces()
- Low-level wrapper for `::fz_new_default_colorspaces()`.
Create a new default colorspace structure with values inherited
from the context, and return a reference to it.
These can be overridden using fz_set_default_xxxx.
These should not be overridden while more than one caller has
the reference for fear of race conditions.
The caller should drop this reference once finished with it.
- ll_fz_new_deflate_output(chain, effort, raw)
- Low-level wrapper for `::fz_new_deflate_output()`.
- ll_fz_new_deflated_data(source, source_length, level)
- Wrapper for out-params of fz_new_deflated_data().
Returns: unsigned char *, size_t compressed_length
- ll_fz_new_deflated_data_from_buffer(buffer, level)
- Wrapper for out-params of fz_new_deflated_data_from_buffer().
Returns: unsigned char *, size_t compressed_length
- ll_fz_new_deflated_data_from_buffer_outparams_fn(buffer, level, outparams)
- ll_fz_new_deflated_data_outparams_fn(source, source_length, level, outparams)
- ll_fz_new_device_of_size(size)
- Low-level wrapper for `::fz_new_device_of_size()`.
Devices are created by calls to device implementations, for
instance: foo_new_device(). These will be implemented by calling
fz_new_derived_device(ctx, foo_device) where foo_device is a
structure "derived from" fz_device, for instance
typedef struct { fz_device base; ...extras...} foo_device;
- ll_fz_new_display_list(mediabox)
- Low-level wrapper for `::fz_new_display_list()`.
Create an empty display list.
A display list contains drawing commands (text, images, etc.).
Use fz_new_list_device for populating the list.
mediabox: Bounds of the page (in points) represented by the
display list.
- ll_fz_new_display_list_from_page(page)
- Low-level wrapper for `::fz_new_display_list_from_page()`.
Create a display list.
Ownership of the display list is returned to the caller.
- ll_fz_new_display_list_from_page_contents(page)
- Low-level wrapper for `::fz_new_display_list_from_page_contents()`.
Create a display list from page contents (no annotations).
Ownership of the display list is returned to the caller.
- ll_fz_new_display_list_from_page_number(doc, number)
- Low-level wrapper for `::fz_new_display_list_from_page_number()`.
- ll_fz_new_display_list_from_svg(buf, base_uri, zip)
- Wrapper for out-params of fz_new_display_list_from_svg().
Returns: fz_display_list *, float w, float h
- ll_fz_new_display_list_from_svg_outparams_fn(buf, base_uri, zip, outparams)
- ll_fz_new_display_list_from_svg_xml(xmldoc, xml, base_uri, zip)
- Wrapper for out-params of fz_new_display_list_from_svg_xml().
Returns: fz_display_list *, float w, float h
- ll_fz_new_display_list_from_svg_xml_outparams_fn(xmldoc, xml, base_uri, zip, outparams)
- ll_fz_new_document_of_size(size)
- Low-level wrapper for `::fz_new_document_of_size()`.
New documents are typically created by calls like
foo_new_document(fz_context *ctx, ...). These work by
deriving a new document type from fz_document, for instance:
typedef struct { fz_document base; ...extras... } foo_document;
These are allocated by calling
fz_new_derived_document(ctx, foo_document)
- ll_fz_new_document_writer(path, format, options)
- Low-level wrapper for `::fz_new_document_writer()`.
Create a new fz_document_writer, for a
file of the given type.
path: The document name to write (or NULL for default)
format: Which format to write (currently cbz, html, pdf, pam,
pbm, pgm, pkm, png, ppm, pnm, svg, text, xhtml, docx, odt)
options: NULL, or pointer to comma separated string to control
file generation.
- ll_fz_new_document_writer_of_size(size, begin_page, end_page, close, drop)
- Low-level wrapper for `::fz_new_document_writer_of_size()`.
Internal function to allocate a
block for a derived document_writer structure, with the base
structure's function pointers populated correctly, and the extra
space zero initialised.
- ll_fz_new_document_writer_with_buffer(buf, format, options)
- Low-level wrapper for `::fz_new_document_writer_with_buffer()`.
- ll_fz_new_document_writer_with_output(out, format, options)
- Low-level wrapper for `::fz_new_document_writer_with_output()`.
Like fz_new_document_writer but takes a fz_output for writing
the result. Only works for multi-page formats.
- ll_fz_new_docx_writer(path, options)
- Low-level wrapper for `::fz_new_docx_writer()`.
- ll_fz_new_docx_writer_with_output(out, options)
- Low-level wrapper for `::fz_new_docx_writer_with_output()`.
- ll_fz_new_draw_device(transform, dest)
- Low-level wrapper for `::fz_new_draw_device()`.
Create a device to draw on a pixmap.
dest: Target pixmap for the draw device. See fz_new_pixmap*
for how to obtain a pixmap. The pixmap is not cleared by the
draw device, see fz_clear_pixmap* for how to clear it prior to
calling fz_new_draw_device. Free the device by calling
fz_drop_device.
transform: Transform from user space in points to device space
in pixels.
- ll_fz_new_draw_device_type3(transform, dest)
- Low-level wrapper for `::fz_new_draw_device_type3()`.
- ll_fz_new_draw_device_with_bbox(transform, dest, clip)
- Low-level wrapper for `::fz_new_draw_device_with_bbox()`.
Create a device to draw on a pixmap.
dest: Target pixmap for the draw device. See fz_new_pixmap*
for how to obtain a pixmap. The pixmap is not cleared by the
draw device, see fz_clear_pixmap* for how to clear it prior to
calling fz_new_draw_device. Free the device by calling
fz_drop_device.
transform: Transform from user space in points to device space
in pixels.
clip: Bounding box to restrict any marking operations of the
draw device.
- ll_fz_new_draw_device_with_bbox_proof(transform, dest, clip, cs)
- Low-level wrapper for `::fz_new_draw_device_with_bbox_proof()`.
Create a device to draw on a pixmap.
dest: Target pixmap for the draw device. See fz_new_pixmap*
for how to obtain a pixmap. The pixmap is not cleared by the
draw device, see fz_clear_pixmap* for how to clear it prior to
calling fz_new_draw_device. Free the device by calling
fz_drop_device.
transform: Transform from user space in points to device space
in pixels.
clip: Bounding box to restrict any marking operations of the
draw device.
proof_cs: Color space to render to prior to mapping to color
space defined by pixmap.
- ll_fz_new_draw_device_with_options(options, mediabox)
- Wrapper for out-params of fz_new_draw_device_with_options().
Returns: fz_device *, ::fz_pixmap *pixmap
- ll_fz_new_draw_device_with_options_outparams_fn(options, mediabox, outparams)
- ll_fz_new_draw_device_with_proof(transform, dest, proof_cs)
- Low-level wrapper for `::fz_new_draw_device_with_proof()`.
Create a device to draw on a pixmap.
dest: Target pixmap for the draw device. See fz_new_pixmap*
for how to obtain a pixmap. The pixmap is not cleared by the
draw device, see fz_clear_pixmap* for how to clear it prior to
calling fz_new_draw_device. Free the device by calling
fz_drop_device.
transform: Transform from user space in points to device space
in pixels.
proof_cs: Intermediate color space to map though when mapping to
color space defined by pixmap.
- ll_fz_new_font_from_buffer(name, buffer, index, use_glyph_bbox)
- Low-level wrapper for `::fz_new_font_from_buffer()`.
Create a new font from a font file in a fz_buffer.
Fonts created in this way, will be eligible for embedding by default.
name: Name of font (leave NULL to use name from font).
buffer: Buffer to load from.
index: Which font from the file to load (0 for default).
use_glyph_box: 1 if we should use the glyph bbox, 0 otherwise.
Returns new font handle, or throws exception on error.
- ll_fz_new_font_from_file(name, path, index, use_glyph_bbox)
- Low-level wrapper for `::fz_new_font_from_file()`.
Create a new font from a font file.
Fonts created in this way, will be eligible for embedding by default.
name: Name of font (leave NULL to use name from font).
path: File path to load from.
index: Which font from the file to load (0 for default).
use_glyph_box: 1 if we should use the glyph bbox, 0 otherwise.
Returns new font handle, or throws exception on error.
- ll_fz_new_font_from_memory(name, data, len, index, use_glyph_bbox)
- Low-level wrapper for `::fz_new_font_from_memory()`.
Create a new font from a font file in memory.
Fonts created in this way, will be eligible for embedding by default.
name: Name of font (leave NULL to use name from font).
data: Pointer to the font file data.
len: Length of the font file data.
index: Which font from the file to load (0 for default).
use_glyph_box: 1 if we should use the glyph bbox, 0 otherwise.
Returns new font handle, or throws exception on error.
- ll_fz_new_hash_table(initialsize, keylen, lock, drop_val)
- Low-level wrapper for `::fz_new_hash_table()`.
Create a new hash table.
initialsize: The initial size of the hashtable. The hashtable
may grow (double in size) if it starts to get crowded (80%
full).
keylen: byte length for each key.
lock: -1 for no lock, otherwise the FZ_LOCK to use to protect
this table.
drop_val: Function to use to destroy values on table drop.
- ll_fz_new_icc_colorspace(type, flags, name, buf)
- Low-level wrapper for `::fz_new_icc_colorspace()`.
Create a colorspace from an ICC profile supplied in buf.
Limited checking is done to ensure that the colorspace type is
appropriate for the supplied ICC profile.
An additional reference is taken to buf, which will be dropped
on destruction. Ownership is NOT passed in.
The returned reference should be dropped when it is finished
with.
Colorspaces are immutable once created.
- ll_fz_new_image_from_buffer(buffer)
- Low-level wrapper for `::fz_new_image_from_buffer()`.
Create a new image from a
buffer of data, inferring its type from the format
of the data.
- ll_fz_new_image_from_compressed_buffer(w, h, bpc, colorspace, xres, yres, interpolate, imagemask, buffer, mask)
- Wrapper for out-params of fz_new_image_from_compressed_buffer().
Returns: fz_image *, float decode, int colorkey
- ll_fz_new_image_from_compressed_buffer_outparams_fn(w, h, bpc, colorspace, xres, yres, interpolate, imagemask, buffer, mask, outparams)
- ll_fz_new_image_from_display_list(w, h, list)
- Low-level wrapper for `::fz_new_image_from_display_list()`.
Create a new image from a display list.
w, h: The conceptual width/height of the image.
transform: The matrix that needs to be applied to the given
list to make it render to the unit square.
list: The display list.
- ll_fz_new_image_from_file(path)
- Low-level wrapper for `::fz_new_image_from_file()`.
Create a new image from the contents
of a file, inferring its type from the format of the
data.
- ll_fz_new_image_from_pixmap(pixmap, mask)
- Low-level wrapper for `::fz_new_image_from_pixmap()`.
Create an image from the given
pixmap.
pixmap: The pixmap to base the image upon. A new reference
to this is taken.
mask: NULL, or another image to use as a mask for this one.
A new reference is taken to this image. Supplying a masked
image as a mask to another image is illegal!
- ll_fz_new_image_from_svg(buf, base_uri, zip)
- Low-level wrapper for `::fz_new_image_from_svg()`.
Create a scalable image from an SVG document.
- ll_fz_new_image_from_svg_xml(xmldoc, xml, base_uri, zip)
- Low-level wrapper for `::fz_new_image_from_svg_xml()`.
Create a scalable image from an SVG document.
- ll_fz_new_image_of_size(w, h, bpc, colorspace, xres, yres, interpolate, imagemask, mask, size, get_pixmap, get_size, drop)
- Wrapper for out-params of fz_new_image_of_size().
Returns: fz_image *, float decode, int colorkey
- ll_fz_new_image_of_size_outparams_fn(w, h, bpc, colorspace, xres, yres, interpolate, imagemask, mask, size, get_pixmap, get_size, drop, outparams)
- ll_fz_new_indexed_colorspace(base, high, lookup)
- Low-level wrapper for `::fz_new_indexed_colorspace()`.
Create an indexed colorspace.
The supplied lookup table is high palette entries long. Each
entry is n bytes long, where n is given by the number of
colorants in the base colorspace, one byte per colorant.
Ownership of lookup is passed it; it will be freed on
destruction, so must be heap allocated.
The colorspace will keep an additional reference to the base
colorspace that will be dropped on destruction.
The returned reference should be dropped when it is finished
with.
Colorspaces are immutable once created.
- ll_fz_new_jpeg_pixmap_writer(path, options)
- Low-level wrapper for `::fz_new_jpeg_pixmap_writer()`.
- ll_fz_new_layout()
- Low-level wrapper for `::fz_new_layout()`.
Create a new layout block, with new allocation pool, zero
matrices, and initialise linked pointers.
- ll_fz_new_link_of_size(size, rect, uri)
- Low-level wrapper for `::fz_new_link_of_size()`.
Create a new link record.
next is set to NULL with the expectation that the caller will
handle the linked list setup. Internal function.
Different document types will be implemented by deriving from
fz_link. This macro allocates such derived structures, and
initialises the base sections.
- ll_fz_new_list_device(list)
- Low-level wrapper for `::fz_new_list_device()`.
Create a rendering device for a display list.
When the device is rendering a page it will populate the
display list with drawing commands (text, images, etc.). The
display list can later be reused to render a page many times
without having to re-interpret the page from the document file
for each rendering. Once the device is no longer needed, free
it with fz_drop_device.
list: A display list that the list device takes a reference to.
- ll_fz_new_log_for_module(module)
- Low-level wrapper for `::fz_new_log_for_module()`.
Internal function to actually do the opening of the logfile.
Caller should close/drop the output when finished with it.
- ll_fz_new_mono_pcl_band_writer(out, options)
- Low-level wrapper for `::fz_new_mono_pcl_band_writer()`.
Create a new band writer, outputing monochrome pcl.
- ll_fz_new_mono_pwg_band_writer(out, pwg)
- Low-level wrapper for `::fz_new_mono_pwg_band_writer()`.
Create a new monochrome pwg band writer.
- ll_fz_new_multi_archive()
- Low-level wrapper for `::fz_new_multi_archive()`.
Create a new multi archive (initially empty).
- ll_fz_new_ocr_device(target, ctm, mediabox, with_list, language, datadir, progress, progress_arg)
- Low-level wrapper for `::fz_new_ocr_device()`.
Create a device to OCR the text on the page.
Renders the page internally to a bitmap that is then OCRd. Text
is then forwarded onto the target device.
target: The target device to receive the OCRd text.
ctm: The transform to apply to the mediabox to get the size for
the rendered page image. Also used to calculate the resolution
for the page image. In general, this will be the same as the CTM
that you pass to fz_run_page (or fz_run_display_list) to feed
this device.
mediabox: The mediabox (in points). Combined with the CTM to get
the bounds of the pixmap used internally for the rendered page
image.
with_list: If with_list is false, then all non-text operations
are forwarded instantly to the target device. This results in
the target device seeing all NON-text operations, followed by
all the text operations (derived from OCR).
If with_list is true, then all the marking operations are
collated into a display list which is then replayed to the
target device at the end.
language: NULL (for "eng"), or a pointer to a string to describe
the languages/scripts that should be used for OCR (e.g.
"eng,ara").
datadir: NULL (for ""), or a pointer to a path string otherwise
provided to Tesseract in the TESSDATA_PREFIX environment variable.
progress: NULL, or function to be called periodically to indicate
progress. Return 0 to continue, or 1 to cancel. progress_arg is
returned as the void *. The int is a value between 0 and 100 to
indicate progress.
progress_arg: A void * value to be parrotted back to the progress
function.
- ll_fz_new_odt_writer(path, options)
- Low-level wrapper for `::fz_new_odt_writer()`.
- ll_fz_new_odt_writer_with_output(out, options)
- Low-level wrapper for `::fz_new_odt_writer_with_output()`.
- ll_fz_new_outline()
- Low-level wrapper for `::fz_new_outline()`.
Create a new outline entry with zeroed fields for the caller
to fill in.
- ll_fz_new_outline_iterator(doc)
- Low-level wrapper for `::fz_new_outline_iterator()`.
Get an iterator for the document outline.
Should be freed by fz_drop_outline_iterator.
- ll_fz_new_outline_iterator_of_size(size, doc)
- Low-level wrapper for `::fz_new_outline_iterator_of_size()`.
- ll_fz_new_output(bufsiz, state, write, close, drop)
- Low-level wrapper for `::fz_new_output()`.
Create a new output object with the given
internal state and function pointers.
state: Internal state (opaque to everything but implementation).
write: Function to output a given buffer.
close: Cleanup function to destroy state when output closed.
May permissibly be null.
- ll_fz_new_output_with_buffer(buf)
- Low-level wrapper for `::fz_new_output_with_buffer()`.
Open an output stream that appends
to a buffer.
buf: The buffer to append to.
- ll_fz_new_output_with_path(filename, append)
- Low-level wrapper for `::fz_new_output_with_path()`.
Open an output stream that writes to a
given path.
filename: The filename to write to (specified in UTF-8).
append: non-zero if we should append to the file, rather than
overwriting it.
- ll_fz_new_page_of_size(size, doc)
- Low-level wrapper for `::fz_new_page_of_size()`.
Different document types will be implemented by deriving from
fz_page. This macro allocates such derived structures, and
initialises the base sections.
- ll_fz_new_pam_band_writer(out)
- Low-level wrapper for `::fz_new_pam_band_writer()`.
Create a band writer targetting pnm (greyscale, rgb or cmyk,
with or without alpha).
- ll_fz_new_pam_pixmap_writer(path, options)
- Low-level wrapper for `::fz_new_pam_pixmap_writer()`.
- ll_fz_new_path()
- Low-level wrapper for `::fz_new_path()`.
Create a new (empty) path structure.
- ll_fz_new_pbm_band_writer(out)
- Low-level wrapper for `::fz_new_pbm_band_writer()`.
Create a new band writer, targetting pbm.
- ll_fz_new_pbm_pixmap_writer(path, options)
- Low-level wrapper for `::fz_new_pbm_pixmap_writer()`.
- ll_fz_new_pcl_writer(path, options)
- Low-level wrapper for `::fz_new_pcl_writer()`.
- ll_fz_new_pcl_writer_with_output(out, options)
- Low-level wrapper for `::fz_new_pcl_writer_with_output()`.
- ll_fz_new_pclm_band_writer(out, options)
- Low-level wrapper for `::fz_new_pclm_band_writer()`.
Create a new band writer, outputing pclm
- ll_fz_new_pclm_writer(path, options)
- Low-level wrapper for `::fz_new_pclm_writer()`.
- ll_fz_new_pclm_writer_with_output(out, options)
- Low-level wrapper for `::fz_new_pclm_writer_with_output()`.
- ll_fz_new_pdf_writer(path, options)
- Low-level wrapper for `::fz_new_pdf_writer()`.
Document writers for various possible output formats.
All of the "_with_output" variants pass the ownership of out in
immediately upon calling. The writers are responsible for
dropping the fz_output when they are finished with it (even
if they throw an exception during creation).
- ll_fz_new_pdf_writer_with_output(out, options)
- Low-level wrapper for `::fz_new_pdf_writer_with_output()`.
- ll_fz_new_pdfocr_band_writer(out, options)
- Low-level wrapper for `::fz_new_pdfocr_band_writer()`.
Create a new band writer, outputing pdfocr.
Ownership of output stays with the caller, the band writer
borrows the reference. The caller must keep the output around
for the duration of the band writer, and then close/drop as
appropriate.
- ll_fz_new_pdfocr_writer(path, options)
- Low-level wrapper for `::fz_new_pdfocr_writer()`.
- ll_fz_new_pdfocr_writer_with_output(out, options)
- Low-level wrapper for `::fz_new_pdfocr_writer_with_output()`.
- ll_fz_new_pgm_pixmap_writer(path, options)
- Low-level wrapper for `::fz_new_pgm_pixmap_writer()`.
- ll_fz_new_pixmap(cs, w, h, seps, alpha)
- Low-level wrapper for `::fz_new_pixmap()`.
Create a new pixmap, with its origin at (0,0)
cs: The colorspace to use for the pixmap, or NULL for an alpha
plane/mask.
w: The width of the pixmap (in pixels)
h: The height of the pixmap (in pixels)
seps: Details of separations.
alpha: 0 for no alpha, 1 for alpha.
Returns a pointer to the new pixmap. Throws exception on failure
to allocate.
- ll_fz_new_pixmap_from_alpha_channel(src)
- Low-level wrapper for `::fz_new_pixmap_from_alpha_channel()`.
- ll_fz_new_pixmap_from_color_and_mask(color, mask)
- Low-level wrapper for `::fz_new_pixmap_from_color_and_mask()`.
- ll_fz_new_pixmap_from_display_list(list, ctm, cs, alpha)
- Low-level wrapper for `::fz_new_pixmap_from_display_list()`.
Render the page to a pixmap using the transform and colorspace.
Ownership of the pixmap is returned to the caller.
- ll_fz_new_pixmap_from_display_list_with_separations(list, ctm, cs, seps, alpha)
- Low-level wrapper for `::fz_new_pixmap_from_display_list_with_separations()`.
Render the page contents with control over spot colors.
Ownership of the pixmap is returned to the caller.
- ll_fz_new_pixmap_from_page(page, ctm, cs, alpha)
- Low-level wrapper for `::fz_new_pixmap_from_page()`.
- ll_fz_new_pixmap_from_page_contents(page, ctm, cs, alpha)
- Low-level wrapper for `::fz_new_pixmap_from_page_contents()`.
Render the page contents without annotations.
Ownership of the pixmap is returned to the caller.
- ll_fz_new_pixmap_from_page_contents_with_separations(page, ctm, cs, seps, alpha)
- Low-level wrapper for `::fz_new_pixmap_from_page_contents_with_separations()`.
- ll_fz_new_pixmap_from_page_number(doc, number, ctm, cs, alpha)
- Low-level wrapper for `::fz_new_pixmap_from_page_number()`.
- ll_fz_new_pixmap_from_page_number_with_separations(doc, number, ctm, cs, seps, alpha)
- Low-level wrapper for `::fz_new_pixmap_from_page_number_with_separations()`.
- ll_fz_new_pixmap_from_page_with_separations(page, ctm, cs, seps, alpha)
- Low-level wrapper for `::fz_new_pixmap_from_page_with_separations()`.
- ll_fz_new_pixmap_from_pixmap(pixmap, rect)
- Low-level wrapper for `::fz_new_pixmap_from_pixmap()`.
Create a new pixmap that represents a subarea of the specified
pixmap. A reference is taken to this pixmap that will be dropped
on destruction.
The supplied rectangle must be wholly contained within the
original pixmap.
Returns a pointer to the new pixmap. Throws exception on failure
to allocate.
- ll_fz_new_pixmap_with_bbox(colorspace, bbox, seps, alpha)
- Low-level wrapper for `::fz_new_pixmap_with_bbox()`.
Create a pixmap of a given size, location and pixel format.
The bounding box specifies the size of the created pixmap and
where it will be located. The colorspace determines the number
of components per pixel. Alpha is always present. Pixmaps are
reference counted, so drop references using fz_drop_pixmap.
colorspace: Colorspace format used for the created pixmap. The
pixmap will keep a reference to the colorspace.
bbox: Bounding box specifying location/size of created pixmap.
seps: Details of separations.
alpha: 0 for no alpha, 1 for alpha.
Returns a pointer to the new pixmap. Throws exception on failure
to allocate.
- ll_fz_new_pixmap_with_bbox_and_data(colorspace, rect, seps, alpha, samples)
- Low-level wrapper for `::fz_new_pixmap_with_bbox_and_data()`.
Create a pixmap of a given size, location and pixel format,
using the supplied data block.
The bounding box specifies the size of the created pixmap and
where it will be located. The colorspace determines the number
of components per pixel. Alpha is always present. Pixmaps are
reference counted, so drop references using fz_drop_pixmap.
colorspace: Colorspace format used for the created pixmap. The
pixmap will keep a reference to the colorspace.
rect: Bounding box specifying location/size of created pixmap.
seps: Details of separations.
alpha: Number of alpha planes (0 or 1).
samples: The data block to keep the samples in.
Returns a pointer to the new pixmap. Throws exception on failure
to allocate.
- ll_fz_new_pixmap_with_data(colorspace, w, h, seps, alpha, stride, samples)
- Low-level wrapper for `::fz_new_pixmap_with_data()`.
Create a new pixmap, with its origin at
(0,0) using the supplied data block.
cs: The colorspace to use for the pixmap, or NULL for an alpha
plane/mask.
w: The width of the pixmap (in pixels)
h: The height of the pixmap (in pixels)
seps: Details of separations.
alpha: 0 for no alpha, 1 for alpha.
stride: The byte offset from the pixel data in a row to the
pixel data in the next row.
samples: The data block to keep the samples in.
Returns a pointer to the new pixmap. Throws exception on failure to
allocate.
- ll_fz_new_pixmap_writer(path, options, default_path, n, save)
- Low-level wrapper for `::fz_new_pixmap_writer()`.
- ll_fz_new_pkm_band_writer(out)
- Low-level wrapper for `::fz_new_pkm_band_writer()`.
Create a new pkm band writer for CMYK pixmaps.
- ll_fz_new_pkm_pixmap_writer(path, options)
- Low-level wrapper for `::fz_new_pkm_pixmap_writer()`.
- ll_fz_new_png_band_writer(out)
- Low-level wrapper for `::fz_new_png_band_writer()`.
Create a new png band writer (greyscale or RGB, with or without
alpha).
- ll_fz_new_png_pixmap_writer(path, options)
- Low-level wrapper for `::fz_new_png_pixmap_writer()`.
- ll_fz_new_pnm_band_writer(out)
- Low-level wrapper for `::fz_new_pnm_band_writer()`.
Create a band writer targetting pnm (greyscale or rgb, no
alpha).
- ll_fz_new_pnm_pixmap_writer(path, options)
- Low-level wrapper for `::fz_new_pnm_pixmap_writer()`.
- ll_fz_new_pool()
- Low-level wrapper for `::fz_new_pool()`.
Create a new pool to allocate from.
- ll_fz_new_ppm_pixmap_writer(path, options)
- Low-level wrapper for `::fz_new_ppm_pixmap_writer()`.
- ll_fz_new_ps_band_writer(out)
- Low-level wrapper for `::fz_new_ps_band_writer()`.
Create a postscript band writer for gray, rgb, or cmyk, no
alpha.
- ll_fz_new_ps_writer(path, options)
- Low-level wrapper for `::fz_new_ps_writer()`.
- ll_fz_new_ps_writer_with_output(out, options)
- Low-level wrapper for `::fz_new_ps_writer_with_output()`.
- ll_fz_new_psd_band_writer(out)
- Low-level wrapper for `::fz_new_psd_band_writer()`.
Open a PSD band writer.
- ll_fz_new_pwg_band_writer(out, pwg)
- Low-level wrapper for `::fz_new_pwg_band_writer()`.
Create a new color pwg band writer.
- ll_fz_new_pwg_writer(path, options)
- Low-level wrapper for `::fz_new_pwg_writer()`.
- ll_fz_new_pwg_writer_with_output(out, options)
- Low-level wrapper for `::fz_new_pwg_writer_with_output()`.
- ll_fz_new_rle_output(chain)
- Low-level wrapper for `::fz_new_rle_output()`.
- ll_fz_new_separations(controllable)
- Low-level wrapper for `::fz_new_separations()`.
Create a new separations structure (initially empty)
- ll_fz_new_stext_device(page, options)
- Low-level wrapper for `::fz_new_stext_device()`.
Create a device to extract the text on a page.
Gather the text on a page into blocks and lines.
The reading order is taken from the order the text is drawn in
the source file, so may not be accurate.
page: The text page to which content should be added. This will
usually be a newly created (empty) text page, but it can be one
containing data already (for example when merging multiple
pages, or watermarking).
options: Options to configure the stext device.
- ll_fz_new_stext_page(mediabox)
- Low-level wrapper for `::fz_new_stext_page()`.
Create an empty text page.
The text page is filled out by the text device to contain the
blocks and lines of text on the page.
mediabox: optional mediabox information.
- ll_fz_new_stext_page_from_chapter_page_number(doc, chapter, number, options)
- Low-level wrapper for `::fz_new_stext_page_from_chapter_page_number()`.
- ll_fz_new_stext_page_from_display_list(list, options)
- Low-level wrapper for `::fz_new_stext_page_from_display_list()`.
- ll_fz_new_stext_page_from_page(page, options)
- Low-level wrapper for `::fz_new_stext_page_from_page()`.
Extract text from page.
Ownership of the fz_stext_page is returned to the caller.
- ll_fz_new_stext_page_from_page_number(doc, number, options)
- Low-level wrapper for `::fz_new_stext_page_from_page_number()`.
- ll_fz_new_store_context(max)
- Low-level wrapper for `::fz_new_store_context()`.
Create a new store inside the context
max: The maximum size (in bytes) that the store is allowed to
grow to. FZ_STORE_UNLIMITED means no limit.
- ll_fz_new_story(buf, user_css, em, archive)
- Low-level wrapper for `::fz_new_story()`.
- ll_fz_new_stream(state, next, drop)
- Low-level wrapper for `::fz_new_stream()`.
Create a new stream object with the given
internal state and function pointers.
state: Internal state (opaque to everything but implementation).
next: Should provide the next set of bytes (up to max) of stream
data. Return the number of bytes read, or EOF when there is no
more data.
drop: Should clean up and free the internal state. May not
throw exceptions.
- ll_fz_new_stroke_state()
- Low-level wrapper for `::fz_new_stroke_state()`.
Create a new (empty) stroke state structure (with no dash
data) and return a reference to it.
Throws exception on failure to allocate.
- ll_fz_new_stroke_state_with_dash_len(len)
- Low-level wrapper for `::fz_new_stroke_state_with_dash_len()`.
Create a new (empty) stroke state structure, with room for
dash data of the given length, and return a reference to it.
len: The number of dash elements to allow room for.
Throws exception on failure to allocate.
- ll_fz_new_svg_device(out, page_width, page_height, text_format, reuse_images)
- Low-level wrapper for `::fz_new_svg_device()`.
Create a device that outputs (single page) SVG files to
the given output stream.
Equivalent to fz_new_svg_device_with_id passing id = NULL.
- ll_fz_new_svg_device_with_id(out, page_width, page_height, text_format, reuse_images)
- Wrapper for out-params of fz_new_svg_device_with_id().
Returns: fz_device *, int id
- ll_fz_new_svg_device_with_id_outparams_fn(out, page_width, page_height, text_format, reuse_images, outparams)
- ll_fz_new_svg_writer(path, options)
- Low-level wrapper for `::fz_new_svg_writer()`.
- ll_fz_new_test_device(threshold, options, passthrough)
- Wrapper for out-params of fz_new_test_device().
Returns: fz_device *, int is_color
- ll_fz_new_test_device_outparams_fn(threshold, options, passthrough, outparams)
- ll_fz_new_text()
- Low-level wrapper for `::fz_new_text()`.
Create a new empty fz_text object.
Throws exception on failure to allocate.
- ll_fz_new_text_writer(format, path, options)
- Low-level wrapper for `::fz_new_text_writer()`.
- ll_fz_new_text_writer_with_output(format, out, options)
- Low-level wrapper for `::fz_new_text_writer_with_output()`.
- ll_fz_new_trace_device(out)
- Low-level wrapper for `::fz_new_trace_device()`.
Create a device to print a debug trace of all device calls.
- ll_fz_new_tree_archive(tree)
- Low-level wrapper for `::fz_new_tree_archive()`.
Create an archive that holds named buffers.
tree can either be a preformed tree with fz_buffers as values,
or it can be NULL for an empty tree.
- ll_fz_new_type3_font(name, matrix)
- Low-level wrapper for `::fz_new_type3_font()`.
Create a new (empty) type3 font.
name: Name of font (or NULL).
matrix: Font matrix.
Returns a new font handle, or throws exception on
allocation failure.
- ll_fz_new_xhtml_document_from_document(old_doc, opts)
- Low-level wrapper for `::fz_new_xhtml_document_from_document()`.
Use text extraction to convert the input document into XHTML,
then open the result as a new document that can be reflowed.
- ll_fz_new_xmltext_device(out)
- Low-level wrapper for `::fz_new_xmltext_device()`.
Create a device to output raw information.
- ll_fz_new_zip_writer(filename)
- Low-level wrapper for `::fz_new_zip_writer()`.
Create a new zip writer that writes to a given file.
Open an archive using a seekable stream object rather than
opening a file or directory on disk.
- ll_fz_new_zip_writer_with_output(out)
- Low-level wrapper for `::fz_new_zip_writer_with_output()`.
Create a new zip writer that writes to a given output stream.
Ownership of out passes in immediately upon calling this function.
The caller should never drop the fz_output, even if this function throws
an exception.
- ll_fz_next_page(doc, loc)
- Low-level wrapper for `::fz_next_page()`.
Function to get the location of the next page (allowing for the
end of chapters etc). If at the end of the document, returns the
current location.
- ll_fz_normalize_vector(p)
- Low-level wrapper for `::fz_normalize_vector()`.
Normalize a vector to length one.
- ll_fz_open_a85d(chain)
- Low-level wrapper for `::fz_open_a85d()`.
a85d filter performs ASCII 85 Decoding of data read
from the chained filter.
- ll_fz_open_accelerated_document(filename, accel)
- Low-level wrapper for `::fz_open_accelerated_document()`.
Open a document file and read its basic structure so pages and
objects can be located. MuPDF will try to repair broken
documents (without actually changing the file contents).
The returned fz_document is used when calling most other
document related functions.
filename: a path to a file as it would be given to open(2).
- ll_fz_open_accelerated_document_with_stream(magic, stream, accel)
- Low-level wrapper for `::fz_open_accelerated_document_with_stream()`.
Open a document using the specified stream object rather than
opening a file on disk.
magic: a string used to detect document type; either a file name
or mime-type.
- ll_fz_open_aesd(chain, key, keylen)
- Low-level wrapper for `::fz_open_aesd()`.
aesd filter performs AES decoding of data read from the chained
filter using the supplied key.
- ll_fz_open_ahxd(chain)
- Low-level wrapper for `::fz_open_ahxd()`.
ahxd filter performs ASCII Hex decoding of data read
from the chained filter.
- ll_fz_open_arc4(chain, key, keylen)
- Low-level wrapper for `::fz_open_arc4()`.
arc4 filter performs RC4 decoding of data read from the chained
filter using the supplied key.
- ll_fz_open_archive(filename)
- Low-level wrapper for `::fz_open_archive()`.
Open a zip or tar archive
Open a file and identify its archive type based on the archive
signature contained inside.
filename: a path to a file as it would be given to open(2).
- ll_fz_open_archive_entry(arch, name)
- Low-level wrapper for `::fz_open_archive_entry()`.
Opens an archive entry as a stream.
name: Entry name to look for, this must be an exact match to
the entry name in the archive.
Throws an exception if a matching entry cannot be found.
- ll_fz_open_archive_with_stream(file)
- Low-level wrapper for `::fz_open_archive_with_stream()`.
Open zip or tar archive stream.
Open an archive using a seekable stream object rather than
opening a file or directory on disk.
- ll_fz_open_buffer(buf)
- Low-level wrapper for `::fz_open_buffer()`.
Open a buffer as a stream.
buf: The buffer to open. Ownership of the buffer is NOT passed
in (this function takes its own reference).
Returns pointer to newly created stream. May throw exceptions on
failure to allocate.
- ll_fz_open_compressed_buffer(arg_1)
- Low-level wrapper for `::fz_open_compressed_buffer()`.
Open a stream to read the decompressed version of a buffer.
- ll_fz_open_concat(max, pad)
- Low-level wrapper for `::fz_open_concat()`.
Concat filter concatenates several streams into one.
- ll_fz_open_dctd(chain, color_transform, invert_cmyk, l2factor, jpegtables)
- Low-level wrapper for `::fz_open_dctd()`.
dctd filter performs DCT (JPEG) decoding of data read
from the chained filter.
color_transform implements the PDF color_transform option
use -1 for default behavior
use 0 to disable YUV-RGB / YCCK-CMYK transforms
use 1 to enable YUV-RGB / YCCK-CMYK transforms
invert_cmyk implements the necessary inversion for Photoshop CMYK images
use 0 if embedded in PDF
use 1 if not embedded in PDF
For subsampling on decode, set l2factor to the log2 of the
reduction required (therefore 0 = full size decode).
jpegtables is an optional stream from which the JPEG tables
can be read. Use NULL if not required.
- ll_fz_open_directory(path)
- Low-level wrapper for `::fz_open_directory()`.
Open a directory as if it was an archive.
A special case where a directory is opened as if it was an
archive.
Note that for directories it is not possible to retrieve the
number of entries or list the entries. It is however possible
to check if the archive has a particular entry.
path: a path to a directory as it would be given to opendir(3).
- ll_fz_open_document(filename)
- Low-level wrapper for `::fz_open_document()`.
Open a document file and read its basic structure so pages and
objects can be located. MuPDF will try to repair broken
documents (without actually changing the file contents).
The returned fz_document is used when calling most other
document related functions.
filename: a path to a file as it would be given to open(2).
- ll_fz_open_document_with_buffer(magic, buffer)
- Low-level wrapper for `::fz_open_document_with_buffer()`.
Open a document using a buffer rather than opening a file on disk.
- ll_fz_open_document_with_stream(magic, stream)
- Low-level wrapper for `::fz_open_document_with_stream()`.
Open a document using the specified stream object rather than
opening a file on disk.
magic: a string used to detect document type; either a file name
or mime-type.
- ll_fz_open_endstream_filter(chain, len, offset)
- Low-level wrapper for `::fz_open_endstream_filter()`.
The endstream filter reads a PDF substream, and starts to look
for an 'endstream' token after the specified length.
- ll_fz_open_faxd(chain, k, end_of_line, encoded_byte_align, columns, rows, end_of_block, black_is_1)
- Low-level wrapper for `::fz_open_faxd()`.
faxd filter performs FAX decoding of data read from
the chained filter.
k: see fax specification (fax default is 0).
end_of_line: whether we expect end of line markers (fax default
is 0).
encoded_byte_align: whether we align to bytes after each line
(fax default is 0).
columns: how many columns in the image (fax default is 1728).
rows: 0 for unspecified or the number of rows of data to expect.
end_of_block: whether we expect end of block markers (fax
default is 1).
black_is_1: determines the polarity of the image (fax default is
0).
- ll_fz_open_file(filename)
- Low-level wrapper for `::fz_open_file()`.
Open the named file and wrap it in a stream.
filename: Path to a file. On non-Windows machines the filename
should be exactly as it would be passed to fopen(2). On Windows
machines, the path should be UTF-8 encoded so that non-ASCII
characters can be represented. Other platforms do the encoding
as standard anyway (and in most cases, particularly for MacOS
and Linux, the encoding they use is UTF-8 anyway).
- ll_fz_open_file_ptr_no_close(file)
- Low-level wrapper for `::fz_open_file_ptr_no_close()`.
Create a stream from a FILE * that will not be closed
when the stream is dropped.
- ll_fz_open_flated(chain, window_bits)
- Low-level wrapper for `::fz_open_flated()`.
flated filter performs LZ77 decoding (inflating) of data read
from the chained filter.
window_bits: How large a decompression window to use. Typically
15. A negative number, -n, means to use n bits, but to expect
raw data with no header.
- ll_fz_open_image_decomp_stream(arg_0, arg_1)
- Wrapper for out-params of fz_open_image_decomp_stream().
Returns: fz_stream *, int l2factor
- ll_fz_open_image_decomp_stream_from_buffer(arg_0)
- Wrapper for out-params of fz_open_image_decomp_stream_from_buffer().
Returns: fz_stream *, int l2factor
- ll_fz_open_image_decomp_stream_from_buffer_outparams_fn(arg_0, outparams)
- ll_fz_open_image_decomp_stream_outparams_fn(arg_0, arg_1, outparams)
- ll_fz_open_jbig2d(chain, globals, embedded)
- Low-level wrapper for `::fz_open_jbig2d()`.
Open a filter that performs jbig2 decompression on the chained
stream, using the optional globals record.
- ll_fz_open_leecher(chain, buf)
- Low-level wrapper for `::fz_open_leecher()`.
Attach a filter to a stream that will store any
characters read from the stream into the supplied buffer.
chain: The underlying stream to leech from.
buf: The buffer into which the read data should be appended.
The buffer will be resized as required.
Returns pointer to newly created stream. May throw exceptions on
failure to allocate.
- ll_fz_open_lzwd(chain, early_change, min_bits, reverse_bits, old_tiff)
- Low-level wrapper for `::fz_open_lzwd()`.
lzwd filter performs LZW decoding of data read from the chained
filter.
early_change: (Default 1) specifies whether to change codes 1
bit early.
min_bits: (Default 9) specifies the minimum number of bits to
use.
reverse_bits: (Default 0) allows for compatibility with gif and
old style tiffs (1).
old_tiff: (Default 0) allows for different handling of the clear
code, as found in old style tiffs.
- ll_fz_open_memory(data, len)
- Low-level wrapper for `::fz_open_memory()`.
Open a block of memory as a stream.
data: Pointer to start of data block. Ownership of the data
block is NOT passed in.
len: Number of bytes in data block.
Returns pointer to newly created stream. May throw exceptions on
failure to allocate.
- ll_fz_open_null_filter(chain, len, offset)
- Low-level wrapper for `::fz_open_null_filter()`.
The null filter reads a specified amount of data from the
substream.
- ll_fz_open_predict(chain, predictor, columns, colors, bpc)
- Low-level wrapper for `::fz_open_predict()`.
predict filter performs pixel prediction on data read from
the chained filter.
predictor: 1 = copy, 2 = tiff, other = inline PNG predictor
columns: width of image in pixels
colors: number of components.
bpc: bits per component (typically 8)
- ll_fz_open_range_filter(chain, ranges, nranges)
- Low-level wrapper for `::fz_open_range_filter()`.
The range filter copies data from specified ranges of the
chained stream.
- ll_fz_open_reflowed_document(underdoc, opts)
- Low-level wrapper for `::fz_open_reflowed_document()`.
- ll_fz_open_rld(chain)
- Low-level wrapper for `::fz_open_rld()`.
rld filter performs Run Length Decoding of data read
from the chained filter.
- ll_fz_open_sgilog16(chain, w)
- Low-level wrapper for `::fz_open_sgilog16()`.
SGI Log 16bit (greyscale) decode from the chained filter.
Decodes lines of w pixels to 8bpp greyscale.
- ll_fz_open_sgilog24(chain, w)
- Low-level wrapper for `::fz_open_sgilog24()`.
SGI Log 24bit (LUV) decode from the chained filter.
Decodes lines of w pixels to 8bpc rgb.
- ll_fz_open_sgilog32(chain, w)
- Low-level wrapper for `::fz_open_sgilog32()`.
SGI Log 32bit (LUV) decode from the chained filter.
Decodes lines of w pixels to 8bpc rgb.
- ll_fz_open_tar_archive(filename)
- Low-level wrapper for `::fz_open_tar_archive()`.
Open a tar archive file.
An exception is throw if the file is not a tar archive as
indicated by the presence of a tar signature.
filename: a path to a tar archive file as it would be given to
open(2).
- ll_fz_open_tar_archive_with_stream(file)
- Low-level wrapper for `::fz_open_tar_archive_with_stream()`.
Open a tar archive stream.
Open an archive using a seekable stream object rather than
opening a file or directory on disk.
An exception is throw if the stream is not a tar archive as
indicated by the presence of a tar signature.
- ll_fz_open_thunder(chain, w)
- Low-level wrapper for `::fz_open_thunder()`.
4bit greyscale Thunderscan decoding from the chained filter.
Decodes lines of w pixels to 8bpp greyscale.
- ll_fz_open_zip_archive(path)
- Low-level wrapper for `::fz_open_zip_archive()`.
Open a zip archive file.
An exception is throw if the file is not a zip archive as
indicated by the presence of a zip signature.
filename: a path to a zip archive file as it would be given to
open(2).
- ll_fz_open_zip_archive_with_stream(file)
- Low-level wrapper for `::fz_open_zip_archive_with_stream()`.
Open a zip archive stream.
Open an archive using a seekable stream object rather than
opening a file or directory on disk.
An exception is throw if the stream is not a zip archive as
indicated by the presence of a zip signature.
- ll_fz_option_eq(a, b)
- Low-level wrapper for `::fz_option_eq()`.
Check to see if an option, a, from a string matches a reference
option, b.
(i.e. a could be 'foo' or 'foo,bar...' etc, but b can only be
'foo'.)
- ll_fz_outline_glyph(font, gid, ctm)
- Low-level wrapper for `::fz_outline_glyph()`.
Look a glyph up from a font, and return the outline of the
glyph using the given transform.
The caller owns the returned path, and so is responsible for
ensuring that it eventually gets dropped.
- ll_fz_outline_iterator_delete(iter)
- Low-level wrapper for `::fz_outline_iterator_delete()`.
Delete the current item.
This implicitly moves us to the 'next' item, and the return code is as for fz_outline_iterator_next.
- ll_fz_outline_iterator_down(iter)
- Low-level wrapper for `::fz_outline_iterator_down()`.
- ll_fz_outline_iterator_from_outline(outline)
- Low-level wrapper for `::fz_outline_iterator_from_outline()`.
- ll_fz_outline_iterator_insert(iter, item)
- Low-level wrapper for `::fz_outline_iterator_insert()`.
Call to insert a new item BEFORE the current point.
Ownership of pointers are retained by the caller. The item data will be copied.
After an insert, we do not change where we are pointing.
The return code is the same as for next, it indicates the current iterator position.
- ll_fz_outline_iterator_item(iter)
- Low-level wrapper for `::fz_outline_iterator_item()`.
Call to get the current outline item.
Can return NULL. The item is only valid until the next call.
- ll_fz_outline_iterator_next(iter)
- Low-level wrapper for `::fz_outline_iterator_next()`.
Calls to move the iterator position.
A negative return value means we could not move as requested. Otherwise:
0 = the final position has a valid item.
1 = not a valid item, but we can insert an item here.
- ll_fz_outline_iterator_prev(iter)
- Low-level wrapper for `::fz_outline_iterator_prev()`.
- ll_fz_outline_iterator_up(iter)
- Low-level wrapper for `::fz_outline_iterator_up()`.
- ll_fz_outline_iterator_update(iter, item)
- Low-level wrapper for `::fz_outline_iterator_update()`.
Update the current item properties according to the given item.
- ll_fz_output_accelerator(doc, accel)
- Low-level wrapper for `::fz_output_accelerator()`.
Output accelerator data for the document to a given output
stream.
- ll_fz_output_supports_stream(out)
- Low-level wrapper for `::fz_output_supports_stream()`.
Query whether a given fz_output supports fz_stream_from_output.
- ll_fz_pack_path(pack, path)
- Low-level wrapper for `::fz_pack_path()`.
Pack a path into the given block.
To minimise the size of paths, this function allows them to be
packed into a buffer with other information. Paths can be used
interchangeably regardless of how they are packed.
pack: Pointer to a block of data to pack the path into. Should
be aligned by the caller to the same alignment as required for
a fz_path pointer.
path: The path to pack.
Returns the number of bytes within the block used. Callers can
access the packed path data by casting the value of pack on
entry to be a fz_path *.
Throws exceptions on failure to allocate.
Implementation details: Paths can be 'unpacked', 'flat', or
'open'. Standard paths, as created are 'unpacked'. Paths
will be packed as 'flat', unless they are too large
(where large indicates that they exceed some private
implementation defined limits, currently including having
more than 256 coordinates or commands).
Large paths are 'open' packed as a header into the given block,
plus pointers to other data blocks.
Users should not have to care about whether paths are 'open'
or 'flat' packed. Simply pack a path (if required), and then
forget about the details.
- ll_fz_packed_path_size(path)
- Low-level wrapper for `::fz_packed_path_size()`.
Return the number of bytes required to pack a path.
- ll_fz_page_label(page, buf, size)
- Low-level wrapper for `::fz_page_label()`.
Get page label for a given page.
- ll_fz_page_number_from_location(doc, loc)
- Low-level wrapper for `::fz_page_number_from_location()`.
Converts from chapter+page to page number. This may cause many
chapters to be laid out in order to calculate the number of
pages within those chapters.
- ll_fz_page_presentation(page, transition)
- Wrapper for out-params of fz_page_presentation().
Returns: fz_transition *, float duration
- ll_fz_page_presentation_outparams_fn(page, transition, outparams)
- ll_fz_page_separations(page)
- Low-level wrapper for `::fz_page_separations()`.
Get the separations details for a page.
This will be NULL, unless the format specifically supports
separations (such as PDF files). May be NULL even
so, if there are no separations on a page.
Returns a reference that must be dropped.
- ll_fz_page_uses_overprint(page)
- Low-level wrapper for `::fz_page_uses_overprint()`.
Query if a given page requires overprint.
- ll_fz_paint_shade(shade, override_cs, ctm, dest, color_params, bbox, eop)
- Wrapper for out-params of fz_paint_shade().
Returns: ::fz_shade_color_cache *cache
- ll_fz_paint_shade_outparams_fn(shade, override_cs, ctm, dest, color_params, bbox, eop, outparams)
- ll_fz_parse_draw_options(options, string)
- Low-level wrapper for `::fz_parse_draw_options()`.
Parse draw device options from a comma separated key-value string.
- ll_fz_parse_page_range(s, n)
- ll_fz_parse_page_range_orig = ll_fz_parse_page_range(s, n)
- Wrapper for out-params of fz_parse_page_range().
Returns: const char *, int a, int b
- ll_fz_parse_page_range_outparams_fn(s, n, outparams)
- ll_fz_parse_pcl_options(opts, args)
- Low-level wrapper for `::fz_parse_pcl_options()`.
Parse PCL options.
Currently defined options and values are as follows:
preset=X Either "generic" or one of the presets as for fz_pcl_preset.
spacing=0 No vertical spacing capability
spacing=1 PCL 3 spacing (<ESC>*p+<n>Y)
spacing=2 PCL 4 spacing (<ESC>*b<n>Y)
spacing=3 PCL 5 spacing (<ESC>*b<n>Y and clear seed row)
mode2 Disable/Enable mode 2 graphics compression
mode3 Disable/Enable mode 3 graphics compression
eog_reset End of graphics (<ESC>*rB) resets all parameters
has_duplex Duplex supported (<ESC>&l<duplex>S)
has_papersize Papersize setting supported (<ESC>&l<sizecode>A)
has_copies Number of copies supported (<ESC>&l<copies>X)
is_ljet4pjl Disable/Enable HP 4PJL model-specific output
is_oce9050 Disable/Enable Oce 9050 model-specific output
- ll_fz_parse_pclm_options(opts, args)
- Low-level wrapper for `::fz_parse_pclm_options()`.
Parse PCLm options.
Currently defined options and values are as follows:
compression=none: No compression
compression=flate: Flate compression
strip-height=n: Strip height (default 16)
- ll_fz_parse_pdfocr_options(opts, args)
- Low-level wrapper for `::fz_parse_pdfocr_options()`.
Parse PDFOCR options.
Currently defined options and values are as follows:
compression=none: No compression
compression=flate: Flate compression
strip-height=n: Strip height (default 16)
ocr-language=<lang>: OCR Language (default eng)
ocr-datadir=<datadir>: OCR data path (default rely on TESSDATA_PREFIX)
- ll_fz_parse_stext_options(opts, string)
- Low-level wrapper for `::fz_parse_stext_options()`.
Parse stext device options from a comma separated key-value
string.
- ll_fz_parse_xml(buf, preserve_white)
- Low-level wrapper for `::fz_parse_xml()`.
Parse the contents of buffer into a tree of xml nodes.
preserve_white: whether to keep or delete all-whitespace nodes.
- ll_fz_parse_xml_archive_entry(arch, filename, preserve_white)
- Low-level wrapper for `::fz_parse_xml_archive_entry()`.
Parse the contents of an archive entry into a tree of xml nodes.
preserve_white: whether to keep or delete all-whitespace nodes.
- ll_fz_parse_xml_from_html5(buf)
- Low-level wrapper for `::fz_parse_xml_from_html5()`.
Parse the contents of a buffer into a tree of XML nodes,
using the HTML5 parsing algorithm.
- ll_fz_parse_xml_stream(stream, preserve_white)
- Low-level wrapper for `::fz_parse_xml_stream()`.
Parse the contents of buffer into a tree of xml nodes.
preserve_white: whether to keep or delete all-whitespace nodes.
- ll_fz_pcl_preset(opts, preset)
- Low-level wrapper for `::fz_pcl_preset()`.
Initialize PCL option struct for a given preset.
Currently defined presets include:
generic Generic PCL printer
ljet4 HP DeskJet
dj500 HP DeskJet 500
fs600 Kyocera FS-600
lj HP LaserJet, HP LaserJet Plus
lj2 HP LaserJet IIp, HP LaserJet IId
lj3 HP LaserJet III
lj3d HP LaserJet IIId
lj4 HP LaserJet 4
lj4pl HP LaserJet 4 PL
lj4d HP LaserJet 4d
lp2563b HP 2563B line printer
oce9050 Oce 9050 Line printer
- ll_fz_pdfocr_band_writer_set_progress(writer, progress_fn, progress_arg)
- Low-level wrapper for `::fz_pdfocr_band_writer_set_progress()`.
Set the progress callback for a pdfocr bandwriter.
- ll_fz_pdfocr_writer_set_progress(writer, progress, arg_3)
- Low-level wrapper for `::fz_pdfocr_writer_set_progress()`.
- ll_fz_peek_byte(stm)
- Low-level wrapper for `::fz_peek_byte()`.
Peek at the next byte in a stream.
stm: The stream to peek at.
Returns -1 for EOF, or the next byte that will be read.
- ll_fz_pixmap_alpha(pix)
- Low-level wrapper for `::fz_pixmap_alpha()`.
Return the number of alpha planes in a pixmap.
Returns the number of alphas. Does not throw exceptions.
- ll_fz_pixmap_bbox(pix)
- Low-level wrapper for `::fz_pixmap_bbox()`.
Return the bounding box for a pixmap.
- ll_fz_pixmap_colorants(pix)
- Low-level wrapper for `::fz_pixmap_colorants()`.
Return the number of colorants in a pixmap.
Returns the number of colorants (components, less any spots and
alpha).
- ll_fz_pixmap_colorspace(pix)
- Low-level wrapper for `::fz_pixmap_colorspace()`.
Return the colorspace of a pixmap
Returns colorspace.
- ll_fz_pixmap_components(pix)
- Low-level wrapper for `::fz_pixmap_components()`.
Return the number of components in a pixmap.
Returns the number of components (including spots and alpha).
- ll_fz_pixmap_copy(pm, src, n)
- ll_fz_pixmap_copy_raw(pm, samples)
- ll_fz_pixmap_height(pix)
- Low-level wrapper for `::fz_pixmap_height()`.
Return the height of the pixmap in pixels.
- ll_fz_pixmap_image_tile(cimg)
- Low-level wrapper for `::fz_pixmap_image_tile()`.
Retrieve the underlying fz_pixmap for an image.
Returns a pointer to the underlying fz_pixmap for an image,
or NULL if this image is not based upon an fz_pixmap.
No reference is returned. Lifespan is limited to that of
the image itself. If required, use fz_keep_pixmap to take
a reference to keep it longer.
- ll_fz_pixmap_samples(pix)
- Low-level wrapper for `::fz_pixmap_samples()`.
Returns a pointer to the pixel data of a pixmap.
Returns the pointer.
- ll_fz_pixmap_samples_int(pixmap)
- Low-level wrapper for `::fz_pixmap_samples_int()`.
- ll_fz_pixmap_samples_memoryview(pixmap)
- Returns a writable Python `memoryview` for a `fz_pixmap`.
- ll_fz_pixmap_spots(pix)
- Low-level wrapper for `::fz_pixmap_spots()`.
Return the number of spots in a pixmap.
Returns the number of spots (components, less colorants and
alpha). Does not throw exceptions.
- ll_fz_pixmap_stride(pix)
- Low-level wrapper for `::fz_pixmap_stride()`.
Return the number of bytes in a row in the pixmap.
- ll_fz_pixmap_width(pix)
- Low-level wrapper for `::fz_pixmap_width()`.
Return the width of the pixmap in pixels.
- ll_fz_pixmap_x(pix)
- Low-level wrapper for `::fz_pixmap_x()`.
Return the x value of the pixmap in pixels.
- ll_fz_pixmap_y(pix)
- Low-level wrapper for `::fz_pixmap_y()`.
Return the y value of the pixmap in pixels.
- ll_fz_place_story(story, where, filled)
- Low-level wrapper for `::fz_place_story()`.
- ll_fz_pool_alloc(pool, size)
- Low-level wrapper for `::fz_pool_alloc()`.
Allocate a block of size bytes from the pool.
- ll_fz_pool_size(pool)
- Low-level wrapper for `::fz_pool_size()`.
The current size of the pool.
The number of bytes of storage currently allocated to the pool.
This is the total of the storage used for the blocks making
up the pool, rather then total of the allocated blocks so far,
so it will increase in 'lumps'.
from the pool, then the pool size may still be X
- ll_fz_pool_strdup(pool, s)
- Low-level wrapper for `::fz_pool_strdup()`.
strdup equivalent allocating from the pool.
- ll_fz_pop_clip(dev)
- Low-level wrapper for `::fz_pop_clip()`.
- ll_fz_post_scale(m, sx, sy)
- Low-level wrapper for `::fz_post_scale()`.
Scale a matrix by postmultiplication.
m: Pointer to the matrix to scale
sx, sy: Scaling factors along the X- and Y-axes. A scaling
factor of 1.0 will not cause any scaling along the relevant
axis.
Returns m (updated).
- ll_fz_pre_rotate(m, degrees)
- Low-level wrapper for `::fz_pre_rotate()`.
Rotate a transformation by premultiplying.
The premultiplied matrix is of the form
[ cos(deg) sin(deg) -sin(deg) cos(deg) 0 0 ].
m: Pointer to matrix to premultiply.
degrees: Degrees of counter clockwise rotation. Values less
than zero and greater than 360 are handled as expected.
Returns m (updated).
- ll_fz_pre_scale(m, sx, sy)
- Low-level wrapper for `::fz_pre_scale()`.
Scale a matrix by premultiplication.
m: Pointer to the matrix to scale
sx, sy: Scaling factors along the X- and Y-axes. A scaling
factor of 1.0 will not cause any scaling along the relevant
axis.
Returns m (updated).
- ll_fz_pre_shear(m, sx, sy)
- Low-level wrapper for `::fz_pre_shear()`.
Premultiply a matrix with a shearing matrix.
The shearing matrix is of the form [ 1 sy sx 1 0 0 ].
m: pointer to matrix to premultiply
sx, sy: Shearing factors. A shearing factor of 0.0 will not
cause any shearing along the relevant axis.
Returns m (updated).
- ll_fz_pre_translate(m, tx, ty)
- Low-level wrapper for `::fz_pre_translate()`.
Translate a matrix by premultiplication.
m: The matrix to translate
tx, ty: Translation distances along the X- and Y-axes. A
translation of 0 will not cause any translation along the
relevant axis.
Returns m.
- ll_fz_prepare_t3_glyph(font, gid)
- Low-level wrapper for `::fz_prepare_t3_glyph()`.
Force a type3 font to cache the displaylist for a given glyph
id.
This caching can involve reading the underlying file, so must
happen ahead of time, so we aren't suddenly forced to read the
file while playing a displaylist back.
- ll_fz_previous_page(doc, loc)
- Low-level wrapper for `::fz_previous_page()`.
Function to get the location of the previous page (allowing for
the end of chapters etc). If already at the start of the
document, returns the current page.
- ll_fz_print_stext_header_as_html(out)
- Low-level wrapper for `::fz_print_stext_header_as_html()`.
- ll_fz_print_stext_header_as_xhtml(out)
- Low-level wrapper for `::fz_print_stext_header_as_xhtml()`.
- ll_fz_print_stext_page_as_html(out, page, id)
- Low-level wrapper for `::fz_print_stext_page_as_html()`.
Output structured text to a file in HTML (visual) format.
- ll_fz_print_stext_page_as_json(out, page, scale)
- Low-level wrapper for `::fz_print_stext_page_as_json()`.
Output structured text to a file in JSON format.
- ll_fz_print_stext_page_as_text(out, page)
- Low-level wrapper for `::fz_print_stext_page_as_text()`.
Output structured text to a file in plain-text UTF-8 format.
- ll_fz_print_stext_page_as_xhtml(out, page, id)
- Low-level wrapper for `::fz_print_stext_page_as_xhtml()`.
Output structured text to a file in XHTML (semantic) format.
- ll_fz_print_stext_page_as_xml(out, page, id)
- Low-level wrapper for `::fz_print_stext_page_as_xml()`.
Output structured text to a file in XML format.
- ll_fz_print_stext_trailer_as_html(out)
- Low-level wrapper for `::fz_print_stext_trailer_as_html()`.
- ll_fz_print_stext_trailer_as_xhtml(out)
- Low-level wrapper for `::fz_print_stext_trailer_as_xhtml()`.
- ll_fz_process_opened_pages(doc, process_openend_page, state)
- Low-level wrapper for `::fz_process_opened_pages()`.
Iterates over all opened pages of the document, calling the
provided callback for each page for processing. If the callback
returns non-NULL then the iteration stops and that value is returned
to the called of fz_process_opened_pages().
The state pointer provided to fz_process_opened_pages() is
passed on to the callback but is owned by the caller.
Returns the first non-NULL value returned by the callback,
or NULL if the callback returned NULL for all opened pages.
- ll_fz_process_shade(shade, ctm, scissor, prepare, process, process_arg)
- Low-level wrapper for `::fz_process_shade()`.
Process a shade, using supplied callback functions. This
decomposes the shading to a mesh (even ones that are not
natively meshes, such as linear or radial shadings), and
processes triangles from those meshes.
shade: The shade to process.
ctm: The transform to use
prepare: Callback function to 'prepare' each vertex.
This function is passed an array of floats, and populates
a fz_vertex structure.
process: This function is passed 3 pointers to vertex
structures, and actually performs the processing (typically
filling the area between the vertexes).
process_arg: An opaque argument passed through from caller
to callback functions.
- ll_fz_purge_glyph_cache()
- Low-level wrapper for `::fz_purge_glyph_cache()`.
Purge all the glyphs from the cache.
- ll_fz_quad_from_rect(r)
- Low-level wrapper for `::fz_quad_from_rect()`.
Convert a rect to a quad (losslessly).
- ll_fz_quadto(path, x0, y0, x1, y1)
- Low-level wrapper for `::fz_quadto()`.
Append a 'quadto' command to an open path. (For a
quadratic bezier).
path: The path to modify.
x0, y0: The control coordinates for the quadratic curve.
x1, y1: The end coordinates for the quadratic curve.
Throws exceptions on failure to allocate, or attempting to
modify a packed path.
- ll_fz_read(stm, data, len)
- Low-level wrapper for `::fz_read()`.
Read from a stream into a given data block.
stm: The stream to read from.
data: The data block to read into.
len: The length of the data block (in bytes).
Returns the number of bytes read. May throw exceptions.
- ll_fz_read_all(stm, initial)
- Low-level wrapper for `::fz_read_all()`.
Read all of a stream into a buffer.
stm: The stream to read from
initial: Suggested initial size for the buffer.
Returns a buffer created from reading from the stream. May throw
exceptions on failure to allocate.
- ll_fz_read_archive_entry(arch, name)
- Low-level wrapper for `::fz_read_archive_entry()`.
Reads all bytes in an archive entry
into a buffer.
name: Entry name to look for, this must be an exact match to
the entry name in the archive.
Throws an exception if a matching entry cannot be found.
- ll_fz_read_best(stm, initial, worst_case)
- Wrapper for out-params of fz_read_best().
Returns: fz_buffer *, int truncated
- ll_fz_read_best_outparams_fn(stm, initial, worst_case, outparams)
- ll_fz_read_bits(stm, n)
- Low-level wrapper for `::fz_read_bits()`.
Read the next n bits from a stream (assumed to
be packed most significant bit first).
stm: The stream to read from.
n: The number of bits to read, between 1 and 8*sizeof(int)
inclusive.
Returns -1 for EOF, or the required number of bits.
- ll_fz_read_byte(stm)
- Low-level wrapper for `::fz_read_byte()`.
Read the next byte from a stream.
stm: The stream t read from.
Returns -1 for end of stream, or the next byte. May
throw exceptions.
- ll_fz_read_file(filename)
- Low-level wrapper for `::fz_read_file()`.
Read all the contents of a file into a buffer.
- ll_fz_read_float(stm)
- Low-level wrapper for `::fz_read_float()`.
- ll_fz_read_float_le(stm)
- Low-level wrapper for `::fz_read_float_le()`.
- ll_fz_read_int16(stm)
- Low-level wrapper for `::fz_read_int16()`.
- ll_fz_read_int16_le(stm)
- Low-level wrapper for `::fz_read_int16_le()`.
- ll_fz_read_int32(stm)
- Low-level wrapper for `::fz_read_int32()`.
- ll_fz_read_int32_le(stm)
- Low-level wrapper for `::fz_read_int32_le()`.
- ll_fz_read_int64(stm)
- Low-level wrapper for `::fz_read_int64()`.
- ll_fz_read_int64_le(stm)
- Low-level wrapper for `::fz_read_int64_le()`.
- ll_fz_read_line(stm, buf, max)
- Low-level wrapper for `::fz_read_line()`.
Read a line from stream into the buffer until either a
terminating newline or EOF, which it replaces with a null byte
('').
Returns buf on success, and NULL when end of file occurs while
no characters have been read.
- ll_fz_read_rbits(stm, n)
- Low-level wrapper for `::fz_read_rbits()`.
Read the next n bits from a stream (assumed to
be packed least significant bit first).
stm: The stream to read from.
n: The number of bits to read, between 1 and 8*sizeof(int)
inclusive.
Returns (unsigned int)-1 for EOF, or the required number of bits.
- ll_fz_read_string(stm, buffer, len)
- Low-level wrapper for `::fz_read_string()`.
Read a null terminated string from the stream into
a buffer of a given length. The buffer will be null terminated.
Throws on failure (including the failure to fit the entire
string including the terminator into the buffer).
- ll_fz_read_uint16(stm)
- Low-level wrapper for `::fz_read_uint16()`.
fz_read_[u]int(16|24|32|64)(_le)?
Read a 16/32/64 bit signed/unsigned integer from stream,
in big or little-endian byte orders.
Throws an exception if EOF is encountered.
- ll_fz_read_uint16_le(stm)
- Low-level wrapper for `::fz_read_uint16_le()`.
- ll_fz_read_uint24(stm)
- Low-level wrapper for `::fz_read_uint24()`.
- ll_fz_read_uint24_le(stm)
- Low-level wrapper for `::fz_read_uint24_le()`.
- ll_fz_read_uint32(stm)
- Low-level wrapper for `::fz_read_uint32()`.
- ll_fz_read_uint32_le(stm)
- Low-level wrapper for `::fz_read_uint32_le()`.
- ll_fz_read_uint64(stm)
- Low-level wrapper for `::fz_read_uint64()`.
- ll_fz_read_uint64_le(stm)
- Low-level wrapper for `::fz_read_uint64_le()`.
- ll_fz_realloc(p, size)
- Low-level wrapper for `::fz_realloc()`.
Reallocates a block of memory to given size. Existing contents
up to min(old_size,new_size) are maintained. The rest of the
block is uninitialised.
fz_realloc(ctx, NULL, size) behaves like fz_malloc(ctx, size).
fz_realloc(ctx, p, 0); behaves like fz_free(ctx, p).
Throws exception in the event of failure to allocate.
- ll_fz_realloc_no_throw(p, size)
- Low-level wrapper for `::fz_realloc_no_throw()`.
fz_realloc equivalent that returns NULL rather than throwing
exceptions.
- ll_fz_realpath(path, resolved_path)
- Low-level wrapper for `::fz_realpath()`.
Resolve a path to an absolute file name.
The resolved path buffer must be of at least PATH_MAX size.
- ll_fz_recognize_document(magic)
- Low-level wrapper for `::fz_recognize_document()`.
Given a magic find a document handler that can handle a
document of this type.
magic: Can be a filename extension (including initial period) or
a mimetype.
- ll_fz_recognize_document_content(filename)
- Low-level wrapper for `::fz_recognize_document_content()`.
Given a filename find a document handler that can handle a
document of this type.
filename: The filename of the document. This will be opened and sampled
to check data.
- ll_fz_recognize_document_stream_content(stream, magic)
- Low-level wrapper for `::fz_recognize_document_stream_content()`.
Given a magic find a document handler that can handle a
document of this type.
stream: the file stream to sample.
magic: Can be a filename extension (including initial period) or
a mimetype.
- ll_fz_recognize_image_format(p)
- Low-level wrapper for `::fz_recognize_image_format()`.
Recognise image format strings in the first 8 bytes from image
data.
- ll_fz_rect_from_irect(bbox)
- Low-level wrapper for `::fz_rect_from_irect()`.
Convert a bbox into a rect.
For our purposes, a rect can represent all the values we meet in
a bbox, so nothing can go wrong.
rect: A place to store the generated rectangle.
bbox: The bbox to convert.
Returns rect (updated).
- ll_fz_rect_from_quad(q)
- Low-level wrapper for `::fz_rect_from_quad()`.
Convert a quad to the smallest rect that covers it.
- ll_fz_rectto(path, x0, y0, x1, y1)
- Low-level wrapper for `::fz_rectto()`.
Append a 'rectto' command to an open path.
The rectangle is equivalent to:
moveto x0 y0
lineto x1 y0
lineto x1 y1
lineto x0 y1
closepath
path: The path to modify.
x0, y0: First corner of the rectangle.
x1, y1: Second corner of the rectangle.
Throws exceptions on failure to allocate, or attempting to
modify a packed path.
- ll_fz_register_document_handler(handler)
- Low-level wrapper for `::fz_register_document_handler()`.
Register a handler for a document type.
handler: The handler to register.
- ll_fz_register_document_handlers()
- Low-level wrapper for `::fz_register_document_handlers()`.
Register handlers
for all the standard document types supported in
this build.
- ll_fz_remove_item(drop, key, type)
- Low-level wrapper for `::fz_remove_item()`.
Remove an item from the store.
If an item indexed by the given key exists in the store, remove
it.
drop: The function used to free the value (to ensure we get a
value of the correct type).
key: The key used to find the item to remove.
type: Functions used to manipulate the key.
- ll_fz_render_flags(dev, set, clear)
- Low-level wrapper for `::fz_render_flags()`.
- ll_fz_render_glyph_pixmap(font, gid, ctm, scissor, aa)
- Low-level wrapper for `::fz_render_glyph_pixmap()`.
Create a pixmap containing a rendered glyph.
Lookup gid from font, clip it with scissor, and rendering it
with aa bits of antialiasing into a new pixmap.
The caller takes ownership of the pixmap and so must free it.
Note: This function is no longer used for normal rendering
operations, and is kept around just because we use it in the
app. It should be considered "at risk" of removal from the API.
- ll_fz_render_t3_glyph_direct(dev, font, gid, trm, gstate, def_cs)
- Low-level wrapper for `::fz_render_t3_glyph_direct()`.
Nasty PDF interpreter specific hernia, required to allow the
interpreter to replay glyphs from a type3 font directly into
the target device.
This is only used in exceptional circumstances (such as type3
glyphs that inherit current graphics state, or nested type3
glyphs).
- ll_fz_rendering_intent_name(ri)
- Low-level wrapper for `::fz_rendering_intent_name()`.
Map from enumerated rendering intent to string.
The returned string is static and therefore must not be freed.
- ll_fz_reset_story(story)
- Low-level wrapper for `::fz_reset_story()`.
- ll_fz_resize_buffer(buf, capacity)
- Low-level wrapper for `::fz_resize_buffer()`.
Ensure that a buffer has a given capacity,
truncating data if required.
capacity: The desired capacity for the buffer. If the current
size of the buffer contents is smaller than capacity, it is
truncated.
- ll_fz_resolve_link(doc, uri)
- Wrapper for out-params of fz_resolve_link().
Returns: fz_location, float xp, float yp
- ll_fz_resolve_link_dest(doc, uri)
- Low-level wrapper for `::fz_resolve_link_dest()`.
Resolve an internal link to a page number, location, and possible viewing parameters.
Returns location (-1,-1) if the URI cannot be resolved.
- ll_fz_resolve_link_outparams_fn(doc, uri, outparams)
- ll_fz_rethrow()
- Low-level wrapper for `::fz_rethrow()`.
- ll_fz_rethrow_if(errcode)
- Low-level wrapper for `::fz_rethrow_if()`.
Within an fz_catch() block, rethrow the current exception
if the errcode of the current exception matches.
This assumes no intervening use of fz_try/fz_catch.
- ll_fz_rotate(degrees)
- Low-level wrapper for `::fz_rotate()`.
Create a rotation matrix.
The returned matrix is of the form
[ cos(deg) sin(deg) -sin(deg) cos(deg) 0 0 ].
m: Pointer to place to store matrix
degrees: Degrees of counter clockwise rotation. Values less
than zero and greater than 360 are handled as expected.
Returns m.
- ll_fz_round_rect(rect)
- Low-level wrapper for `::fz_round_rect()`.
Round rectangle coordinates.
Coordinates in a bounding box are integers, so rounding of the
rects coordinates takes place. The top left corner is rounded
upwards and left while the bottom right corner is rounded
downwards and to the right.
This differs from fz_irect_from_rect, in that fz_irect_from_rect
slavishly follows the numbers (i.e any slight over/under
calculations can cause whole extra pixels to be added).
fz_round_rect allows for a small amount of rounding error when
calculating the bbox.
- ll_fz_run_display_list(list, dev, ctm, scissor, cookie)
- Low-level wrapper for `::fz_run_display_list()`.
(Re)-run a display list through a device.
list: A display list, created by fz_new_display_list and
populated with objects from a page by running fz_run_page on a
device obtained from fz_new_list_device.
ctm: Transform to apply to display list contents. May include
for example scaling and rotation, see fz_scale, fz_rotate and
fz_concat. Set to fz_identity if no transformation is desired.
scissor: Only the part of the contents of the display list
visible within this area will be considered when the list is
run through the device. This does not imply for tile objects
contained in the display list.
cookie: Communication mechanism between caller and library
running the page. Intended for multi-threaded applications,
while single-threaded applications set cookie to NULL. The
caller may abort an ongoing page run. Cookie also communicates
progress information back to the caller. The fields inside
cookie are continually updated while the page is being run.
- ll_fz_run_page(page, dev, transform, cookie)
- Low-level wrapper for `::fz_run_page()`.
Run a page through a device.
page: Page obtained from fz_load_page.
dev: Device obtained from fz_new_*_device.
transform: Transform to apply to page. May include for example
scaling and rotation, see fz_scale, fz_rotate and fz_concat.
Set to fz_identity if no transformation is desired.
cookie: Communication mechanism between caller and library
rendering the page. Intended for multi-threaded applications,
while single-threaded applications set cookie to NULL. The
caller may abort an ongoing rendering of a page. Cookie also
communicates progress information back to the caller. The
fields inside cookie are continually updated while the page is
rendering.
- ll_fz_run_page_annots(page, dev, transform, cookie)
- Low-level wrapper for `::fz_run_page_annots()`.
Run the annotations on a page through a device.
- ll_fz_run_page_contents(page, dev, transform, cookie)
- Low-level wrapper for `::fz_run_page_contents()`.
Run a page through a device. Just the main
page content, without the annotations, if any.
page: Page obtained from fz_load_page.
dev: Device obtained from fz_new_*_device.
transform: Transform to apply to page. May include for example
scaling and rotation, see fz_scale, fz_rotate and fz_concat.
Set to fz_identity if no transformation is desired.
cookie: Communication mechanism between caller and library
rendering the page. Intended for multi-threaded applications,
while single-threaded applications set cookie to NULL. The
caller may abort an ongoing rendering of a page. Cookie also
communicates progress information back to the caller. The
fields inside cookie are continually updated while the page is
rendering.
- ll_fz_run_page_widgets(page, dev, transform, cookie)
- Low-level wrapper for `::fz_run_page_widgets()`.
Run the widgets on a page through a device.
- ll_fz_run_t3_glyph(font, gid, trm, dev)
- Low-level wrapper for `::fz_run_t3_glyph()`.
Run a glyph from a Type3 font to
a given device.
font: The font to find the glyph in.
gid: The glyph to run.
trm: The transform to apply.
dev: The device to render onto.
- ll_fz_runeidx(str, p)
- Low-level wrapper for `::fz_runeidx()`.
Compute the index of a rune in a string.
str: Pointer to beginning of a string.
p: Pointer to a char in str.
Returns the index of the rune pointed to by p in str.
- ll_fz_runelen(rune)
- Low-level wrapper for `::fz_runelen()`.
Count how many chars are required to represent a rune.
rune: The rune to encode.
Returns the number of bytes required to represent this run in
UTF8.
- ll_fz_runeptr(str, idx)
- Low-level wrapper for `::fz_runeptr()`.
Obtain a pointer to the char representing the rune
at a given index.
str: Pointer to beginning of a string.
idx: Index of a rune to return a char pointer to.
Returns a pointer to the char where the desired rune starts,
or NULL if the string ends before the index is reached.
- ll_fz_runetochar(str, rune)
- Low-level wrapper for `::fz_runetochar()`.
UTF8 encode a rune to a sequence of chars.
str: Pointer to a place to put the UTF8 encoded character.
rune: Pointer to a 'rune'.
Returns the number of bytes the rune took to output.
- ll_fz_samples_get(pixmap, offset)
- Low-level wrapper for `::fz_samples_get()`.
Provides simple (but slow) access to pixmap data from Python and C#.
- ll_fz_samples_set(pixmap, offset, value)
- Low-level wrapper for `::fz_samples_set()`.
Provides simple (but slow) write access to pixmap data from Python and
C#.
- ll_fz_save_accelerator(doc, accel)
- Low-level wrapper for `::fz_save_accelerator()`.
Save accelerator data for the document to a given file.
- ll_fz_save_bitmap_as_pbm(bitmap, filename)
- Low-level wrapper for `::fz_save_bitmap_as_pbm()`.
Save a bitmap as a pbm.
- ll_fz_save_bitmap_as_pcl(bitmap, filename, append, pcl)
- Low-level wrapper for `::fz_save_bitmap_as_pcl()`.
Save a bitmap as mono PCL.
- ll_fz_save_bitmap_as_pkm(bitmap, filename)
- Low-level wrapper for `::fz_save_bitmap_as_pkm()`.
Save a CMYK bitmap as a pkm.
- ll_fz_save_bitmap_as_pwg(bitmap, filename, append, pwg)
- Low-level wrapper for `::fz_save_bitmap_as_pwg()`.
Save a bitmap as a PWG.
- ll_fz_save_buffer(buf, filename)
- Low-level wrapper for `::fz_save_buffer()`.
Save the contents of a buffer to a file.
- ll_fz_save_pixmap_as_jpeg(pixmap, filename, quality)
- Low-level wrapper for `::fz_save_pixmap_as_jpeg()`.
Save a pixmap as a JPEG.
- ll_fz_save_pixmap_as_pam(pixmap, filename)
- Low-level wrapper for `::fz_save_pixmap_as_pam()`.
Save a pixmap as a pnm (greyscale, rgb or cmyk, with or without
alpha).
- ll_fz_save_pixmap_as_pbm(pixmap, filename)
- Low-level wrapper for `::fz_save_pixmap_as_pbm()`.
Save a pixmap as a pbm. (Performing halftoning).
- ll_fz_save_pixmap_as_pcl(pixmap, filename, append, pcl)
- Low-level wrapper for `::fz_save_pixmap_as_pcl()`.
Save an (RGB) pixmap as color PCL.
- ll_fz_save_pixmap_as_pclm(pixmap, filename, append, options)
- Low-level wrapper for `::fz_save_pixmap_as_pclm()`.
Save a (Greyscale or RGB) pixmap as pclm.
- ll_fz_save_pixmap_as_pdfocr(pixmap, filename, append, options)
- Low-level wrapper for `::fz_save_pixmap_as_pdfocr()`.
Save a (Greyscale or RGB) pixmap as pdfocr.
- ll_fz_save_pixmap_as_pkm(pixmap, filename)
- Low-level wrapper for `::fz_save_pixmap_as_pkm()`.
Save a CMYK pixmap as a pkm. (Performing halftoning).
- ll_fz_save_pixmap_as_png(pixmap, filename)
- Low-level wrapper for `::fz_save_pixmap_as_png()`.
Save a (Greyscale or RGB) pixmap as a png.
- ll_fz_save_pixmap_as_pnm(pixmap, filename)
- Low-level wrapper for `::fz_save_pixmap_as_pnm()`.
Save a pixmap as a pnm (greyscale or rgb, no alpha).
- ll_fz_save_pixmap_as_ps(pixmap, filename, append)
- Low-level wrapper for `::fz_save_pixmap_as_ps()`.
Save a (gray, rgb, or cmyk, no alpha) pixmap out as postscript.
- ll_fz_save_pixmap_as_psd(pixmap, filename)
- Low-level wrapper for `::fz_save_pixmap_as_psd()`.
Save a pixmap as a PSD file.
- ll_fz_save_pixmap_as_pwg(pixmap, filename, append, pwg)
- Low-level wrapper for `::fz_save_pixmap_as_pwg()`.
Save a pixmap as a PWG.
- ll_fz_scale(sx, sy)
- Low-level wrapper for `::fz_scale()`.
Create a scaling matrix.
The returned matrix is of the form [ sx 0 0 sy 0 0 ].
m: Pointer to the matrix to populate
sx, sy: Scaling factors along the X- and Y-axes. A scaling
factor of 1.0 will not cause any scaling along the relevant
axis.
Returns m.
- ll_fz_search_chapter_page_number(doc, chapter, page, needle, hit_bbox, hit_max)
- Wrapper for out-params of fz_search_chapter_page_number().
Returns: int, int hit_mark
- ll_fz_search_chapter_page_number_outparams_fn(doc, chapter, page, needle, hit_bbox, hit_max, outparams)
- ll_fz_search_display_list(list, needle, hit_bbox, hit_max)
- Wrapper for out-params of fz_search_display_list().
Returns: int, int hit_mark
- ll_fz_search_display_list_outparams_fn(list, needle, hit_bbox, hit_max, outparams)
- ll_fz_search_page(page, needle, hit_bbox, hit_max)
- Wrapper for out-params of fz_search_page().
Returns: int, int hit_mark
- ll_fz_search_page2(doc, number, needle, hit_max)
- Low-level wrapper for `::fz_search_page2()`.
C++ alternative to fz_search_page() that returns information in a std::vector.
- ll_fz_search_page_number(doc, number, needle, hit_bbox, hit_max)
- Wrapper for out-params of fz_search_page_number().
Returns: int, int hit_mark
- ll_fz_search_page_number_outparams_fn(doc, number, needle, hit_bbox, hit_max, outparams)
- ll_fz_search_page_outparams_fn(page, needle, hit_bbox, hit_max, outparams)
- ll_fz_search_stext_page(text, needle, hit_bbox, hit_max)
- Wrapper for out-params of fz_search_stext_page().
Returns: int, int hit_mark
- ll_fz_search_stext_page_outparams_fn(text, needle, hit_bbox, hit_max, outparams)
- ll_fz_seek(stm, offset, whence)
- Low-level wrapper for `::fz_seek()`.
Seek within a stream.
stm: The stream to seek within.
offset: The offset to seek to.
whence: From where the offset is measured (see fseek).
SEEK_SET - start of stream.
SEEK_CUR - current position.
SEEK_END - end of stream.
- ll_fz_seek_output(out, off, whence)
- Low-level wrapper for `::fz_seek_output()`.
Seek to the specified file position.
See fseek for arguments.
Throw an error on unseekable outputs.
- ll_fz_separation_current_behavior(sep, separation)
- Low-level wrapper for `::fz_separation_current_behavior()`.
Test for the current behavior of a separation.
- ll_fz_separation_equivalent(seps, idx, dst_cs, prf, color_params)
- Wrapper for out-params of fz_separation_equivalent().
Returns: float dst_color
- ll_fz_separation_equivalent_outparams_fn(seps, idx, dst_cs, prf, color_params, outparams)
- ll_fz_separation_name(sep, separation)
- Low-level wrapper for `::fz_separation_name()`.
- ll_fz_set_aa_level(bits)
- Low-level wrapper for `::fz_set_aa_level()`.
Set the number of bits of antialiasing we should
use (for both text and graphics).
bits: The number of bits of antialiasing to use (values are
clamped to within the 0 to 8 range).
- ll_fz_set_compressed_image_buffer(cimg, buf)
- Low-level wrapper for `::fz_set_compressed_image_buffer()`.
- ll_fz_set_default_cmyk(default_cs, cs)
- Low-level wrapper for `::fz_set_default_cmyk()`.
- ll_fz_set_default_colorspaces(dev, default_cs)
- Low-level wrapper for `::fz_set_default_colorspaces()`.
- ll_fz_set_default_gray(default_cs, cs)
- Low-level wrapper for `::fz_set_default_gray()`.
Set new defaults within the default colorspace structure.
New references are taken to the new default, and references to
the old defaults dropped.
Never throws exceptions.
- ll_fz_set_default_output_intent(default_cs, cs)
- Low-level wrapper for `::fz_set_default_output_intent()`.
- ll_fz_set_default_rgb(default_cs, cs)
- Low-level wrapper for `::fz_set_default_rgb()`.
- ll_fz_set_error_callback(error_cb, user)
- Low-level wrapper for `::fz_set_error_callback()`.
Set the error callback. This will be called as part of the
exception handling.
The callback must not throw exceptions!
- ll_fz_set_font_bbox(font, xmin, ymin, xmax, ymax)
- Low-level wrapper for `::fz_set_font_bbox()`.
Set the font bbox.
font: The font to set the bbox for.
xmin, ymin, xmax, ymax: The bounding box.
- ll_fz_set_font_embedding(font, embed)
- Low-level wrapper for `::fz_set_font_embedding()`.
Control whether a given font should be embedded or not when writing.
- ll_fz_set_graphics_aa_level(bits)
- Low-level wrapper for `::fz_set_graphics_aa_level()`.
Set the number of bits of antialiasing we
should use for graphics.
bits: The number of bits of antialiasing to use (values are
clamped to within the 0 to 8 range).
- ll_fz_set_graphics_min_line_width(min_line_width)
- Low-level wrapper for `::fz_set_graphics_min_line_width()`.
Set the minimum line width to be
used for stroked lines.
min_line_width: The minimum line width to use (in pixels).
- ll_fz_set_link_rect(link, rect)
- Low-level wrapper for `::fz_set_link_rect()`.
- ll_fz_set_link_uri(link, uri)
- Low-level wrapper for `::fz_set_link_uri()`.
- ll_fz_set_metadata(doc, key, value)
- Low-level wrapper for `::fz_set_metadata()`.
- ll_fz_set_pixmap_image_tile(cimg, pix)
- Low-level wrapper for `::fz_set_pixmap_image_tile()`.
- ll_fz_set_pixmap_resolution(pix, xres, yres)
- Low-level wrapper for `::fz_set_pixmap_resolution()`.
Set the pixels per inch resolution of the pixmap.
- ll_fz_set_separation_behavior(sep, separation, behavior)
- Low-level wrapper for `::fz_set_separation_behavior()`.
Control the rendering of a given separation.
- ll_fz_set_stddbg(out)
- Low-level wrapper for `::fz_set_stddbg()`.
Set the output stream to be used for fz_stddbg. Set to NULL to
reset to default (stderr).
- ll_fz_set_text_aa_level(bits)
- Low-level wrapper for `::fz_set_text_aa_level()`.
Set the number of bits of antialiasing we
should use for text.
bits: The number of bits of antialiasing to use (values are
clamped to within the 0 to 8 range).
- ll_fz_set_use_document_css(use)
- Low-level wrapper for `::fz_set_use_document_css()`.
Toggle whether to respect document styles in HTML and EPUB.
- ll_fz_set_user_context(user)
- Low-level wrapper for `::fz_set_user_context()`.
Set the user field in the context.
NULL initially, this field can be set to any opaque value
required by the user. It is copied on clones.
- ll_fz_set_user_css(text)
- Low-level wrapper for `::fz_set_user_css()`.
Set the user stylesheet source text for use with HTML and EPUB.
- ll_fz_set_warning_callback(warning_cb, user)
- Low-level wrapper for `::fz_set_warning_callback()`.
Set the warning callback. This will be called as part of the
exception handling.
The callback must not throw exceptions!
- ll_fz_sha256_final(state, digest)
- Low-level wrapper for `::fz_sha256_final()`.
MD5 finalization. Ends an MD5 message-digest operation, writing
the message digest and zeroizing the context.
Never throws an exception.
- ll_fz_sha256_init(state)
- Low-level wrapper for `::fz_sha256_init()`.
SHA256 initialization. Begins an SHA256 operation, initialising
the supplied context.
Never throws an exception.
- ll_fz_sha256_update(state, input, inlen)
- Low-level wrapper for `::fz_sha256_update()`.
SHA256 block update operation. Continues an SHA256 message-
digest operation, processing another message block, and updating
the context.
Never throws an exception.
- ll_fz_sha384_final(state, digest)
- Low-level wrapper for `::fz_sha384_final()`.
SHA384 finalization. Ends an SHA384 message-digest operation,
writing the message digest and zeroizing the context.
Never throws an exception.
- ll_fz_sha384_init(state)
- Low-level wrapper for `::fz_sha384_init()`.
SHA384 initialization. Begins an SHA384 operation, initialising
the supplied context.
Never throws an exception.
- ll_fz_sha384_update(state, input, inlen)
- Low-level wrapper for `::fz_sha384_update()`.
SHA384 block update operation. Continues an SHA384 message-
digest operation, processing another message block, and updating
the context.
Never throws an exception.
- ll_fz_sha512_final(state, digest)
- Low-level wrapper for `::fz_sha512_final()`.
SHA512 finalization. Ends an SHA512 message-digest operation,
writing the message digest and zeroizing the context.
Never throws an exception.
- ll_fz_sha512_init(state)
- Low-level wrapper for `::fz_sha512_init()`.
SHA512 initialization. Begins an SHA512 operation, initialising
the supplied context.
Never throws an exception.
- ll_fz_sha512_update(state, input, inlen)
- Low-level wrapper for `::fz_sha512_update()`.
SHA512 block update operation. Continues an SHA512 message-
digest operation, processing another message block, and updating
the context.
Never throws an exception.
- ll_fz_shear(sx, sy)
- Low-level wrapper for `::fz_shear()`.
Create a shearing matrix.
The returned matrix is of the form [ 1 sy sx 1 0 0 ].
m: pointer to place to store returned matrix
sx, sy: Shearing factors. A shearing factor of 0.0 will not
cause any shearing along the relevant axis.
Returns m.
- ll_fz_show_glyph(text, font, trm, glyph, unicode, wmode, bidi_level, markup_dir, language)
- Low-level wrapper for `::fz_show_glyph()`.
Add a glyph/unicode value to a text object.
text: Text object to add to.
font: The font the glyph should be added in.
trm: The transform to use for the glyph.
glyph: The glyph id to add.
unicode: The unicode character for the glyph.
wmode: 1 for vertical mode, 0 for horizontal.
bidi_level: The bidirectional level for this glyph.
markup_dir: The direction of the text as specified in the
markup.
language: The language in use (if known, 0 otherwise)
(e.g. FZ_LANG_zh_Hans).
Throws exception on failure to allocate.
- ll_fz_show_string(text, font, trm, s, wmode, bidi_level, markup_dir, language)
- Low-level wrapper for `::fz_show_string()`.
Add a UTF8 string to a text object.
text: Text object to add to.
font: The font the string should be added in.
trm: The transform to use.
s: The utf-8 string to add.
wmode: 1 for vertical mode, 0 for horizontal.
bidi_level: The bidirectional level for this glyph.
markup_dir: The direction of the text as specified in the markup.
language: The language in use (if known, 0 otherwise)
(e.g. FZ_LANG_zh_Hans).
Returns the transform updated with the advance width of the
string.
- ll_fz_shrink_store(percent)
- Low-level wrapper for `::fz_shrink_store()`.
Evict items from the store until the total size of
the objects in the store is reduced to a given percentage of its
current size.
percent: %age of current size to reduce the store to.
Returns non zero if we managed to free enough memory, zero
otherwise.
- ll_fz_skip(stm, len)
- Low-level wrapper for `::fz_skip()`.
Read from a stream discarding data.
stm: The stream to read from.
len: The number of bytes to read.
Returns the number of bytes read. May throw exceptions.
- ll_fz_skip_space(stm)
- Low-level wrapper for `::fz_skip_space()`.
Skip over whitespace (bytes <= 32) in a stream.
- ll_fz_skip_string(stm, str)
- Low-level wrapper for `::fz_skip_string()`.
Skip over a given string in a stream. Return 0 if successfully
skipped, non-zero otherwise. As many characters will be skipped
over as matched in the string.
- ll_fz_slice_buffer(buf, start, end)
- Low-level wrapper for `::fz_slice_buffer()`.
Create a new buffer with a (subset of) the data from the buffer.
start: if >= 0, offset from start of buffer, if < 0 offset from end of buffer.
end: if >= 0, offset from start of buffer, if < 0 offset from end of buffer.
- ll_fz_snap_selection(page, ap, bp, mode)
- Low-level wrapper for `::fz_snap_selection()`.
- ll_fz_start_throw_on_repair()
- Low-level wrapper for `::fz_start_throw_on_repair()`.
- ll_fz_stat_ctime(path)
- Low-level wrapper for `::fz_stat_ctime()`.
- ll_fz_stat_mtime(path)
- Low-level wrapper for `::fz_stat_mtime()`.
- ll_fz_stddbg()
- Low-level wrapper for `::fz_stddbg()`.
Retrieve an fz_output for the default debugging stream. On
Windows this will be OutputDebugString for non-console apps.
Otherwise, it is always fz_stderr.
Optionally may be fz_dropped when finished with.
- ll_fz_stderr()
- Low-level wrapper for `::fz_stderr()`.
Retrieve an fz_output that directs to stdout.
Optionally may be fz_dropped when finished with.
- ll_fz_stdout()
- Low-level wrapper for `::fz_stdout()`.
Retrieve an fz_output that directs to stdout.
Optionally may be fz_dropped when finished with.
- ll_fz_store_item(key, val, itemsize, type)
- Low-level wrapper for `::fz_store_item()`.
Add an item to the store.
Add an item into the store, returning NULL for success. If an
item with the same key is found in the store, then our item will
not be inserted, and the function will return a pointer to that
value instead. This function takes its own reference to val, as
required (i.e. the caller maintains ownership of its own
reference).
key: The key used to index the item.
val: The value to store.
itemsize: The size in bytes of the value (as counted towards the
store size).
type: Functions used to manipulate the key.
- ll_fz_store_scavenge(size)
- Wrapper for out-params of fz_store_scavenge().
Returns: int, int phase
- ll_fz_store_scavenge_external(size)
- Wrapper for out-params of fz_store_scavenge_external().
Returns: int, int phase
- ll_fz_store_scavenge_external_outparams_fn(size, outparams)
- ll_fz_store_scavenge_outparams_fn(size, outparams)
- ll_fz_story_document(story)
- Low-level wrapper for `::fz_story_document()`.
- ll_fz_story_positions(story, python_callback)
- Custom replacement for `ll_fz_story_positions()` that takes
a Python callable `python_callback`.
- ll_fz_story_positions_director(story, cb)
- ll_fz_story_positions_orig = ll_fz_story_positions(story, cb, arg)
- Low-level wrapper for `::fz_story_positions()`.
- ll_fz_story_warnings(story)
- Low-level wrapper for `::fz_story_warnings()`.
- ll_fz_strcasecmp(a, b)
- Low-level wrapper for `::fz_strcasecmp()`.
Case insensitive (ASCII only) string comparison.
- ll_fz_strdup(s)
- Low-level wrapper for `::fz_strdup()`.
Portable strdup implementation, using fz allocators.
- ll_fz_stream_from_output(arg_1)
- Low-level wrapper for `::fz_stream_from_output()`.
Obtain the fz_output in the form of a fz_stream.
This allows data to be read back from some forms of fz_output
object. When finished reading, the fz_stream should be released
by calling fz_drop_stream. Until the fz_stream is dropped, no
further operations should be performed on the fz_output object.
- ll_fz_string_from_box_type(box)
- Low-level wrapper for `::fz_string_from_box_type()`.
- ll_fz_string_from_buffer(buf)
- Low-level wrapper for `::fz_string_from_buffer()`.
Ensure that a buffer's data ends in a
0 byte, and return a pointer to it.
- ll_fz_string_from_text_language(str, lang)
- Low-level wrapper for `::fz_string_from_text_language()`.
Recover ISO 639 (639-{1,2,3,5}) language specification
strings losslessly from a 15 bit fz_text_language code.
No validation is carried out. See note above.
- ll_fz_strlcat(dst, src, n)
- Low-level wrapper for `::fz_strlcat()`.
Concatenate 2 strings, with a maximum length.
dst: pointer to first string in a buffer of n bytes.
src: pointer to string to concatenate.
n: Size (in bytes) of buffer that dst is in.
Returns the real length that a concatenated dst + src would have
been (not including terminator).
- ll_fz_strlcpy(dst, src, n)
- Low-level wrapper for `::fz_strlcpy()`.
Copy at most n-1 chars of a string into a destination
buffer with null termination, returning the real length of the
initial string (excluding terminator).
dst: Destination buffer, at least n bytes long.
src: C string (non-NULL).
n: Size of dst buffer in bytes.
Returns the length (excluding terminator) of src.
- ll_fz_strncasecmp(a, b, n)
- Low-level wrapper for `::fz_strncasecmp()`.
- ll_fz_strnlen(s, maxlen)
- Low-level wrapper for `::fz_strnlen()`.
Return strlen(s), if that is less than maxlen, or maxlen if
there is no null byte ('') among the first maxlen bytes.
- ll_fz_stroke_path(dev, path, stroke, ctm, colorspace, color, alpha, color_params)
- Low-level wrapper for `::fz_stroke_path()`.
- ll_fz_stroke_text(dev, text, stroke, ctm, colorspace, color, alpha, color_params)
- Low-level wrapper for `::fz_stroke_text()`.
- ll_fz_strsep(delim)
- Wrapper for out-params of fz_strsep().
Returns: char *, char *stringp
- ll_fz_strsep_outparams_fn(delim, outparams)
- ll_fz_strtof(s)
- Wrapper for out-params of fz_strtof().
Returns: float, char *es
- ll_fz_strtof_outparams_fn(s, outparams)
- ll_fz_structure_from_string(str)
- Low-level wrapper for `::fz_structure_from_string()`.
- ll_fz_structure_to_string(type)
- Low-level wrapper for `::fz_structure_to_string()`.
- ll_fz_subpixel_adjust(ctm, subpix_ctm, qe, qf)
- Low-level wrapper for `::fz_subpixel_adjust()`.
Perform subpixel quantisation and adjustment on a glyph matrix.
ctm: On entry, the desired 'ideal' transformation for a glyph.
On exit, adjusted to a (very similar) transformation quantised
for subpixel caching.
subpix_ctm: Initialised by the routine to the transform that
should be used to render the glyph.
qe, qf: which subpixel position we quantised to.
Returns: the size of the glyph.
Note: This is currently only exposed for use in our app. It
should be considered "at risk" of removal from the API.
- ll_fz_sync_bits(stm)
- Low-level wrapper for `::fz_sync_bits()`.
Called after reading bits to tell the stream
that we are about to return to reading bytewise. Resyncs
the stream to whole byte boundaries.
- ll_fz_tell(stm)
- Low-level wrapper for `::fz_tell()`.
return the current reading position within a stream
- ll_fz_tell_output(out)
- Low-level wrapper for `::fz_tell_output()`.
Return the current file position.
Throw an error on untellable outputs.
- ll_fz_terminate_buffer(buf)
- Low-level wrapper for `::fz_terminate_buffer()`.
Zero-terminate buffer in order to use as a C string.
This byte is invisible and does not affect the length of the
buffer as returned by fz_buffer_storage. The zero byte is
written *after* the data, and subsequent writes will overwrite
the terminating byte.
Subsequent changes to the size of the buffer (such as by
fz_buffer_trim, fz_buffer_grow, fz_resize_buffer, etc) may
invalidate this.
- ll_fz_text_aa_level()
- Low-level wrapper for `::fz_text_aa_level()`.
Get the number of bits of antialiasing we are
using for text. Between 0 and 8.
- ll_fz_text_language_from_string(str)
- Low-level wrapper for `::fz_text_language_from_string()`.
Convert ISO 639 (639-{1,2,3,5}) language specification
strings losslessly to a 15 bit fz_text_language code.
No validation is carried out. Obviously invalid (out
of spec) codes will be mapped to FZ_LANG_UNSET, but
well-formed (but undefined) codes will be blithely
accepted.
- ll_fz_tint_pixmap(pix, black, white)
- Low-level wrapper for `::fz_tint_pixmap()`.
Tint all the pixels in an RGB, BGR, or Gray pixmap.
black: Map black to this hexadecimal RGB color.
white: Map white to this hexadecimal RGB color.
- ll_fz_tolower(c)
- Low-level wrapper for `::fz_tolower()`.
Unicode aware tolower and toupper functions.
- ll_fz_toupper(c)
- Low-level wrapper for `::fz_toupper()`.
- ll_fz_transform_page(mediabox, resolution, rotate)
- Low-level wrapper for `::fz_transform_page()`.
Create transform matrix to draw page
at a given resolution and rotation. Adjusts the scaling
factors so that the page covers whole number of
pixels and adjust the page origin to be at 0,0.
- ll_fz_transform_path(path, transform)
- Low-level wrapper for `::fz_transform_path()`.
Transform a path by a given
matrix.
path: The path to modify (must not be a packed path).
transform: The transform to apply.
Throws exceptions if the path is packed, or on failure
to allocate.
- ll_fz_transform_point(point, m)
- Low-level wrapper for `::fz_transform_point()`.
Apply a transformation to a point.
transform: Transformation matrix to apply. See fz_concat,
fz_scale, fz_rotate and fz_translate for how to create a
matrix.
point: Pointer to point to update.
Returns transform (unchanged).
- ll_fz_transform_point_xy(x, y, m)
- Low-level wrapper for `::fz_transform_point_xy()`.
- ll_fz_transform_quad(q, m)
- Low-level wrapper for `::fz_transform_quad()`.
Transform a quad by a matrix.
- ll_fz_transform_rect(rect, m)
- Low-level wrapper for `::fz_transform_rect()`.
Apply a transform to a rectangle.
After the four corner points of the axis-aligned rectangle
have been transformed it may not longer be axis-aligned. So a
new axis-aligned rectangle is created covering at least the
area of the transformed rectangle.
transform: Transformation matrix to apply. See fz_concat,
fz_scale and fz_rotate for how to create a matrix.
rect: Rectangle to be transformed. The two special cases
fz_empty_rect and fz_infinite_rect, may be used but are
returned unchanged as expected.
- ll_fz_transform_vector(vector, m)
- Low-level wrapper for `::fz_transform_vector()`.
Apply a transformation to a vector.
transform: Transformation matrix to apply. See fz_concat,
fz_scale and fz_rotate for how to create a matrix. Any
translation will be ignored.
vector: Pointer to vector to update.
- ll_fz_translate(tx, ty)
- Low-level wrapper for `::fz_translate()`.
Create a translation matrix.
The returned matrix is of the form [ 1 0 0 1 tx ty ].
m: A place to store the created matrix.
tx, ty: Translation distances along the X- and Y-axes. A
translation of 0 will not cause any translation along the
relevant axis.
Returns m.
- ll_fz_translate_irect(a, xoff, yoff)
- Low-level wrapper for `::fz_translate_irect()`.
- ll_fz_translate_rect(a, xoff, yoff)
- Low-level wrapper for `::fz_translate_rect()`.
Translate bounding box.
Translate a bbox by a given x and y offset. Allows for overflow.
- ll_fz_tree_archive_add_buffer(arch_, name, buf)
- Low-level wrapper for `::fz_tree_archive_add_buffer()`.
Add a named buffer to an existing tree archive.
The tree will take a new reference to the buffer. Ownership
is not transferred.
- ll_fz_tree_archive_add_data(arch_, name, data, size)
- Low-level wrapper for `::fz_tree_archive_add_data()`.
Add a named block of data to an existing tree archive.
The data will be copied into a buffer, and so the caller
may free it as soon as this returns.
- ll_fz_tree_insert(root, key, value)
- Low-level wrapper for `::fz_tree_insert()`.
Insert a new key/value pair and rebalance the tree.
Return the new root of the tree after inserting and rebalancing.
May be called with a NULL root to create a new tree.
No data is copied into the tree structure; key and value are
merely kept as pointers.
- ll_fz_tree_lookup(node, key)
- Low-level wrapper for `::fz_tree_lookup()`.
Look for the value of a node in the tree with the given key.
Simple pointer equivalence is used for key.
Returns NULL for no match.
- ll_fz_trim_buffer(buf)
- Low-level wrapper for `::fz_trim_buffer()`.
Trim wasted capacity from a buffer by resizing internal memory.
- ll_fz_trim_path(path)
- Low-level wrapper for `::fz_trim_path()`.
Minimise the internal storage used by a path.
As paths are constructed, the internal buffers
grow. To avoid repeated reallocations they
grow with some spare space. Once a path has
been fully constructed, this call allows the
excess space to be trimmed.
- ll_fz_truncate_output(arg_1)
- Low-level wrapper for `::fz_truncate_output()`.
Truncate the output at the current position.
This allows output streams which have seeked back from the end
of their storage to be truncated at the current point.
- ll_fz_try_invert_matrix(inv, src)
- Low-level wrapper for `::fz_try_invert_matrix()`.
Attempt to create an inverse matrix.
inverse: Place to store inverse matrix.
matrix: Matrix to invert. A degenerate matrix, where the
determinant is equal to zero, can not be inverted.
Returns 1 if matrix is degenerate (singular), or 0 otherwise.
- ll_fz_try_open_archive_entry(arch, name)
- Low-level wrapper for `::fz_try_open_archive_entry()`.
Opens an archive entry as a stream.
Returns NULL if a matching entry cannot be found, otherwise
behaves exactly as fz_open_archive_entry.
- ll_fz_try_open_archive_with_stream(file)
- Low-level wrapper for `::fz_try_open_archive_with_stream()`.
Open zip or tar archive stream.
Does the same as fz_open_archive_with_stream, but will not throw
an error in the event of failing to recognise the format. Will
still throw errors in other cases though!
- ll_fz_try_open_file(name)
- Low-level wrapper for `::fz_try_open_file()`.
Open the named file and wrap it in a stream.
Does the same as fz_open_file, but in the event the file
does not open, it will return NULL rather than throw an
exception.
- ll_fz_try_parse_xml_archive_entry(arch, filename, preserve_white)
- Low-level wrapper for `::fz_try_parse_xml_archive_entry()`.
Try and parse the contents of an archive entry into a tree of xml nodes.
preserve_white: whether to keep or delete all-whitespace nodes.
Will return NULL if the archive entry can't be found. Otherwise behaves
the same as fz_parse_xml_archive_entry. May throw exceptions.
- ll_fz_try_read_archive_entry(arch, name)
- Low-level wrapper for `::fz_try_read_archive_entry()`.
Reads all bytes in an archive entry
into a buffer.
name: Entry name to look for, this must be an exact match to
the entry name in the archive.
Returns NULL if a matching entry cannot be found. Otherwise behaves
the same as fz_read_archive_entry. Exceptions may be thrown.
- ll_fz_try_read_file(filename)
- Low-level wrapper for `::fz_try_read_file()`.
Read all the contents of a file into a buffer.
Returns NULL if the file does not exist, otherwise
behaves exactly as fz_read_file.
- ll_fz_tune_image_decode(image_decode, arg)
- Low-level wrapper for `::fz_tune_image_decode()`.
Set the tuning function to use for
image decode.
image_decode: Function to use.
arg: Opaque argument to be passed to tuning function.
- ll_fz_tune_image_scale(image_scale, arg)
- Low-level wrapper for `::fz_tune_image_scale()`.
Set the tuning function to use for
image scaling.
image_scale: Function to use.
arg: Opaque argument to be passed to tuning function.
- ll_fz_unicode_from_glyph_name(name)
- Low-level wrapper for `::fz_unicode_from_glyph_name()`.
- ll_fz_unicode_from_glyph_name_strict(name)
- Low-level wrapper for `::fz_unicode_from_glyph_name_strict()`.
- ll_fz_union_rect(a, b)
- Low-level wrapper for `::fz_union_rect()`.
Compute union of two rectangles.
Given two rectangles, update the first to be the smallest
axis-aligned rectangle that encompasses both given rectangles.
If either rectangle is infinite then the union is also infinite.
If either rectangle is empty then the union is simply the
non-empty rectangle. Should both rectangles be empty, then the
union is also empty.
- ll_fz_unlock(lock)
- Low-level wrapper for `::fz_unlock()`.
Unlock one of the user supplied mutexes.
- ll_fz_unpack_stream(src, depth, w, h, n, indexed, pad, skip)
- Low-level wrapper for `::fz_unpack_stream()`.
- ll_fz_unread_byte(stm)
- Low-level wrapper for `::fz_unread_byte()`.
Unread the single last byte successfully
read from a stream. Do not call this without having
successfully read a byte.
stm: The stream to operate upon.
- ll_fz_unshare_stroke_state(shared)
- Low-level wrapper for `::fz_unshare_stroke_state()`.
Given a reference to a (possibly) shared stroke_state structure,
return a reference to an equivalent stroke_state structure
that is guaranteed to be unshared (i.e. one that can
safely be modified).
shared: The reference to a (possibly) shared structure
to unshare. Ownership of this reference is passed in
to this function, even in the case of exceptions being
thrown.
Exceptions may be thrown in the event of failure to
allocate if required.
- ll_fz_unshare_stroke_state_with_dash_len(shared, len)
- Low-level wrapper for `::fz_unshare_stroke_state_with_dash_len()`.
Given a reference to a (possibly) shared stroke_state structure,
return a reference to a stroke_state structure (with room for a
given amount of dash data) that is guaranteed to be unshared
(i.e. one that can safely be modified).
shared: The reference to a (possibly) shared structure
to unshare. Ownership of this reference is passed in
to this function, even in the case of exceptions being
thrown.
Exceptions may be thrown in the event of failure to
allocate if required.
- ll_fz_urldecode(url)
- Low-level wrapper for `::fz_urldecode()`.
Like fz_decode_uri_component but in-place.
- ll_fz_use_document_css()
- Low-level wrapper for `::fz_use_document_css()`.
Return whether to respect document styles in HTML and EPUB.
- ll_fz_user_context()
- Low-level wrapper for `::fz_user_context()`.
Read the user field from the context.
- ll_fz_user_css()
- Low-level wrapper for `::fz_user_css()`.
Get the user stylesheet source text.
- ll_fz_utflen(s)
- Low-level wrapper for `::fz_utflen()`.
Count how many runes the UTF-8 encoded string
consists of.
s: The UTF-8 encoded, NUL-terminated text string.
Returns the number of runes in the string.
- ll_fz_var_imp(arg_0)
- Low-level wrapper for `::fz_var_imp()`.
- ll_fz_walk_path(path, walker, arg)
- Low-level wrapper for `::fz_walk_path()`.
Walk the segments of a path, calling the
appropriate callback function from a given set for each
segment of the path.
path: The path to walk.
walker: The set of callback functions to use. The first
4 callback pointers in the set must be non-NULL. The
subsequent ones can either be supplied, or can be left
as NULL, in which case the top 4 functions will be
called as appropriate to simulate them.
arg: An opaque argument passed in to each callback.
Exceptions will only be thrown if the underlying callback
functions throw them.
- ll_fz_warn(text)
- ll_fz_warn_original = ll_fz_warn(*args)
- Low-level wrapper for `::fz_warn()`.
- ll_fz_warning_callback()
- Wrapper for out-params of fz_warning_callback().
Returns: fz_warning_cb *, void *user
- ll_fz_warning_callback_outparams_fn(outparams)
- ll_fz_warp_pixmap(src, points, width, height)
- Low-level wrapper for `::fz_warp_pixmap()`.
- ll_fz_windows_1250_from_unicode(u)
- Low-level wrapper for `::fz_windows_1250_from_unicode()`.
- ll_fz_windows_1251_from_unicode(u)
- Low-level wrapper for `::fz_windows_1251_from_unicode()`.
- ll_fz_windows_1252_from_unicode(u)
- Low-level wrapper for `::fz_windows_1252_from_unicode()`.
- ll_fz_write_band(writer, stride, band_height, samples)
- Low-level wrapper for `::fz_write_band()`.
Cause a band writer to write the next band
of data for an image.
stride: The byte offset from the first byte of the data
for a pixel to the first byte of the data for the same pixel
on the row below.
band_height: The number of lines in this band.
samples: Pointer to first byte of the data.
- ll_fz_write_base64(out, data, size, newline)
- Low-level wrapper for `::fz_write_base64()`.
Write a base64 encoded data block, optionally with periodic
newlines.
- ll_fz_write_base64_buffer(out, data, newline)
- Low-level wrapper for `::fz_write_base64_buffer()`.
Write a base64 encoded fz_buffer, optionally with periodic
newlines.
- ll_fz_write_bitmap_as_pbm(out, bitmap)
- Low-level wrapper for `::fz_write_bitmap_as_pbm()`.
Write a bitmap as a pbm.
- ll_fz_write_bitmap_as_pcl(out, bitmap, pcl)
- Low-level wrapper for `::fz_write_bitmap_as_pcl()`.
Write a bitmap as mono PCL.
- ll_fz_write_bitmap_as_pkm(out, bitmap)
- Low-level wrapper for `::fz_write_bitmap_as_pkm()`.
Write a CMYK bitmap as a pkm.
- ll_fz_write_bitmap_as_pwg(out, bitmap, pwg)
- Low-level wrapper for `::fz_write_bitmap_as_pwg()`.
Write a bitmap as a PWG.
- ll_fz_write_bitmap_as_pwg_page(out, bitmap, pwg)
- Low-level wrapper for `::fz_write_bitmap_as_pwg_page()`.
Write a bitmap as a PWG page.
Caller should provide a file header by calling
fz_write_pwg_file_header, but can then write several pages to
the same file.
- ll_fz_write_bits(out, data, num_bits)
- Low-level wrapper for `::fz_write_bits()`.
Write num_bits of data to the end of the output stream, assumed to be packed
most significant bits first.
- ll_fz_write_bits_sync(out)
- Low-level wrapper for `::fz_write_bits_sync()`.
Sync to byte boundary after writing bits.
- ll_fz_write_buffer(out, data)
- Low-level wrapper for `::fz_write_buffer()`.
- ll_fz_write_byte(out, x)
- Low-level wrapper for `::fz_write_byte()`.
- ll_fz_write_char(out, x)
- Low-level wrapper for `::fz_write_char()`.
- ll_fz_write_data(out, data, size)
- Low-level wrapper for `::fz_write_data()`.
Write data to output.
data: Pointer to data to write.
size: Size of data to write in bytes.
- ll_fz_write_document(wri, doc)
- Low-level wrapper for `::fz_write_document()`.
Convenience function to feed all the pages of a document to
fz_begin_page/fz_run_page/fz_end_page.
- ll_fz_write_float_be(out, f)
- Low-level wrapper for `::fz_write_float_be()`.
- ll_fz_write_float_le(out, f)
- Low-level wrapper for `::fz_write_float_le()`.
- ll_fz_write_header(writer, w, h, n, alpha, xres, yres, pagenum, cs, seps)
- Low-level wrapper for `::fz_write_header()`.
Cause a band writer to write the header for
a banded image with the given properties/dimensions etc. This
also configures the bandwriter for the format of the data to be
passed in future calls.
w, h: Width and Height of the entire page.
n: Number of components (including spots and alphas).
alpha: Number of alpha components.
xres, yres: X and Y resolutions in dpi.
cs: Colorspace (NULL for bitmaps)
seps: Separation details (or NULL).
- ll_fz_write_image_as_data_uri(out, image)
- Low-level wrapper for `::fz_write_image_as_data_uri()`.
Write image as a data URI (for HTML and SVG output).
- ll_fz_write_int16_be(out, x)
- Low-level wrapper for `::fz_write_int16_be()`.
- ll_fz_write_int16_le(out, x)
- Low-level wrapper for `::fz_write_int16_le()`.
- ll_fz_write_int32_be(out, x)
- Low-level wrapper for `::fz_write_int32_be()`.
Write different sized data to an output stream.
- ll_fz_write_int32_le(out, x)
- Low-level wrapper for `::fz_write_int32_le()`.
- ll_fz_write_pixmap_as_data_uri(out, pixmap)
- Low-level wrapper for `::fz_write_pixmap_as_data_uri()`.
- ll_fz_write_pixmap_as_pam(out, pixmap)
- Low-level wrapper for `::fz_write_pixmap_as_pam()`.
Write a pixmap as a pnm (greyscale, rgb or cmyk, with or without
alpha).
- ll_fz_write_pixmap_as_pcl(out, pixmap, pcl)
- Low-level wrapper for `::fz_write_pixmap_as_pcl()`.
Write an (RGB) pixmap as color PCL.
- ll_fz_write_pixmap_as_pclm(out, pixmap, options)
- Low-level wrapper for `::fz_write_pixmap_as_pclm()`.
Write a (Greyscale or RGB) pixmap as pclm.
- ll_fz_write_pixmap_as_pdfocr(out, pixmap, options)
- Low-level wrapper for `::fz_write_pixmap_as_pdfocr()`.
Write a (Greyscale or RGB) pixmap as pdfocr.
- ll_fz_write_pixmap_as_png(out, pixmap)
- Low-level wrapper for `::fz_write_pixmap_as_png()`.
Write a (Greyscale or RGB) pixmap as a png.
- ll_fz_write_pixmap_as_pnm(out, pixmap)
- Low-level wrapper for `::fz_write_pixmap_as_pnm()`.
Write a pixmap as a pnm (greyscale or rgb, no alpha).
- ll_fz_write_pixmap_as_ps(out, pixmap)
- Low-level wrapper for `::fz_write_pixmap_as_ps()`.
Write a (gray, rgb, or cmyk, no alpha) pixmap out as postscript.
- ll_fz_write_pixmap_as_psd(out, pixmap)
- Low-level wrapper for `::fz_write_pixmap_as_psd()`.
Write a pixmap as a PSD file.
- ll_fz_write_pixmap_as_pwg(out, pixmap, pwg)
- Low-level wrapper for `::fz_write_pixmap_as_pwg()`.
Write a pixmap as a PWG.
- ll_fz_write_pixmap_as_pwg_page(out, pixmap, pwg)
- Low-level wrapper for `::fz_write_pixmap_as_pwg_page()`.
Write a pixmap as a PWG page.
Caller should provide a file header by calling
fz_write_pwg_file_header, but can then write several pages to
the same file.
- ll_fz_write_ps_file_header(out)
- Low-level wrapper for `::fz_write_ps_file_header()`.
Write the file level header for ps band writer output.
- ll_fz_write_ps_file_trailer(out, pages)
- Low-level wrapper for `::fz_write_ps_file_trailer()`.
Write the file level trailer for ps band writer output.
- ll_fz_write_pwg_file_header(out)
- Low-level wrapper for `::fz_write_pwg_file_header()`.
Output the file header to a pwg stream, ready for pages to follow it.
- ll_fz_write_rune(out, rune)
- Low-level wrapper for `::fz_write_rune()`.
Write a UTF-8 encoded unicode character.
- ll_fz_write_stabilized_story(writer, user_css, em, contentfn, contentfn_ref, rectfn, rectfn_ref, pagefn, pagefn_ref, archive)
- Low-level wrapper for `::fz_write_stabilized_story()`.
- ll_fz_write_story(writer, story, rectfn, rectfn_ref, positionfn, positionfn_ref, pagefn, pagefn_ref)
- Low-level wrapper for `::fz_write_story()`.
- ll_fz_write_string(out, s)
- Low-level wrapper for `::fz_write_string()`.
Write a string. Does not write zero terminator.
- ll_fz_write_uint16_be(out, x)
- Low-level wrapper for `::fz_write_uint16_be()`.
- ll_fz_write_uint16_le(out, x)
- Low-level wrapper for `::fz_write_uint16_le()`.
- ll_fz_write_uint32_be(out, x)
- Low-level wrapper for `::fz_write_uint32_be()`.
- ll_fz_write_uint32_le(out, x)
- Low-level wrapper for `::fz_write_uint32_le()`.
- ll_fz_write_zip_entry(zip, name, buf, compress)
- Low-level wrapper for `::fz_write_zip_entry()`.
Given a buffer of data, (optionally) compress it, and add it to
the zip file with the given name.
- ll_fz_xml_add_att(pool, node, key, val)
- Low-level wrapper for `::fz_xml_add_att()`.
Add an attribute to an XML node.
- ll_fz_xml_att(item, att)
- Low-level wrapper for `::fz_xml_att()`.
Return the value of an attribute of an XML node.
NULL if the attribute doesn't exist.
- ll_fz_xml_att_alt(item, one, two)
- Low-level wrapper for `::fz_xml_att_alt()`.
Return the value of an attribute of an XML node.
If the first attribute doesn't exist, try the second.
NULL if neither attribute exists.
- ll_fz_xml_att_eq(item, name, match)
- Low-level wrapper for `::fz_xml_att_eq()`.
Check for a matching attribute on an XML node.
If the node has the requested attribute (name), and the value
matches (match) then return 1. Otherwise, 0.
- ll_fz_xml_down(item)
- Low-level wrapper for `::fz_xml_down()`.
Return first child of XML node.
- ll_fz_xml_find(item, tag)
- Low-level wrapper for `::fz_xml_find()`.
Search the siblings of XML nodes starting with item looking for
the first with the given tag.
Return NULL if none found.
- ll_fz_xml_find_dfs(item, tag, att, match)
- Low-level wrapper for `::fz_xml_find_dfs()`.
Perform a depth first search from item, returning the first
child that matches the given tag (or any tag if tag is NULL),
with the given attribute (if att is non NULL), that matches
match (if match is non NULL).
- ll_fz_xml_find_dfs_top(item, tag, att, match, top)
- Low-level wrapper for `::fz_xml_find_dfs_top()`.
Perform a depth first search from item, returning the first
child that matches the given tag (or any tag if tag is NULL),
with the given attribute (if att is non NULL), that matches
match (if match is non NULL). The search stops if it ever
reaches the top of the tree, or the declared 'top' item.
- ll_fz_xml_find_down(item, tag)
- Low-level wrapper for `::fz_xml_find_down()`.
Search the siblings of XML nodes starting with the first child
of item looking for the first with the given tag.
Return NULL if none found.
- ll_fz_xml_find_down_match(item, tag, att, match)
- Low-level wrapper for `::fz_xml_find_down_match()`.
Search the siblings of XML nodes starting with the first child
of item looking for the first with the given tag (or any tag if
tag is NULL), and with a matching attribute.
Return NULL if none found.
- ll_fz_xml_find_match(item, tag, att, match)
- Low-level wrapper for `::fz_xml_find_match()`.
Search the siblings of XML nodes starting with item looking for
the first with the given tag (or any tag if tag is NULL), and
with a matching attribute.
Return NULL if none found.
- ll_fz_xml_find_next(item, tag)
- Low-level wrapper for `::fz_xml_find_next()`.
Search the siblings of XML nodes starting with the first sibling
of item looking for the first with the given tag.
Return NULL if none found.
- ll_fz_xml_find_next_dfs(item, tag, att, match)
- Low-level wrapper for `::fz_xml_find_next_dfs()`.
Perform a depth first search onwards from item, returning the first
child that matches the given tag (or any tag if tag is NULL),
with the given attribute (if att is non NULL), that matches
match (if match is non NULL).
- ll_fz_xml_find_next_dfs_top(item, tag, att, match, top)
- Low-level wrapper for `::fz_xml_find_next_dfs_top()`.
Perform a depth first search onwards from item, returning the first
child that matches the given tag (or any tag if tag is NULL),
with the given attribute (if att is non NULL), that matches
match (if match is non NULL). The search stops if it ever reaches
the top of the tree, or the declared 'top' item.
- ll_fz_xml_find_next_match(item, tag, att, match)
- Low-level wrapper for `::fz_xml_find_next_match()`.
Search the siblings of XML nodes starting with the first sibling
of item looking for the first with the given tag (or any tag if tag
is NULL), and with a matching attribute.
Return NULL if none found.
- ll_fz_xml_is_tag(item, name)
- Low-level wrapper for `::fz_xml_is_tag()`.
Return true if the tag name matches.
- ll_fz_xml_next(item)
- Low-level wrapper for `::fz_xml_next()`.
Return next sibling of XML node.
- ll_fz_xml_prev(item)
- Low-level wrapper for `::fz_xml_prev()`.
Return previous sibling of XML node.
- ll_fz_xml_root(xml)
- Low-level wrapper for `::fz_xml_root()`.
Return the topmost XML node of a document.
- ll_fz_xml_tag(item)
- Low-level wrapper for `::fz_xml_tag()`.
Return tag of XML node. Return NULL for text nodes.
- ll_fz_xml_text(item)
- Low-level wrapper for `::fz_xml_text()`.
Return the text content of an XML node.
Return NULL if the node is a tag.
- ll_fz_xml_up(item)
- Low-level wrapper for `::fz_xml_up()`.
Return parent of XML node.
- ll_pdf_abandon_operation(doc)
- Low-level wrapper for `::pdf_abandon_operation()`.
- ll_pdf_access_alert_event(evt)
- Low-level wrapper for `::pdf_access_alert_event()`.
- ll_pdf_access_exec_menu_item_event(evt)
- Low-level wrapper for `::pdf_access_exec_menu_item_event()`.
- ll_pdf_access_launch_url_event(evt)
- Low-level wrapper for `::pdf_access_launch_url_event()`.
- ll_pdf_access_mail_doc_event(evt)
- Low-level wrapper for `::pdf_access_mail_doc_event()`.
- ll_pdf_add_annot_border_dash_item(annot, length)
- Low-level wrapper for `::pdf_add_annot_border_dash_item()`.
- ll_pdf_add_annot_ink_list(annot, n, stroke)
- Low-level wrapper for `::pdf_add_annot_ink_list()`.
- ll_pdf_add_annot_ink_list_stroke(annot)
- Low-level wrapper for `::pdf_add_annot_ink_list_stroke()`.
- ll_pdf_add_annot_ink_list_stroke_vertex(annot, p)
- Low-level wrapper for `::pdf_add_annot_ink_list_stroke_vertex()`.
- ll_pdf_add_annot_quad_point(annot, quad)
- Low-level wrapper for `::pdf_add_annot_quad_point()`.
- ll_pdf_add_annot_vertex(annot, p)
- Low-level wrapper for `::pdf_add_annot_vertex()`.
- ll_pdf_add_cid_font(doc, font)
- Low-level wrapper for `::pdf_add_cid_font()`.
- ll_pdf_add_cjk_font(doc, font, script, wmode, serif)
- Low-level wrapper for `::pdf_add_cjk_font()`.
- ll_pdf_add_codespace(cmap, low, high, n)
- Low-level wrapper for `::pdf_add_codespace()`.
- ll_pdf_add_embedded_file(doc, filename, mimetype, contents, created, modifed, add_checksum)
- Low-level wrapper for `::pdf_add_embedded_file()`.
- ll_pdf_add_hmtx(font, lo, hi, w)
- Low-level wrapper for `::pdf_add_hmtx()`.
- ll_pdf_add_image(doc, image)
- Low-level wrapper for `::pdf_add_image()`.
- ll_pdf_add_journal_fragment(doc, parent, copy, copy_stream, newobj)
- Low-level wrapper for `::pdf_add_journal_fragment()`.
- ll_pdf_add_new_array(doc, initial)
- Low-level wrapper for `::pdf_add_new_array()`.
- ll_pdf_add_new_dict(doc, initial)
- Low-level wrapper for `::pdf_add_new_dict()`.
- ll_pdf_add_object(doc, obj)
- Low-level wrapper for `::pdf_add_object()`.
- ll_pdf_add_object_drop(doc, obj)
- Low-level wrapper for `::pdf_add_object_drop()`.
- ll_pdf_add_page(doc, mediabox, rotate, resources, contents)
- Low-level wrapper for `::pdf_add_page()`.
- ll_pdf_add_simple_font(doc, font, encoding)
- Low-level wrapper for `::pdf_add_simple_font()`.
- ll_pdf_add_stream(doc, buf, obj, compressed)
- Low-level wrapper for `::pdf_add_stream()`.
- ll_pdf_add_substitute_font(doc, font)
- Low-level wrapper for `::pdf_add_substitute_font()`.
- ll_pdf_add_vmtx(font, lo, hi, x, y, w)
- Low-level wrapper for `::pdf_add_vmtx()`.
- ll_pdf_annot_MK_BC(annot, color)
- Wrapper for out-params of pdf_annot_MK_BC().
Returns: int n
- ll_pdf_annot_MK_BC_outparams_fn(annot, color, outparams)
- ll_pdf_annot_MK_BC_rgb(annot, rgb)
- Low-level wrapper for `::pdf_annot_MK_BC_rgb()`.
- ll_pdf_annot_MK_BG(annot, color)
- Wrapper for out-params of pdf_annot_MK_BG().
Returns: int n
- ll_pdf_annot_MK_BG_outparams_fn(annot, color, outparams)
- ll_pdf_annot_MK_BG_rgb(annot, rgb)
- Low-level wrapper for `::pdf_annot_MK_BG_rgb()`.
- ll_pdf_annot_active(annot)
- Low-level wrapper for `::pdf_annot_active()`.
- ll_pdf_annot_ap(annot)
- Low-level wrapper for `::pdf_annot_ap()`.
- ll_pdf_annot_author(annot)
- Low-level wrapper for `::pdf_annot_author()`.
- ll_pdf_annot_border(annot)
- Low-level wrapper for `::pdf_annot_border()`.
- ll_pdf_annot_border_dash_count(annot)
- Low-level wrapper for `::pdf_annot_border_dash_count()`.
- ll_pdf_annot_border_dash_item(annot, i)
- Low-level wrapper for `::pdf_annot_border_dash_item()`.
- ll_pdf_annot_border_effect(annot)
- Low-level wrapper for `::pdf_annot_border_effect()`.
- ll_pdf_annot_border_effect_intensity(annot)
- Low-level wrapper for `::pdf_annot_border_effect_intensity()`.
- ll_pdf_annot_border_style(annot)
- Low-level wrapper for `::pdf_annot_border_style()`.
- ll_pdf_annot_border_width(annot)
- Low-level wrapper for `::pdf_annot_border_width()`.
- ll_pdf_annot_color(annot, color)
- Wrapper for out-params of pdf_annot_color().
Returns: int n
- ll_pdf_annot_color_outparams_fn(annot, color, outparams)
- ll_pdf_annot_contents(annot)
- Low-level wrapper for `::pdf_annot_contents()`.
- ll_pdf_annot_creation_date(annot)
- Low-level wrapper for `::pdf_annot_creation_date()`.
- ll_pdf_annot_default_appearance(annot, color)
- Wrapper for out-params of pdf_annot_default_appearance().
Returns: const char *font, float size, int n
- ll_pdf_annot_default_appearance_outparams_fn(annot, color, outparams)
- ll_pdf_annot_ensure_local_xref(annot)
- Low-level wrapper for `::pdf_annot_ensure_local_xref()`.
- ll_pdf_annot_event_blur(annot)
- Low-level wrapper for `::pdf_annot_event_blur()`.
- ll_pdf_annot_event_down(annot)
- Low-level wrapper for `::pdf_annot_event_down()`.
- ll_pdf_annot_event_enter(annot)
- Low-level wrapper for `::pdf_annot_event_enter()`.
- ll_pdf_annot_event_exit(annot)
- Low-level wrapper for `::pdf_annot_event_exit()`.
- ll_pdf_annot_event_focus(annot)
- Low-level wrapper for `::pdf_annot_event_focus()`.
- ll_pdf_annot_event_page_close(annot)
- Low-level wrapper for `::pdf_annot_event_page_close()`.
- ll_pdf_annot_event_page_invisible(annot)
- Low-level wrapper for `::pdf_annot_event_page_invisible()`.
- ll_pdf_annot_event_page_open(annot)
- Low-level wrapper for `::pdf_annot_event_page_open()`.
- ll_pdf_annot_event_page_visible(annot)
- Low-level wrapper for `::pdf_annot_event_page_visible()`.
- ll_pdf_annot_event_up(annot)
- Low-level wrapper for `::pdf_annot_event_up()`.
- ll_pdf_annot_field_event_keystroke(doc, annot, evt)
- Low-level wrapper for `::pdf_annot_field_event_keystroke()`.
- ll_pdf_annot_field_flags(annot)
- Low-level wrapper for `::pdf_annot_field_flags()`.
- ll_pdf_annot_field_label(widget)
- Low-level wrapper for `::pdf_annot_field_label()`.
- ll_pdf_annot_field_value(annot)
- Low-level wrapper for `::pdf_annot_field_value()`.
- ll_pdf_annot_filespec(annot)
- Low-level wrapper for `::pdf_annot_filespec()`.
- ll_pdf_annot_flags(annot)
- Low-level wrapper for `::pdf_annot_flags()`.
- ll_pdf_annot_has_author(annot)
- Low-level wrapper for `::pdf_annot_has_author()`.
- ll_pdf_annot_has_border(annot)
- Low-level wrapper for `::pdf_annot_has_border()`.
- ll_pdf_annot_has_border_effect(annot)
- Low-level wrapper for `::pdf_annot_has_border_effect()`.
- ll_pdf_annot_has_filespec(annot)
- Low-level wrapper for `::pdf_annot_has_filespec()`.
- ll_pdf_annot_has_icon_name(annot)
- Low-level wrapper for `::pdf_annot_has_icon_name()`.
- ll_pdf_annot_has_ink_list(annot)
- Low-level wrapper for `::pdf_annot_has_ink_list()`.
- ll_pdf_annot_has_interior_color(annot)
- Low-level wrapper for `::pdf_annot_has_interior_color()`.
- ll_pdf_annot_has_line(annot)
- Low-level wrapper for `::pdf_annot_has_line()`.
- ll_pdf_annot_has_line_ending_styles(annot)
- Low-level wrapper for `::pdf_annot_has_line_ending_styles()`.
- ll_pdf_annot_has_open(annot)
- Low-level wrapper for `::pdf_annot_has_open()`.
- ll_pdf_annot_has_quad_points(annot)
- Low-level wrapper for `::pdf_annot_has_quad_points()`.
- ll_pdf_annot_has_rect(annot)
- Low-level wrapper for `::pdf_annot_has_rect()`.
- ll_pdf_annot_has_vertices(annot)
- Low-level wrapper for `::pdf_annot_has_vertices()`.
- ll_pdf_annot_hidden_for_editing(annot)
- Low-level wrapper for `::pdf_annot_hidden_for_editing()`.
- ll_pdf_annot_hot(annot)
- Low-level wrapper for `::pdf_annot_hot()`.
- ll_pdf_annot_icon_name(annot)
- Low-level wrapper for `::pdf_annot_icon_name()`.
- ll_pdf_annot_ink_list_count(annot)
- Low-level wrapper for `::pdf_annot_ink_list_count()`.
- ll_pdf_annot_ink_list_stroke_count(annot, i)
- Low-level wrapper for `::pdf_annot_ink_list_stroke_count()`.
- ll_pdf_annot_ink_list_stroke_vertex(annot, i, k)
- Low-level wrapper for `::pdf_annot_ink_list_stroke_vertex()`.
- ll_pdf_annot_interior_color(annot, color)
- Wrapper for out-params of pdf_annot_interior_color().
Returns: int n
- ll_pdf_annot_interior_color_outparams_fn(annot, color, outparams)
- ll_pdf_annot_is_open(annot)
- Low-level wrapper for `::pdf_annot_is_open()`.
- ll_pdf_annot_is_standard_stamp(annot)
- Low-level wrapper for `::pdf_annot_is_standard_stamp()`.
- ll_pdf_annot_language(annot)
- Low-level wrapper for `::pdf_annot_language()`.
- ll_pdf_annot_line(annot, a, b)
- Low-level wrapper for `::pdf_annot_line()`.
- ll_pdf_annot_line_end_style(annot)
- Low-level wrapper for `::pdf_annot_line_end_style()`.
- ll_pdf_annot_line_ending_styles(annot)
- Wrapper for out-params of pdf_annot_line_ending_styles().
Returns: enum pdf_line_ending start_style, enum pdf_line_ending end_style
- ll_pdf_annot_line_ending_styles_outparams_fn(annot, outparams)
- ll_pdf_annot_line_start_style(annot)
- Low-level wrapper for `::pdf_annot_line_start_style()`.
- ll_pdf_annot_modification_date(annot)
- Low-level wrapper for `::pdf_annot_modification_date()`.
- ll_pdf_annot_needs_resynthesis(annot)
- Low-level wrapper for `::pdf_annot_needs_resynthesis()`.
- ll_pdf_annot_obj(annot)
- Low-level wrapper for `::pdf_annot_obj()`.
- ll_pdf_annot_opacity(annot)
- Low-level wrapper for `::pdf_annot_opacity()`.
- ll_pdf_annot_page(annot)
- Low-level wrapper for `::pdf_annot_page()`.
- ll_pdf_annot_pop_and_discard_local_xref(annot)
- Low-level wrapper for `::pdf_annot_pop_and_discard_local_xref()`.
- ll_pdf_annot_pop_local_xref(annot)
- Low-level wrapper for `::pdf_annot_pop_local_xref()`.
- ll_pdf_annot_popup(annot)
- Low-level wrapper for `::pdf_annot_popup()`.
- ll_pdf_annot_push_local_xref(annot)
- Low-level wrapper for `::pdf_annot_push_local_xref()`.
- ll_pdf_annot_quad_point(annot, i)
- Low-level wrapper for `::pdf_annot_quad_point()`.
- ll_pdf_annot_quad_point_count(annot)
- Low-level wrapper for `::pdf_annot_quad_point_count()`.
- ll_pdf_annot_quadding(annot)
- Low-level wrapper for `::pdf_annot_quadding()`.
- ll_pdf_annot_rect(annot)
- Low-level wrapper for `::pdf_annot_rect()`.
- ll_pdf_annot_request_resynthesis(annot)
- Low-level wrapper for `::pdf_annot_request_resynthesis()`.
- ll_pdf_annot_transform(annot)
- Low-level wrapper for `::pdf_annot_transform()`.
- ll_pdf_annot_type(annot)
- Low-level wrapper for `::pdf_annot_type()`.
- ll_pdf_annot_type_from_string(subtype)
- Low-level wrapper for `::pdf_annot_type_from_string()`.
- ll_pdf_annot_vertex(annot, i)
- Low-level wrapper for `::pdf_annot_vertex()`.
- ll_pdf_annot_vertex_count(annot)
- Low-level wrapper for `::pdf_annot_vertex_count()`.
- ll_pdf_append_explicit_dest_to_uri(url, dest)
- Low-level wrapper for `::pdf_append_explicit_dest_to_uri()`.
- ll_pdf_append_named_dest_to_uri(url, name)
- Low-level wrapper for `::pdf_append_named_dest_to_uri()`.
- ll_pdf_append_token(buf, tok, lex)
- Low-level wrapper for `::pdf_append_token()`.
- ll_pdf_apply_redaction(annot, opts)
- Low-level wrapper for `::pdf_apply_redaction()`.
- ll_pdf_array_contains(array, obj)
- Low-level wrapper for `::pdf_array_contains()`.
- ll_pdf_array_delete(array, index)
- Low-level wrapper for `::pdf_array_delete()`.
- ll_pdf_array_find(array, obj)
- Low-level wrapper for `::pdf_array_find()`.
- ll_pdf_array_get(array, i)
- Low-level wrapper for `::pdf_array_get()`.
- ll_pdf_array_get_bool(array, index)
- Low-level wrapper for `::pdf_array_get_bool()`.
- ll_pdf_array_get_int(array, index)
- Low-level wrapper for `::pdf_array_get_int()`.
- ll_pdf_array_get_matrix(array, index)
- Low-level wrapper for `::pdf_array_get_matrix()`.
- ll_pdf_array_get_name(array, index)
- Low-level wrapper for `::pdf_array_get_name()`.
- ll_pdf_array_get_real(array, index)
- Low-level wrapper for `::pdf_array_get_real()`.
- ll_pdf_array_get_rect(array, index)
- Low-level wrapper for `::pdf_array_get_rect()`.
- ll_pdf_array_get_string(array, index)
- Wrapper for out-params of pdf_array_get_string().
Returns: const char *, size_t sizep
- ll_pdf_array_get_string_outparams_fn(array, index, outparams)
- ll_pdf_array_get_text_string(array, index)
- Low-level wrapper for `::pdf_array_get_text_string()`.
- ll_pdf_array_insert(array, obj, index)
- Low-level wrapper for `::pdf_array_insert()`.
- ll_pdf_array_insert_drop(array, obj, index)
- Low-level wrapper for `::pdf_array_insert_drop()`.
- ll_pdf_array_len(array)
- Low-level wrapper for `::pdf_array_len()`.
- ll_pdf_array_push(array, obj)
- Low-level wrapper for `::pdf_array_push()`.
- ll_pdf_array_push_array(array, initial)
- Low-level wrapper for `::pdf_array_push_array()`.
- ll_pdf_array_push_bool(array, x)
- Low-level wrapper for `::pdf_array_push_bool()`.
- ll_pdf_array_push_dict(array, initial)
- Low-level wrapper for `::pdf_array_push_dict()`.
- ll_pdf_array_push_drop(array, obj)
- Low-level wrapper for `::pdf_array_push_drop()`.
- ll_pdf_array_push_int(array, x)
- Low-level wrapper for `::pdf_array_push_int()`.
- ll_pdf_array_push_name(array, x)
- Low-level wrapper for `::pdf_array_push_name()`.
- ll_pdf_array_push_real(array, x)
- Low-level wrapper for `::pdf_array_push_real()`.
- ll_pdf_array_push_string(array, x, n)
- Low-level wrapper for `::pdf_array_push_string()`.
- ll_pdf_array_push_text_string(array, x)
- Low-level wrapper for `::pdf_array_push_text_string()`.
- ll_pdf_array_put(array, i, obj)
- Low-level wrapper for `::pdf_array_put()`.
- ll_pdf_array_put_drop(array, i, obj)
- Low-level wrapper for `::pdf_array_put_drop()`.
- ll_pdf_authenticate_password(doc, pw)
- Low-level wrapper for `::pdf_authenticate_password()`.
- ll_pdf_begin_implicit_operation(doc)
- Low-level wrapper for `::pdf_begin_implicit_operation()`.
- ll_pdf_begin_operation(doc, operation)
- Low-level wrapper for `::pdf_begin_operation()`.
- ll_pdf_bound_annot(annot)
- Low-level wrapper for `::pdf_bound_annot()`.
- ll_pdf_bound_page(page, box)
- Low-level wrapper for `::pdf_bound_page()`.
- ll_pdf_bound_widget(widget)
- Low-level wrapper for `::pdf_bound_widget()`.
- ll_pdf_button_field_on_state(field)
- Low-level wrapper for `::pdf_button_field_on_state()`.
- ll_pdf_cache_object(doc, num)
- Low-level wrapper for `::pdf_cache_object()`.
Retrieve the pdf_xref_entry for a given object.
This can cause xref reorganisations (solidifications etc) due to
repairs, so all held pdf_xref_entries should be considered
invalid after this call (other than the returned one).
- ll_pdf_calculate_form(doc)
- Low-level wrapper for `::pdf_calculate_form()`.
- ll_pdf_can_be_saved_incrementally(doc)
- Low-level wrapper for `::pdf_can_be_saved_incrementally()`.
- ll_pdf_can_redo(doc)
- Low-level wrapper for `::pdf_can_redo()`.
- ll_pdf_can_undo(doc)
- Low-level wrapper for `::pdf_can_undo()`.
- ll_pdf_check_certificate(verifier, doc, signature)
- Low-level wrapper for `::pdf_check_certificate()`.
- ll_pdf_check_digest(verifier, doc, signature)
- Low-level wrapper for `::pdf_check_digest()`.
- ll_pdf_check_signature(verifier, doc, signature, ebuf, ebufsize)
- Low-level wrapper for `::pdf_check_signature()`.
- ll_pdf_check_widget_certificate(verifier, widget)
- Low-level wrapper for `::pdf_check_widget_certificate()`.
- ll_pdf_check_widget_digest(verifier, widget)
- Low-level wrapper for `::pdf_check_widget_digest()`.
- ll_pdf_choice_field_option(field, exportval, i)
- Low-level wrapper for `::pdf_choice_field_option()`.
- ll_pdf_choice_field_option_count(field)
- Low-level wrapper for `::pdf_choice_field_option_count()`.
- ll_pdf_choice_widget_is_multiselect(tw)
- Low-level wrapper for `::pdf_choice_widget_is_multiselect()`.
- ll_pdf_choice_widget_options(tw, exportval, opts)
- Low-level wrapper for `::pdf_choice_widget_options()`.
- ll_pdf_choice_widget_set_value(tw, n, opts)
- Low-level wrapper for `::pdf_choice_widget_set_value()`.
- ll_pdf_choice_widget_value(tw, opts)
- Low-level wrapper for `::pdf_choice_widget_value()`.
- ll_pdf_clean_file(infile, outfile, password, opts, retainlen)
- Low-level wrapper for `::pdf_clean_file()`.
- ll_pdf_clean_font_name(fontname)
- Low-level wrapper for `::pdf_clean_font_name()`.
- ll_pdf_clean_obj(obj)
- Low-level wrapper for `::pdf_clean_obj()`.
- ll_pdf_clear_annot_border_dash(annot)
- Low-level wrapper for `::pdf_clear_annot_border_dash()`.
- ll_pdf_clear_annot_ink_list(annot)
- Low-level wrapper for `::pdf_clear_annot_ink_list()`.
- ll_pdf_clear_annot_quad_points(annot)
- Low-level wrapper for `::pdf_clear_annot_quad_points()`.
- ll_pdf_clear_annot_vertices(annot)
- Low-level wrapper for `::pdf_clear_annot_vertices()`.
- ll_pdf_clear_signature(widget)
- Low-level wrapper for `::pdf_clear_signature()`.
- ll_pdf_clear_xref(doc)
- Low-level wrapper for `::pdf_clear_xref()`.
- ll_pdf_clear_xref_to_mark(doc)
- Low-level wrapper for `::pdf_clear_xref_to_mark()`.
- ll_pdf_close_processor(proc)
- Low-level wrapper for `::pdf_close_processor()`.
- ll_pdf_cmap_size(cmap)
- Low-level wrapper for `::pdf_cmap_size()`.
- ll_pdf_cmap_wmode(cmap)
- Low-level wrapper for `::pdf_cmap_wmode()`.
- ll_pdf_copy_array(array)
- Low-level wrapper for `::pdf_copy_array()`.
- ll_pdf_copy_dict(dict)
- Low-level wrapper for `::pdf_copy_dict()`.
- ll_pdf_count_layer_config_ui(doc)
- Low-level wrapper for `::pdf_count_layer_config_ui()`.
- ll_pdf_count_layer_configs(doc)
- Low-level wrapper for `::pdf_count_layer_configs()`.
- ll_pdf_count_layers(doc)
- Low-level wrapper for `::pdf_count_layers()`.
- ll_pdf_count_objects(doc)
- Low-level wrapper for `::pdf_count_objects()`.
- ll_pdf_count_pages(doc)
- Low-level wrapper for `::pdf_count_pages()`.
- ll_pdf_count_pages_imp(doc, chapter)
- Low-level wrapper for `::pdf_count_pages_imp()`.
- ll_pdf_count_signatures(doc)
- Low-level wrapper for `::pdf_count_signatures()`.
- ll_pdf_count_unsaved_versions(doc)
- Low-level wrapper for `::pdf_count_unsaved_versions()`.
- ll_pdf_count_versions(doc)
- Low-level wrapper for `::pdf_count_versions()`.
- ll_pdf_create_annot(page, type)
- Low-level wrapper for `::pdf_create_annot()`.
- ll_pdf_create_annot_raw(page, type)
- Low-level wrapper for `::pdf_create_annot_raw()`.
- ll_pdf_create_document()
- Low-level wrapper for `::pdf_create_document()`.
- ll_pdf_create_field_name(doc, prefix, buf, len)
- Low-level wrapper for `::pdf_create_field_name()`.
- ll_pdf_create_link(page, bbox, uri)
- Low-level wrapper for `::pdf_create_link()`.
- ll_pdf_create_object(doc)
- Low-level wrapper for `::pdf_create_object()`.
- ll_pdf_create_signature_widget(page, name)
- Low-level wrapper for `::pdf_create_signature_widget()`.
- ll_pdf_crypt_encrypt_metadata(crypt)
- Low-level wrapper for `::pdf_crypt_encrypt_metadata()`.
- ll_pdf_crypt_key(crypt)
- Low-level wrapper for `::pdf_crypt_key()`.
- ll_pdf_crypt_length(crypt)
- Low-level wrapper for `::pdf_crypt_length()`.
- ll_pdf_crypt_method(crypt)
- Low-level wrapper for `::pdf_crypt_method()`.
- ll_pdf_crypt_obj(crypt, obj, num, gen)
- Low-level wrapper for `::pdf_crypt_obj()`.
- ll_pdf_crypt_owner_encryption(crypt)
- Low-level wrapper for `::pdf_crypt_owner_encryption()`.
- ll_pdf_crypt_owner_password(crypt)
- Low-level wrapper for `::pdf_crypt_owner_password()`.
- ll_pdf_crypt_permissions(crypt)
- Low-level wrapper for `::pdf_crypt_permissions()`.
- ll_pdf_crypt_permissions_encryption(crypt)
- Low-level wrapper for `::pdf_crypt_permissions_encryption()`.
- ll_pdf_crypt_revision(crypt)
- Low-level wrapper for `::pdf_crypt_revision()`.
- ll_pdf_crypt_stream_method(crypt)
- Low-level wrapper for `::pdf_crypt_stream_method()`.
- ll_pdf_crypt_string_method(crypt)
- Low-level wrapper for `::pdf_crypt_string_method()`.
- ll_pdf_crypt_user_encryption(crypt)
- Low-level wrapper for `::pdf_crypt_user_encryption()`.
- ll_pdf_crypt_user_password(crypt)
- Low-level wrapper for `::pdf_crypt_user_password()`.
- ll_pdf_crypt_version(crypt)
- Low-level wrapper for `::pdf_crypt_version()`.
- ll_pdf_cycle(here, prev, obj)
- Low-level wrapper for `::pdf_cycle()`.
- ll_pdf_debug_doc_changes(doc)
- Low-level wrapper for `::pdf_debug_doc_changes()`.
- ll_pdf_debug_obj(obj)
- Low-level wrapper for `::pdf_debug_obj()`.
- ll_pdf_debug_ref(obj)
- Low-level wrapper for `::pdf_debug_ref()`.
- ll_pdf_decode_cmap(cmap, s, e)
- Wrapper for out-params of pdf_decode_cmap().
Returns: int, unsigned int cpt
- ll_pdf_decode_cmap_outparams_fn(cmap, s, e, outparams)
- ll_pdf_deep_copy_obj(obj)
- Low-level wrapper for `::pdf_deep_copy_obj()`.
- ll_pdf_delete_annot(page, annot)
- Low-level wrapper for `::pdf_delete_annot()`.
- ll_pdf_delete_link(page, link)
- Low-level wrapper for `::pdf_delete_link()`.
- ll_pdf_delete_object(doc, num)
- Low-level wrapper for `::pdf_delete_object()`.
- ll_pdf_delete_page(doc, number)
- Low-level wrapper for `::pdf_delete_page()`.
- ll_pdf_delete_page_labels(doc, index)
- Low-level wrapper for `::pdf_delete_page_labels()`.
- ll_pdf_delete_page_range(doc, start, end)
- Low-level wrapper for `::pdf_delete_page_range()`.
- ll_pdf_deselect_layer_config_ui(doc, ui)
- Low-level wrapper for `::pdf_deselect_layer_config_ui()`.
- ll_pdf_deserialise_journal(doc, stm)
- Low-level wrapper for `::pdf_deserialise_journal()`.
- ll_pdf_dict_del(dict, key)
- Low-level wrapper for `::pdf_dict_del()`.
- ll_pdf_dict_dels(dict, key)
- Low-level wrapper for `::pdf_dict_dels()`.
- ll_pdf_dict_get(dict, key)
- Low-level wrapper for `::pdf_dict_get()`.
- ll_pdf_dict_get_bool(dict, key)
- Low-level wrapper for `::pdf_dict_get_bool()`.
- ll_pdf_dict_get_date(dict, key)
- Low-level wrapper for `::pdf_dict_get_date()`.
- ll_pdf_dict_get_inheritable(dict, key)
- Low-level wrapper for `::pdf_dict_get_inheritable()`.
- ll_pdf_dict_get_int(dict, key)
- Low-level wrapper for `::pdf_dict_get_int()`.
- ll_pdf_dict_get_int64(dict, key)
- Low-level wrapper for `::pdf_dict_get_int64()`.
- ll_pdf_dict_get_key(dict, idx)
- Low-level wrapper for `::pdf_dict_get_key()`.
- ll_pdf_dict_get_matrix(dict, key)
- Low-level wrapper for `::pdf_dict_get_matrix()`.
- ll_pdf_dict_get_name(dict, key)
- Low-level wrapper for `::pdf_dict_get_name()`.
- ll_pdf_dict_get_put_drop(dict, key, val)
- Wrapper for out-params of pdf_dict_get_put_drop().
Returns: ::pdf_obj *old_val
- ll_pdf_dict_get_put_drop_outparams_fn(dict, key, val, outparams)
- ll_pdf_dict_get_real(dict, key)
- Low-level wrapper for `::pdf_dict_get_real()`.
- ll_pdf_dict_get_rect(dict, key)
- Low-level wrapper for `::pdf_dict_get_rect()`.
- ll_pdf_dict_get_string(dict, key)
- Wrapper for out-params of pdf_dict_get_string().
Returns: const char *, size_t sizep
- ll_pdf_dict_get_string_outparams_fn(dict, key, outparams)
- ll_pdf_dict_get_text_string(dict, key)
- Low-level wrapper for `::pdf_dict_get_text_string()`.
- ll_pdf_dict_get_val(dict, idx)
- Low-level wrapper for `::pdf_dict_get_val()`.
- ll_pdf_dict_geta(dict, key, abbrev)
- Low-level wrapper for `::pdf_dict_geta()`.
- ll_pdf_dict_getl(obj, *tail)
- Python implementation of ll_pdf_dict_getl(), because SWIG
doesn't handle variadic args. Each item in `tail` should be
`mupdf.pdf_obj`.
- ll_pdf_dict_getp(dict, path)
- Low-level wrapper for `::pdf_dict_getp()`.
- ll_pdf_dict_getp_inheritable(dict, path)
- Low-level wrapper for `::pdf_dict_getp_inheritable()`.
- ll_pdf_dict_gets(dict, key)
- Low-level wrapper for `::pdf_dict_gets()`.
- ll_pdf_dict_gets_inheritable(dict, key)
- Low-level wrapper for `::pdf_dict_gets_inheritable()`.
- ll_pdf_dict_getsa(dict, key, abbrev)
- Low-level wrapper for `::pdf_dict_getsa()`.
- ll_pdf_dict_len(dict)
- Low-level wrapper for `::pdf_dict_len()`.
- ll_pdf_dict_put(dict, key, val)
- Low-level wrapper for `::pdf_dict_put()`.
- ll_pdf_dict_put_array(dict, key, initial)
- Low-level wrapper for `::pdf_dict_put_array()`.
- ll_pdf_dict_put_bool(dict, key, x)
- Low-level wrapper for `::pdf_dict_put_bool()`.
- ll_pdf_dict_put_date(dict, key, time)
- Low-level wrapper for `::pdf_dict_put_date()`.
- ll_pdf_dict_put_dict(dict, key, initial)
- Low-level wrapper for `::pdf_dict_put_dict()`.
- ll_pdf_dict_put_drop(dict, key, val)
- Low-level wrapper for `::pdf_dict_put_drop()`.
- ll_pdf_dict_put_int(dict, key, x)
- Low-level wrapper for `::pdf_dict_put_int()`.
- ll_pdf_dict_put_matrix(dict, key, x)
- Low-level wrapper for `::pdf_dict_put_matrix()`.
- ll_pdf_dict_put_name(dict, key, x)
- Low-level wrapper for `::pdf_dict_put_name()`.
- ll_pdf_dict_put_real(dict, key, x)
- Low-level wrapper for `::pdf_dict_put_real()`.
- ll_pdf_dict_put_rect(dict, key, x)
- Low-level wrapper for `::pdf_dict_put_rect()`.
- ll_pdf_dict_put_string(dict, key, x, n)
- Low-level wrapper for `::pdf_dict_put_string()`.
- ll_pdf_dict_put_text_string(dict, key, x)
- Low-level wrapper for `::pdf_dict_put_text_string()`.
- ll_pdf_dict_put_val_null(obj, idx)
- Low-level wrapper for `::pdf_dict_put_val_null()`.
- ll_pdf_dict_putl(obj, val, *tail)
- Python implementation of ll_pdf_dict_putl() because SWIG
doesn't handle variadic args. Each item in `tail` should
be a SWIG wrapper for a `pdf_obj`.
- ll_pdf_dict_putp(dict, path, val)
- Low-level wrapper for `::pdf_dict_putp()`.
- ll_pdf_dict_putp_drop(dict, path, val)
- Low-level wrapper for `::pdf_dict_putp_drop()`.
- ll_pdf_dict_puts(dict, key, val)
- Low-level wrapper for `::pdf_dict_puts()`.
- ll_pdf_dict_puts_dict(dict, key, initial)
- Low-level wrapper for `::pdf_dict_puts_dict()`.
- ll_pdf_dict_puts_drop(dict, key, val)
- Low-level wrapper for `::pdf_dict_puts_drop()`.
- ll_pdf_dirty_annot(annot)
- Low-level wrapper for `::pdf_dirty_annot()`.
- ll_pdf_dirty_obj(obj)
- Low-level wrapper for `::pdf_dirty_obj()`.
- ll_pdf_disable_js(doc)
- Low-level wrapper for `::pdf_disable_js()`.
- ll_pdf_discard_journal(journal)
- Low-level wrapper for `::pdf_discard_journal()`.
- ll_pdf_doc_was_linearized(doc)
- Low-level wrapper for `::pdf_doc_was_linearized()`.
- ll_pdf_document_event_did_print(doc)
- Low-level wrapper for `::pdf_document_event_did_print()`.
- ll_pdf_document_event_did_save(doc)
- Low-level wrapper for `::pdf_document_event_did_save()`.
- ll_pdf_document_event_will_close(doc)
- Low-level wrapper for `::pdf_document_event_will_close()`.
- ll_pdf_document_event_will_print(doc)
- Low-level wrapper for `::pdf_document_event_will_print()`.
- ll_pdf_document_event_will_save(doc)
- Low-level wrapper for `::pdf_document_event_will_save()`.
- ll_pdf_document_from_fz_document(ptr)
- Low-level wrapper for `::pdf_document_from_fz_document()`.
- ll_pdf_document_language(doc)
- Low-level wrapper for `::pdf_document_language()`.
- ll_pdf_document_output_intent(doc)
- Low-level wrapper for `::pdf_document_output_intent()`.
- ll_pdf_document_permissions(doc)
- Low-level wrapper for `::pdf_document_permissions()`.
- ll_pdf_drop_annot(annot)
- Low-level wrapper for `::pdf_drop_annot()`.
- ll_pdf_drop_cmap(cmap)
- Low-level wrapper for `::pdf_drop_cmap()`.
- ll_pdf_drop_cmap_imp(cmap)
- Low-level wrapper for `::pdf_drop_cmap_imp()`.
- ll_pdf_drop_crypt(crypt)
- Low-level wrapper for `::pdf_drop_crypt()`.
- ll_pdf_drop_document(doc)
- Low-level wrapper for `::pdf_drop_document()`.
- ll_pdf_drop_font(font)
- Low-level wrapper for `::pdf_drop_font()`.
- ll_pdf_drop_function(func)
- Low-level wrapper for `::pdf_drop_function()`.
- ll_pdf_drop_graft_map(map)
- Low-level wrapper for `::pdf_drop_graft_map()`.
- ll_pdf_drop_journal(journal)
- Low-level wrapper for `::pdf_drop_journal()`.
- ll_pdf_drop_js(js)
- Low-level wrapper for `::pdf_drop_js()`.
- ll_pdf_drop_local_xref(xref)
- Low-level wrapper for `::pdf_drop_local_xref()`.
- ll_pdf_drop_local_xref_and_resources(doc)
- Low-level wrapper for `::pdf_drop_local_xref_and_resources()`.
- ll_pdf_drop_locked_fields(locked)
- Low-level wrapper for `::pdf_drop_locked_fields()`.
- ll_pdf_drop_mark_bits(marks)
- Low-level wrapper for `::pdf_drop_mark_bits()`.
- ll_pdf_drop_obj(obj)
- Low-level wrapper for `::pdf_drop_obj()`.
- ll_pdf_drop_ocg(doc)
- Low-level wrapper for `::pdf_drop_ocg()`.
- ll_pdf_drop_page_tree(doc)
- Low-level wrapper for `::pdf_drop_page_tree()`.
- ll_pdf_drop_page_tree_internal(doc)
- Low-level wrapper for `::pdf_drop_page_tree_internal()`.
- ll_pdf_drop_pattern(pat)
- Low-level wrapper for `::pdf_drop_pattern()`.
- ll_pdf_drop_processor(proc)
- Low-level wrapper for `::pdf_drop_processor()`.
- ll_pdf_drop_resource_tables(doc)
- Low-level wrapper for `::pdf_drop_resource_tables()`.
- ll_pdf_drop_signer(signer)
- Low-level wrapper for `::pdf_drop_signer()`.
- ll_pdf_drop_singleton_obj(obj)
- Low-level wrapper for `::pdf_drop_singleton_obj()`.
- ll_pdf_drop_verifier(verifier)
- Low-level wrapper for `::pdf_drop_verifier()`.
- ll_pdf_drop_widget(widget)
- Low-level wrapper for `::pdf_drop_widget()`.
- ll_pdf_edit_text_field_value(widget, value, change)
- Wrapper for out-params of pdf_edit_text_field_value().
Returns: int, int selStart, int selEnd, char *newvalue
- ll_pdf_edit_text_field_value_outparams_fn(widget, value, change, outparams)
- ll_pdf_empty_store(doc)
- Low-level wrapper for `::pdf_empty_store()`.
- ll_pdf_enable_journal(doc)
- Low-level wrapper for `::pdf_enable_journal()`.
- ll_pdf_enable_js(doc)
- Low-level wrapper for `::pdf_enable_js()`.
- ll_pdf_enable_layer(doc, layer, enabled)
- Low-level wrapper for `::pdf_enable_layer()`.
- ll_pdf_encrypt_data(crypt, num, gen, fmt_str_out, arg, s, n)
- Low-level wrapper for `::pdf_encrypt_data()`.
- ll_pdf_encrypted_len(crypt, num, gen, len)
- Low-level wrapper for `::pdf_encrypted_len()`.
- ll_pdf_end_hmtx(font)
- Low-level wrapper for `::pdf_end_hmtx()`.
- ll_pdf_end_operation(doc)
- Low-level wrapper for `::pdf_end_operation()`.
- ll_pdf_end_vmtx(font)
- Low-level wrapper for `::pdf_end_vmtx()`.
- ll_pdf_ensure_solid_xref(doc, num)
- Low-level wrapper for `::pdf_ensure_solid_xref()`.
- ll_pdf_eval_function(func, in_, inlen, outlen)
- Wrapper for out-params of pdf_eval_function().
Returns: float out
- ll_pdf_eval_function_outparams_fn(func, _in, inlen, outlen, outparams)
- ll_pdf_event_issue_alert(doc, evt)
- Low-level wrapper for `::pdf_event_issue_alert()`.
- ll_pdf_event_issue_exec_menu_item(doc, item)
- Low-level wrapper for `::pdf_event_issue_exec_menu_item()`.
- ll_pdf_event_issue_launch_url(doc, url, new_frame)
- Low-level wrapper for `::pdf_event_issue_launch_url()`.
- ll_pdf_event_issue_mail_doc(doc, evt)
- Low-level wrapper for `::pdf_event_issue_mail_doc()`.
- ll_pdf_event_issue_print(doc)
- Low-level wrapper for `::pdf_event_issue_print()`.
- ll_pdf_field_border_style(field)
- Low-level wrapper for `::pdf_field_border_style()`.
- ll_pdf_field_display(field)
- Low-level wrapper for `::pdf_field_display()`.
- ll_pdf_field_event_calculate(doc, field)
- Low-level wrapper for `::pdf_field_event_calculate()`.
- ll_pdf_field_event_format(doc, field)
- Low-level wrapper for `::pdf_field_event_format()`.
- ll_pdf_field_event_keystroke(doc, field, evt)
- Low-level wrapper for `::pdf_field_event_keystroke()`.
- ll_pdf_field_event_validate(doc, field, value)
- Wrapper for out-params of pdf_field_event_validate().
Returns: int, char *newvalue
- ll_pdf_field_event_validate_outparams_fn(doc, field, value, outparams)
- ll_pdf_field_flags(field)
- Low-level wrapper for `::pdf_field_flags()`.
- ll_pdf_field_label(field)
- Low-level wrapper for `::pdf_field_label()`.
- ll_pdf_field_reset(doc, field)
- Low-level wrapper for `::pdf_field_reset()`.
- ll_pdf_field_set_border_style(field, text)
- Low-level wrapper for `::pdf_field_set_border_style()`.
- ll_pdf_field_set_button_caption(field, text)
- Low-level wrapper for `::pdf_field_set_button_caption()`.
- ll_pdf_field_set_display(field, d)
- Low-level wrapper for `::pdf_field_set_display()`.
- ll_pdf_field_set_fill_color(field, col)
- Low-level wrapper for `::pdf_field_set_fill_color()`.
- ll_pdf_field_set_text_color(field, col)
- Low-level wrapper for `::pdf_field_set_text_color()`.
- ll_pdf_field_type(field)
- Low-level wrapper for `::pdf_field_type()`.
- ll_pdf_field_type_string(field)
- Low-level wrapper for `::pdf_field_type_string()`.
- ll_pdf_field_value(field)
- Low-level wrapper for `::pdf_field_value()`.
- ll_pdf_filter_annot_contents(doc, annot, options)
- Low-level wrapper for `::pdf_filter_annot_contents()`.
- ll_pdf_filter_page_contents(doc, page, options)
- Low-level wrapper for `::pdf_filter_page_contents()`.
- ll_pdf_filter_xobject_instance(old_xobj, page_res, ctm, options, cycle_up)
- Low-level wrapper for `::pdf_filter_xobject_instance()`.
- ll_pdf_find_font_resource(doc, type, encoding, item, key)
- Low-level wrapper for `::pdf_find_font_resource()`.
- ll_pdf_find_item(drop, key)
- Low-level wrapper for `::pdf_find_item()`.
- ll_pdf_find_locked_fields(doc, version)
- Low-level wrapper for `::pdf_find_locked_fields()`.
- ll_pdf_find_locked_fields_for_sig(doc, sig)
- Low-level wrapper for `::pdf_find_locked_fields_for_sig()`.
- ll_pdf_find_version_for_obj(doc, obj)
- Low-level wrapper for `::pdf_find_version_for_obj()`.
- ll_pdf_first_annot(page)
- Low-level wrapper for `::pdf_first_annot()`.
- ll_pdf_first_widget(page)
- Low-level wrapper for `::pdf_first_widget()`.
- ll_pdf_flatten_inheritable_page_items(page)
- Low-level wrapper for `::pdf_flatten_inheritable_page_items()`.
- ll_pdf_font_cid_to_gid(fontdesc, cid)
- Low-level wrapper for `::pdf_font_cid_to_gid()`.
- ll_pdf_font_writing_supported(font)
- Low-level wrapper for `::pdf_font_writing_supported()`.
- ll_pdf_forget_xref(doc)
- Low-level wrapper for `::pdf_forget_xref()`.
- ll_pdf_format_date(time, s, n)
- Low-level wrapper for `::pdf_format_date()`.
- ll_pdf_format_write_options(buffer, buffer_len, opts)
- Low-level wrapper for `::pdf_format_write_options()`.
- ll_pdf_function_size(func)
- Low-level wrapper for `::pdf_function_size()`.
- ll_pdf_get_bound_document(obj)
- Low-level wrapper for `::pdf_get_bound_document()`.
- ll_pdf_get_doc_event_callback_data(doc)
- Low-level wrapper for `::pdf_get_doc_event_callback_data()`.
- ll_pdf_get_embedded_file_params(fs, out)
- Low-level wrapper for `::pdf_get_embedded_file_params()`.
- ll_pdf_get_incremental_xref_entry(doc, i)
- Low-level wrapper for `::pdf_get_incremental_xref_entry()`.
- ll_pdf_get_indirect_document(obj)
- Low-level wrapper for `::pdf_get_indirect_document()`.
- ll_pdf_get_populating_xref_entry(doc, i)
- Low-level wrapper for `::pdf_get_populating_xref_entry()`.
- ll_pdf_get_widget_editing_state(widget)
- Low-level wrapper for `::pdf_get_widget_editing_state()`.
- ll_pdf_get_xref_entry(doc, i)
- Low-level wrapper for `::pdf_get_xref_entry()`.
- ll_pdf_get_xref_entry_no_change(doc, i)
- Low-level wrapper for `::pdf_get_xref_entry_no_change()`.
- ll_pdf_get_xref_entry_no_null(doc, i)
- Low-level wrapper for `::pdf_get_xref_entry_no_null()`.
- ll_pdf_graft_mapped_object(map, obj)
- Low-level wrapper for `::pdf_graft_mapped_object()`.
- ll_pdf_graft_mapped_page(map, page_to, src, page_from)
- Low-level wrapper for `::pdf_graft_mapped_page()`.
- ll_pdf_graft_object(dst, obj)
- Low-level wrapper for `::pdf_graft_object()`.
- ll_pdf_graft_page(dst, page_to, src, page_from)
- Low-level wrapper for `::pdf_graft_page()`.
- ll_pdf_has_permission(doc, p)
- Low-level wrapper for `::pdf_has_permission()`.
- ll_pdf_has_unsaved_changes(doc)
- Low-level wrapper for `::pdf_has_unsaved_changes()`.
- ll_pdf_has_unsaved_sigs(doc)
- Low-level wrapper for `::pdf_has_unsaved_sigs()`.
- ll_pdf_insert_font_resource(doc, key, obj)
- Low-level wrapper for `::pdf_insert_font_resource()`.
- ll_pdf_insert_page(doc, at, page)
- Low-level wrapper for `::pdf_insert_page()`.
- ll_pdf_invalidate_xfa(doc)
- Low-level wrapper for `::pdf_invalidate_xfa()`.
- ll_pdf_is_array(obj)
- Low-level wrapper for `::pdf_is_array()`.
- ll_pdf_is_bool(obj)
- Low-level wrapper for `::pdf_is_bool()`.
- ll_pdf_is_dict(obj)
- Low-level wrapper for `::pdf_is_dict()`.
- ll_pdf_is_embedded_file(fs)
- Low-level wrapper for `::pdf_is_embedded_file()`.
- ll_pdf_is_field_locked(locked, name)
- Low-level wrapper for `::pdf_is_field_locked()`.
- ll_pdf_is_indirect(obj)
- Low-level wrapper for `::pdf_is_indirect()`.
- ll_pdf_is_int(obj)
- Low-level wrapper for `::pdf_is_int()`.
- ll_pdf_is_jpx_image(dict)
- Low-level wrapper for `::pdf_is_jpx_image()`.
- ll_pdf_is_local_object(doc, obj)
- Low-level wrapper for `::pdf_is_local_object()`.
- ll_pdf_is_name(obj)
- Low-level wrapper for `::pdf_is_name()`.
- ll_pdf_is_null(obj)
- Low-level wrapper for `::pdf_is_null()`.
- ll_pdf_is_number(obj)
- Low-level wrapper for `::pdf_is_number()`.
- ll_pdf_is_ocg_hidden(doc, rdb, usage, ocg)
- Low-level wrapper for `::pdf_is_ocg_hidden()`.
- ll_pdf_is_real(obj)
- Low-level wrapper for `::pdf_is_real()`.
- ll_pdf_is_stream(obj)
- Low-level wrapper for `::pdf_is_stream()`.
- ll_pdf_is_string(obj)
- Low-level wrapper for `::pdf_is_string()`.
- ll_pdf_is_tint_colorspace(cs)
- Low-level wrapper for `::pdf_is_tint_colorspace()`.
- ll_pdf_js_event_init(js, target, value, willCommit)
- Low-level wrapper for `::pdf_js_event_init()`.
- ll_pdf_js_event_init_keystroke(js, target, evt)
- Low-level wrapper for `::pdf_js_event_init_keystroke()`.
- ll_pdf_js_event_result(js)
- Low-level wrapper for `::pdf_js_event_result()`.
- ll_pdf_js_event_result_keystroke(js, evt)
- Low-level wrapper for `::pdf_js_event_result_keystroke()`.
- ll_pdf_js_event_result_validate(js)
- Wrapper for out-params of pdf_js_event_result_validate().
Returns: int, char *newvalue
- ll_pdf_js_event_result_validate_outparams_fn(js, outparams)
- ll_pdf_js_event_value(js)
- Low-level wrapper for `::pdf_js_event_value()`.
- ll_pdf_js_execute(js, name, code)
- Wrapper for out-params of pdf_js_execute().
Returns: char *result
- ll_pdf_js_execute_outparams_fn(js, name, code, outparams)
- ll_pdf_js_get_console(doc)
- Low-level wrapper for `::pdf_js_get_console()`.
- ll_pdf_js_set_console(doc, console, user)
- Low-level wrapper for `::pdf_js_set_console()`.
- ll_pdf_js_supported(doc)
- Low-level wrapper for `::pdf_js_supported()`.
- ll_pdf_keep_annot(annot)
- Low-level wrapper for `::pdf_keep_annot()`.
- ll_pdf_keep_cmap(cmap)
- Low-level wrapper for `::pdf_keep_cmap()`.
- ll_pdf_keep_document(doc)
- Low-level wrapper for `::pdf_keep_document()`.
- ll_pdf_keep_font(fontdesc)
- Low-level wrapper for `::pdf_keep_font()`.
- ll_pdf_keep_function(func)
- Low-level wrapper for `::pdf_keep_function()`.
- ll_pdf_keep_graft_map(map)
- Low-level wrapper for `::pdf_keep_graft_map()`.
- ll_pdf_keep_obj(obj)
- Low-level wrapper for `::pdf_keep_obj()`.
- ll_pdf_keep_pattern(pat)
- Low-level wrapper for `::pdf_keep_pattern()`.
- ll_pdf_keep_processor(proc)
- Low-level wrapper for `::pdf_keep_processor()`.
- ll_pdf_keep_widget(widget)
- Low-level wrapper for `::pdf_keep_widget()`.
- ll_pdf_layer_config_info(doc, config_num, info)
- Low-level wrapper for `::pdf_layer_config_info()`.
- ll_pdf_layer_config_ui_info(doc, ui, info)
- Low-level wrapper for `::pdf_layer_config_ui_info()`.
- ll_pdf_layer_is_enabled(doc, layer)
- Low-level wrapper for `::pdf_layer_is_enabled()`.
- ll_pdf_layer_name(doc, layer)
- Low-level wrapper for `::pdf_layer_name()`.
- ll_pdf_layout_fit_text(font, lang, str, bounds)
- Low-level wrapper for `::pdf_layout_fit_text()`.
- ll_pdf_layout_text_widget(annot)
- Low-level wrapper for `::pdf_layout_text_widget()`.
- ll_pdf_lex(f, lexbuf)
- Low-level wrapper for `::pdf_lex()`.
- ll_pdf_lex_no_string(f, lexbuf)
- Low-level wrapper for `::pdf_lex_no_string()`.
- ll_pdf_lexbuf_fin(lexbuf)
- Low-level wrapper for `::pdf_lexbuf_fin()`.
- ll_pdf_lexbuf_grow(lexbuf)
- Low-level wrapper for `::pdf_lexbuf_grow()`.
- ll_pdf_lexbuf_init(lexbuf, size)
- Low-level wrapper for `::pdf_lexbuf_init()`.
- ll_pdf_line_ending_from_name(end)
- Low-level wrapper for `::pdf_line_ending_from_name()`.
- ll_pdf_line_ending_from_string(end)
- Low-level wrapper for `::pdf_line_ending_from_string()`.
- ll_pdf_load_builtin_cmap(name)
- Low-level wrapper for `::pdf_load_builtin_cmap()`.
- ll_pdf_load_cmap(file)
- Low-level wrapper for `::pdf_load_cmap()`.
- ll_pdf_load_colorspace(obj)
- Low-level wrapper for `::pdf_load_colorspace()`.
- ll_pdf_load_compressed_inline_image(doc, dict, length, cstm, indexed, image)
- Low-level wrapper for `::pdf_load_compressed_inline_image()`.
- ll_pdf_load_compressed_stream(doc, num, worst_case)
- Low-level wrapper for `::pdf_load_compressed_stream()`.
- ll_pdf_load_default_colorspaces(doc, page)
- Low-level wrapper for `::pdf_load_default_colorspaces()`.
- ll_pdf_load_embedded_cmap(doc, ref)
- Low-level wrapper for `::pdf_load_embedded_cmap()`.
- ll_pdf_load_embedded_file_contents(fs)
- Low-level wrapper for `::pdf_load_embedded_file_contents()`.
- ll_pdf_load_encoding(encoding)
- Wrapper for out-params of pdf_load_encoding().
Returns: const char *estrings
- ll_pdf_load_encoding_outparams_fn(encoding, outparams)
- ll_pdf_load_field_name = ll_pdf_load_field_name2(field)
- Alternative to `ll_pdf_load_field_name()` that returns a std::string.
- ll_pdf_load_field_name2(field)
- Alternative to `ll_pdf_load_field_name()` that returns a std::string.
- ll_pdf_load_font(doc, rdb, obj)
- Low-level wrapper for `::pdf_load_font()`.
- ll_pdf_load_function(ref, _in, out)
- Low-level wrapper for `::pdf_load_function()`.
- ll_pdf_load_hail_mary_font(doc)
- Low-level wrapper for `::pdf_load_hail_mary_font()`.
- ll_pdf_load_image(doc, obj)
- Low-level wrapper for `::pdf_load_image()`.
- ll_pdf_load_inline_image(doc, rdb, dict, file)
- Low-level wrapper for `::pdf_load_inline_image()`.
- ll_pdf_load_journal(doc, filename)
- Low-level wrapper for `::pdf_load_journal()`.
- ll_pdf_load_link_annots(arg_1, arg_2, annots, pagenum, page_ctm)
- Low-level wrapper for `::pdf_load_link_annots()`.
- ll_pdf_load_links(page)
- Low-level wrapper for `::pdf_load_links()`.
- ll_pdf_load_name_tree(doc, which)
- Low-level wrapper for `::pdf_load_name_tree()`.
- ll_pdf_load_object(doc, num)
- Low-level wrapper for `::pdf_load_object()`.
Load a given object.
This can cause xref reorganisations (solidifications etc) due to
repairs, so all held pdf_xref_entries should be considered
invalid after this call (other than the returned one).
- ll_pdf_load_outline(doc)
- Low-level wrapper for `::pdf_load_outline()`.
- ll_pdf_load_page(doc, number)
- Low-level wrapper for `::pdf_load_page()`.
- ll_pdf_load_page_imp(doc, chapter, number)
- Low-level wrapper for `::pdf_load_page_imp()`.
- ll_pdf_load_page_tree(doc)
- Low-level wrapper for `::pdf_load_page_tree()`.
- ll_pdf_load_pattern(doc, obj)
- Low-level wrapper for `::pdf_load_pattern()`.
- ll_pdf_load_raw_stream(ref)
- Low-level wrapper for `::pdf_load_raw_stream()`.
- ll_pdf_load_raw_stream_number(doc, num)
- Low-level wrapper for `::pdf_load_raw_stream_number()`.
- ll_pdf_load_shading(doc, obj)
- Low-level wrapper for `::pdf_load_shading()`.
- ll_pdf_load_stream(ref)
- Low-level wrapper for `::pdf_load_stream()`.
- ll_pdf_load_stream_number(doc, num)
- Low-level wrapper for `::pdf_load_stream_number()`.
- ll_pdf_load_stream_or_string_as_utf8(src)
- Low-level wrapper for `::pdf_load_stream_or_string_as_utf8()`.
- ll_pdf_load_system_cmap(name)
- Low-level wrapper for `::pdf_load_system_cmap()`.
- ll_pdf_load_to_unicode(doc, font, collection, cmapstm)
- Wrapper for out-params of pdf_load_to_unicode().
Returns: const char *strings
- ll_pdf_load_to_unicode_outparams_fn(doc, font, collection, cmapstm, outparams)
- ll_pdf_load_type3_font(doc, rdb, obj)
- Low-level wrapper for `::pdf_load_type3_font()`.
- ll_pdf_load_type3_glyphs(doc, fontdesc)
- Low-level wrapper for `::pdf_load_type3_glyphs()`.
- ll_pdf_load_unencrypted_object(doc, num)
- Low-level wrapper for `::pdf_load_unencrypted_object()`.
- ll_pdf_lookup_cmap(cmap, cpt)
- Low-level wrapper for `::pdf_lookup_cmap()`.
- ll_pdf_lookup_cmap_full(cmap, cpt)
- Wrapper for out-params of pdf_lookup_cmap_full().
Returns: int, int out
- ll_pdf_lookup_cmap_full_outparams_fn(cmap, cpt, outparams)
- ll_pdf_lookup_dest(doc, needle)
- Low-level wrapper for `::pdf_lookup_dest()`.
- ll_pdf_lookup_field(form, name)
- Low-level wrapper for `::pdf_lookup_field()`.
- ll_pdf_lookup_hmtx(font, cid)
- Low-level wrapper for `::pdf_lookup_hmtx()`.
- ll_pdf_lookup_metadata(doc, key, ptr, size)
- Low-level wrapper for `::pdf_lookup_metadata()`.
- ll_pdf_lookup_metadata2(doc, key)
- Low-level wrapper for `::pdf_lookup_metadata2()`.
C++ alternative to `pdf_lookup_metadata()` that returns a `std::string`
or calls `fz_throw()` if not found.
- ll_pdf_lookup_name(doc, which, needle)
- Low-level wrapper for `::pdf_lookup_name()`.
- ll_pdf_lookup_number(root, needle)
- Low-level wrapper for `::pdf_lookup_number()`.
- ll_pdf_lookup_page_number(doc, pageobj)
- Low-level wrapper for `::pdf_lookup_page_number()`.
- ll_pdf_lookup_page_obj(doc, needle)
- Low-level wrapper for `::pdf_lookup_page_obj()`.
- ll_pdf_lookup_substitute_font(mono, serif, bold, italic)
- Wrapper for out-params of pdf_lookup_substitute_font().
Returns: const unsigned char *, int len
- ll_pdf_lookup_substitute_font_outparams_fn(mono, serif, bold, italic, outparams)
- ll_pdf_lookup_vmtx(font, cid)
- Low-level wrapper for `::pdf_lookup_vmtx()`.
- ll_pdf_map_one_to_many(cmap, one, len)
- Wrapper for out-params of pdf_map_one_to_many().
Returns: int many
- ll_pdf_map_one_to_many_outparams_fn(cmap, one, len, outparams)
- ll_pdf_map_range_to_range(cmap, srclo, srchi, dstlo)
- Low-level wrapper for `::pdf_map_range_to_range()`.
- ll_pdf_mark_bits_reset(marks)
- Low-level wrapper for `::pdf_mark_bits_reset()`.
- ll_pdf_mark_bits_set(marks, obj)
- Low-level wrapper for `::pdf_mark_bits_set()`.
- ll_pdf_mark_list_free(list)
- Low-level wrapper for `::pdf_mark_list_free()`.
- ll_pdf_mark_list_init(list)
- Low-level wrapper for `::pdf_mark_list_init()`.
- ll_pdf_mark_list_pop(list)
- Low-level wrapper for `::pdf_mark_list_pop()`.
- ll_pdf_mark_list_push(list, obj)
- Low-level wrapper for `::pdf_mark_list_push()`.
- ll_pdf_mark_obj(obj)
- Low-level wrapper for `::pdf_mark_obj()`.
- ll_pdf_mark_xref(doc)
- Low-level wrapper for `::pdf_mark_xref()`.
- ll_pdf_metadata(doc)
- Low-level wrapper for `::pdf_metadata()`.
- ll_pdf_minimize_document(doc)
- Low-level wrapper for `::pdf_minimize_document()`.
- ll_pdf_name_eq(a, b)
- Low-level wrapper for `::pdf_name_eq()`.
- ll_pdf_name_from_line_ending(end)
- Low-level wrapper for `::pdf_name_from_line_ending()`.
- ll_pdf_needs_password(doc)
- Low-level wrapper for `::pdf_needs_password()`.
- ll_pdf_new_action_from_link(doc, uri)
- Low-level wrapper for `::pdf_new_action_from_link()`.
- ll_pdf_new_array(doc, initialcap)
- Low-level wrapper for `::pdf_new_array()`.
- ll_pdf_new_buffer_processor(buffer, ahxencode)
- Low-level wrapper for `::pdf_new_buffer_processor()`.
- ll_pdf_new_cmap()
- Low-level wrapper for `::pdf_new_cmap()`.
- ll_pdf_new_color_filter(doc, chain, struct_parents, transform, options, copts)
- Low-level wrapper for `::pdf_new_color_filter()`.
- ll_pdf_new_crypt(enc, id)
- Low-level wrapper for `::pdf_new_crypt()`.
- ll_pdf_new_date(doc, time)
- Low-level wrapper for `::pdf_new_date()`.
- ll_pdf_new_dest_from_link(doc, uri, is_remote)
- Low-level wrapper for `::pdf_new_dest_from_link()`.
- ll_pdf_new_dict(doc, initialcap)
- Low-level wrapper for `::pdf_new_dict()`.
- ll_pdf_new_display_list_from_annot(annot)
- Low-level wrapper for `::pdf_new_display_list_from_annot()`.
- ll_pdf_new_encrypt(opwd_utf8, upwd_utf8, id, permissions, algorithm)
- Low-level wrapper for `::pdf_new_encrypt()`.
- ll_pdf_new_font_desc()
- Low-level wrapper for `::pdf_new_font_desc()`.
- ll_pdf_new_graft_map(dst)
- Low-level wrapper for `::pdf_new_graft_map()`.
- ll_pdf_new_identity_cmap(wmode, bytes)
- Low-level wrapper for `::pdf_new_identity_cmap()`.
- ll_pdf_new_indirect(doc, num, gen)
- Low-level wrapper for `::pdf_new_indirect()`.
- ll_pdf_new_int(i)
- Low-level wrapper for `::pdf_new_int()`.
- ll_pdf_new_link(page, rect, uri, obj)
- Low-level wrapper for `::pdf_new_link()`.
- ll_pdf_new_local_xref(doc)
- Low-level wrapper for `::pdf_new_local_xref()`.
- ll_pdf_new_mark_bits(doc)
- Low-level wrapper for `::pdf_new_mark_bits()`.
- ll_pdf_new_matrix(doc, mtx)
- Low-level wrapper for `::pdf_new_matrix()`.
- ll_pdf_new_name(str)
- Low-level wrapper for `::pdf_new_name()`.
- ll_pdf_new_outline_iterator(doc)
- Low-level wrapper for `::pdf_new_outline_iterator()`.
- ll_pdf_new_output_processor(out, ahxencode)
- Low-level wrapper for `::pdf_new_output_processor()`.
- ll_pdf_new_pdf_device(doc, topctm, resources, contents)
- Low-level wrapper for `::pdf_new_pdf_device()`.
- ll_pdf_new_pixmap_from_annot(annot, ctm, cs, seps, alpha)
- Low-level wrapper for `::pdf_new_pixmap_from_annot()`.
- ll_pdf_new_pixmap_from_page_contents_with_separations_and_usage(page, ctm, cs, seps, alpha, usage, box)
- Low-level wrapper for `::pdf_new_pixmap_from_page_contents_with_separations_and_usage()`.
- ll_pdf_new_pixmap_from_page_contents_with_usage(page, ctm, cs, alpha, usage, box)
- Low-level wrapper for `::pdf_new_pixmap_from_page_contents_with_usage()`.
- ll_pdf_new_pixmap_from_page_with_separations_and_usage(page, ctm, cs, seps, alpha, usage, box)
- Low-level wrapper for `::pdf_new_pixmap_from_page_with_separations_and_usage()`.
- ll_pdf_new_pixmap_from_page_with_usage(page, ctm, cs, alpha, usage, box)
- Low-level wrapper for `::pdf_new_pixmap_from_page_with_usage()`.
- ll_pdf_new_processor(size)
- Low-level wrapper for `::pdf_new_processor()`.
- ll_pdf_new_real(f)
- Low-level wrapper for `::pdf_new_real()`.
- ll_pdf_new_rect(doc, rect)
- Low-level wrapper for `::pdf_new_rect()`.
- ll_pdf_new_run_processor(doc, dev, ctm, struct_parent, usage, gstate, default_cs, cookie)
- Low-level wrapper for `::pdf_new_run_processor()`.
- ll_pdf_new_sanitize_filter(doc, chain, struct_parents, transform, options, sopts)
- Low-level wrapper for `::pdf_new_sanitize_filter()`.
- ll_pdf_new_stext_page_from_annot(annot, options)
- Low-level wrapper for `::pdf_new_stext_page_from_annot()`.
- ll_pdf_new_string(str, len)
- Low-level wrapper for `::pdf_new_string()`.
- ll_pdf_new_text_string(s)
- Low-level wrapper for `::pdf_new_text_string()`.
- ll_pdf_new_uri_from_explicit_dest(dest)
- Low-level wrapper for `::pdf_new_uri_from_explicit_dest()`.
- ll_pdf_new_uri_from_path_and_explicit_dest(path, dest)
- Low-level wrapper for `::pdf_new_uri_from_path_and_explicit_dest()`.
- ll_pdf_new_uri_from_path_and_named_dest(path, name)
- Low-level wrapper for `::pdf_new_uri_from_path_and_named_dest()`.
- ll_pdf_new_utf8_from_pdf_stream_obj(src)
- Low-level wrapper for `::pdf_new_utf8_from_pdf_stream_obj()`.
- ll_pdf_new_utf8_from_pdf_string(srcptr, srclen)
- Low-level wrapper for `::pdf_new_utf8_from_pdf_string()`.
- ll_pdf_new_utf8_from_pdf_string_obj(src)
- Low-level wrapper for `::pdf_new_utf8_from_pdf_string_obj()`.
- ll_pdf_new_xobject(doc, bbox, matrix, res, buffer)
- Low-level wrapper for `::pdf_new_xobject()`.
- ll_pdf_next_annot(annot)
- Low-level wrapper for `::pdf_next_annot()`.
- ll_pdf_next_widget(previous)
- Low-level wrapper for `::pdf_next_widget()`.
- ll_pdf_obj_is_dirty(obj)
- Low-level wrapper for `::pdf_obj_is_dirty()`.
- ll_pdf_obj_is_incremental(obj)
- Low-level wrapper for `::pdf_obj_is_incremental()`.
- ll_pdf_obj_marked(obj)
- Low-level wrapper for `::pdf_obj_marked()`.
- ll_pdf_obj_memo(obj, bit)
- Wrapper for out-params of pdf_obj_memo().
Returns: int, int memo
- ll_pdf_obj_memo_outparams_fn(obj, bit, outparams)
- ll_pdf_obj_num_is_stream(doc, num)
- Low-level wrapper for `::pdf_obj_num_is_stream()`.
- ll_pdf_obj_parent_num(obj)
- Low-level wrapper for `::pdf_obj_parent_num()`.
- ll_pdf_obj_refs(ref)
- Low-level wrapper for `::pdf_obj_refs()`.
- ll_pdf_objcmp(a, b)
- Low-level wrapper for `::pdf_objcmp()`.
- ll_pdf_objcmp_deep(a, b)
- Low-level wrapper for `::pdf_objcmp_deep()`.
- ll_pdf_objcmp_resolve(a, b)
- Low-level wrapper for `::pdf_objcmp_resolve()`.
- ll_pdf_open_contents_stream(doc, obj)
- Low-level wrapper for `::pdf_open_contents_stream()`.
- ll_pdf_open_crypt(chain, crypt, num, gen)
- Low-level wrapper for `::pdf_open_crypt()`.
- ll_pdf_open_crypt_with_filter(chain, crypt, name, num, gen)
- Low-level wrapper for `::pdf_open_crypt_with_filter()`.
- ll_pdf_open_document(filename)
- Low-level wrapper for `::pdf_open_document()`.
- ll_pdf_open_document_with_stream(file)
- Low-level wrapper for `::pdf_open_document_with_stream()`.
- ll_pdf_open_inline_stream(doc, stmobj, length, chain, params)
- Low-level wrapper for `::pdf_open_inline_stream()`.
- ll_pdf_open_raw_stream(ref)
- Low-level wrapper for `::pdf_open_raw_stream()`.
- ll_pdf_open_raw_stream_number(doc, num)
- Low-level wrapper for `::pdf_open_raw_stream_number()`.
- ll_pdf_open_stream(ref)
- Low-level wrapper for `::pdf_open_stream()`.
- ll_pdf_open_stream_number(doc, num)
- Low-level wrapper for `::pdf_open_stream_number()`.
- ll_pdf_open_stream_with_offset(doc, num, dict, stm_ofs)
- Low-level wrapper for `::pdf_open_stream_with_offset()`.
- ll_pdf_page_contents(page)
- Low-level wrapper for `::pdf_page_contents()`.
- ll_pdf_page_event_close(page)
- Low-level wrapper for `::pdf_page_event_close()`.
- ll_pdf_page_event_open(page)
- Low-level wrapper for `::pdf_page_event_open()`.
- ll_pdf_page_from_fz_page(ptr)
- Low-level wrapper for `::pdf_page_from_fz_page()`.
- ll_pdf_page_group(page)
- Low-level wrapper for `::pdf_page_group()`.
- ll_pdf_page_has_transparency(page)
- Low-level wrapper for `::pdf_page_has_transparency()`.
- ll_pdf_page_label(doc, page, buf, size)
- Low-level wrapper for `::pdf_page_label()`.
- ll_pdf_page_label_imp(doc, chapter, page, buf, size)
- Low-level wrapper for `::pdf_page_label_imp()`.
- ll_pdf_page_obj_transform(pageobj, page_mediabox, page_ctm)
- Low-level wrapper for `::pdf_page_obj_transform()`.
- ll_pdf_page_obj_transform_box(pageobj, page_mediabox, page_ctm, box)
- Low-level wrapper for `::pdf_page_obj_transform_box()`.
- ll_pdf_page_presentation(page, transition)
- Wrapper for out-params of pdf_page_presentation().
Returns: fz_transition *, float duration
- ll_pdf_page_presentation_outparams_fn(page, transition, outparams)
- ll_pdf_page_resources(page)
- Low-level wrapper for `::pdf_page_resources()`.
- ll_pdf_page_separations(page)
- Low-level wrapper for `::pdf_page_separations()`.
- ll_pdf_page_transform(page, mediabox, ctm)
- Low-level wrapper for `::pdf_page_transform()`.
- ll_pdf_page_transform_box(page, mediabox, ctm, box)
- Low-level wrapper for `::pdf_page_transform_box()`.
- ll_pdf_page_write(doc, mediabox)
- Wrapper for out-params of pdf_page_write().
Returns: fz_device *, ::pdf_obj *presources, ::fz_buffer *pcontents
- ll_pdf_page_write_outparams_fn(doc, mediabox, outparams)
- ll_pdf_parse_array(doc, f, buf)
- Low-level wrapper for `::pdf_parse_array()`.
- ll_pdf_parse_date(s)
- Low-level wrapper for `::pdf_parse_date()`.
- ll_pdf_parse_default_appearance(da, color)
- Wrapper for out-params of pdf_parse_default_appearance().
Returns: const char *font, float size, int n
- ll_pdf_parse_default_appearance_outparams_fn(da, color, outparams)
- ll_pdf_parse_dict(doc, f, buf)
- Low-level wrapper for `::pdf_parse_dict()`.
- ll_pdf_parse_ind_obj(doc, f)
- Wrapper for out-params of pdf_parse_ind_obj().
Returns: pdf_obj *, int num, int gen, int64_t stm_ofs, int try_repair
- ll_pdf_parse_ind_obj_outparams_fn(doc, f, outparams)
- ll_pdf_parse_journal_obj(doc, stm)
- Wrapper for out-params of pdf_parse_journal_obj().
Returns: pdf_obj *, int onum, ::fz_buffer *ostm, int newobj
- ll_pdf_parse_journal_obj_outparams_fn(doc, stm, outparams)
- ll_pdf_parse_stm_obj(doc, f, buf)
- Low-level wrapper for `::pdf_parse_stm_obj()`.
- ll_pdf_parse_write_options(opts, args)
- Low-level wrapper for `::pdf_parse_write_options()`.
- ll_pdf_pin_document(obj)
- Low-level wrapper for `::pdf_pin_document()`.
- ll_pdf_preview_signature_as_display_list(w, h, lang, signer, appearance_flags, graphic, reason, location)
- Low-level wrapper for `::pdf_preview_signature_as_display_list()`.
- ll_pdf_preview_signature_as_pixmap(w, h, lang, signer, appearance_flags, graphic, reason, location)
- Low-level wrapper for `::pdf_preview_signature_as_pixmap()`.
- ll_pdf_print_crypt(out, crypt)
- Low-level wrapper for `::pdf_print_crypt()`.
- ll_pdf_print_default_appearance(buf, nbuf, font, size, n, color)
- Low-level wrapper for `::pdf_print_default_appearance()`.
- ll_pdf_print_encrypted_obj(out, obj, tight, ascii, crypt, num, gen)
- Low-level wrapper for `::pdf_print_encrypted_obj()`.
- ll_pdf_print_font(out, fontdesc)
- Low-level wrapper for `::pdf_print_font()`.
- ll_pdf_print_obj(out, obj, tight, ascii)
- Low-level wrapper for `::pdf_print_obj()`.
- ll_pdf_process_annot(proc, annot, cookie)
- Low-level wrapper for `::pdf_process_annot()`.
- ll_pdf_process_contents(proc, doc, obj, res, cookie)
- Wrapper for out-params of pdf_process_contents().
Returns: ::pdf_obj *out_res
- ll_pdf_process_contents_outparams_fn(proc, doc, obj, res, cookie, outparams)
- ll_pdf_process_glyph(proc, doc, resources, contents)
- Low-level wrapper for `::pdf_process_glyph()`.
- ll_pdf_process_raw_contents(proc, doc, rdb, stmobj, cookie)
- Low-level wrapper for `::pdf_process_raw_contents()`.
- ll_pdf_processor_pop_resources(proc)
- Low-level wrapper for `::pdf_processor_pop_resources()`.
- ll_pdf_processor_push_resources(proc, res)
- Low-level wrapper for `::pdf_processor_push_resources()`.
- ll_pdf_progressive_advance(doc, pagenum)
- Low-level wrapper for `::pdf_progressive_advance()`.
- ll_pdf_purge_local_font_resources(doc)
- Low-level wrapper for `::pdf_purge_local_font_resources()`.
- ll_pdf_purge_locals_from_store(doc)
- Low-level wrapper for `::pdf_purge_locals_from_store()`.
- ll_pdf_read_journal(doc, stm)
- Low-level wrapper for `::pdf_read_journal()`.
- ll_pdf_read_ocg(doc)
- Low-level wrapper for `::pdf_read_ocg()`.
- ll_pdf_recolor_shade(shade, reshade, opaque)
- Low-level wrapper for `::pdf_recolor_shade()`.
Recolor a shade.
- ll_pdf_redact_page(doc, page, opts)
- Low-level wrapper for `::pdf_redact_page()`.
- ll_pdf_redo(doc)
- Low-level wrapper for `::pdf_redo()`.
- ll_pdf_remove_item(drop, key)
- Low-level wrapper for `::pdf_remove_item()`.
- ll_pdf_repair_obj(doc, buf)
- Wrapper for out-params of pdf_repair_obj().
Returns: int, int64_t stmofsp, int64_t stmlenp, ::pdf_obj *encrypt, ::pdf_obj *id, ::pdf_obj *page, int64_t tmpofs, ::pdf_obj *root
- ll_pdf_repair_obj_outparams_fn(doc, buf, outparams)
- ll_pdf_repair_obj_stms(doc)
- Low-level wrapper for `::pdf_repair_obj_stms()`.
- ll_pdf_repair_trailer(doc)
- Low-level wrapper for `::pdf_repair_trailer()`.
- ll_pdf_repair_xref(doc)
- Low-level wrapper for `::pdf_repair_xref()`.
- ll_pdf_replace_xref(doc, entries, n)
- Low-level wrapper for `::pdf_replace_xref()`.
- ll_pdf_reset_form(doc, fields, exclude)
- Low-level wrapper for `::pdf_reset_form()`.
- ll_pdf_resolve_indirect(ref)
- Low-level wrapper for `::pdf_resolve_indirect()`.
Resolve an indirect object (or chain of objects).
This can cause xref reorganisations (solidifications etc) due to
repairs, so all held pdf_xref_entries should be considered
invalid after this call (other than the returned one).
- ll_pdf_resolve_indirect_chain(ref)
- Low-level wrapper for `::pdf_resolve_indirect_chain()`.
- ll_pdf_resolve_link(doc, uri)
- Wrapper for out-params of pdf_resolve_link().
Returns: int, float xp, float yp
- ll_pdf_resolve_link_dest(doc, uri)
- Low-level wrapper for `::pdf_resolve_link_dest()`.
- ll_pdf_resolve_link_outparams_fn(doc, uri, outparams)
- ll_pdf_run_annot(annot, dev, ctm, cookie)
- Low-level wrapper for `::pdf_run_annot()`.
- ll_pdf_run_glyph(doc, resources, contents, dev, ctm, gstate, default_cs)
- Low-level wrapper for `::pdf_run_glyph()`.
- ll_pdf_run_page(page, dev, ctm, cookie)
- Low-level wrapper for `::pdf_run_page()`.
- ll_pdf_run_page_annots(page, dev, ctm, cookie)
- Low-level wrapper for `::pdf_run_page_annots()`.
- ll_pdf_run_page_annots_with_usage(page, dev, ctm, usage, cookie)
- Low-level wrapper for `::pdf_run_page_annots_with_usage()`.
- ll_pdf_run_page_contents(page, dev, ctm, cookie)
- Low-level wrapper for `::pdf_run_page_contents()`.
- ll_pdf_run_page_contents_with_usage(page, dev, ctm, usage, cookie)
- Low-level wrapper for `::pdf_run_page_contents_with_usage()`.
- ll_pdf_run_page_widgets(page, dev, ctm, cookie)
- Low-level wrapper for `::pdf_run_page_widgets()`.
- ll_pdf_run_page_widgets_with_usage(page, dev, ctm, usage, cookie)
- Low-level wrapper for `::pdf_run_page_widgets_with_usage()`.
- ll_pdf_run_page_with_usage(page, dev, ctm, usage, cookie)
- Low-level wrapper for `::pdf_run_page_with_usage()`.
- ll_pdf_sample_shade_function(shade, n, funcs, t0, t1)
- Wrapper for out-params of pdf_sample_shade_function().
Returns: ::pdf_function *func
- ll_pdf_sample_shade_function_outparams_fn(shade, n, funcs, t0, t1, outparams)
- ll_pdf_save_document(doc, filename, opts)
- Low-level wrapper for `::pdf_save_document()`.
- ll_pdf_save_journal(doc, filename)
- Low-level wrapper for `::pdf_save_journal()`.
- ll_pdf_save_snapshot(doc, filename)
- Low-level wrapper for `::pdf_save_snapshot()`.
- ll_pdf_select_layer_config(doc, config_num)
- Low-level wrapper for `::pdf_select_layer_config()`.
- ll_pdf_select_layer_config_ui(doc, ui)
- Low-level wrapper for `::pdf_select_layer_config_ui()`.
- ll_pdf_serialise_journal(doc, out)
- Low-level wrapper for `::pdf_serialise_journal()`.
- ll_pdf_set_annot_active(annot, active)
- Low-level wrapper for `::pdf_set_annot_active()`.
- ll_pdf_set_annot_appearance(annot, appearance, state, ctm, bbox, res, contents)
- Low-level wrapper for `::pdf_set_annot_appearance()`.
- ll_pdf_set_annot_appearance_from_display_list(annot, appearance, state, ctm, list)
- Low-level wrapper for `::pdf_set_annot_appearance_from_display_list()`.
- ll_pdf_set_annot_author(annot, author)
- Low-level wrapper for `::pdf_set_annot_author()`.
- ll_pdf_set_annot_border(annot, width)
- Low-level wrapper for `::pdf_set_annot_border()`.
- ll_pdf_set_annot_border_effect(annot, effect)
- Low-level wrapper for `::pdf_set_annot_border_effect()`.
- ll_pdf_set_annot_border_effect_intensity(annot, intensity)
- Low-level wrapper for `::pdf_set_annot_border_effect_intensity()`.
- ll_pdf_set_annot_border_style(annot, style)
- Low-level wrapper for `::pdf_set_annot_border_style()`.
- ll_pdf_set_annot_border_width(annot, width)
- Low-level wrapper for `::pdf_set_annot_border_width()`.
- ll_pdf_set_annot_color(annot, color)
- Low-level Python implementation of pdf_set_annot_color()
using ll_pdf_set_annot_color2().
- ll_pdf_set_annot_color2(annot, n, color0, color1, color2, color3)
- ll_pdf_set_annot_contents(annot, text)
- Low-level wrapper for `::pdf_set_annot_contents()`.
- ll_pdf_set_annot_creation_date(annot, time)
- Low-level wrapper for `::pdf_set_annot_creation_date()`.
- ll_pdf_set_annot_default_appearance(annot, font, size, n, color)
- Low-level wrapper for `::pdf_set_annot_default_appearance()`.
- ll_pdf_set_annot_field_value(doc, widget, text, ignore_trigger_events)
- Low-level wrapper for `::pdf_set_annot_field_value()`.
- ll_pdf_set_annot_filespec(annot, obj)
- Low-level wrapper for `::pdf_set_annot_filespec()`.
- ll_pdf_set_annot_flags(annot, flags)
- Low-level wrapper for `::pdf_set_annot_flags()`.
- ll_pdf_set_annot_hidden_for_editing(annot, hidden)
- Low-level wrapper for `::pdf_set_annot_hidden_for_editing()`.
- ll_pdf_set_annot_hot(annot, hot)
- Low-level wrapper for `::pdf_set_annot_hot()`.
- ll_pdf_set_annot_icon_name(annot, name)
- Low-level wrapper for `::pdf_set_annot_icon_name()`.
- ll_pdf_set_annot_ink_list(annot, n, count, v)
- Low-level wrapper for `::pdf_set_annot_ink_list()`.
- ll_pdf_set_annot_interior_color(annot, color)
- Low-level Python version of pdf_set_annot_color() using
pdf_set_annot_color2().
- ll_pdf_set_annot_interior_color2(annot, n, color0, color1, color2, color3)
- ll_pdf_set_annot_is_open(annot, is_open)
- Low-level wrapper for `::pdf_set_annot_is_open()`.
- ll_pdf_set_annot_language(annot, lang)
- Low-level wrapper for `::pdf_set_annot_language()`.
- ll_pdf_set_annot_line(annot, a, b)
- Low-level wrapper for `::pdf_set_annot_line()`.
- ll_pdf_set_annot_line_end_style(annot, e)
- Low-level wrapper for `::pdf_set_annot_line_end_style()`.
- ll_pdf_set_annot_line_ending_styles(annot, start_style, end_style)
- Low-level wrapper for `::pdf_set_annot_line_ending_styles()`.
- ll_pdf_set_annot_line_start_style(annot, s)
- Low-level wrapper for `::pdf_set_annot_line_start_style()`.
- ll_pdf_set_annot_modification_date(annot, time)
- Low-level wrapper for `::pdf_set_annot_modification_date()`.
- ll_pdf_set_annot_opacity(annot, opacity)
- Low-level wrapper for `::pdf_set_annot_opacity()`.
- ll_pdf_set_annot_popup(annot, rect)
- Low-level wrapper for `::pdf_set_annot_popup()`.
- ll_pdf_set_annot_quad_points(annot, n, qv)
- Low-level wrapper for `::pdf_set_annot_quad_points()`.
- ll_pdf_set_annot_quadding(annot, q)
- Low-level wrapper for `::pdf_set_annot_quadding()`.
- ll_pdf_set_annot_rect(annot, rect)
- Low-level wrapper for `::pdf_set_annot_rect()`.
- ll_pdf_set_annot_resynthesised(annot)
- Low-level wrapper for `::pdf_set_annot_resynthesised()`.
- ll_pdf_set_annot_stamp_image(annot, image)
- Low-level wrapper for `::pdf_set_annot_stamp_image()`.
- ll_pdf_set_annot_vertex(annot, i, p)
- Low-level wrapper for `::pdf_set_annot_vertex()`.
- ll_pdf_set_annot_vertices(annot, n, v)
- Low-level wrapper for `::pdf_set_annot_vertices()`.
- ll_pdf_set_choice_field_value(widget, value)
- Low-level wrapper for `::pdf_set_choice_field_value()`.
- ll_pdf_set_cmap_wmode(cmap, wmode)
- Low-level wrapper for `::pdf_set_cmap_wmode()`.
- ll_pdf_set_default_hmtx(font, w)
- Low-level wrapper for `::pdf_set_default_hmtx()`.
- ll_pdf_set_default_vmtx(font, y, w)
- Low-level wrapper for `::pdf_set_default_vmtx()`.
- ll_pdf_set_doc_event_callback(doc, event_cb, free_event_data_cb, data)
- Low-level wrapper for `::pdf_set_doc_event_callback()`.
- ll_pdf_set_document_language(doc, lang)
- Low-level wrapper for `::pdf_set_document_language()`.
- ll_pdf_set_field_value(doc, field, text, ignore_trigger_events)
- Low-level wrapper for `::pdf_set_field_value()`.
- ll_pdf_set_font_wmode(font, wmode)
- Low-level wrapper for `::pdf_set_font_wmode()`.
- ll_pdf_set_int(obj, i)
- Low-level wrapper for `::pdf_set_int()`.
- ll_pdf_set_layer_config_as_default(doc)
- Low-level wrapper for `::pdf_set_layer_config_as_default()`.
- ll_pdf_set_obj_memo(obj, bit, memo)
- Low-level wrapper for `::pdf_set_obj_memo()`.
- ll_pdf_set_obj_parent(obj, num)
- Low-level wrapper for `::pdf_set_obj_parent()`.
- ll_pdf_set_page_labels(doc, index, style, prefix, start)
- Low-level wrapper for `::pdf_set_page_labels()`.
- ll_pdf_set_populating_xref_trailer(doc, trailer)
- Low-level wrapper for `::pdf_set_populating_xref_trailer()`.
- ll_pdf_set_str_len(obj, newlen)
- Low-level wrapper for `::pdf_set_str_len()`.
- ll_pdf_set_text_field_value(widget, value)
- Low-level wrapper for `::pdf_set_text_field_value()`.
- ll_pdf_set_usecmap(cmap, usecmap)
- Low-level wrapper for `::pdf_set_usecmap()`.
- ll_pdf_set_widget_editing_state(widget, editing)
- Low-level wrapper for `::pdf_set_widget_editing_state()`.
- ll_pdf_sign_signature(widget, signer, appearance_flags, graphic, reason, location)
- Low-level wrapper for `::pdf_sign_signature()`.
- ll_pdf_sign_signature_with_appearance(widget, signer, date, disp_list)
- Low-level wrapper for `::pdf_sign_signature_with_appearance()`.
- ll_pdf_signature_appearance_signed(rect, lang, img, left_text, right_text, include_logo)
- Low-level wrapper for `::pdf_signature_appearance_signed()`.
- ll_pdf_signature_appearance_unsigned(rect, lang)
- Low-level wrapper for `::pdf_signature_appearance_unsigned()`.
- ll_pdf_signature_byte_range(doc, signature, byte_range)
- Low-level wrapper for `::pdf_signature_byte_range()`.
- ll_pdf_signature_contents(doc, signature)
- Wrapper for out-params of pdf_signature_contents().
Returns: size_t, char *contents
- ll_pdf_signature_contents_outparams_fn(doc, signature, outparams)
- ll_pdf_signature_drop_distinguished_name(name)
- Low-level wrapper for `::pdf_signature_drop_distinguished_name()`.
- ll_pdf_signature_error_description(err)
- Low-level wrapper for `::pdf_signature_error_description()`.
- ll_pdf_signature_format_distinguished_name(name)
- Low-level wrapper for `::pdf_signature_format_distinguished_name()`.
- ll_pdf_signature_get_signatory(verifier, doc, signature)
- Low-level wrapper for `::pdf_signature_get_signatory()`.
- ll_pdf_signature_get_widget_signatory(verifier, widget)
- Low-level wrapper for `::pdf_signature_get_widget_signatory()`.
- ll_pdf_signature_hash_bytes(doc, signature)
- Low-level wrapper for `::pdf_signature_hash_bytes()`.
- ll_pdf_signature_incremental_change_since_signing(doc, signature)
- Low-level wrapper for `::pdf_signature_incremental_change_since_signing()`.
- ll_pdf_signature_info(name, dn, reason, location, date, include_labels)
- Low-level wrapper for `::pdf_signature_info()`.
- ll_pdf_signature_is_signed(doc, field)
- Low-level wrapper for `::pdf_signature_is_signed()`.
- ll_pdf_signature_set_value(doc, field, signer, stime)
- Low-level wrapper for `::pdf_signature_set_value()`.
- ll_pdf_sort_cmap(cmap)
- Low-level wrapper for `::pdf_sort_cmap()`.
- ll_pdf_sort_dict(dict)
- Low-level wrapper for `::pdf_sort_dict()`.
- ll_pdf_specifics(doc)
- Low-level wrapper for `::pdf_specifics()`.
- ll_pdf_sprint_obj(buf, cap, obj, tight, ascii)
- Wrapper for out-params of pdf_sprint_obj().
Returns: char *, size_t len
- ll_pdf_sprint_obj_outparams_fn(buf, cap, obj, tight, ascii, outparams)
- ll_pdf_store_item(key, val, itemsize)
- Low-level wrapper for `::pdf_store_item()`.
- ll_pdf_string_from_annot_type(type)
- Low-level wrapper for `::pdf_string_from_annot_type()`.
- ll_pdf_string_from_line_ending(end)
- Low-level wrapper for `::pdf_string_from_line_ending()`.
- ll_pdf_text_widget_format(tw)
- Low-level wrapper for `::pdf_text_widget_format()`.
- ll_pdf_text_widget_max_len(tw)
- Low-level wrapper for `::pdf_text_widget_max_len()`.
- ll_pdf_to_bool(obj)
- Low-level wrapper for `::pdf_to_bool()`.
- ll_pdf_to_date(time)
- Low-level wrapper for `::pdf_to_date()`.
- ll_pdf_to_gen(obj)
- Low-level wrapper for `::pdf_to_gen()`.
- ll_pdf_to_int(obj)
- Low-level wrapper for `::pdf_to_int()`.
- ll_pdf_to_int64(obj)
- Low-level wrapper for `::pdf_to_int64()`.
- ll_pdf_to_matrix(array)
- Low-level wrapper for `::pdf_to_matrix()`.
- ll_pdf_to_name(obj)
- Low-level wrapper for `::pdf_to_name()`.
- ll_pdf_to_num(obj)
- Low-level wrapper for `::pdf_to_num()`.
- ll_pdf_to_quad(array, offset)
- Low-level wrapper for `::pdf_to_quad()`.
- ll_pdf_to_real(obj)
- Low-level wrapper for `::pdf_to_real()`.
- ll_pdf_to_rect(array)
- Low-level wrapper for `::pdf_to_rect()`.
- ll_pdf_to_str_buf(obj)
- Low-level wrapper for `::pdf_to_str_buf()`.
- ll_pdf_to_str_len(obj)
- Low-level wrapper for `::pdf_to_str_len()`.
- ll_pdf_to_string(obj)
- Wrapper for out-params of pdf_to_string().
Returns: const char *, size_t sizep
- ll_pdf_to_string_outparams_fn(obj, outparams)
- ll_pdf_to_text_string(obj)
- Low-level wrapper for `::pdf_to_text_string()`.
- ll_pdf_toggle_layer_config_ui(doc, ui)
- Low-level wrapper for `::pdf_toggle_layer_config_ui()`.
- ll_pdf_toggle_widget(widget)
- Low-level wrapper for `::pdf_toggle_widget()`.
- ll_pdf_tos_get_text(tos)
- Low-level wrapper for `::pdf_tos_get_text()`.
- ll_pdf_tos_make_trm(tos, text, fontdesc, cid, trm)
- Low-level wrapper for `::pdf_tos_make_trm()`.
- ll_pdf_tos_move_after_char(tos)
- Low-level wrapper for `::pdf_tos_move_after_char()`.
- ll_pdf_tos_newline(tos, leading)
- Low-level wrapper for `::pdf_tos_newline()`.
- ll_pdf_tos_reset(tos, render)
- Low-level wrapper for `::pdf_tos_reset()`.
- ll_pdf_tos_restore(tos, save)
- Low-level wrapper for `::pdf_tos_restore()`.
- ll_pdf_tos_save(tos, save)
- Low-level wrapper for `::pdf_tos_save()`.
- ll_pdf_tos_set_matrix(tos, a, b, c, d, e, f)
- Low-level wrapper for `::pdf_tos_set_matrix()`.
- ll_pdf_tos_translate(tos, tx, ty)
- Low-level wrapper for `::pdf_tos_translate()`.
- ll_pdf_trailer(doc)
- Low-level wrapper for `::pdf_trailer()`.
- ll_pdf_undo(doc)
- Low-level wrapper for `::pdf_undo()`.
- ll_pdf_undoredo_state(doc)
- Wrapper for out-params of pdf_undoredo_state().
Returns: int, int steps
- ll_pdf_undoredo_state_outparams_fn(doc, outparams)
- ll_pdf_undoredo_step(doc, step)
- Low-level wrapper for `::pdf_undoredo_step()`.
- ll_pdf_unmark_obj(obj)
- Low-level wrapper for `::pdf_unmark_obj()`.
- ll_pdf_update_annot(annot)
- Low-level wrapper for `::pdf_update_annot()`.
- ll_pdf_update_default_colorspaces(old_cs, res)
- Low-level wrapper for `::pdf_update_default_colorspaces()`.
- ll_pdf_update_object(doc, num, obj)
- Low-level wrapper for `::pdf_update_object()`.
- ll_pdf_update_page(page)
- Low-level wrapper for `::pdf_update_page()`.
- ll_pdf_update_stream(doc, ref, buf, compressed)
- Low-level wrapper for `::pdf_update_stream()`.
- ll_pdf_update_widget(widget)
- Low-level wrapper for `::pdf_update_widget()`.
- ll_pdf_update_xobject(doc, xobj, bbox, mat, res, buffer)
- Low-level wrapper for `::pdf_update_xobject()`.
- ll_pdf_validate_change_history(doc)
- Low-level wrapper for `::pdf_validate_change_history()`.
- ll_pdf_validate_changes(doc, version)
- Low-level wrapper for `::pdf_validate_changes()`.
- ll_pdf_validate_signature(widget)
- Low-level wrapper for `::pdf_validate_signature()`.
- ll_pdf_verify_embedded_file_checksum(fs)
- Low-level wrapper for `::pdf_verify_embedded_file_checksum()`.
- ll_pdf_version(doc)
- Low-level wrapper for `::pdf_version()`.
- ll_pdf_walk_tree(tree, kid_name, arrive, leave, arg)
- Wrapper for out-params of pdf_walk_tree().
Returns: ::pdf_obj *names, ::pdf_obj *values
- ll_pdf_walk_tree_outparams_fn(tree, kid_name, arrive, leave, arg, outparams)
- ll_pdf_was_pure_xfa(doc)
- Low-level wrapper for `::pdf_was_pure_xfa()`.
- ll_pdf_was_repaired(doc)
- Low-level wrapper for `::pdf_was_repaired()`.
- ll_pdf_widget_is_readonly(widget)
- Low-level wrapper for `::pdf_widget_is_readonly()`.
- ll_pdf_widget_is_signed(widget)
- Low-level wrapper for `::pdf_widget_is_signed()`.
- ll_pdf_widget_type(widget)
- Low-level wrapper for `::pdf_widget_type()`.
- ll_pdf_write_digest(out, byte_range, field, digest_offset, digest_length, signer)
- Low-level wrapper for `::pdf_write_digest()`.
- ll_pdf_write_document(doc, out, opts)
- Low-level wrapper for `::pdf_write_document()`.
- ll_pdf_write_journal(doc, out)
- Low-level wrapper for `::pdf_write_journal()`.
- ll_pdf_write_snapshot(doc, out)
- Low-level wrapper for `::pdf_write_snapshot()`.
- ll_pdf_xobject_bbox(xobj)
- Low-level wrapper for `::pdf_xobject_bbox()`.
- ll_pdf_xobject_colorspace(xobj)
- Low-level wrapper for `::pdf_xobject_colorspace()`.
- ll_pdf_xobject_isolated(xobj)
- Low-level wrapper for `::pdf_xobject_isolated()`.
- ll_pdf_xobject_knockout(xobj)
- Low-level wrapper for `::pdf_xobject_knockout()`.
- ll_pdf_xobject_matrix(xobj)
- Low-level wrapper for `::pdf_xobject_matrix()`.
- ll_pdf_xobject_resources(xobj)
- Low-level wrapper for `::pdf_xobject_resources()`.
- ll_pdf_xobject_transparency(xobj)
- Low-level wrapper for `::pdf_xobject_transparency()`.
- ll_pdf_xref_ensure_incremental_object(doc, num)
- Low-level wrapper for `::pdf_xref_ensure_incremental_object()`.
- ll_pdf_xref_ensure_local_object(doc, num)
- Low-level wrapper for `::pdf_xref_ensure_local_object()`.
- ll_pdf_xref_entry_map(doc, fn, arg)
- Low-level wrapper for `::pdf_xref_entry_map()`.
- ll_pdf_xref_is_incremental(doc, num)
- Low-level wrapper for `::pdf_xref_is_incremental()`.
- ll_pdf_xref_len(doc)
- Low-level wrapper for `::pdf_xref_len()`.
- ll_pdf_xref_obj_is_unsaved_signature(doc, obj)
- Low-level wrapper for `::pdf_xref_obj_is_unsaved_signature()`.
- ll_pdf_xref_remove_unsaved_signature(doc, field)
- Low-level wrapper for `::pdf_xref_remove_unsaved_signature()`.
- ll_pdf_xref_store_unsaved_signature(doc, field, signer)
- Low-level wrapper for `::pdf_xref_store_unsaved_signature()`.
- log(text)
- memmove(data, indata)
- new_bytes(nelements)
- new_floats(nelements)
- new_pint()
- obj_enum_to_obj(n)
- page_merge_helper(old_annots, graft_map, doc_des, new_annots, n)
- pdf_abandon_operation(doc)
- Class-aware wrapper for `::pdf_abandon_operation()`.
- pdf_access_exec_menu_item_event(evt)
- Class-aware wrapper for `::pdf_access_exec_menu_item_event()`.
- pdf_add_annot_border_dash_item(annot, length)
- Class-aware wrapper for `::pdf_add_annot_border_dash_item()`.
- pdf_add_annot_ink_list(annot, n, stroke)
- Class-aware wrapper for `::pdf_add_annot_ink_list()`.
- pdf_add_annot_ink_list_stroke(annot)
- Class-aware wrapper for `::pdf_add_annot_ink_list_stroke()`.
- pdf_add_annot_ink_list_stroke_vertex(annot, p)
- Class-aware wrapper for `::pdf_add_annot_ink_list_stroke_vertex()`.
- pdf_add_annot_quad_point(annot, quad)
- Class-aware wrapper for `::pdf_add_annot_quad_point()`.
- pdf_add_annot_vertex(annot, p)
- Class-aware wrapper for `::pdf_add_annot_vertex()`.
- pdf_add_cid_font(doc, font)
- Class-aware wrapper for `::pdf_add_cid_font()`.
- pdf_add_cjk_font(doc, font, script, wmode, serif)
- Class-aware wrapper for `::pdf_add_cjk_font()`.
- pdf_add_codespace(cmap, low, high, n)
- Class-aware wrapper for `::pdf_add_codespace()`.
- pdf_add_embedded_file(doc, filename, mimetype, contents, created, modifed, add_checksum)
- Class-aware wrapper for `::pdf_add_embedded_file()`.
- pdf_add_hmtx(font, lo, hi, w)
- Class-aware wrapper for `::pdf_add_hmtx()`.
- pdf_add_image(doc, image)
- Class-aware wrapper for `::pdf_add_image()`.
- pdf_add_journal_fragment(doc, parent, copy, copy_stream, newobj)
- Class-aware wrapper for `::pdf_add_journal_fragment()`.
- pdf_add_new_array(doc, initial)
- Class-aware wrapper for `::pdf_add_new_array()`.
- pdf_add_new_dict(doc, initial)
- Class-aware wrapper for `::pdf_add_new_dict()`.
- pdf_add_object(doc, obj)
- Class-aware wrapper for `::pdf_add_object()`.
- pdf_add_page(doc, mediabox, rotate, resources, contents)
- Class-aware wrapper for `::pdf_add_page()`.
- pdf_add_simple_font(doc, font, encoding)
- Class-aware wrapper for `::pdf_add_simple_font()`.
- pdf_add_stream(doc, buf, obj, compressed)
- Class-aware wrapper for `::pdf_add_stream()`.
- pdf_add_substitute_font(doc, font)
- Class-aware wrapper for `::pdf_add_substitute_font()`.
- pdf_add_vmtx(font, lo, hi, x, y, w)
- Class-aware wrapper for `::pdf_add_vmtx()`.
- pdf_annot_MK_BC = pdf_annot_MK_BC_outparams_fn(annot, color)
- Class-aware helper for out-params of pdf_annot_MK_BC() [pdf_annot_MK_BC()].
- pdf_annot_MK_BC_outparams_fn(annot, color)
- Class-aware helper for out-params of pdf_annot_MK_BC() [pdf_annot_MK_BC()].
- pdf_annot_MK_BC_rgb(annot, rgb)
- Class-aware wrapper for `::pdf_annot_MK_BC_rgb()`.
- pdf_annot_MK_BG = pdf_annot_MK_BG_outparams_fn(annot, color)
- Class-aware helper for out-params of pdf_annot_MK_BG() [pdf_annot_MK_BG()].
- pdf_annot_MK_BG_outparams_fn(annot, color)
- Class-aware helper for out-params of pdf_annot_MK_BG() [pdf_annot_MK_BG()].
- pdf_annot_MK_BG_rgb(annot, rgb)
- Class-aware wrapper for `::pdf_annot_MK_BG_rgb()`.
- pdf_annot_active(annot)
- Class-aware wrapper for `::pdf_annot_active()`.
- pdf_annot_ap(annot)
- Class-aware wrapper for `::pdf_annot_ap()`.
- pdf_annot_author(annot)
- Class-aware wrapper for `::pdf_annot_author()`.
- pdf_annot_border(annot)
- Class-aware wrapper for `::pdf_annot_border()`.
- pdf_annot_border_dash_count(annot)
- Class-aware wrapper for `::pdf_annot_border_dash_count()`.
- pdf_annot_border_dash_item(annot, i)
- Class-aware wrapper for `::pdf_annot_border_dash_item()`.
- pdf_annot_border_effect(annot)
- Class-aware wrapper for `::pdf_annot_border_effect()`.
- pdf_annot_border_effect_intensity(annot)
- Class-aware wrapper for `::pdf_annot_border_effect_intensity()`.
- pdf_annot_border_style(annot)
- Class-aware wrapper for `::pdf_annot_border_style()`.
- pdf_annot_border_width(annot)
- Class-aware wrapper for `::pdf_annot_border_width()`.
- pdf_annot_color = pdf_annot_color_outparams_fn(annot, color)
- Class-aware helper for out-params of pdf_annot_color() [pdf_annot_color()].
- pdf_annot_color_outparams_fn(annot, color)
- Class-aware helper for out-params of pdf_annot_color() [pdf_annot_color()].
- pdf_annot_contents(annot)
- Class-aware wrapper for `::pdf_annot_contents()`.
- pdf_annot_creation_date(annot)
- Class-aware wrapper for `::pdf_annot_creation_date()`.
- pdf_annot_default_appearance = pdf_annot_default_appearance_outparams_fn(annot, color)
- Class-aware helper for out-params of pdf_annot_default_appearance() [pdf_annot_default_appearance()].
- pdf_annot_default_appearance_outparams_fn(annot, color)
- Class-aware helper for out-params of pdf_annot_default_appearance() [pdf_annot_default_appearance()].
- pdf_annot_ensure_local_xref(annot)
- Class-aware wrapper for `::pdf_annot_ensure_local_xref()`.
- pdf_annot_event_blur(annot)
- Class-aware wrapper for `::pdf_annot_event_blur()`.
- pdf_annot_event_down(annot)
- Class-aware wrapper for `::pdf_annot_event_down()`.
- pdf_annot_event_enter(annot)
- Class-aware wrapper for `::pdf_annot_event_enter()`.
- pdf_annot_event_exit(annot)
- Class-aware wrapper for `::pdf_annot_event_exit()`.
- pdf_annot_event_focus(annot)
- Class-aware wrapper for `::pdf_annot_event_focus()`.
- pdf_annot_event_page_close(annot)
- Class-aware wrapper for `::pdf_annot_event_page_close()`.
- pdf_annot_event_page_invisible(annot)
- Class-aware wrapper for `::pdf_annot_event_page_invisible()`.
- pdf_annot_event_page_open(annot)
- Class-aware wrapper for `::pdf_annot_event_page_open()`.
- pdf_annot_event_page_visible(annot)
- Class-aware wrapper for `::pdf_annot_event_page_visible()`.
- pdf_annot_event_up(annot)
- Class-aware wrapper for `::pdf_annot_event_up()`.
- pdf_annot_field_event_keystroke(doc, annot, evt)
- Class-aware wrapper for `::pdf_annot_field_event_keystroke()`.
- pdf_annot_field_flags(annot)
- Class-aware wrapper for `::pdf_annot_field_flags()`.
- pdf_annot_field_label(widget)
- Class-aware wrapper for `::pdf_annot_field_label()`.
- pdf_annot_field_value(annot)
- Class-aware wrapper for `::pdf_annot_field_value()`.
- pdf_annot_filespec(annot)
- Class-aware wrapper for `::pdf_annot_filespec()`.
- pdf_annot_flags(annot)
- Class-aware wrapper for `::pdf_annot_flags()`.
- pdf_annot_has_author(annot)
- Class-aware wrapper for `::pdf_annot_has_author()`.
- pdf_annot_has_border(annot)
- Class-aware wrapper for `::pdf_annot_has_border()`.
- pdf_annot_has_border_effect(annot)
- Class-aware wrapper for `::pdf_annot_has_border_effect()`.
- pdf_annot_has_filespec(annot)
- Class-aware wrapper for `::pdf_annot_has_filespec()`.
- pdf_annot_has_icon_name(annot)
- Class-aware wrapper for `::pdf_annot_has_icon_name()`.
- pdf_annot_has_ink_list(annot)
- Class-aware wrapper for `::pdf_annot_has_ink_list()`.
- pdf_annot_has_interior_color(annot)
- Class-aware wrapper for `::pdf_annot_has_interior_color()`.
- pdf_annot_has_line(annot)
- Class-aware wrapper for `::pdf_annot_has_line()`.
- pdf_annot_has_line_ending_styles(annot)
- Class-aware wrapper for `::pdf_annot_has_line_ending_styles()`.
- pdf_annot_has_open(annot)
- Class-aware wrapper for `::pdf_annot_has_open()`.
- pdf_annot_has_quad_points(annot)
- Class-aware wrapper for `::pdf_annot_has_quad_points()`.
- pdf_annot_has_rect(annot)
- Class-aware wrapper for `::pdf_annot_has_rect()`.
- pdf_annot_has_vertices(annot)
- Class-aware wrapper for `::pdf_annot_has_vertices()`.
- pdf_annot_hidden_for_editing(annot)
- Class-aware wrapper for `::pdf_annot_hidden_for_editing()`.
- pdf_annot_hot(annot)
- Class-aware wrapper for `::pdf_annot_hot()`.
- pdf_annot_icon_name(annot)
- Class-aware wrapper for `::pdf_annot_icon_name()`.
- pdf_annot_ink_list_count(annot)
- Class-aware wrapper for `::pdf_annot_ink_list_count()`.
- pdf_annot_ink_list_stroke_count(annot, i)
- Class-aware wrapper for `::pdf_annot_ink_list_stroke_count()`.
- pdf_annot_ink_list_stroke_vertex(annot, i, k)
- Class-aware wrapper for `::pdf_annot_ink_list_stroke_vertex()`.
- pdf_annot_interior_color = pdf_annot_interior_color_outparams_fn(annot, color)
- Class-aware helper for out-params of pdf_annot_interior_color() [pdf_annot_interior_color()].
- pdf_annot_interior_color_outparams_fn(annot, color)
- Class-aware helper for out-params of pdf_annot_interior_color() [pdf_annot_interior_color()].
- pdf_annot_is_open(annot)
- Class-aware wrapper for `::pdf_annot_is_open()`.
- pdf_annot_is_standard_stamp(annot)
- Class-aware wrapper for `::pdf_annot_is_standard_stamp()`.
- pdf_annot_language(annot)
- Class-aware wrapper for `::pdf_annot_language()`.
- pdf_annot_line(annot, a, b)
- Class-aware wrapper for `::pdf_annot_line()`.
- pdf_annot_line_end_style(annot)
- Class-aware wrapper for `::pdf_annot_line_end_style()`.
- pdf_annot_line_ending_styles = pdf_annot_line_ending_styles_outparams_fn(annot)
- Class-aware helper for out-params of pdf_annot_line_ending_styles() [pdf_annot_line_ending_styles()].
- pdf_annot_line_ending_styles_outparams_fn(annot)
- Class-aware helper for out-params of pdf_annot_line_ending_styles() [pdf_annot_line_ending_styles()].
- pdf_annot_line_start_style(annot)
- Class-aware wrapper for `::pdf_annot_line_start_style()`.
- pdf_annot_modification_date(annot)
- Class-aware wrapper for `::pdf_annot_modification_date()`.
- pdf_annot_needs_resynthesis(annot)
- Class-aware wrapper for `::pdf_annot_needs_resynthesis()`.
- pdf_annot_obj(annot)
- Class-aware wrapper for `::pdf_annot_obj()`.
- pdf_annot_opacity(annot)
- Class-aware wrapper for `::pdf_annot_opacity()`.
- pdf_annot_page(annot)
- Class-aware wrapper for `::pdf_annot_page()`.
- pdf_annot_pop_and_discard_local_xref(annot)
- Class-aware wrapper for `::pdf_annot_pop_and_discard_local_xref()`.
- pdf_annot_pop_local_xref(annot)
- Class-aware wrapper for `::pdf_annot_pop_local_xref()`.
- pdf_annot_popup(annot)
- Class-aware wrapper for `::pdf_annot_popup()`.
- pdf_annot_push_local_xref(annot)
- Class-aware wrapper for `::pdf_annot_push_local_xref()`.
- pdf_annot_quad_point(annot, i)
- Class-aware wrapper for `::pdf_annot_quad_point()`.
- pdf_annot_quad_point_count(annot)
- Class-aware wrapper for `::pdf_annot_quad_point_count()`.
- pdf_annot_quadding(annot)
- Class-aware wrapper for `::pdf_annot_quadding()`.
- pdf_annot_rect(annot)
- Class-aware wrapper for `::pdf_annot_rect()`.
- pdf_annot_request_resynthesis(annot)
- Class-aware wrapper for `::pdf_annot_request_resynthesis()`.
- pdf_annot_transform(annot)
- Class-aware wrapper for `::pdf_annot_transform()`.
- pdf_annot_type(annot)
- Class-aware wrapper for `::pdf_annot_type()`.
- pdf_annot_type_from_string(subtype)
- Class-aware wrapper for `::pdf_annot_type_from_string()`.
- pdf_annot_vertex(annot, i)
- Class-aware wrapper for `::pdf_annot_vertex()`.
- pdf_annot_vertex_count(annot)
- Class-aware wrapper for `::pdf_annot_vertex_count()`.
- pdf_append_explicit_dest_to_uri(url, dest)
- Class-aware wrapper for `::pdf_append_explicit_dest_to_uri()`.
- pdf_append_named_dest_to_uri(url, name)
- Class-aware wrapper for `::pdf_append_named_dest_to_uri()`.
- pdf_append_token(buf, tok, lex)
- Class-aware wrapper for `::pdf_append_token()`.
- pdf_apply_redaction(annot, opts)
- Class-aware wrapper for `::pdf_apply_redaction()`.
- pdf_array_contains(array, obj)
- Class-aware wrapper for `::pdf_array_contains()`.
- pdf_array_delete(array, index)
- Class-aware wrapper for `::pdf_array_delete()`.
- pdf_array_find(array, obj)
- Class-aware wrapper for `::pdf_array_find()`.
- pdf_array_get(array, i)
- Class-aware wrapper for `::pdf_array_get()`.
- pdf_array_get_bool(array, index)
- Class-aware wrapper for `::pdf_array_get_bool()`.
- pdf_array_get_int(array, index)
- Class-aware wrapper for `::pdf_array_get_int()`.
- pdf_array_get_matrix(array, index)
- Class-aware wrapper for `::pdf_array_get_matrix()`.
- pdf_array_get_name(array, index)
- Class-aware wrapper for `::pdf_array_get_name()`.
- pdf_array_get_real(array, index)
- Class-aware wrapper for `::pdf_array_get_real()`.
- pdf_array_get_rect(array, index)
- Class-aware wrapper for `::pdf_array_get_rect()`.
- pdf_array_get_string = pdf_array_get_string_outparams_fn(array, index)
- Class-aware helper for out-params of pdf_array_get_string() [pdf_array_get_string()].
- pdf_array_get_string_outparams_fn(array, index)
- Class-aware helper for out-params of pdf_array_get_string() [pdf_array_get_string()].
- pdf_array_get_text_string(array, index)
- Class-aware wrapper for `::pdf_array_get_text_string()`.
- pdf_array_insert(array, obj, index)
- Class-aware wrapper for `::pdf_array_insert()`.
- pdf_array_len(array)
- Class-aware wrapper for `::pdf_array_len()`.
- pdf_array_push(array, obj)
- Class-aware wrapper for `::pdf_array_push()`.
- pdf_array_push_array(array, initial)
- Class-aware wrapper for `::pdf_array_push_array()`.
- pdf_array_push_bool(array, x)
- Class-aware wrapper for `::pdf_array_push_bool()`.
- pdf_array_push_dict(array, initial)
- Class-aware wrapper for `::pdf_array_push_dict()`.
- pdf_array_push_int(array, x)
- Class-aware wrapper for `::pdf_array_push_int()`.
- pdf_array_push_name(array, x)
- Class-aware wrapper for `::pdf_array_push_name()`.
- pdf_array_push_real(array, x)
- Class-aware wrapper for `::pdf_array_push_real()`.
- pdf_array_push_string(array, x, n)
- Class-aware wrapper for `::pdf_array_push_string()`.
- pdf_array_push_text_string(array, x)
- Class-aware wrapper for `::pdf_array_push_text_string()`.
- pdf_array_put(array, i, obj)
- Class-aware wrapper for `::pdf_array_put()`.
- pdf_authenticate_password(doc, pw)
- Class-aware wrapper for `::pdf_authenticate_password()`.
- pdf_begin_implicit_operation(doc)
- Class-aware wrapper for `::pdf_begin_implicit_operation()`.
- pdf_begin_operation(doc, operation)
- Class-aware wrapper for `::pdf_begin_operation()`.
- pdf_bound_annot(annot)
- Class-aware wrapper for `::pdf_bound_annot()`.
- pdf_bound_page(page, box)
- Class-aware wrapper for `::pdf_bound_page()`.
- pdf_bound_widget(widget)
- Class-aware wrapper for `::pdf_bound_widget()`.
- pdf_button_field_on_state(field)
- Class-aware wrapper for `::pdf_button_field_on_state()`.
- pdf_calculate_form(doc)
- Class-aware wrapper for `::pdf_calculate_form()`.
- pdf_can_be_saved_incrementally(doc)
- Class-aware wrapper for `::pdf_can_be_saved_incrementally()`.
- pdf_can_redo(doc)
- Class-aware wrapper for `::pdf_can_redo()`.
- pdf_can_undo(doc)
- Class-aware wrapper for `::pdf_can_undo()`.
- pdf_check_certificate(verifier, doc, signature)
- Class-aware wrapper for `::pdf_check_certificate()`.
- pdf_check_digest(verifier, doc, signature)
- Class-aware wrapper for `::pdf_check_digest()`.
- pdf_check_signature(verifier, doc, signature, ebuf, ebufsize)
- Class-aware wrapper for `::pdf_check_signature()`.
- pdf_check_widget_certificate(verifier, widget)
- Class-aware wrapper for `::pdf_check_widget_certificate()`.
- pdf_check_widget_digest(verifier, widget)
- Class-aware wrapper for `::pdf_check_widget_digest()`.
- pdf_choice_field_option(field, exportval, i)
- Class-aware wrapper for `::pdf_choice_field_option()`.
- pdf_choice_field_option_count(field)
- Class-aware wrapper for `::pdf_choice_field_option_count()`.
- pdf_choice_widget_is_multiselect(tw)
- Class-aware wrapper for `::pdf_choice_widget_is_multiselect()`.
- pdf_choice_widget_options(tw, exportval, opts)
- Class-aware wrapper for `::pdf_choice_widget_options()`.
- pdf_choice_widget_set_value(tw, n, opts)
- Class-aware wrapper for `::pdf_choice_widget_set_value()`.
- pdf_choice_widget_value(tw, opts)
- Class-aware wrapper for `::pdf_choice_widget_value()`.
- pdf_clean_file(infile, outfile, password, opts, retainlen)
- Class-aware wrapper for `::pdf_clean_file()`.
- pdf_clean_font_name(fontname)
- Class-aware wrapper for `::pdf_clean_font_name()`.
- pdf_clean_obj(obj)
- Class-aware wrapper for `::pdf_clean_obj()`.
- pdf_clear_annot_border_dash(annot)
- Class-aware wrapper for `::pdf_clear_annot_border_dash()`.
- pdf_clear_annot_ink_list(annot)
- Class-aware wrapper for `::pdf_clear_annot_ink_list()`.
- pdf_clear_annot_quad_points(annot)
- Class-aware wrapper for `::pdf_clear_annot_quad_points()`.
- pdf_clear_annot_vertices(annot)
- Class-aware wrapper for `::pdf_clear_annot_vertices()`.
- pdf_clear_signature(widget)
- Class-aware wrapper for `::pdf_clear_signature()`.
- pdf_clear_xref(doc)
- Class-aware wrapper for `::pdf_clear_xref()`.
- pdf_clear_xref_to_mark(doc)
- Class-aware wrapper for `::pdf_clear_xref_to_mark()`.
- pdf_close_processor(proc)
- Class-aware wrapper for `::pdf_close_processor()`.
- pdf_cmap_size(cmap)
- Class-aware wrapper for `::pdf_cmap_size()`.
- pdf_cmap_wmode(cmap)
- Class-aware wrapper for `::pdf_cmap_wmode()`.
- pdf_copy_array(array)
- Class-aware wrapper for `::pdf_copy_array()`.
- pdf_copy_dict(dict)
- Class-aware wrapper for `::pdf_copy_dict()`.
- pdf_count_layer_config_ui(doc)
- Class-aware wrapper for `::pdf_count_layer_config_ui()`.
- pdf_count_layer_configs(doc)
- Class-aware wrapper for `::pdf_count_layer_configs()`.
- pdf_count_layers(doc)
- Class-aware wrapper for `::pdf_count_layers()`.
- pdf_count_objects(doc)
- Class-aware wrapper for `::pdf_count_objects()`.
- pdf_count_pages(doc)
- Class-aware wrapper for `::pdf_count_pages()`.
- pdf_count_pages_imp(doc, chapter)
- Class-aware wrapper for `::pdf_count_pages_imp()`.
- pdf_count_signatures(doc)
- Class-aware wrapper for `::pdf_count_signatures()`.
- pdf_count_unsaved_versions(doc)
- Class-aware wrapper for `::pdf_count_unsaved_versions()`.
- pdf_count_versions(doc)
- Class-aware wrapper for `::pdf_count_versions()`.
- pdf_create_annot(page, type)
- Class-aware wrapper for `::pdf_create_annot()`.
- pdf_create_annot_raw(page, type)
- Class-aware wrapper for `::pdf_create_annot_raw()`.
- pdf_create_document()
- Class-aware wrapper for `::pdf_create_document()`.
- pdf_create_field_name(doc, prefix, buf, len)
- Class-aware wrapper for `::pdf_create_field_name()`.
- pdf_create_link(page, bbox, uri)
- Class-aware wrapper for `::pdf_create_link()`.
- pdf_create_object(doc)
- Class-aware wrapper for `::pdf_create_object()`.
- pdf_create_signature_widget(page, name)
- Class-aware wrapper for `::pdf_create_signature_widget()`.
- pdf_crypt_encrypt_metadata(crypt)
- Class-aware wrapper for `::pdf_crypt_encrypt_metadata()`.
- pdf_crypt_key(crypt)
- Class-aware wrapper for `::pdf_crypt_key()`.
- pdf_crypt_length(crypt)
- Class-aware wrapper for `::pdf_crypt_length()`.
- pdf_crypt_method(crypt)
- Class-aware wrapper for `::pdf_crypt_method()`.
- pdf_crypt_obj(crypt, obj, num, gen)
- Class-aware wrapper for `::pdf_crypt_obj()`.
- pdf_crypt_owner_encryption(crypt)
- Class-aware wrapper for `::pdf_crypt_owner_encryption()`.
- pdf_crypt_owner_password(crypt)
- Class-aware wrapper for `::pdf_crypt_owner_password()`.
- pdf_crypt_permissions(crypt)
- Class-aware wrapper for `::pdf_crypt_permissions()`.
- pdf_crypt_permissions_encryption(crypt)
- Class-aware wrapper for `::pdf_crypt_permissions_encryption()`.
- pdf_crypt_revision(crypt)
- Class-aware wrapper for `::pdf_crypt_revision()`.
- pdf_crypt_stream_method(crypt)
- Class-aware wrapper for `::pdf_crypt_stream_method()`.
- pdf_crypt_string_method(crypt)
- Class-aware wrapper for `::pdf_crypt_string_method()`.
- pdf_crypt_user_encryption(crypt)
- Class-aware wrapper for `::pdf_crypt_user_encryption()`.
- pdf_crypt_user_password(crypt)
- Class-aware wrapper for `::pdf_crypt_user_password()`.
- pdf_crypt_version(crypt)
- Class-aware wrapper for `::pdf_crypt_version()`.
- pdf_cycle(here, prev, obj)
- Class-aware wrapper for `::pdf_cycle()`.
- pdf_debug_doc_changes(doc)
- Class-aware wrapper for `::pdf_debug_doc_changes()`.
- pdf_debug_obj(obj)
- Class-aware wrapper for `::pdf_debug_obj()`.
- pdf_debug_ref(obj)
- Class-aware wrapper for `::pdf_debug_ref()`.
- pdf_decode_cmap = pdf_decode_cmap_outparams_fn(cmap, s, e)
- Class-aware helper for out-params of pdf_decode_cmap() [pdf_decode_cmap()].
- pdf_decode_cmap_outparams_fn(cmap, s, e)
- Class-aware helper for out-params of pdf_decode_cmap() [pdf_decode_cmap()].
- pdf_deep_copy_obj(obj)
- Class-aware wrapper for `::pdf_deep_copy_obj()`.
- pdf_delete_annot(page, annot)
- Class-aware wrapper for `::pdf_delete_annot()`.
- pdf_delete_link(page, link)
- Class-aware wrapper for `::pdf_delete_link()`.
- pdf_delete_object(doc, num)
- Class-aware wrapper for `::pdf_delete_object()`.
- pdf_delete_page(doc, number)
- Class-aware wrapper for `::pdf_delete_page()`.
- pdf_delete_page_labels(doc, index)
- Class-aware wrapper for `::pdf_delete_page_labels()`.
- pdf_delete_page_range(doc, start, end)
- Class-aware wrapper for `::pdf_delete_page_range()`.
- pdf_deselect_layer_config_ui(doc, ui)
- Class-aware wrapper for `::pdf_deselect_layer_config_ui()`.
- pdf_deserialise_journal(doc, stm)
- Class-aware wrapper for `::pdf_deserialise_journal()`.
- pdf_dict_del(dict, key)
- Class-aware wrapper for `::pdf_dict_del()`.
- pdf_dict_dels(dict, key)
- Class-aware wrapper for `::pdf_dict_dels()`.
- pdf_dict_get(dict, key)
- Class-aware wrapper for `::pdf_dict_get()`.
- pdf_dict_get_bool(dict, key)
- Class-aware wrapper for `::pdf_dict_get_bool()`.
- pdf_dict_get_date(dict, key)
- Class-aware wrapper for `::pdf_dict_get_date()`.
- pdf_dict_get_inheritable(dict, key)
- Class-aware wrapper for `::pdf_dict_get_inheritable()`.
- pdf_dict_get_int(dict, key)
- Class-aware wrapper for `::pdf_dict_get_int()`.
- pdf_dict_get_int64(dict, key)
- Class-aware wrapper for `::pdf_dict_get_int64()`.
- pdf_dict_get_key(dict, idx)
- Class-aware wrapper for `::pdf_dict_get_key()`.
- pdf_dict_get_matrix(dict, key)
- Class-aware wrapper for `::pdf_dict_get_matrix()`.
- pdf_dict_get_name(dict, key)
- Class-aware wrapper for `::pdf_dict_get_name()`.
- pdf_dict_get_real(dict, key)
- Class-aware wrapper for `::pdf_dict_get_real()`.
- pdf_dict_get_rect(dict, key)
- Class-aware wrapper for `::pdf_dict_get_rect()`.
- pdf_dict_get_string = pdf_dict_get_string_outparams_fn(dict, key)
- Class-aware helper for out-params of pdf_dict_get_string() [pdf_dict_get_string()].
- pdf_dict_get_string_outparams_fn(dict, key)
- Class-aware helper for out-params of pdf_dict_get_string() [pdf_dict_get_string()].
- pdf_dict_get_text_string(dict, key)
- Class-aware wrapper for `::pdf_dict_get_text_string()`.
- pdf_dict_get_val(dict, idx)
- Class-aware wrapper for `::pdf_dict_get_val()`.
- pdf_dict_geta(dict, key, abbrev)
- Class-aware wrapper for `::pdf_dict_geta()`.
- pdf_dict_getl(obj, *tail)
- Python implementation of pdf_dict_getl(), because SWIG
doesn't handle variadic args. Each item in `tail` should be
a `mupdf.PdfObj`.
- pdf_dict_getp(dict, path)
- Class-aware wrapper for `::pdf_dict_getp()`.
- pdf_dict_getp_inheritable(dict, path)
- Class-aware wrapper for `::pdf_dict_getp_inheritable()`.
- pdf_dict_gets(dict, key)
- Class-aware wrapper for `::pdf_dict_gets()`.
- pdf_dict_gets_inheritable(dict, key)
- Class-aware wrapper for `::pdf_dict_gets_inheritable()`.
- pdf_dict_getsa(dict, key, abbrev)
- Class-aware wrapper for `::pdf_dict_getsa()`.
- pdf_dict_len(dict)
- Class-aware wrapper for `::pdf_dict_len()`.
- pdf_dict_put(dict, key, val)
- Class-aware wrapper for `::pdf_dict_put()`.
- pdf_dict_put_array(dict, key, initial)
- Class-aware wrapper for `::pdf_dict_put_array()`.
- pdf_dict_put_bool(dict, key, x)
- Class-aware wrapper for `::pdf_dict_put_bool()`.
- pdf_dict_put_date(dict, key, time)
- Class-aware wrapper for `::pdf_dict_put_date()`.
- pdf_dict_put_dict(dict, key, initial)
- Class-aware wrapper for `::pdf_dict_put_dict()`.
- pdf_dict_put_int(dict, key, x)
- Class-aware wrapper for `::pdf_dict_put_int()`.
- pdf_dict_put_matrix(dict, key, x)
- Class-aware wrapper for `::pdf_dict_put_matrix()`.
- pdf_dict_put_name(dict, key, x)
- Class-aware wrapper for `::pdf_dict_put_name()`.
- pdf_dict_put_real(dict, key, x)
- Class-aware wrapper for `::pdf_dict_put_real()`.
- pdf_dict_put_rect(dict, key, x)
- Class-aware wrapper for `::pdf_dict_put_rect()`.
- pdf_dict_put_string(dict, key, x, n)
- Class-aware wrapper for `::pdf_dict_put_string()`.
- pdf_dict_put_text_string(dict, key, x)
- Class-aware wrapper for `::pdf_dict_put_text_string()`.
- pdf_dict_put_val_null(obj, idx)
- Class-aware wrapper for `::pdf_dict_put_val_null()`.
- pdf_dict_putl(obj, val, *tail)
- Python implementation of pdf_dict_putl(fz_context *ctx,
pdf_obj *obj, pdf_obj *val, ...) because SWIG doesn't
handle variadic args. Each item in `tail` should
be a SWIG wrapper for a `PdfObj`.
- pdf_dict_putl_drop(obj, *tail)
- pdf_dict_putp(dict, path, val)
- Class-aware wrapper for `::pdf_dict_putp()`.
- pdf_dict_puts(dict, key, val)
- Class-aware wrapper for `::pdf_dict_puts()`.
- pdf_dict_puts_dict(dict, key, initial)
- Class-aware wrapper for `::pdf_dict_puts_dict()`.
- pdf_dirty_annot(annot)
- Class-aware wrapper for `::pdf_dirty_annot()`.
- pdf_dirty_obj(obj)
- Class-aware wrapper for `::pdf_dirty_obj()`.
- pdf_disable_js(doc)
- Class-aware wrapper for `::pdf_disable_js()`.
- pdf_discard_journal(journal)
- Class-aware wrapper for `::pdf_discard_journal()`.
- pdf_doc_was_linearized(doc)
- Class-aware wrapper for `::pdf_doc_was_linearized()`.
- pdf_document_event_did_print(doc)
- Class-aware wrapper for `::pdf_document_event_did_print()`.
- pdf_document_event_did_save(doc)
- Class-aware wrapper for `::pdf_document_event_did_save()`.
- pdf_document_event_will_close(doc)
- Class-aware wrapper for `::pdf_document_event_will_close()`.
- pdf_document_event_will_print(doc)
- Class-aware wrapper for `::pdf_document_event_will_print()`.
- pdf_document_event_will_save(doc)
- Class-aware wrapper for `::pdf_document_event_will_save()`.
- pdf_document_from_fz_document(ptr)
- Class-aware wrapper for `::pdf_document_from_fz_document()`.
- pdf_document_language(doc)
- Class-aware wrapper for `::pdf_document_language()`.
- pdf_document_output_intent(doc)
- Class-aware wrapper for `::pdf_document_output_intent()`.
- pdf_document_permissions(doc)
- Class-aware wrapper for `::pdf_document_permissions()`.
- pdf_edit_text_field_value = pdf_edit_text_field_value_outparams_fn(widget, value, change)
- Class-aware helper for out-params of pdf_edit_text_field_value() [pdf_edit_text_field_value()].
- pdf_edit_text_field_value_outparams_fn(widget, value, change)
- Class-aware helper for out-params of pdf_edit_text_field_value() [pdf_edit_text_field_value()].
- pdf_empty_store(doc)
- Class-aware wrapper for `::pdf_empty_store()`.
- pdf_enable_journal(doc)
- Class-aware wrapper for `::pdf_enable_journal()`.
- pdf_enable_js(doc)
- Class-aware wrapper for `::pdf_enable_js()`.
- pdf_enable_layer(doc, layer, enabled)
- Class-aware wrapper for `::pdf_enable_layer()`.
- pdf_encrypt_data(crypt, num, gen, fmt_str_out, arg, s, n)
- Class-aware wrapper for `::pdf_encrypt_data()`.
- pdf_encrypted_len(crypt, num, gen, len)
- Class-aware wrapper for `::pdf_encrypted_len()`.
- pdf_end_hmtx(font)
- Class-aware wrapper for `::pdf_end_hmtx()`.
- pdf_end_operation(doc)
- Class-aware wrapper for `::pdf_end_operation()`.
- pdf_end_vmtx(font)
- Class-aware wrapper for `::pdf_end_vmtx()`.
- pdf_ensure_solid_xref(doc, num)
- Class-aware wrapper for `::pdf_ensure_solid_xref()`.
- pdf_eval_function = pdf_eval_function_outparams_fn(func, in_, inlen, outlen)
- Class-aware helper for out-params of pdf_eval_function() [pdf_eval_function()].
- pdf_eval_function_outparams_fn(func, in_, inlen, outlen)
- Class-aware helper for out-params of pdf_eval_function() [pdf_eval_function()].
- pdf_event_issue_alert(doc, evt)
- Class-aware wrapper for `::pdf_event_issue_alert()`.
- pdf_event_issue_exec_menu_item(doc, item)
- Class-aware wrapper for `::pdf_event_issue_exec_menu_item()`.
- pdf_event_issue_launch_url(doc, url, new_frame)
- Class-aware wrapper for `::pdf_event_issue_launch_url()`.
- pdf_event_issue_mail_doc(doc, evt)
- Class-aware wrapper for `::pdf_event_issue_mail_doc()`.
- pdf_event_issue_print(doc)
- Class-aware wrapper for `::pdf_event_issue_print()`.
- pdf_field_border_style(field)
- Class-aware wrapper for `::pdf_field_border_style()`.
- pdf_field_display(field)
- Class-aware wrapper for `::pdf_field_display()`.
- pdf_field_event_calculate(doc, field)
- Class-aware wrapper for `::pdf_field_event_calculate()`.
- pdf_field_event_format(doc, field)
- Class-aware wrapper for `::pdf_field_event_format()`.
- pdf_field_event_keystroke(doc, field, evt)
- Class-aware wrapper for `::pdf_field_event_keystroke()`.
- pdf_field_event_validate = pdf_field_event_validate_outparams_fn(doc, field, value)
- Class-aware helper for out-params of pdf_field_event_validate() [pdf_field_event_validate()].
- pdf_field_event_validate_outparams_fn(doc, field, value)
- Class-aware helper for out-params of pdf_field_event_validate() [pdf_field_event_validate()].
- pdf_field_flags(field)
- Class-aware wrapper for `::pdf_field_flags()`.
- pdf_field_label(field)
- Class-aware wrapper for `::pdf_field_label()`.
- pdf_field_reset(doc, field)
- Class-aware wrapper for `::pdf_field_reset()`.
- pdf_field_set_border_style(field, text)
- Class-aware wrapper for `::pdf_field_set_border_style()`.
- pdf_field_set_button_caption(field, text)
- Class-aware wrapper for `::pdf_field_set_button_caption()`.
- pdf_field_set_display(field, d)
- Class-aware wrapper for `::pdf_field_set_display()`.
- pdf_field_set_fill_color(field, col)
- Class-aware wrapper for `::pdf_field_set_fill_color()`.
- pdf_field_set_text_color(field, col)
- Class-aware wrapper for `::pdf_field_set_text_color()`.
- pdf_field_type(field)
- Class-aware wrapper for `::pdf_field_type()`.
- pdf_field_type_string(field)
- Class-aware wrapper for `::pdf_field_type_string()`.
- pdf_field_value(field)
- Class-aware wrapper for `::pdf_field_value()`.
- pdf_filter_annot_contents(doc, annot, options)
- Class-aware wrapper for `::pdf_filter_annot_contents()`.
- pdf_filter_page_contents(doc, page, options)
- Class-aware wrapper for `::pdf_filter_page_contents()`.
- pdf_filter_xobject_instance(old_xobj, page_res, ctm, options, cycle_up)
- Class-aware wrapper for `::pdf_filter_xobject_instance()`.
- pdf_find_font_resource(doc, type, encoding, item, key)
- Class-aware wrapper for `::pdf_find_font_resource()`.
- pdf_find_item(drop, key)
- Class-aware wrapper for `::pdf_find_item()`.
- pdf_find_version_for_obj(doc, obj)
- Class-aware wrapper for `::pdf_find_version_for_obj()`.
- pdf_first_annot(page)
- Class-aware wrapper for `::pdf_first_annot()`.
- pdf_first_widget(page)
- Class-aware wrapper for `::pdf_first_widget()`.
- pdf_flatten_inheritable_page_items(page)
- Class-aware wrapper for `::pdf_flatten_inheritable_page_items()`.
- pdf_font_cid_to_gid(fontdesc, cid)
- Class-aware wrapper for `::pdf_font_cid_to_gid()`.
- pdf_font_writing_supported(font)
- Class-aware wrapper for `::pdf_font_writing_supported()`.
- pdf_forget_xref(doc)
- Class-aware wrapper for `::pdf_forget_xref()`.
- pdf_format_date(time, s, n)
- Class-aware wrapper for `::pdf_format_date()`.
- pdf_format_write_options(buffer, buffer_len, opts)
- Class-aware wrapper for `::pdf_format_write_options()`.
- pdf_function_size(func)
- Class-aware wrapper for `::pdf_function_size()`.
- pdf_get_bound_document(obj)
- Class-aware wrapper for `::pdf_get_bound_document()`.
- pdf_get_doc_event_callback_data(doc)
- Class-aware wrapper for `::pdf_get_doc_event_callback_data()`.
- pdf_get_embedded_file_params(fs, out)
- Class-aware wrapper for `::pdf_get_embedded_file_params()`.
- pdf_get_indirect_document(obj)
- Class-aware wrapper for `::pdf_get_indirect_document()`.
- pdf_get_widget_editing_state(widget)
- Class-aware wrapper for `::pdf_get_widget_editing_state()`.
- pdf_graft_mapped_object(map, obj)
- Class-aware wrapper for `::pdf_graft_mapped_object()`.
- pdf_graft_mapped_page(map, page_to, src, page_from)
- Class-aware wrapper for `::pdf_graft_mapped_page()`.
- pdf_graft_object(dst, obj)
- Class-aware wrapper for `::pdf_graft_object()`.
- pdf_graft_page(dst, page_to, src, page_from)
- Class-aware wrapper for `::pdf_graft_page()`.
- pdf_has_permission(doc, p)
- Class-aware wrapper for `::pdf_has_permission()`.
- pdf_has_unsaved_changes(doc)
- Class-aware wrapper for `::pdf_has_unsaved_changes()`.
- pdf_has_unsaved_sigs(doc)
- Class-aware wrapper for `::pdf_has_unsaved_sigs()`.
- pdf_insert_font_resource(doc, key, obj)
- Class-aware wrapper for `::pdf_insert_font_resource()`.
- pdf_insert_page(doc, at, page)
- Class-aware wrapper for `::pdf_insert_page()`.
- pdf_invalidate_xfa(doc)
- Class-aware wrapper for `::pdf_invalidate_xfa()`.
- pdf_is_array(obj)
- Class-aware wrapper for `::pdf_is_array()`.
- pdf_is_bool(obj)
- Class-aware wrapper for `::pdf_is_bool()`.
- pdf_is_dict(obj)
- Class-aware wrapper for `::pdf_is_dict()`.
- pdf_is_embedded_file(fs)
- Class-aware wrapper for `::pdf_is_embedded_file()`.
- pdf_is_field_locked(locked, name)
- Class-aware wrapper for `::pdf_is_field_locked()`.
- pdf_is_indirect(obj)
- Class-aware wrapper for `::pdf_is_indirect()`.
- pdf_is_int(obj)
- Class-aware wrapper for `::pdf_is_int()`.
- pdf_is_jpx_image(dict)
- Class-aware wrapper for `::pdf_is_jpx_image()`.
- pdf_is_local_object(doc, obj)
- Class-aware wrapper for `::pdf_is_local_object()`.
- pdf_is_name(obj)
- Class-aware wrapper for `::pdf_is_name()`.
- pdf_is_null(obj)
- Class-aware wrapper for `::pdf_is_null()`.
- pdf_is_number(obj)
- Class-aware wrapper for `::pdf_is_number()`.
- pdf_is_ocg_hidden(doc, rdb, usage, ocg)
- Class-aware wrapper for `::pdf_is_ocg_hidden()`.
- pdf_is_real(obj)
- Class-aware wrapper for `::pdf_is_real()`.
- pdf_is_stream(obj)
- Class-aware wrapper for `::pdf_is_stream()`.
- pdf_is_string(obj)
- Class-aware wrapper for `::pdf_is_string()`.
- pdf_is_tint_colorspace(cs)
- Class-aware wrapper for `::pdf_is_tint_colorspace()`.
- pdf_js_event_init(js, target, value, willCommit)
- Class-aware wrapper for `::pdf_js_event_init()`.
- pdf_js_event_init_keystroke(js, target, evt)
- Class-aware wrapper for `::pdf_js_event_init_keystroke()`.
- pdf_js_event_result(js)
- Class-aware wrapper for `::pdf_js_event_result()`.
- pdf_js_event_result_keystroke(js, evt)
- Class-aware wrapper for `::pdf_js_event_result_keystroke()`.
- pdf_js_event_result_validate = pdf_js_event_result_validate_outparams_fn(js)
- Class-aware helper for out-params of pdf_js_event_result_validate() [pdf_js_event_result_validate()].
- pdf_js_event_result_validate_outparams_fn(js)
- Class-aware helper for out-params of pdf_js_event_result_validate() [pdf_js_event_result_validate()].
- pdf_js_event_value(js)
- Class-aware wrapper for `::pdf_js_event_value()`.
- pdf_js_execute = pdf_js_execute_outparams_fn(js, name, code)
- Class-aware helper for out-params of pdf_js_execute() [pdf_js_execute()].
- pdf_js_execute_outparams_fn(js, name, code)
- Class-aware helper for out-params of pdf_js_execute() [pdf_js_execute()].
- pdf_js_set_console(doc, console, user)
- Class-aware wrapper for `::pdf_js_set_console()`.
- pdf_js_supported(doc)
- Class-aware wrapper for `::pdf_js_supported()`.
- pdf_layer_config_info(doc, config_num, info)
- Class-aware wrapper for `::pdf_layer_config_info()`.
- pdf_layer_config_ui_info(doc, ui, info)
- Class-aware wrapper for `::pdf_layer_config_ui_info()`.
- pdf_layer_is_enabled(doc, layer)
- Class-aware wrapper for `::pdf_layer_is_enabled()`.
- pdf_layer_name(doc, layer)
- Class-aware wrapper for `::pdf_layer_name()`.
- pdf_layout_fit_text(font, lang, str, bounds)
- Class-aware wrapper for `::pdf_layout_fit_text()`.
- pdf_lex(f, lexbuf)
- Class-aware wrapper for `::pdf_lex()`.
- pdf_lex_no_string(f, lexbuf)
- Class-aware wrapper for `::pdf_lex_no_string()`.
- pdf_lexbuf_fin(lexbuf)
- Class-aware wrapper for `::pdf_lexbuf_fin()`.
- pdf_lexbuf_grow(lexbuf)
- Class-aware wrapper for `::pdf_lexbuf_grow()`.
- pdf_lexbuf_init(lexbuf, size)
- Class-aware wrapper for `::pdf_lexbuf_init()`.
- pdf_line_ending_from_name(end)
- Class-aware wrapper for `::pdf_line_ending_from_name()`.
- pdf_line_ending_from_string(end)
- Class-aware wrapper for `::pdf_line_ending_from_string()`.
- pdf_load_builtin_cmap(name)
- Class-aware wrapper for `::pdf_load_builtin_cmap()`.
- pdf_load_cmap(file)
- Class-aware wrapper for `::pdf_load_cmap()`.
- pdf_load_colorspace(obj)
- Class-aware wrapper for `::pdf_load_colorspace()`.
- pdf_load_compressed_inline_image(doc, dict, length, cstm, indexed, image)
- Class-aware wrapper for `::pdf_load_compressed_inline_image()`.
- pdf_load_default_colorspaces(doc, page)
- Class-aware wrapper for `::pdf_load_default_colorspaces()`.
- pdf_load_embedded_cmap(doc, ref)
- Class-aware wrapper for `::pdf_load_embedded_cmap()`.
- pdf_load_embedded_file_contents(fs)
- Class-aware wrapper for `::pdf_load_embedded_file_contents()`.
- pdf_load_encoding = pdf_load_encoding_outparams_fn(encoding)
- Class-aware helper for out-params of pdf_load_encoding() [pdf_load_encoding()].
- pdf_load_encoding_outparams_fn(encoding)
- Class-aware helper for out-params of pdf_load_encoding() [pdf_load_encoding()].
- pdf_load_field_name = pdf_load_field_name2(field)
- Alternative to `pdf_load_field_name()` that returns a std::string.
- pdf_load_field_name2(field)
- Alternative to `pdf_load_field_name()` that returns a std::string.
- pdf_load_function(ref, _in, out)
- Class-aware wrapper for `::pdf_load_function()`.
- pdf_load_image(doc, obj)
- Class-aware wrapper for `::pdf_load_image()`.
- pdf_load_inline_image(doc, rdb, dict, file)
- Class-aware wrapper for `::pdf_load_inline_image()`.
- pdf_load_journal(doc, filename)
- Class-aware wrapper for `::pdf_load_journal()`.
- pdf_load_link_annots(arg_0, arg_1, annots, pagenum, page_ctm)
- Class-aware wrapper for `::pdf_load_link_annots()`.
- pdf_load_links(page)
- Class-aware wrapper for `::pdf_load_links()`.
- pdf_load_name_tree(doc, which)
- Class-aware wrapper for `::pdf_load_name_tree()`.
- pdf_load_object(doc, num)
- Class-aware wrapper for `::pdf_load_object()`.
Load a given object.
This can cause xref reorganisations (solidifications etc) due to
repairs, so all held pdf_xref_entries should be considered
invalid after this call (other than the returned one).
- pdf_load_outline(doc)
- Class-aware wrapper for `::pdf_load_outline()`.
- pdf_load_page(doc, number)
- Class-aware wrapper for `::pdf_load_page()`.
- pdf_load_page_imp(doc, chapter, number)
- Class-aware wrapper for `::pdf_load_page_imp()`.
- pdf_load_page_tree(doc)
- Class-aware wrapper for `::pdf_load_page_tree()`.
- pdf_load_pattern(doc, obj)
- Class-aware wrapper for `::pdf_load_pattern()`.
- pdf_load_raw_stream(ref)
- Class-aware wrapper for `::pdf_load_raw_stream()`.
- pdf_load_raw_stream_number(doc, num)
- Class-aware wrapper for `::pdf_load_raw_stream_number()`.
- pdf_load_shading(doc, obj)
- Class-aware wrapper for `::pdf_load_shading()`.
- pdf_load_stream(ref)
- Class-aware wrapper for `::pdf_load_stream()`.
- pdf_load_stream_number(doc, num)
- Class-aware wrapper for `::pdf_load_stream_number()`.
- pdf_load_stream_or_string_as_utf8(src)
- Class-aware wrapper for `::pdf_load_stream_or_string_as_utf8()`.
- pdf_load_system_cmap(name)
- Class-aware wrapper for `::pdf_load_system_cmap()`.
- pdf_load_to_unicode = pdf_load_to_unicode_outparams_fn(doc, font, collection, cmapstm)
- Class-aware helper for out-params of pdf_load_to_unicode() [pdf_load_to_unicode()].
- pdf_load_to_unicode_outparams_fn(doc, font, collection, cmapstm)
- Class-aware helper for out-params of pdf_load_to_unicode() [pdf_load_to_unicode()].
- pdf_load_type3_glyphs(doc, fontdesc)
- Class-aware wrapper for `::pdf_load_type3_glyphs()`.
- pdf_load_unencrypted_object(doc, num)
- Class-aware wrapper for `::pdf_load_unencrypted_object()`.
- pdf_lookup_cmap(cmap, cpt)
- Class-aware wrapper for `::pdf_lookup_cmap()`.
- pdf_lookup_cmap_full = pdf_lookup_cmap_full_outparams_fn(cmap, cpt)
- Class-aware helper for out-params of pdf_lookup_cmap_full() [pdf_lookup_cmap_full()].
- pdf_lookup_cmap_full_outparams_fn(cmap, cpt)
- Class-aware helper for out-params of pdf_lookup_cmap_full() [pdf_lookup_cmap_full()].
- pdf_lookup_dest(doc, needle)
- Class-aware wrapper for `::pdf_lookup_dest()`.
- pdf_lookup_field(form, name)
- Class-aware wrapper for `::pdf_lookup_field()`.
- pdf_lookup_metadata(document, key)
- Likepsd_lookup_metadata2() but returns None on error
instead of raising exception.
- pdf_lookup_metadata2(doc, key)
- Class-aware wrapper for `::pdf_lookup_metadata2()`.
C++ alternative to `pdf_lookup_metadata()` that returns a `std::string`
or calls `fz_throw()` if not found.
- pdf_lookup_name(doc, which, needle)
- Class-aware wrapper for `::pdf_lookup_name()`.
- pdf_lookup_number(root, needle)
- Class-aware wrapper for `::pdf_lookup_number()`.
- pdf_lookup_page_number(doc, pageobj)
- Class-aware wrapper for `::pdf_lookup_page_number()`.
- pdf_lookup_page_obj(doc, needle)
- Class-aware wrapper for `::pdf_lookup_page_obj()`.
- pdf_lookup_substitute_font = pdf_lookup_substitute_font_outparams_fn(mono, serif, bold, italic)
- Class-aware helper for out-params of pdf_lookup_substitute_font() [pdf_lookup_substitute_font()].
- pdf_lookup_substitute_font_outparams_fn(mono, serif, bold, italic)
- Class-aware helper for out-params of pdf_lookup_substitute_font() [pdf_lookup_substitute_font()].
- pdf_map_one_to_many = pdf_map_one_to_many_outparams_fn(cmap, one, len)
- Class-aware helper for out-params of pdf_map_one_to_many() [pdf_map_one_to_many()].
- pdf_map_one_to_many_outparams_fn(cmap, one, len)
- Class-aware helper for out-params of pdf_map_one_to_many() [pdf_map_one_to_many()].
- pdf_map_range_to_range(cmap, srclo, srchi, dstlo)
- Class-aware wrapper for `::pdf_map_range_to_range()`.
- pdf_mark_bits_reset(marks)
- Class-aware wrapper for `::pdf_mark_bits_reset()`.
- pdf_mark_bits_set(marks, obj)
- Class-aware wrapper for `::pdf_mark_bits_set()`.
- pdf_mark_list_free(list)
- Class-aware wrapper for `::pdf_mark_list_free()`.
- pdf_mark_list_init(list)
- Class-aware wrapper for `::pdf_mark_list_init()`.
- pdf_mark_list_pop(list)
- Class-aware wrapper for `::pdf_mark_list_pop()`.
- pdf_mark_list_push(list, obj)
- Class-aware wrapper for `::pdf_mark_list_push()`.
- pdf_mark_obj(obj)
- Class-aware wrapper for `::pdf_mark_obj()`.
- pdf_mark_xref(doc)
- Class-aware wrapper for `::pdf_mark_xref()`.
- pdf_metadata(doc)
- Class-aware wrapper for `::pdf_metadata()`.
- pdf_minimize_document(doc)
- Class-aware wrapper for `::pdf_minimize_document()`.
- pdf_name_eq(a, b)
- Class-aware wrapper for `::pdf_name_eq()`.
- pdf_name_from_line_ending(end)
- Class-aware wrapper for `::pdf_name_from_line_ending()`.
- pdf_needs_password(doc)
- Class-aware wrapper for `::pdf_needs_password()`.
- pdf_new_action_from_link(doc, uri)
- Class-aware wrapper for `::pdf_new_action_from_link()`.
- pdf_new_array(doc, initialcap)
- Class-aware wrapper for `::pdf_new_array()`.
- pdf_new_buffer_processor(buffer, ahxencode)
- Class-aware wrapper for `::pdf_new_buffer_processor()`.
- pdf_new_cmap()
- Class-aware wrapper for `::pdf_new_cmap()`.
- pdf_new_color_filter(doc, chain, struct_parents, transform, options, copts)
- Class-aware wrapper for `::pdf_new_color_filter()`.
- pdf_new_date(doc, time)
- Class-aware wrapper for `::pdf_new_date()`.
- pdf_new_dest_from_link(doc, uri, is_remote)
- Class-aware wrapper for `::pdf_new_dest_from_link()`.
- pdf_new_dict(doc, initialcap)
- Class-aware wrapper for `::pdf_new_dict()`.
- pdf_new_display_list_from_annot(annot)
- Class-aware wrapper for `::pdf_new_display_list_from_annot()`.
- pdf_new_graft_map(dst)
- Class-aware wrapper for `::pdf_new_graft_map()`.
- pdf_new_identity_cmap(wmode, bytes)
- Class-aware wrapper for `::pdf_new_identity_cmap()`.
- pdf_new_indirect(doc, num, gen)
- Class-aware wrapper for `::pdf_new_indirect()`.
- pdf_new_int(i)
- Class-aware wrapper for `::pdf_new_int()`.
- pdf_new_link(page, rect, uri, obj)
- Class-aware wrapper for `::pdf_new_link()`.
- pdf_new_matrix(doc, mtx)
- Class-aware wrapper for `::pdf_new_matrix()`.
- pdf_new_name(str)
- Class-aware wrapper for `::pdf_new_name()`.
- pdf_new_output_processor(out, ahxencode)
- Class-aware wrapper for `::pdf_new_output_processor()`.
- pdf_new_pdf_device(doc, topctm, resources, contents)
- Class-aware wrapper for `::pdf_new_pdf_device()`.
- pdf_new_pixmap_from_annot(annot, ctm, cs, seps, alpha)
- Class-aware wrapper for `::pdf_new_pixmap_from_annot()`.
- pdf_new_pixmap_from_page_contents_with_separations_and_usage(page, ctm, cs, seps, alpha, usage, box)
- Class-aware wrapper for `::pdf_new_pixmap_from_page_contents_with_separations_and_usage()`.
- pdf_new_pixmap_from_page_contents_with_usage(page, ctm, cs, alpha, usage, box)
- Class-aware wrapper for `::pdf_new_pixmap_from_page_contents_with_usage()`.
- pdf_new_pixmap_from_page_with_separations_and_usage(page, ctm, cs, seps, alpha, usage, box)
- Class-aware wrapper for `::pdf_new_pixmap_from_page_with_separations_and_usage()`.
- pdf_new_pixmap_from_page_with_usage(page, ctm, cs, alpha, usage, box)
- Class-aware wrapper for `::pdf_new_pixmap_from_page_with_usage()`.
- pdf_new_processor(size)
- Class-aware wrapper for `::pdf_new_processor()`.
- pdf_new_real(f)
- Class-aware wrapper for `::pdf_new_real()`.
- pdf_new_rect(doc, rect)
- Class-aware wrapper for `::pdf_new_rect()`.
- pdf_new_run_processor(doc, dev, ctm, struct_parent, usage, gstate, default_cs, cookie)
- Class-aware wrapper for `::pdf_new_run_processor()`.
- pdf_new_sanitize_filter(doc, chain, struct_parents, transform, options, sopts)
- Class-aware wrapper for `::pdf_new_sanitize_filter()`.
- pdf_new_string(str, len)
- Class-aware wrapper for `::pdf_new_string()`.
- pdf_new_text_string(s)
- Class-aware wrapper for `::pdf_new_text_string()`.
- pdf_new_uri_from_explicit_dest(dest)
- Class-aware wrapper for `::pdf_new_uri_from_explicit_dest()`.
- pdf_new_uri_from_path_and_explicit_dest(path, dest)
- Class-aware wrapper for `::pdf_new_uri_from_path_and_explicit_dest()`.
- pdf_new_uri_from_path_and_named_dest(path, name)
- Class-aware wrapper for `::pdf_new_uri_from_path_and_named_dest()`.
- pdf_new_utf8_from_pdf_stream_obj(src)
- Class-aware wrapper for `::pdf_new_utf8_from_pdf_stream_obj()`.
- pdf_new_utf8_from_pdf_string(srcptr, srclen)
- Class-aware wrapper for `::pdf_new_utf8_from_pdf_string()`.
- pdf_new_utf8_from_pdf_string_obj(src)
- Class-aware wrapper for `::pdf_new_utf8_from_pdf_string_obj()`.
- pdf_new_xobject(doc, bbox, matrix, res, buffer)
- Class-aware wrapper for `::pdf_new_xobject()`.
- pdf_next_annot(annot)
- Class-aware wrapper for `::pdf_next_annot()`.
- pdf_next_widget(previous)
- Class-aware wrapper for `::pdf_next_widget()`.
- pdf_obj_is_dirty(obj)
- Class-aware wrapper for `::pdf_obj_is_dirty()`.
- pdf_obj_is_incremental(obj)
- Class-aware wrapper for `::pdf_obj_is_incremental()`.
- pdf_obj_marked(obj)
- Class-aware wrapper for `::pdf_obj_marked()`.
- pdf_obj_memo = pdf_obj_memo_outparams_fn(obj, bit)
- Class-aware helper for out-params of pdf_obj_memo() [pdf_obj_memo()].
- pdf_obj_memo_outparams_fn(obj, bit)
- Class-aware helper for out-params of pdf_obj_memo() [pdf_obj_memo()].
- pdf_obj_num_is_stream(doc, num)
- Class-aware wrapper for `::pdf_obj_num_is_stream()`.
- pdf_obj_parent_num(obj)
- Class-aware wrapper for `::pdf_obj_parent_num()`.
- pdf_obj_refs(ref)
- Class-aware wrapper for `::pdf_obj_refs()`.
- pdf_objcmp(a, b)
- Class-aware wrapper for `::pdf_objcmp()`.
- pdf_objcmp_deep(a, b)
- Class-aware wrapper for `::pdf_objcmp_deep()`.
- pdf_objcmp_resolve(a, b)
- Class-aware wrapper for `::pdf_objcmp_resolve()`.
- pdf_open_contents_stream(doc, obj)
- Class-aware wrapper for `::pdf_open_contents_stream()`.
- pdf_open_crypt(chain, crypt, num, gen)
- Class-aware wrapper for `::pdf_open_crypt()`.
- pdf_open_crypt_with_filter(chain, crypt, name, num, gen)
- Class-aware wrapper for `::pdf_open_crypt_with_filter()`.
- pdf_open_document(filename)
- Class-aware wrapper for `::pdf_open_document()`.
- pdf_open_document_with_stream(file)
- Class-aware wrapper for `::pdf_open_document_with_stream()`.
- pdf_open_inline_stream(doc, stmobj, length, chain, params)
- Class-aware wrapper for `::pdf_open_inline_stream()`.
- pdf_open_raw_stream(ref)
- Class-aware wrapper for `::pdf_open_raw_stream()`.
- pdf_open_raw_stream_number(doc, num)
- Class-aware wrapper for `::pdf_open_raw_stream_number()`.
- pdf_open_stream(ref)
- Class-aware wrapper for `::pdf_open_stream()`.
- pdf_open_stream_number(doc, num)
- Class-aware wrapper for `::pdf_open_stream_number()`.
- pdf_open_stream_with_offset(doc, num, dict, stm_ofs)
- Class-aware wrapper for `::pdf_open_stream_with_offset()`.
- pdf_page_contents(page)
- Class-aware wrapper for `::pdf_page_contents()`.
- pdf_page_event_close(page)
- Class-aware wrapper for `::pdf_page_event_close()`.
- pdf_page_event_open(page)
- Class-aware wrapper for `::pdf_page_event_open()`.
- pdf_page_from_fz_page(ptr)
- Class-aware wrapper for `::pdf_page_from_fz_page()`.
- pdf_page_group(page)
- Class-aware wrapper for `::pdf_page_group()`.
- pdf_page_has_transparency(page)
- Class-aware wrapper for `::pdf_page_has_transparency()`.
- pdf_page_label(doc, page, buf, size)
- Class-aware wrapper for `::pdf_page_label()`.
- pdf_page_label_imp(doc, chapter, page, buf, size)
- Class-aware wrapper for `::pdf_page_label_imp()`.
- pdf_page_obj_transform(pageobj, page_mediabox, page_ctm)
- Class-aware wrapper for `::pdf_page_obj_transform()`.
- pdf_page_obj_transform_box(pageobj, page_mediabox, page_ctm, box)
- Class-aware wrapper for `::pdf_page_obj_transform_box()`.
- pdf_page_presentation = pdf_page_presentation_outparams_fn(page, transition)
- Class-aware helper for out-params of pdf_page_presentation() [pdf_page_presentation()].
- pdf_page_presentation_outparams_fn(page, transition)
- Class-aware helper for out-params of pdf_page_presentation() [pdf_page_presentation()].
- pdf_page_resources(page)
- Class-aware wrapper for `::pdf_page_resources()`.
- pdf_page_separations(page)
- Class-aware wrapper for `::pdf_page_separations()`.
- pdf_page_transform(page, mediabox, ctm)
- Class-aware wrapper for `::pdf_page_transform()`.
- pdf_page_transform_box(page, mediabox, ctm, box)
- Class-aware wrapper for `::pdf_page_transform_box()`.
- pdf_page_write = pdf_page_write_outparams_fn(doc, mediabox)
- Class-aware helper for out-params of pdf_page_write() [pdf_page_write()].
- pdf_page_write_outparams_fn(doc, mediabox)
- Class-aware helper for out-params of pdf_page_write() [pdf_page_write()].
- pdf_parse_array(doc, f, buf)
- Class-aware wrapper for `::pdf_parse_array()`.
- pdf_parse_date(s)
- Class-aware wrapper for `::pdf_parse_date()`.
- pdf_parse_default_appearance = pdf_parse_default_appearance_outparams_fn(da, color)
- Class-aware helper for out-params of pdf_parse_default_appearance() [pdf_parse_default_appearance()].
- pdf_parse_default_appearance_outparams_fn(da, color)
- Class-aware helper for out-params of pdf_parse_default_appearance() [pdf_parse_default_appearance()].
- pdf_parse_dict(doc, f, buf)
- Class-aware wrapper for `::pdf_parse_dict()`.
- pdf_parse_ind_obj = pdf_parse_ind_obj_outparams_fn(doc, f)
- Class-aware helper for out-params of pdf_parse_ind_obj() [pdf_parse_ind_obj()].
- pdf_parse_ind_obj_outparams_fn(doc, f)
- Class-aware helper for out-params of pdf_parse_ind_obj() [pdf_parse_ind_obj()].
- pdf_parse_journal_obj = pdf_parse_journal_obj_outparams_fn(doc, stm)
- Class-aware helper for out-params of pdf_parse_journal_obj() [pdf_parse_journal_obj()].
- pdf_parse_journal_obj_outparams_fn(doc, stm)
- Class-aware helper for out-params of pdf_parse_journal_obj() [pdf_parse_journal_obj()].
- pdf_parse_stm_obj(doc, f, buf)
- Class-aware wrapper for `::pdf_parse_stm_obj()`.
- pdf_parse_write_options(opts, args)
- Class-aware wrapper for `::pdf_parse_write_options()`.
- pdf_pin_document(obj)
- Class-aware wrapper for `::pdf_pin_document()`.
- pdf_preview_signature_as_display_list(w, h, lang, signer, appearance_flags, graphic, reason, location)
- Class-aware wrapper for `::pdf_preview_signature_as_display_list()`.
- pdf_preview_signature_as_pixmap(w, h, lang, signer, appearance_flags, graphic, reason, location)
- Class-aware wrapper for `::pdf_preview_signature_as_pixmap()`.
- pdf_print_crypt(out, crypt)
- Class-aware wrapper for `::pdf_print_crypt()`.
- pdf_print_default_appearance(buf, nbuf, font, size, n, color)
- Class-aware wrapper for `::pdf_print_default_appearance()`.
- pdf_print_encrypted_obj(out, obj, tight, ascii, crypt, num, gen)
- Class-aware wrapper for `::pdf_print_encrypted_obj()`.
- pdf_print_font(out, fontdesc)
- Class-aware wrapper for `::pdf_print_font()`.
- pdf_print_obj(out, obj, tight, ascii)
- Class-aware wrapper for `::pdf_print_obj()`.
- pdf_process_annot(proc, annot, cookie)
- Class-aware wrapper for `::pdf_process_annot()`.
- pdf_process_contents = pdf_process_contents_outparams_fn(proc, doc, obj, res, cookie)
- Class-aware helper for out-params of pdf_process_contents() [pdf_process_contents()].
- pdf_process_contents_outparams_fn(proc, doc, obj, res, cookie)
- Class-aware helper for out-params of pdf_process_contents() [pdf_process_contents()].
- pdf_process_glyph(proc, doc, resources, contents)
- Class-aware wrapper for `::pdf_process_glyph()`.
- pdf_process_raw_contents(proc, doc, rdb, stmobj, cookie)
- Class-aware wrapper for `::pdf_process_raw_contents()`.
- pdf_processor_pop_resources(proc)
- Class-aware wrapper for `::pdf_processor_pop_resources()`.
- pdf_processor_push_resources(proc, res)
- Class-aware wrapper for `::pdf_processor_push_resources()`.
- pdf_progressive_advance(doc, pagenum)
- Class-aware wrapper for `::pdf_progressive_advance()`.
- pdf_purge_local_font_resources(doc)
- Class-aware wrapper for `::pdf_purge_local_font_resources()`.
- pdf_purge_locals_from_store(doc)
- Class-aware wrapper for `::pdf_purge_locals_from_store()`.
- pdf_read_journal(doc, stm)
- Class-aware wrapper for `::pdf_read_journal()`.
- pdf_recolor_shade(shade, reshade, opaque)
- Class-aware wrapper for `::pdf_recolor_shade()`.
Recolor a shade.
- pdf_redact_page(doc, page, opts)
- Class-aware wrapper for `::pdf_redact_page()`.
- pdf_redo(doc)
- Class-aware wrapper for `::pdf_redo()`.
- pdf_remove_item(drop, key)
- Class-aware wrapper for `::pdf_remove_item()`.
- pdf_repair_obj = pdf_repair_obj_outparams_fn(doc, buf)
- Class-aware helper for out-params of pdf_repair_obj() [pdf_repair_obj()].
- pdf_repair_obj_outparams_fn(doc, buf)
- Class-aware helper for out-params of pdf_repair_obj() [pdf_repair_obj()].
- pdf_repair_obj_stms(doc)
- Class-aware wrapper for `::pdf_repair_obj_stms()`.
- pdf_repair_trailer(doc)
- Class-aware wrapper for `::pdf_repair_trailer()`.
- pdf_repair_xref(doc)
- Class-aware wrapper for `::pdf_repair_xref()`.
- pdf_replace_xref(doc, entries, n)
- Class-aware wrapper for `::pdf_replace_xref()`.
- pdf_reset_form(doc, fields, exclude)
- Class-aware wrapper for `::pdf_reset_form()`.
- pdf_resolve_indirect(ref)
- Class-aware wrapper for `::pdf_resolve_indirect()`.
Resolve an indirect object (or chain of objects).
This can cause xref reorganisations (solidifications etc) due to
repairs, so all held pdf_xref_entries should be considered
invalid after this call (other than the returned one).
- pdf_resolve_indirect_chain(ref)
- Class-aware wrapper for `::pdf_resolve_indirect_chain()`.
- pdf_resolve_link = pdf_resolve_link_outparams_fn(doc, uri)
- Class-aware helper for out-params of pdf_resolve_link() [pdf_resolve_link()].
- pdf_resolve_link_outparams_fn(doc, uri)
- Class-aware helper for out-params of pdf_resolve_link() [pdf_resolve_link()].
- pdf_run_annot(annot, dev, ctm, cookie)
- Class-aware wrapper for `::pdf_run_annot()`.
- pdf_run_glyph(doc, resources, contents, dev, ctm, gstate, default_cs)
- Class-aware wrapper for `::pdf_run_glyph()`.
- pdf_run_page(page, dev, ctm, cookie)
- Class-aware wrapper for `::pdf_run_page()`.
- pdf_run_page_annots(page, dev, ctm, cookie)
- Class-aware wrapper for `::pdf_run_page_annots()`.
- pdf_run_page_annots_with_usage(page, dev, ctm, usage, cookie)
- Class-aware wrapper for `::pdf_run_page_annots_with_usage()`.
- pdf_run_page_contents(page, dev, ctm, cookie)
- Class-aware wrapper for `::pdf_run_page_contents()`.
- pdf_run_page_contents_with_usage(page, dev, ctm, usage, cookie)
- Class-aware wrapper for `::pdf_run_page_contents_with_usage()`.
- pdf_run_page_widgets(page, dev, ctm, cookie)
- Class-aware wrapper for `::pdf_run_page_widgets()`.
- pdf_run_page_widgets_with_usage(page, dev, ctm, usage, cookie)
- Class-aware wrapper for `::pdf_run_page_widgets_with_usage()`.
- pdf_run_page_with_usage(page, dev, ctm, usage, cookie)
- Class-aware wrapper for `::pdf_run_page_with_usage()`.
- pdf_sample_shade_function = pdf_sample_shade_function_outparams_fn(shade, n, funcs, t0, t1)
- Class-aware helper for out-params of pdf_sample_shade_function() [pdf_sample_shade_function()].
- pdf_sample_shade_function_outparams_fn(shade, n, funcs, t0, t1)
- Class-aware helper for out-params of pdf_sample_shade_function() [pdf_sample_shade_function()].
- pdf_save_document(doc, filename, opts)
- Class-aware wrapper for `::pdf_save_document()`.
- pdf_save_journal(doc, filename)
- Class-aware wrapper for `::pdf_save_journal()`.
- pdf_save_snapshot(doc, filename)
- Class-aware wrapper for `::pdf_save_snapshot()`.
- pdf_select_layer_config(doc, config_num)
- Class-aware wrapper for `::pdf_select_layer_config()`.
- pdf_select_layer_config_ui(doc, ui)
- Class-aware wrapper for `::pdf_select_layer_config_ui()`.
- pdf_serialise_journal(doc, out)
- Class-aware wrapper for `::pdf_serialise_journal()`.
- pdf_set_annot_active(annot, active)
- Class-aware wrapper for `::pdf_set_annot_active()`.
- pdf_set_annot_appearance(annot, appearance, state, ctm, bbox, res, contents)
- Class-aware wrapper for `::pdf_set_annot_appearance()`.
- pdf_set_annot_appearance_from_display_list(annot, appearance, state, ctm, list)
- Class-aware wrapper for `::pdf_set_annot_appearance_from_display_list()`.
- pdf_set_annot_author(annot, author)
- Class-aware wrapper for `::pdf_set_annot_author()`.
- pdf_set_annot_border(annot, width)
- Class-aware wrapper for `::pdf_set_annot_border()`.
- pdf_set_annot_border_effect(annot, effect)
- Class-aware wrapper for `::pdf_set_annot_border_effect()`.
- pdf_set_annot_border_effect_intensity(annot, intensity)
- Class-aware wrapper for `::pdf_set_annot_border_effect_intensity()`.
- pdf_set_annot_border_style(annot, style)
- Class-aware wrapper for `::pdf_set_annot_border_style()`.
- pdf_set_annot_border_width(annot, width)
- Class-aware wrapper for `::pdf_set_annot_border_width()`.
- pdf_set_annot_color(self, color)
- pdf_set_annot_contents(annot, text)
- Class-aware wrapper for `::pdf_set_annot_contents()`.
- pdf_set_annot_creation_date(annot, time)
- Class-aware wrapper for `::pdf_set_annot_creation_date()`.
- pdf_set_annot_default_appearance(annot, font, size, n, color)
- Class-aware wrapper for `::pdf_set_annot_default_appearance()`.
- pdf_set_annot_field_value(doc, widget, text, ignore_trigger_events)
- Class-aware wrapper for `::pdf_set_annot_field_value()`.
- pdf_set_annot_filespec(annot, obj)
- Class-aware wrapper for `::pdf_set_annot_filespec()`.
- pdf_set_annot_flags(annot, flags)
- Class-aware wrapper for `::pdf_set_annot_flags()`.
- pdf_set_annot_hidden_for_editing(annot, hidden)
- Class-aware wrapper for `::pdf_set_annot_hidden_for_editing()`.
- pdf_set_annot_hot(annot, hot)
- Class-aware wrapper for `::pdf_set_annot_hot()`.
- pdf_set_annot_icon_name(annot, name)
- Class-aware wrapper for `::pdf_set_annot_icon_name()`.
- pdf_set_annot_ink_list(annot, n, count, v)
- Class-aware wrapper for `::pdf_set_annot_ink_list()`.
- pdf_set_annot_interior_color(self, color)
- Python version of pdf_set_annot_color() using
pdf_set_annot_color2().
- pdf_set_annot_is_open(annot, is_open)
- Class-aware wrapper for `::pdf_set_annot_is_open()`.
- pdf_set_annot_language(annot, lang)
- Class-aware wrapper for `::pdf_set_annot_language()`.
- pdf_set_annot_line(annot, a, b)
- Class-aware wrapper for `::pdf_set_annot_line()`.
- pdf_set_annot_line_end_style(annot, e)
- Class-aware wrapper for `::pdf_set_annot_line_end_style()`.
- pdf_set_annot_line_ending_styles(annot, start_style, end_style)
- Class-aware wrapper for `::pdf_set_annot_line_ending_styles()`.
- pdf_set_annot_line_start_style(annot, s)
- Class-aware wrapper for `::pdf_set_annot_line_start_style()`.
- pdf_set_annot_modification_date(annot, time)
- Class-aware wrapper for `::pdf_set_annot_modification_date()`.
- pdf_set_annot_opacity(annot, opacity)
- Class-aware wrapper for `::pdf_set_annot_opacity()`.
- pdf_set_annot_popup(annot, rect)
- Class-aware wrapper for `::pdf_set_annot_popup()`.
- pdf_set_annot_quad_points(annot, n, qv)
- Class-aware wrapper for `::pdf_set_annot_quad_points()`.
- pdf_set_annot_quadding(annot, q)
- Class-aware wrapper for `::pdf_set_annot_quadding()`.
- pdf_set_annot_rect(annot, rect)
- Class-aware wrapper for `::pdf_set_annot_rect()`.
- pdf_set_annot_resynthesised(annot)
- Class-aware wrapper for `::pdf_set_annot_resynthesised()`.
- pdf_set_annot_stamp_image(annot, image)
- Class-aware wrapper for `::pdf_set_annot_stamp_image()`.
- pdf_set_annot_vertex(annot, i, p)
- Class-aware wrapper for `::pdf_set_annot_vertex()`.
- pdf_set_annot_vertices(annot, n, v)
- Class-aware wrapper for `::pdf_set_annot_vertices()`.
- pdf_set_choice_field_value(widget, value)
- Class-aware wrapper for `::pdf_set_choice_field_value()`.
- pdf_set_cmap_wmode(cmap, wmode)
- Class-aware wrapper for `::pdf_set_cmap_wmode()`.
- pdf_set_default_hmtx(font, w)
- Class-aware wrapper for `::pdf_set_default_hmtx()`.
- pdf_set_default_vmtx(font, y, w)
- Class-aware wrapper for `::pdf_set_default_vmtx()`.
- pdf_set_doc_event_callback(doc, event_cb, free_event_data_cb, data)
- Class-aware wrapper for `::pdf_set_doc_event_callback()`.
- pdf_set_document_language(doc, lang)
- Class-aware wrapper for `::pdf_set_document_language()`.
- pdf_set_field_value(doc, field, text, ignore_trigger_events)
- Class-aware wrapper for `::pdf_set_field_value()`.
- pdf_set_font_wmode(font, wmode)
- Class-aware wrapper for `::pdf_set_font_wmode()`.
- pdf_set_int(obj, i)
- Class-aware wrapper for `::pdf_set_int()`.
- pdf_set_layer_config_as_default(doc)
- Class-aware wrapper for `::pdf_set_layer_config_as_default()`.
- pdf_set_obj_memo(obj, bit, memo)
- Class-aware wrapper for `::pdf_set_obj_memo()`.
- pdf_set_obj_parent(obj, num)
- Class-aware wrapper for `::pdf_set_obj_parent()`.
- pdf_set_page_labels(doc, index, style, prefix, start)
- Class-aware wrapper for `::pdf_set_page_labels()`.
- pdf_set_populating_xref_trailer(doc, trailer)
- Class-aware wrapper for `::pdf_set_populating_xref_trailer()`.
- pdf_set_str_len(obj, newlen)
- Class-aware wrapper for `::pdf_set_str_len()`.
- pdf_set_text_field_value(widget, value)
- Class-aware wrapper for `::pdf_set_text_field_value()`.
- pdf_set_usecmap(cmap, usecmap)
- Class-aware wrapper for `::pdf_set_usecmap()`.
- pdf_set_widget_editing_state(widget, editing)
- Class-aware wrapper for `::pdf_set_widget_editing_state()`.
- pdf_sign_signature(widget, signer, appearance_flags, graphic, reason, location)
- Class-aware wrapper for `::pdf_sign_signature()`.
- pdf_sign_signature_with_appearance(widget, signer, date, disp_list)
- Class-aware wrapper for `::pdf_sign_signature_with_appearance()`.
- pdf_signature_appearance_signed(rect, lang, img, left_text, right_text, include_logo)
- Class-aware wrapper for `::pdf_signature_appearance_signed()`.
- pdf_signature_appearance_unsigned(rect, lang)
- Class-aware wrapper for `::pdf_signature_appearance_unsigned()`.
- pdf_signature_byte_range(doc, signature, byte_range)
- Class-aware wrapper for `::pdf_signature_byte_range()`.
- pdf_signature_contents = pdf_signature_contents_outparams_fn(doc, signature)
- Class-aware helper for out-params of pdf_signature_contents() [pdf_signature_contents()].
- pdf_signature_contents_outparams_fn(doc, signature)
- Class-aware helper for out-params of pdf_signature_contents() [pdf_signature_contents()].
- pdf_signature_drop_distinguished_name(name)
- Class-aware wrapper for `::pdf_signature_drop_distinguished_name()`.
- pdf_signature_error_description(err)
- Class-aware wrapper for `::pdf_signature_error_description()`.
- pdf_signature_format_distinguished_name(name)
- Class-aware wrapper for `::pdf_signature_format_distinguished_name()`.
- pdf_signature_hash_bytes(doc, signature)
- Class-aware wrapper for `::pdf_signature_hash_bytes()`.
- pdf_signature_incremental_change_since_signing(doc, signature)
- Class-aware wrapper for `::pdf_signature_incremental_change_since_signing()`.
- pdf_signature_info(name, dn, reason, location, date, include_labels)
- Class-aware wrapper for `::pdf_signature_info()`.
- pdf_signature_is_signed(doc, field)
- Class-aware wrapper for `::pdf_signature_is_signed()`.
- pdf_signature_set_value(doc, field, signer, stime)
- Class-aware wrapper for `::pdf_signature_set_value()`.
- pdf_sort_cmap(cmap)
- Class-aware wrapper for `::pdf_sort_cmap()`.
- pdf_sort_dict(dict)
- Class-aware wrapper for `::pdf_sort_dict()`.
- pdf_specifics(doc)
- Class-aware wrapper for `::pdf_specifics()`.
- pdf_sprint_obj = pdf_sprint_obj_outparams_fn(buf, cap, obj, tight, ascii)
- Class-aware helper for out-params of pdf_sprint_obj() [pdf_sprint_obj()].
- pdf_sprint_obj_outparams_fn(buf, cap, obj, tight, ascii)
- Class-aware helper for out-params of pdf_sprint_obj() [pdf_sprint_obj()].
- pdf_store_item(key, val, itemsize)
- Class-aware wrapper for `::pdf_store_item()`.
- pdf_string_from_annot_type(type)
- Class-aware wrapper for `::pdf_string_from_annot_type()`.
- pdf_string_from_line_ending(end)
- Class-aware wrapper for `::pdf_string_from_line_ending()`.
- pdf_text_widget_format(tw)
- Class-aware wrapper for `::pdf_text_widget_format()`.
- pdf_text_widget_max_len(tw)
- Class-aware wrapper for `::pdf_text_widget_max_len()`.
- pdf_to_bool(obj)
- Class-aware wrapper for `::pdf_to_bool()`.
- pdf_to_date(time)
- Class-aware wrapper for `::pdf_to_date()`.
- pdf_to_gen(obj)
- Class-aware wrapper for `::pdf_to_gen()`.
- pdf_to_int(obj)
- Class-aware wrapper for `::pdf_to_int()`.
- pdf_to_int64(obj)
- Class-aware wrapper for `::pdf_to_int64()`.
- pdf_to_matrix(array)
- Class-aware wrapper for `::pdf_to_matrix()`.
- pdf_to_name(obj)
- Class-aware wrapper for `::pdf_to_name()`.
- pdf_to_num(obj)
- Class-aware wrapper for `::pdf_to_num()`.
- pdf_to_quad(array, offset)
- Class-aware wrapper for `::pdf_to_quad()`.
- pdf_to_real(obj)
- Class-aware wrapper for `::pdf_to_real()`.
- pdf_to_rect(array)
- Class-aware wrapper for `::pdf_to_rect()`.
- pdf_to_str_buf(obj)
- Class-aware wrapper for `::pdf_to_str_buf()`.
- pdf_to_str_len(obj)
- Class-aware wrapper for `::pdf_to_str_len()`.
- pdf_to_string = pdf_to_string_outparams_fn(obj)
- Class-aware helper for out-params of pdf_to_string() [pdf_to_string()].
- pdf_to_string_outparams_fn(obj)
- Class-aware helper for out-params of pdf_to_string() [pdf_to_string()].
- pdf_to_text_string(obj)
- Class-aware wrapper for `::pdf_to_text_string()`.
- pdf_toggle_layer_config_ui(doc, ui)
- Class-aware wrapper for `::pdf_toggle_layer_config_ui()`.
- pdf_toggle_widget(widget)
- Class-aware wrapper for `::pdf_toggle_widget()`.
- pdf_tos_get_text(tos)
- Class-aware wrapper for `::pdf_tos_get_text()`.
- pdf_tos_make_trm(tos, text, fontdesc, cid, trm)
- Class-aware wrapper for `::pdf_tos_make_trm()`.
- pdf_tos_move_after_char(tos)
- Class-aware wrapper for `::pdf_tos_move_after_char()`.
- pdf_tos_newline(tos, leading)
- Class-aware wrapper for `::pdf_tos_newline()`.
- pdf_tos_reset(tos, render)
- Class-aware wrapper for `::pdf_tos_reset()`.
- pdf_tos_restore(tos, save)
- Class-aware wrapper for `::pdf_tos_restore()`.
- pdf_tos_save(tos, save)
- Class-aware wrapper for `::pdf_tos_save()`.
- pdf_tos_set_matrix(tos, a, b, c, d, e, f)
- Class-aware wrapper for `::pdf_tos_set_matrix()`.
- pdf_tos_translate(tos, tx, ty)
- Class-aware wrapper for `::pdf_tos_translate()`.
- pdf_trailer(doc)
- Class-aware wrapper for `::pdf_trailer()`.
- pdf_undo(doc)
- Class-aware wrapper for `::pdf_undo()`.
- pdf_undoredo_state = pdf_undoredo_state_outparams_fn(doc)
- Class-aware helper for out-params of pdf_undoredo_state() [pdf_undoredo_state()].
- pdf_undoredo_state_outparams_fn(doc)
- Class-aware helper for out-params of pdf_undoredo_state() [pdf_undoredo_state()].
- pdf_undoredo_step(doc, step)
- Class-aware wrapper for `::pdf_undoredo_step()`.
- pdf_unmark_obj(obj)
- Class-aware wrapper for `::pdf_unmark_obj()`.
- pdf_update_annot(annot)
- Class-aware wrapper for `::pdf_update_annot()`.
- pdf_update_default_colorspaces(old_cs, res)
- Class-aware wrapper for `::pdf_update_default_colorspaces()`.
- pdf_update_object(doc, num, obj)
- Class-aware wrapper for `::pdf_update_object()`.
- pdf_update_page(page)
- Class-aware wrapper for `::pdf_update_page()`.
- pdf_update_stream(doc, ref, buf, compressed)
- Class-aware wrapper for `::pdf_update_stream()`.
- pdf_update_widget(widget)
- Class-aware wrapper for `::pdf_update_widget()`.
- pdf_update_xobject(doc, xobj, bbox, mat, res, buffer)
- Class-aware wrapper for `::pdf_update_xobject()`.
- pdf_validate_change_history(doc)
- Class-aware wrapper for `::pdf_validate_change_history()`.
- pdf_validate_changes(doc, version)
- Class-aware wrapper for `::pdf_validate_changes()`.
- pdf_validate_signature(widget)
- Class-aware wrapper for `::pdf_validate_signature()`.
- pdf_verify_embedded_file_checksum(fs)
- Class-aware wrapper for `::pdf_verify_embedded_file_checksum()`.
- pdf_version(doc)
- Class-aware wrapper for `::pdf_version()`.
- pdf_walk_tree = pdf_walk_tree_outparams_fn(tree, kid_name, arrive, leave, arg)
- Class-aware helper for out-params of pdf_walk_tree() [pdf_walk_tree()].
- pdf_walk_tree_outparams_fn(tree, kid_name, arrive, leave, arg)
- Class-aware helper for out-params of pdf_walk_tree() [pdf_walk_tree()].
- pdf_was_pure_xfa(doc)
- Class-aware wrapper for `::pdf_was_pure_xfa()`.
- pdf_was_repaired(doc)
- Class-aware wrapper for `::pdf_was_repaired()`.
- pdf_widget_is_readonly(widget)
- Class-aware wrapper for `::pdf_widget_is_readonly()`.
- pdf_widget_is_signed(widget)
- Class-aware wrapper for `::pdf_widget_is_signed()`.
- pdf_widget_type(widget)
- Class-aware wrapper for `::pdf_widget_type()`.
- pdf_write_digest(out, byte_range, field, digest_offset, digest_length, signer)
- Class-aware wrapper for `::pdf_write_digest()`.
- pdf_write_document(doc, out, opts)
- Class-aware wrapper for `::pdf_write_document()`.
- pdf_write_journal(doc, out)
- Class-aware wrapper for `::pdf_write_journal()`.
- pdf_write_snapshot(doc, out)
- Class-aware wrapper for `::pdf_write_snapshot()`.
- pdf_xobject_bbox(xobj)
- Class-aware wrapper for `::pdf_xobject_bbox()`.
- pdf_xobject_colorspace(xobj)
- Class-aware wrapper for `::pdf_xobject_colorspace()`.
- pdf_xobject_isolated(xobj)
- Class-aware wrapper for `::pdf_xobject_isolated()`.
- pdf_xobject_knockout(xobj)
- Class-aware wrapper for `::pdf_xobject_knockout()`.
- pdf_xobject_matrix(xobj)
- Class-aware wrapper for `::pdf_xobject_matrix()`.
- pdf_xobject_resources(xobj)
- Class-aware wrapper for `::pdf_xobject_resources()`.
- pdf_xobject_transparency(xobj)
- Class-aware wrapper for `::pdf_xobject_transparency()`.
- pdf_xref_ensure_incremental_object(doc, num)
- Class-aware wrapper for `::pdf_xref_ensure_incremental_object()`.
- pdf_xref_ensure_local_object(doc, num)
- Class-aware wrapper for `::pdf_xref_ensure_local_object()`.
- pdf_xref_entry_map(doc, fn, arg)
- Class-aware wrapper for `::pdf_xref_entry_map()`.
- pdf_xref_is_incremental(doc, num)
- Class-aware wrapper for `::pdf_xref_is_incremental()`.
- pdf_xref_len(doc)
- Class-aware wrapper for `::pdf_xref_len()`.
- pdf_xref_obj_is_unsaved_signature(doc, obj)
- Class-aware wrapper for `::pdf_xref_obj_is_unsaved_signature()`.
- pdf_xref_remove_unsaved_signature(doc, field)
- Class-aware wrapper for `::pdf_xref_remove_unsaved_signature()`.
- pdf_xref_store_unsaved_signature(doc, field, signer)
- Class-aware wrapper for `::pdf_xref_store_unsaved_signature()`.
- pint_assign(obj, value)
- pint_value(obj)
- py_repr(x)
- py_str(x)
- python_buffer_data(PYTHON_BUFFER_DATA)
- python_memoryview_from_memory(data, size, writable)
- python_mutable_buffer_data(PYTHON_BUFFER_MUTABLE_DATA)
- raw_to_python_bytes(*args)
- reinit_singlethreaded()
- Reinitializes the MuPDF context for single-threaded use, which
is slightly faster when calling code is single threaded.
This should be called before any other use of MuPDF.
- set_diagnostic_callback(description, printfn)
- to_stdstring(s)
- to_string(*args)
- *Overload 1:*
Returns string containing a fz_aa_context's members, labelled and inside (...), using operator<<.
(Convenience overload).
|
*Overload 2:*
Returns string containing a fz_color_params's members, labelled and inside (...), using operator<<.
(Convenience overload).
|
*Overload 3:*
Returns string containing a fz_cookie's members, labelled and inside (...), using operator<<.
(Convenience overload).
|
*Overload 4:*
Returns string containing a fz_draw_options's members, labelled and inside (...), using operator<<.
(Convenience overload).
|
*Overload 5:*
Returns string containing a fz_irect's members, labelled and inside (...), using operator<<.
(Convenience overload).
|
*Overload 6:*
Returns string containing a fz_location's members, labelled and inside (...), using operator<<.
(Convenience overload).
|
*Overload 7:*
Returns string containing a fz_matrix's members, labelled and inside (...), using operator<<.
(Convenience overload).
|
*Overload 8:*
Returns string containing a fz_md5's members, labelled and inside (...), using operator<<.
(Convenience overload).
|
*Overload 9:*
Returns string containing a fz_outline_item's members, labelled and inside (...), using operator<<.
(Convenience overload).
|
*Overload 10:*
Returns string containing a fz_pdfocr_options's members, labelled and inside (...), using operator<<.
(Convenience overload).
|
*Overload 11:*
Returns string containing a fz_point's members, labelled and inside (...), using operator<<.
(Convenience overload).
|
*Overload 12:*
Returns string containing a fz_pwg_options's members, labelled and inside (...), using operator<<.
(Convenience overload).
|
*Overload 13:*
Returns string containing a fz_quad's members, labelled and inside (...), using operator<<.
(Convenience overload).
|
*Overload 14:*
Returns string containing a fz_rect's members, labelled and inside (...), using operator<<.
(Convenience overload).
|
*Overload 15:*
Returns string containing a fz_stext_options's members, labelled and inside (...), using operator<<.
(Convenience overload).
|
*Overload 16:*
Returns string containing a fz_story_element_position's members, labelled and inside (...), using operator<<.
(Convenience overload).
|
*Overload 17:*
Returns string containing a fz_transition's members, labelled and inside (...), using operator<<.
(Convenience overload).
|
*Overload 18:*
Returns string containing a pdf_filter_factory's members, labelled and inside (...), using operator<<.
(Convenience overload).
|
*Overload 19:*
Returns string containing a pdf_filter_options's members, labelled and inside (...), using operator<<.
(Convenience overload).
|
*Overload 20:*
Returns string containing a pdf_layer_config's members, labelled and inside (...), using operator<<.
(Convenience overload).
|
*Overload 21:*
Returns string containing a pdf_layer_config_ui's members, labelled and inside (...), using operator<<.
(Convenience overload).
|
*Overload 22:*
Returns string containing a pdf_redact_options's members, labelled and inside (...), using operator<<.
(Convenience overload).
|
*Overload 23:*
Returns string containing a pdf_sanitize_filter_options's members, labelled and inside (...), using operator<<.
(Convenience overload).
|
*Overload 24:*
Returns string containing a pdf_write_options's members, labelled and inside (...), using operator<<.
(Convenience overload).
- to_string_fz_aa_context(s)
- Returns string containing a fz_aa_context's members, labelled and inside (...), using operator<<.
- to_string_fz_color_params(s)
- Returns string containing a fz_color_params's members, labelled and inside (...), using operator<<.
- to_string_fz_cookie(s)
- Returns string containing a fz_cookie's members, labelled and inside (...), using operator<<.
- to_string_fz_draw_options(s)
- Returns string containing a fz_draw_options's members, labelled and inside (...), using operator<<.
- to_string_fz_irect(s)
- Returns string containing a fz_irect's members, labelled and inside (...), using operator<<.
- to_string_fz_location(s)
- Returns string containing a fz_location's members, labelled and inside (...), using operator<<.
- to_string_fz_matrix(s)
- Returns string containing a fz_matrix's members, labelled and inside (...), using operator<<.
- to_string_fz_md5(s)
- Returns string containing a fz_md5's members, labelled and inside (...), using operator<<.
- to_string_fz_outline_item(s)
- Returns string containing a fz_outline_item's members, labelled and inside (...), using operator<<.
- to_string_fz_pdfocr_options(s)
- Returns string containing a fz_pdfocr_options's members, labelled and inside (...), using operator<<.
- to_string_fz_point(s)
- Returns string containing a fz_point's members, labelled and inside (...), using operator<<.
- to_string_fz_pwg_options(s)
- Returns string containing a fz_pwg_options's members, labelled and inside (...), using operator<<.
- to_string_fz_quad(s)
- Returns string containing a fz_quad's members, labelled and inside (...), using operator<<.
- to_string_fz_rect(s)
- Returns string containing a fz_rect's members, labelled and inside (...), using operator<<.
- to_string_fz_stext_options(s)
- Returns string containing a fz_stext_options's members, labelled and inside (...), using operator<<.
- to_string_fz_story_element_position(s)
- Returns string containing a fz_story_element_position's members, labelled and inside (...), using operator<<.
- to_string_fz_transition(s)
- Returns string containing a fz_transition's members, labelled and inside (...), using operator<<.
- to_string_pdf_filter_factory(s)
- Returns string containing a pdf_filter_factory's members, labelled and inside (...), using operator<<.
- to_string_pdf_filter_options(s)
- Returns string containing a pdf_filter_options's members, labelled and inside (...), using operator<<.
- to_string_pdf_layer_config(s)
- Returns string containing a pdf_layer_config's members, labelled and inside (...), using operator<<.
- to_string_pdf_layer_config_ui(s)
- Returns string containing a pdf_layer_config_ui's members, labelled and inside (...), using operator<<.
- to_string_pdf_redact_options(s)
- Returns string containing a pdf_redact_options's members, labelled and inside (...), using operator<<.
- to_string_pdf_sanitize_filter_options(s)
- Returns string containing a pdf_sanitize_filter_options's members, labelled and inside (...), using operator<<.
- to_string_pdf_write_options(s)
- Returns string containing a pdf_write_options's members, labelled and inside (...), using operator<<.
|