Clarify value of `last_frame`

merge-requests/3/head
jonschz 2024-02-03 08:21:07 +01:00
rodzic 896ba2c60a
commit 3b3534baad
1 zmienionych plików z 7 dodań i 5 usunięć

12
api.rst
Wyświetl plik

@ -1127,11 +1127,13 @@ described in more detail in Section :numref:`sec:imageformat`.
| .. macro:: SANE_FRAME_BLUE | 4 | Blue band of a red/green/blue image. |
+-----------------------------+------+-----------------------------------------+
Member :member:`last_frame` is set to
:macro:`SANE_TRUE` if and only if the frame that is currently
being acquired (or the frame that will be acquired next if there is no
current frame) is the last frame of a multi frame image (e.g., the
current frame is the blue component of a red, green, blue image).
Member :member:`last_frame` is set to :macro:`SANE_FALSE` if and only if
the current image consists of multiple frames (e.g. separate red, green
and blue) *and* the current frame is *not* the last frame of this image
(i.e. at least one frame will follow). In particular,
:member:`last_frame` should always be set to :macro:`SANE_TRUE`
when :member:`format` is set to :macro:`SANE_FRAME_GRAY`
or :macro:`SANE_FRAME_RGB`.
Member :member:`lines` specifies how many scan lines the frame
is comprised of. If this value is -1, the number of lines is not known a