summaryrefslogtreecommitdiffstats
path: root/docs/generators.rst
diff options
context:
space:
mode:
Diffstat (limited to 'docs/generators.rst')
-rw-r--r--docs/generators.rst20
1 files changed, 8 insertions, 12 deletions
diff --git a/docs/generators.rst b/docs/generators.rst
index 7e52fb0..d0925f5 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.
@@ -80,18 +88,6 @@ File reader
example, to load `.foo` files as raw files, set the ``type`` property to
`raw`.
- .. gobj:prop:: retries:uint
-
- Set the number of retries in case files do not exist yet and are being
- written. If you set this, you *must* also set ``number`` otherwise you
- would have to wait basically forever for the execution to finish. Note,
- that only files are considered which come after the last successful
- filename.
-
- .. gobj:prop:: retry-timeout:uint
-
- Seconds to wait before reading new files.
-
Memory reader
=============