summaryrefslogtreecommitdiffstats
path: root/docs
diff options
context:
space:
mode:
authorTomas Farago <sensej007@email.cz>2021-12-01 16:31:11 +0100
committerTomas Farago <sensej007@email.cz>2021-12-01 17:15:01 +0100
commit32f25d2f2095c13110640f27c99d0c95f2d49255 (patch)
treedd01ee8c3acfa5363764cd80debd184d0df0ea92 /docs
parent2d087e948b9976a772bedafb93fee2d92eb00cd2 (diff)
downloadufo-filters-32f25d2f2095c13110640f27c99d0c95f2d49255.tar.gz
ufo-filters-32f25d2f2095c13110640f27c99d0c95f2d49255.tar.bz2
ufo-filters-32f25d2f2095c13110640f27c99d0c95f2d49255.tar.xz
ufo-filters-32f25d2f2095c13110640f27c99d0c95f2d49255.zip
read: add image-start and image-step properties
to skip images in multi-image files. Fixes #164.
Diffstat (limited to 'docs')
-rw-r--r--docs/generators.rst8
1 files changed, 8 insertions, 0 deletions
diff --git a/docs/generators.rst b/docs/generators.rst
index 7e52fb0..9f063ab 100644
--- a/docs/generators.rst
+++ b/docs/generators.rst
@@ -34,10 +34,18 @@ File reader
First index from where files are read.
+ .. gobj:prop:: image-start:uint
+
+ First image index from where images are read in multi-image files.
+
.. gobj:prop:: step:uint
Number of files to skip.
+ .. gobj:prop:: image-step:uint
+
+ Number of images to skip in a multi-image file.
+
.. gobj:prop:: y:uint
Vertical coordinate from where to start reading.