diff mbox series

[FFmpeg-devel,3/2] doc/encoders: Add documentation for the GIF encoder

Message ID 20210221131227.518865-1-derek.buitenhuis@gmail.com
State Accepted
Headers show
Series GIF Palette Improvements
Related show

Checks

Context Check Description
andriy/x86_make success Make finished
andriy/x86_make_fate success Make fate finished
andriy/PPC64_make success Make finished
andriy/PPC64_make_fate success Make fate finished

Commit Message

Derek Buitenhuis Feb. 21, 2021, 1:12 p.m. UTC
Signed-off-by: Derek Buitenhuis <derek.buitenhuis@gmail.com>
---
 doc/encoders.texi | 38 ++++++++++++++++++++++++++++++++++++++
 1 file changed, 38 insertions(+)

Comments

Paul B Mahol Feb. 21, 2021, 6:58 p.m. UTC | #1
probably fine
Moritz Barsnick Feb. 21, 2021, 9:02 p.m. UTC | #2
On Sun, Feb 21, 2021 at 13:12:27 +0000, Derek Buitenhuis wrote:
> +@item global_palette @var{integer}
> +Writes a palette to the global GIF header whee feasible.
                                             ^ where

Moritz
Derek Buitenhuis Feb. 25, 2021, 5:06 p.m. UTC | #3
On 21/02/2021 21:02, Moritz Barsnick wrote:
>> +@item global_palette @var{integer}
>> +Writes a palette to the global GIF header whee feasible.
>                                              ^ where
> 


Fixed and pushed the set (+1 other small fix).

- Derek
diff mbox series

Patch

diff --git a/doc/encoders.texi b/doc/encoders.texi
index 8fb573c416..d7d81e070d 100644
--- a/doc/encoders.texi
+++ b/doc/encoders.texi
@@ -1268,6 +1268,44 @@  disabled
 A description of some of the currently available video encoders
 follows.
 
+@section GIF
+
+GIF image/animation encoder.
+
+@subsection Options
+
+@table @option
+@item gifflags @var{integer}
+Sets the flags used for GIF encoding.
+
+@table @option
+@item offsetting
+Enables picture offsetting.
+
+Default is enabled.
+
+@item transdiff
+Enables transparency detection between frames.
+
+Default is enabled.
+
+@end table
+
+@item gifimage @var{integer}
+Enables encoding one full GIF image per frame, rather than an animated GIF.
+
+Default value is @option{0}.
+
+@item global_palette @var{integer}
+Writes a palette to the global GIF header whee feasible.
+
+If disabled, every frame will always have a palette written, even if there
+is a global palette supplied.
+
+Default value is @option{1}.
+
+@end table
+
 @section Hap
 
 Vidvox Hap video encoder.