Include additional options from the gifsicle command line #42
Conversation
|
@xanderfrangos |
|
Hi @1000ch, There are also not much of test cases for current options either 😕 |
| Type: `string`\ | ||
| Format: `widthxheight` | ||
|
|
||
| Resize the output GIF to the given width and height. If width or height is an underscore `_`, that dimension is chosen so that the aspect ratio remains unchanged. |
There was a problem hiding this comment.
It would be more user-friendly to make this an object instead, like done in #39
Then the resize method and resize colors could be nested in this object.
| ##### lossy | ||
|
|
||
| Type: `number`\ | ||
| Default: `20` |
There was a problem hiding this comment.
Should document the accepted range.
| Type: `string`\ | ||
| Default: `diversity` | ||
|
|
||
| Determine how a smaller colormap is chosen. `diversity`, the default, is xv(1)’s diversity algorithm, which uses a strict subset of the existing colors and generally produces good results. `blend-diversity` is a modification of this: some color values are blended from groups of existing colors. `median-cut` is the median cut algorithm described by Heckbert. |
There was a problem hiding this comment.
Can you linkify some of the terms here so the user can quickly read more about the various methods?
| Type: `string`\ | ||
| Default: `floyd-steinberg` | ||
|
|
||
| Specify a dithering algorithm with the optional method argument. The default, `floyd-steinberg`, uses Floyd-Steinberg error diffusion. This usually looks best, but can cause animation artifacts, because dithering choices will vary from frame to frame. Gifsicle also supports ordered dithering algorithms that avoid animation artifacts. The `ro64` mode uses a large, random-looking pattern and generally produces good results. The `o3`, `o4`, and `o8` modes use smaller, more regular patterns. The `ordered` mode chooses a good ordered dithering algorithm. For special effects, try the halftone modes `halftone`, `squarehalftone`, and `diagonal`. Some modes take optional parameters using commas. The halftone modes take a cell size and a color limit: `halftone,10,3` creates 10-pixel wide halftone cells where each cell uses up to 3 colors. |
There was a problem hiding this comment.
"Some modes"
Should document exactly which modes take arguments and what arguments they take.
I don't think halftone,10,3 is very user-friendly. {ditherMethod: ['halftone', 10, 3]} would probably be better.
|
|
||
| Set the method used to resize images. The `sample` method runs very quickly, but when shrinking images, it produces noisy results. The `mix` method is somewhat slower, but produces better-looking results. The default method is currently `mix`. | ||
|
|
||
| Other methods include `sample`, `box`, `mix`, `catrom`, `mitchell`, `lanczos2`, `lanczos3`. |
There was a problem hiding this comment.
Can you link to more info about these?
|
@sindresorhus All of the provided descriptions come verbatim from the official Gifsicle manual. I unfortunately don't have any additional information than what's there. The resize option could definitely be more user-friendly. |
I've added the following options from the gifsicle command line:
readme.md has also been updated to describe the new options.