doc: Include Binary buffer I/O section for the byte reader/writer

This commit is contained in:
Marco Trevisan (Treviño)
2026-02-21 05:40:56 +01:00
committed by Marco Trevisan
parent 8961a5ee45
commit 9c140036e9
2 changed files with 126 additions and 0 deletions
+120
View File
@@ -134,6 +134,126 @@ fpi_line_asmbl_ctx
fpi_assemble_lines
</SECTION>
<SECTION>
<FILE>fpi-byte-reader</FILE>
<TITLE>FpiByteReader</TITLE>
FpiByteReader
fpi_byte_reader_new
fpi_byte_reader_free
fpi_byte_reader_init
fpi_byte_reader_peek_sub_reader
fpi_byte_reader_get_sub_reader
fpi_byte_reader_set_pos
fpi_byte_reader_get_pos
fpi_byte_reader_get_remaining
fpi_byte_reader_get_size
fpi_byte_reader_skip
fpi_byte_reader_get_uint8
fpi_byte_reader_get_int8
fpi_byte_reader_peek_uint8
fpi_byte_reader_peek_int8
fpi_byte_reader_get_uint16_le
fpi_byte_reader_get_int16_le
fpi_byte_reader_peek_uint16_le
fpi_byte_reader_peek_int16_le
fpi_byte_reader_get_uint16_be
fpi_byte_reader_get_int16_be
fpi_byte_reader_peek_uint16_be
fpi_byte_reader_peek_int16_be
fpi_byte_reader_get_uint24_le
fpi_byte_reader_get_int24_le
fpi_byte_reader_peek_uint24_le
fpi_byte_reader_peek_int24_le
fpi_byte_reader_get_uint24_be
fpi_byte_reader_get_int24_be
fpi_byte_reader_peek_uint24_be
fpi_byte_reader_peek_int24_be
fpi_byte_reader_get_uint32_le
fpi_byte_reader_get_int32_le
fpi_byte_reader_peek_uint32_le
fpi_byte_reader_peek_int32_le
fpi_byte_reader_get_uint32_be
fpi_byte_reader_get_int32_be
fpi_byte_reader_peek_uint32_be
fpi_byte_reader_peek_int32_be
fpi_byte_reader_get_uint64_le
fpi_byte_reader_get_int64_le
fpi_byte_reader_peek_uint64_le
fpi_byte_reader_peek_int64_le
fpi_byte_reader_get_uint64_be
fpi_byte_reader_get_int64_be
fpi_byte_reader_peek_uint64_be
fpi_byte_reader_peek_int64_be
fpi_byte_reader_get_float32_le
fpi_byte_reader_peek_float32_le
fpi_byte_reader_get_float32_be
fpi_byte_reader_peek_float32_be
fpi_byte_reader_get_float64_le
fpi_byte_reader_peek_float64_le
fpi_byte_reader_get_float64_be
fpi_byte_reader_peek_float64_be
fpi_byte_reader_get_data
fpi_byte_reader_peek_data
fpi_byte_reader_dup_data
fpi_byte_reader_masked_scan_uint32
fpi_byte_reader_masked_scan_uint32_peek
fpi_byte_reader_skip_string
fpi_byte_reader_skip_string_utf8
fpi_byte_reader_skip_string_utf16
fpi_byte_reader_skip_string_utf32
fpi_byte_reader_peek_string
fpi_byte_reader_peek_string_utf8
fpi_byte_reader_get_string_utf8
fpi_byte_reader_dup_string_utf8
fpi_byte_reader_dup_string_utf16
fpi_byte_reader_dup_string_utf32
</SECTION>
<SECTION>
<FILE>fpi-byte-writer</FILE>
<TITLE>FpiByteWriter</TITLE>
FpiByteWriter
fpi_byte_writer_new
fpi_byte_writer_new_with_size
fpi_byte_writer_new_with_data
fpi_byte_writer_init
fpi_byte_writer_init_with_size
fpi_byte_writer_init_with_data
fpi_byte_writer_reset
fpi_byte_writer_reset_and_get_data
fpi_byte_writer_free
fpi_byte_writer_free_and_get_data
fpi_byte_writer_get_remaining
fpi_byte_writer_ensure_free_space
fpi_byte_writer_put_uint8
fpi_byte_writer_put_uint16_be
fpi_byte_writer_put_uint24_be
fpi_byte_writer_put_uint32_be
fpi_byte_writer_put_uint64_be
fpi_byte_writer_put_uint16_le
fpi_byte_writer_put_uint24_le
fpi_byte_writer_put_uint32_le
fpi_byte_writer_put_uint64_le
fpi_byte_writer_put_int8
fpi_byte_writer_put_int16_be
fpi_byte_writer_put_int24_be
fpi_byte_writer_put_int32_be
fpi_byte_writer_put_int64_be
fpi_byte_writer_put_int16_le
fpi_byte_writer_put_int24_le
fpi_byte_writer_put_int32_le
fpi_byte_writer_put_int64_le
fpi_byte_writer_put_float32_be
fpi_byte_writer_put_float64_be
fpi_byte_writer_put_float32_le
fpi_byte_writer_put_float64_le
fpi_byte_writer_put_string_utf8
fpi_byte_writer_put_string_utf16
fpi_byte_writer_put_string_utf32
fpi_byte_writer_put_data
fpi_byte_writer_fill
</SECTION>
<SECTION>
<FILE>fpi-context</FILE>
fpi_get_driver_types
+6
View File
@@ -48,6 +48,12 @@
<xi:include href="xml/fpi-log.xml"/>
</chapter>
<chapter id="driver-data">
<title>Binary buffer I/O</title>
<xi:include href="xml/fpi-byte-reader.xml"/>
<xi:include href="xml/fpi-byte-writer.xml"/>
</chapter>
<chapter id="driver-img">
<title>Image manipulation</title>
<xi:include href="xml/fpi-image.xml"/>