Skip to main content
Using Deno in production at your company? Earn free Deno merch.
Give us feedback
Module

x/denops_std/option/vim/mod.ts>renderoptions

📚 Standard module for denops.vim
Go to Latest
variable renderoptions
import { renderoptions } from "https://deno.land/x/denops_std@v5.0.2/option/vim/mod.ts";

Select a text renderer and set its options. The options depend on the renderer.

Syntax:

set rop=type:{renderer}(,{name}:{value})*

Currently, only one optional renderer is available.

render behavior directx Vim will draw text using DirectX (DirectWrite). It makes drawn glyphs more beautiful than default GDI. It requires 'encoding' is "utf-8", and only works on MS-Windows Vista or newer version.

    Options:
      name      meaning             type    value
      gamma     gamma               float   1.0 - 2.2 (maybe)
      contrast  enhancedContrast    float   (unknown)
      level     clearTypeLevel      float   (unknown)
      geom      pixelGeometry       int     0 - 2 (see below)
      renmode   renderingMode       int     0 - 6 (see below)
      taamode   textAntialiasMode   int     0 - 3 (see below)
      scrlines  Scroll Lines        int     (deprecated)

    See this URL for detail (except for scrlines):
      https://msdn.microsoft.com/en-us/library/dd368190.aspx

    For geom: structure of a device pixel.
      0 - DWRITE_PIXEL_GEOMETRY_FLAT
      1 - DWRITE_PIXEL_GEOMETRY_RGB
      2 - DWRITE_PIXEL_GEOMETRY_BGR

    See this URL for detail:
      https://msdn.microsoft.com/en-us/library/dd368114.aspx

    For renmode: method of rendering glyphs.
      0 - DWRITE_RENDERING_MODE_DEFAULT
      1 - DWRITE_RENDERING_MODE_ALIASED
      2 - DWRITE_RENDERING_MODE_GDI_CLASSIC
      3 - DWRITE_RENDERING_MODE_GDI_NATURAL
      4 - DWRITE_RENDERING_MODE_NATURAL
      5 - DWRITE_RENDERING_MODE_NATURAL_SYMMETRIC
      6 - DWRITE_RENDERING_MODE_OUTLINE

    See this URL for detail:
      https://msdn.microsoft.com/en-us/library/dd368118.aspx

    For taamode: antialiasing mode used for drawing text.
      0 - D2D1_TEXT_ANTIALIAS_MODE_DEFAULT
      1 - D2D1_TEXT_ANTIALIAS_MODE_CLEARTYPE
      2 - D2D1_TEXT_ANTIALIAS_MODE_GRAYSCALE
      3 - D2D1_TEXT_ANTIALIAS_MODE_ALIASED

    See this URL for detail:
      https://msdn.microsoft.com/en-us/library/dd368170.aspx

    For scrlines:
    This was used for optimizing scrolling behavior, however this
    is now deprecated.  If specified, it is simply ignored.

    Example:

        set encoding=utf-8
        set gfn=Ricty_Diminished:h12
        set rop=type:directx

    If select a raster font (Courier, Terminal or FixedSys which
    have ".fon" extension in file name) to 'guifont', it will be
    drawn by GDI as a fallback.

    NOTE: It is known that some fonts and options combination
    causes trouble on drawing glyphs.

      - 'renmode:5' and 'renmode:6' will not work with some
        special made fonts (True-Type fonts which includes only
        bitmap glyphs).
      - 'taamode:3' will not work with some vector fonts.

    NOTE: With this option, you can display colored emoji
    (emoticon) in Windows 8.1 or later.  To display colored emoji,
    there are some conditions which you should notice.

      - If your font includes non-colored emoji already, it will
        be used.
      - If your font doesn't have emoji, the system chooses an
        alternative symbol font.  On Windows 10, "Segoe UI Emoji"
        will be used.
      - When this alternative font didn't have fixed width glyph,
        emoji might be rendered beyond the bounding box of drawing
        cell.

Other render types are currently not supported.

(default: empty)

only available when compiled with GUI and DIRECTX on MS-Windows