Skip to content

Commit

Permalink
libhydrium.h: remove incorrect documented reference to NEED_MORE_INPUT
Browse files Browse the repository at this point in the history
  • Loading branch information
Traneptora committed Apr 24, 2023
1 parent 8739afa commit 8c6e012
Showing 1 changed file with 2 additions and 2 deletions.
4 changes: 2 additions & 2 deletions src/include/libhydrium/libhydrium.h
Original file line number Diff line number Diff line change
Expand Up @@ -167,15 +167,15 @@ HYDRIUM_EXPORT HYDStatusCode hyd_provide_output_buffer(HYDEncoder *encoder, uint
* the image width and height were provided with hyd_set_metadata, hydrium will know how big these tiles should be
* and it will not overrun the buffers.
*
* If the encoded tile is fully written to the output buffer, then HYD_NEED_MORE_INPUT will be returned, and it
* If the encoded tile is fully written to the output buffer, then HYD_OK will be returned, and it
* is time to send another tile. Tiles may be sent in (almost) any order, although the lower-right-most tile must
* be sent last. When the tile in the lower right of the image is sent, it is assumed that no more tiles will be sent.
* Sending another tile after that one will result in garbage trailing data after the end of the JPEG XL file.
*
* Any tile except the last one may be left unsent, and these gaps will be populated by zeroes.
*
* If the last tile is sent and the output buffer is not full, HYD_OK is returned. Any return value other than
* HYD_NEED_MORE_INPUT, HYD_NEED_MORE_OUTPUT, or HYD_OK is an error.
* HYD_NEED_MORE_OUTPUT or HYD_OK is an error.
*
* @param encoder A HYDEncoder struct.
* @param buffer An array of three buffers of pixel data.
Expand Down

0 comments on commit 8c6e012

Please sign in to comment.