c/libspng
1
0
Fork 0
mirror of https://github.com/randy408/libspng synced 2025-03-28 21:13:20 +00:00
Code Issues Packages Projects Releases Wiki Activity

docs: small changes to encode.md [skip-ci]

Browse Source
This commit is contained in:
Randy 2021-09-25 16:47:48 +02:00
parent 5517cc473e
commit 60bd6bc016
1 changed files with 2 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
docs/encode.md
View File

@ -3,7 +3,7 @@
The context must be created with the `SPNG_CTX_ENCODER` flag set.
Before any (implicit) write operation an output must be set with
[spng_set_png_stream()](context.md#spng_set_png_stream), [spng_set_png_file()](context.md#spng_set_png_file).
[spng_set_png_stream()](context.md#spng_set_png_stream) or [spng_set_png_file()](context.md#spng_set_png_file).
Alternatively the `SPNG_ENCODE_TO_BUFFER` option can be enabled with [spng_set_option()](context.md#spng_set_option),
in this case the encoder will create and manage an internal output buffer,
@ -16,7 +16,7 @@ In all cases the PNG must be explicitly finalized, this can be done with the `SP
On top of the overhead of the the context buffer the internal write buffer
may grow to the length of entire chunks or more than the length of
the PNG file when no output stream or file is set.
the PNG file when encoding to the internal buffer.
Encoding an image requires at least 2 rows to be kept in memory,
this may increase to 3 rows for future versions.