diff options
Diffstat (limited to 'include/nsgif.h')
| -rw-r--r-- | include/nsgif.h | 15 |
1 files changed, 8 insertions, 7 deletions
diff --git a/include/nsgif.h b/include/nsgif.h index 7e6aa83..7df8981 100644 --- a/include/nsgif.h +++ b/include/nsgif.h @@ -166,15 +166,14 @@ typedef enum nsgif_bitmap_fmt { /** * Client bitmap type. * - * These are client-created and destroyed, via the \ref bitmap callbacks, - * but they are owned by a \ref nsgif_t. + * These are client-created and destroyed, via the \ref nsgif_bitmap_cb_vt + * callbacks, but they are owned by a \ref nsgif_t. * * See \ref nsgif_bitmap_fmt for pixel format information. * * The bitmap may have a row_span greater than the bitmap width, but the * difference between row span and width must be a whole number of pixels - * (a multiple of four bytes). If row span is greater than width, the - * \ref get_rowspan callback must be provided. + * (a multiple of four bytes). */ typedef void nsgif_bitmap_t; @@ -238,6 +237,8 @@ typedef struct nsgif_bitmap_cb_vt { * * If this callback is not provided, LibNSGIF will use the width. * + * If row span is greater than width, this callback must be provided. + * * \param[in] bitmap The bitmap. */ uint32_t (*get_rowspan)(nsgif_bitmap_t *bitmap); @@ -485,7 +486,7 @@ void nsgif_global_palette( * Colours in same pixel format as \ref nsgif_bitmap_t. * * \param[in] gif The \ref nsgif_t object. - * \param[in] frame The \ref frame to get the palette for. + * \param[in] frame The frame to get the palette for. * \param[out] table Client buffer to hold the colour table. * \param[out] entries The number of used entries in the colour table. * \return true if a palette is returned, false otherwise. @@ -511,7 +512,7 @@ bool nsgif_local_palette( * * Both the minimum and the default values can be overridden for a given GIF * by the client. To get frame delays exactly as specified by the GIF file, set - * \ref delay_min to zero. + * `delay_min` to zero. * * Note that this does not affect the frame delay in the frame info * (\ref nsgif_frame_info_t) structure, which will always contain values @@ -520,7 +521,7 @@ bool nsgif_local_palette( * \param[in] gif The \ref nsgif_t object to configure. * \param[in] delay_min The minimum frame delay in centiseconds. * \param[in] delay_default The delay to use if a frame delay is less than - * \ref delay_min. + * `delay_min`. */ void nsgif_set_frame_delay_behaviour( nsgif_t *gif, |