diff options
| author | iantal <weanti@gmail.com> | 2025-02-11 12:38:52 +0100 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2025-02-11 12:38:52 +0100 |
| commit | cc6d0c8dedebd1bd803594fff60d58d3b81ec715 (patch) | |
| tree | c7319728c562cb8ae5eb53beed56f7977f48cee3 /src/lib | |
| parent | 44119c2db51911056e1227e46a0ea883e3d73fbf (diff) | |
code documentation updates
Diffstat (limited to 'src/lib')
| -rw-r--r-- | src/lib/openjp2/openjpeg.h | 5 |
1 files changed, 4 insertions, 1 deletions
diff --git a/src/lib/openjp2/openjpeg.h b/src/lib/openjp2/openjpeg.h index 59abd323..fe2f1ee0 100644 --- a/src/lib/openjp2/openjpeg.h +++ b/src/lib/openjp2/openjpeg.h @@ -635,6 +635,8 @@ typedef void * opj_codec_t; /* * Callback function prototype for read function + * @return returns The number of bytes delivered into + * \a p_buffer. -1 signals end of stream. */ typedef OPJ_SIZE_T(* opj_stream_read_fn)(void * p_buffer, OPJ_SIZE_T p_nb_bytes, void * p_user_data) ; @@ -1239,7 +1241,6 @@ OPJ_API void OPJ_CALLCONV opj_stream_set_user_data(opj_stream_t* p_stream, /** * Sets the length of the user data for the stream. - * * @param p_stream the stream to modify * @param data_length length of the user_data. */ @@ -1437,6 +1438,8 @@ OPJ_API OPJ_BOOL OPJ_CALLCONV opj_set_decoded_components(opj_codec_t *p_codec, * that is to say at the highest resolution level, even if requesting the image at lower * resolution levels. * + * Note: If p_start_x, p_start_y, p_end_x, p_end_y are all 0, then the whole image is decoded. + * * Generally opj_set_decode_area() should be followed by opj_decode(), and the * codec cannot be re-used. * In the particular case of an image made of a single tile, several sequences of |