Showing the changes to DOCS (2 of 9 files). Show all
Unified · Split
| @@ -0,0 +1,6 @@ | |||
| 1 | add `--sub-border-style` and `--osd-border-style` options | ||
| 2 | the border style does not depend on `--(sub/osd)-border-color` and `--(sub/osd)-shadow-color`; now it depends solely on `--(sub/osd)-border-style` | ||
| 3 | make `--(sub/osd)-border-color` an alias of `--(sub/osd)-outline-color` | ||
| 4 | make `--(sub/osd)-border-size` an alias of `--(sub/osd)-outline-size` | ||
| 5 | make `--(sub/osd)-shadow-color` an alias of `--(sub/osd)-back-color`; they cannot both be set now | ||
| 6 | make `--osd-bar-border-size` an alias of `--osd-bar-outline-size` | ||
| @@ -2832,10 +2832,6 @@ Subtitles · 2831 unmodified lines | |||
| 2832 | 2832 | ||
| 2833 | Default: 55. | 2833 | Default: 55. |
| 2834 | 2834 | ||
| 2835 | ``--sub-back-color=<color>`` | ||
| 2836 | See ``--sub-color``. Color used for sub text background. You can use | ||
| 2837 | ``--sub-shadow-offset`` to change its size relative to the text. | ||
| 2838 | |||
| 2839 | ``--sub-blur=<0..20.0>`` | 2835 | ``--sub-blur=<0..20.0>`` |
| 2840 | Gaussian blur factor applied to the sub font border. | 2836 | Gaussian blur factor applied to the sub font border. |
| 2841 | 0 means no blur applied (default). | 2837 | 0 means no blur applied (default). |
| @@ -2846,15 +2842,48 @@ Subtitles · 4 unmodified lines | |||
| 2846 | ``--sub-italic=<yes|no>`` | 2842 | ``--sub-italic=<yes|no>`` |
| 2847 | Format text on italic. | 2843 | Format text on italic. |
| 2848 | 2844 | ||
| 2849 | ``--sub-border-color=<color>`` | 2845 | ``--sub-outline-color=<color>`` |
| 2850 | See ``--sub-color``. Color used for the sub font border. | 2846 | See ``--sub-color``. Color used for the sub font outline. |
| 2847 | |||
| 2848 | ``--sub-border-color`` is an alias for ``--sub-outline-color``. | ||
| 2849 | |||
| 2850 | ``--sub-back-color=<color>`` | ||
| 2851 | See ``--sub-color``. Color used for sub text background. | ||
| 2852 | |||
| 2853 | ``--sub-shadow-color`` is an alias for ``--sub-back-color``. | ||
| 2854 | |||
| 2855 | ``--sub-outline-size=<size>`` | ||
| 2856 | Size of the sub font outline in scaled pixels (see ``--sub-font-size`` | ||
| 2857 | for details). A value of 0 disables outlines. | ||
| 2851 | 2858 | ||
| 2852 | ``--sub-border-size=<size>`` | 2859 | ``--sub-border-size`` is an alias for ``--sub-outline-size``. |
| 2853 | Size of the sub font border in scaled pixels (see ``--sub-font-size`` | ||
| 2854 | for details). A value of 0 disables borders. | ||
| 2855 | 2860 | ||
| 2856 | Default: 3. | 2861 | Default: 3. |
| 2857 | 2862 | ||
| 2863 | ``--sub-border-style=<outline-and-shadow|opaque-box|background-box>`` | ||
| 2864 | The style of the border. | ||
| 2865 | |||
| 2866 | - ``outline-and-shadow``: draw outline and shadow. | ||
| 2867 | The size of the outline is determined by ``--sub-outline-size``, | ||
| 2868 | and the offset of the shadow is determined by ``--sub-shadow-offset``. | ||
| 2869 | The outline is colored by ``--sub-outline-color``, | ||
| 2870 | and the shadow is colored by ``--sub-back-color``. | ||
| 2871 | This corresponds to ``BorderStyle=1`` in the ASS spec. | ||
| 2872 | - ``opaque-box``: draw outline and shadow as opaque boxes that tightly wrap each lines of text. | ||
| 2873 | The margin of the outline opaque box is determined by ``--sub-outline-size``, | ||
| 2874 | and the offset of the shadow opaque box is determined by ``--sub-shadow-offset``. | ||
| 2875 | The outline opaque box is colored by ``--sub-outline-color``, | ||
| 2876 | and the shadow opaque box is colored by ``--sub-back-color``. | ||
| 2877 | Despite its name, the opaque box can be semi-transparent. | ||
| 2878 | This corresponds to ``BorderStyle=3`` in the ASS spec. | ||
| 2879 | - ``background-box``: draw a background box that bounds all lines of text. | ||
| 2880 | The background box is colored by ``--sub-back-color``, | ||
| 2881 | and the margin of the background box is determined by ``--sub-shadow-offset``. | ||
| 2882 | The behavior of the outline is the same as the ``outline-and-shadow`` style. | ||
| 2883 | This corresponds to ``BorderStyle=4``, which is a libass-specific extension. | ||
| 2884 | |||
| 2885 | Default: ``outline-and-shadow``. | ||
| 2886 | |||
| 2858 | ``--sub-color=<color>`` | 2887 | ``--sub-color=<color>`` |
| 2859 | Specify the color used for unstyled text subtitles. | 2888 | Specify the color used for unstyled text subtitles. |
| 2860 | 2889 | ||
| @@ -2924,15 +2953,6 @@ Subtitles · 63 unmodified lines | |||
| 2924 | if ``--sub-ass-override`` is not set to ``no``. | 2953 | if ``--sub-ass-override`` is not set to ``no``. |
| 2925 | Default: ``no``. | 2954 | Default: ``no``. |
| 2926 | 2955 | ||
| 2927 | ``--sub-shadow-color=<color>`` | ||
| 2928 | See ``--sub-color``. Color used for sub text shadow. | ||
| 2929 | |||
| 2930 | .. note:: | ||
| 2931 | |||
| 2932 | ignored when ``--sub-back-color`` is | ||
| 2933 | specified (or more exactly: when that option is not set to completely | ||
| 2934 | transparent). | ||
| 2935 | |||
| 2936 | ``--sub-shadow-offset=<size>`` | 2956 | ``--sub-shadow-offset=<size>`` |
| 2937 | Displacement of the sub text shadow in scaled pixels (see | 2957 | Displacement of the sub text shadow in scaled pixels (see |
| 2938 | ``--sub-font-size`` for details). A value of 0 disables shadows. | 2958 | ``--sub-font-size`` for details). A value of 0 disables shadows. |
| @@ -4411,14 +4431,13 @@ OSD · 1472 unmodified lines | |||
| 4411 | ``--osd-bar-h=<0.1-50>`` | 4431 | ``--osd-bar-h=<0.1-50>`` |
| 4412 | Height of the OSD bar, in percentage of the screen height (default: 3.125). | 4432 | Height of the OSD bar, in percentage of the screen height (default: 3.125). |
| 4413 | 4433 | ||
| 4414 | ``--osd-bar-border-size=<size>`` | 4434 | ``--osd-bar-outline-size=<size>`` |
| 4415 | Size of the border of the OSD bar in scaled pixels (see ``--sub-font-size`` | 4435 | Size of the outline of the OSD bar in scaled pixels (see ``--sub-font-size`` |
| 4416 | for details). | 4436 | for details). |
| 4417 | 4437 | ||
| 4418 | Default: 0.5. | 4438 | ``--osd-bar-border-size`` is an alias for ``--osd-bar-outline-size``. |
| 4419 | 4439 | ||
| 4420 | ``--osd-back-color=<color>`` | 4440 | Default: 0.5. |
| 4421 | See ``--sub-color``. Color used for OSD text background. | ||
| 4422 | 4441 | ||
| 4423 | ``--osd-blur=<0..20.0>`` | 4442 | ``--osd-blur=<0..20.0>`` |
| 4424 | Gaussian blur factor applied to the OSD font border. | 4443 | Gaussian blur factor applied to the OSD font border. |
| @@ -4430,15 +4449,27 @@ OSD · 5 unmodified lines | |||
| 4430 | ``--osd-italic=<yes|no>`` | 4449 | ``--osd-italic=<yes|no>`` |
| 4431 | Format text on italic. | 4450 | Format text on italic. |
| 4432 | 4451 | ||
| 4433 | ``--osd-border-color=<color>`` | 4452 | ``--osd-outline-color=<color>`` |
| 4434 | See ``--sub-color``. Color used for the OSD font border. | 4453 | See ``--sub-color``. Color used for the OSD font outline. |
| 4454 | |||
| 4455 | ``--osd-border-color`` is an alias for ``--osd-outline-color``. | ||
| 4456 | |||
| 4457 | ``--osd-back-color=<color>`` | ||
| 4458 | See ``--sub-color``. Color used for OSD text background. | ||
| 4459 | |||
| 4460 | ``--osd-shadow-color`` is an alias for ``--osd-back-color``. | ||
| 4435 | 4461 | ||
| 4436 | ``--osd-border-size=<size>`` | 4462 | ``--osd-outline-size=<size>`` |
| 4437 | Size of the OSD font border in scaled pixels (see ``--sub-font-size`` | 4463 | Size of the OSD font outline in scaled pixels (see ``--sub-font-size`` |
| 4438 | for details). A value of 0 disables borders. | 4464 | for details). A value of 0 disables outlines. |
| 4465 | |||
| 4466 | ``--osd-border-size`` is an alias for ``--osd-outline-size``. | ||
| 4439 | 4467 | ||
| 4440 | Default: 3. | 4468 | Default: 3. |
| 4441 | 4469 | ||
| 4470 | ``--osd-border-style=<outline-and-shadow|opaque-box|background-box>`` | ||
| 4471 | See ``--sub-border-style``. Style used for OSD text border. | ||
| 4472 | |||
| 4442 | ``--osd-color=<color>`` | 4473 | ``--osd-color=<color>`` |
| 4443 | Specify the color used for OSD. | 4474 | Specify the color used for OSD. |
| 4444 | See ``--sub-color`` for details. | 4475 | See ``--sub-color`` for details. |
| @@ -4495,14 +4526,6 @@ OSD · 50 unmodified lines | |||
| 4495 | respect the value of this option when deciding whether the elements | 4526 | respect the value of this option when deciding whether the elements |
| 4496 | are scaled with window size or not. | 4527 | are scaled with window size or not. |
| 4497 | 4528 | ||
| 4498 | ``--osd-shadow-color=<color>`` | ||
| 4499 | See ``--sub-color``. Color used for OSD shadow. | ||
| 4500 | |||
| 4501 | .. note:: | ||
| 4502 | |||
| 4503 | Ignored when ``--osd-back-color`` is specified (or more exactly: when | ||
| 4504 | that option is not set to completely transparent). | ||
| 4505 | |||
| 4506 | ``--osd-shadow-offset=<size>`` | 4529 | ``--osd-shadow-offset=<size>`` |
| 4507 | Displacement of the OSD shadow in scaled pixels (see | 4530 | Displacement of the OSD shadow in scaled pixels (see |
| 4508 | ``--sub-font-size`` for details). A value of 0 disables shadows. | 4531 | ``--sub-font-size`` for details). A value of 0 disables shadows. |