summaryrefslogtreecommitdiff
path: root/doc/scaler.texi
diff options
context:
space:
mode:
authorGyan Doshi <ffmpeg@gyani.pro>2019-05-17 13:02:04 +0530
committerGyan Doshi <ffmpeg@gyani.pro>2019-05-17 13:07:16 +0530
commitc3458f06f406dc20e4edbdbf808b47d167e8c2bf (patch)
tree175574f85c4886556efa764c48891dbb3443c50c /doc/scaler.texi
parent359d4e10a07d71e0706ce9550e68655fdfa30d64 (diff)
downloadffmpeg-c3458f06f406dc20e4edbdbf808b47d167e8c2bf.tar.gz
doc/scaler: indicate some options as API only.
srcw, srch, dstw, dsth, src_format and dst_format were blocked for CLI use in a0af9fd954 in order to fix ticket #4856
Diffstat (limited to 'doc/scaler.texi')
-rw-r--r--doc/scaler.texi15
1 files changed, 8 insertions, 7 deletions
diff --git a/doc/scaler.texi b/doc/scaler.texi
index f73804adfe..492e021229 100644
--- a/doc/scaler.texi
+++ b/doc/scaler.texi
@@ -5,7 +5,8 @@
The video scaler supports the following named options.
Options may be set by specifying -@var{option} @var{value} in the
-FFmpeg tools. For programmatic use, they can be set explicitly in the
+FFmpeg tools, with a few API-only exceptions noted below.
+For programmatic use, they can be set explicitly in the
@code{SwsContext} options or through the @file{libavutil/opt.h} API.
@table @option
@@ -68,22 +69,22 @@ Select full chroma input.
Enable bitexact output.
@end table
-@item srcw
+@item srcw @var{(API only)}
Set source width.
-@item srch
+@item srch @var{(API only)}
Set source height.
-@item dstw
+@item dstw @var{(API only)}
Set destination width.
-@item dsth
+@item dsth @var{(API only)}
Set destination height.
-@item src_format
+@item src_format @var{(API only)}
Set source pixel format (must be expressed as an integer).
-@item dst_format
+@item dst_format @var{(API only)}
Set destination pixel format (must be expressed as an integer).
@item src_range