plugins.smear-cursor.settings
Options provided to the require('smear_cursor').setup function.
Type: attribute set of anything
Default:
{ }
Example:
{
distance_stop_animating = 0.5;
hide_target_hack = false;
stiffness = 0.8;
trailing_stiffness = 0.5;
}
Declared by:
plugins.smear-cursor.settings.color_levels
Minimum 1, don’t set manually if using cterm_cursor_colors.
Type: null or unsigned integer, meaning >=0, or raw lua code
Default:
null
Plugin default: 16
Declared by:
plugins.smear-cursor.settings.cterm_bg
Cterm background color.
Must set when not using legacy computing symbols.
Type: null or string or (unsigned integer, meaning >=0)
Default:
null
Plugin default: 235
Declared by:
plugins.smear-cursor.settings.cterm_cursor_colors
Cterm color gradient, from bg color (excluded) to cursor color (included).
Type: null or (list of (string or (unsigned integer, meaning >=0) or raw lua code)) or raw lua code
Default:
null
Plugin default:
[
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
]
Declared by:
plugins.smear-cursor.settings.cursor_color
Smear cursor color.
Defaults to Cursor GUI color if not set.
Set to "none" to match the text color at the target cursor position.
Type: null or string or (unsigned integer, meaning >=0)
Default:
null
Plugin default: null
Declared by:
plugins.smear-cursor.settings.delay_animation_start
After changing target position, wait before triggering animation.
Useful if the target changes and rapidly comes back to its original position.
E.g. when hitting a keybinding that triggers CmdlineEnter.
Increase if the cursor makes weird jumps when hitting keys.
The value should be expressed in milliseconds.
Type: null or unsigned integer, meaning >=0, or raw lua code
Default:
null
Plugin default: 5
Declared by:
plugins.smear-cursor.settings.distance_stop_animating
Stop animating when the smear’s tail is within this distance (in characters) from the target.
Type: null or signed integer or floating point number or raw lua code
Default:
null
Plugin default: 0.1
Declared by:
plugins.smear-cursor.settings.filetypes_disabled
List of filetypes where the plugin is disabled.
Type: null or (list of (string or raw lua code)) or raw lua code
Default:
null
Plugin default: [ ]
Declared by:
plugins.smear-cursor.settings.gamma
For color blending.
Type: null or floating point number or raw lua code
Default:
null
Plugin default: 2.2
Declared by:
plugins.smear-cursor.settings.hide_target_hack
Attempt to hide the real cursor by drawing a character below it.
Type: null or boolean or raw lua code
Default:
null
Plugin default: true
Declared by:
plugins.smear-cursor.settings.legacy_computing_symbols_support
Set to true if your font supports legacy computing symbols (block unicode symbols).
Smears will blend better on all backgrounds.
Type: null or boolean or raw lua code
Default:
null
Plugin default: false
Declared by:
plugins.smear-cursor.settings.logging_level
Log level (for debugging purposes).
Also set trailing_stiffness to 0 for debugging.
Type: null or unsigned integer, meaning >=0, or raw lua code
Default:
null
Plugin default: lib.nixvim.mkRaw "vim.log.levels.INFO"
Declared by:
plugins.smear-cursor.settings.matrix_pixel_min_factor
0: all pixels, 1: no pixel
Type: null or integer or floating point number between 0.0 and 1.0 (both inclusive) or raw lua code
Default:
null
Plugin default: 0.5
Declared by:
plugins.smear-cursor.settings.matrix_pixel_threshold
0: all pixels, 1: no pixel
Type: null or integer or floating point number between 0.0 and 1.0 (both inclusive) or raw lua code
Default:
null
Plugin default: 0.7
Declared by:
plugins.smear-cursor.settings.max_kept_windows
Number of windows that stay open for rendering.
Type: null or unsigned integer, meaning >=0, or raw lua code
Default:
null
Plugin default: 50
Declared by:
plugins.smear-cursor.settings.max_length
Maximum smear length.
Type: null or unsigned integer, meaning >=0, or raw lua code
Default:
null
Plugin default: 25
Declared by:
plugins.smear-cursor.settings.max_shade_no_matrix
0: more overhangs, 1: more matrices
Type: null or integer or floating point number between 0.0 and 1.0 (both inclusive) or raw lua code
Default:
null
Plugin default: 0.75
Declared by:
plugins.smear-cursor.settings.max_slope_horizontal
When to switch between rasterization methods.
Type: null or signed integer or floating point number or raw lua code
Default:
null
Plugin default: 0.5
Declared by:
plugins.smear-cursor.settings.min_slope_vertical
When to switch between rasterization methods.
Type: null or signed integer or floating point number or raw lua code
Default:
null
Plugin default: 2
Declared by:
plugins.smear-cursor.settings.minimum_volume_factor
0: no limit, 1: no reduction
Type: null or integer or floating point number between 0.0 and 1.0 (both inclusive) or raw lua code
Default:
null
Plugin default: 0.7
Declared by:
plugins.smear-cursor.settings.normal_bg
Background color.
Defaults to Normal GUI background color if not set.
Type: null or string or (unsigned integer, meaning >=0)
Default:
null
Plugin default: null
Declared by:
plugins.smear-cursor.settings.scroll_buffer_space
Draw the smear in buffer space instead of screen space when scrolling.
Type: null or boolean or raw lua code
Default:
null
Plugin default: true
Declared by:
plugins.smear-cursor.settings.slowdown_exponent
How much the smear slows down when getting close to the target.
< 0: less slowdown, > 0: more slowdown. Keep small, e.g. [-0.2, 0.2]
Type: null or signed integer or floating point number or raw lua code
Default:
null
Plugin default: 0
Declared by:
plugins.smear-cursor.settings.smear_between_buffers
Smear cursor when switching buffers or windows.
Type: null or boolean or raw lua code
Default:
null
Plugin default: true
Declared by:
plugins.smear-cursor.settings.smear_between_neighbor_lines
Smear cursor when moving within line or to neighbor lines.
Type: null or boolean or raw lua code
Default:
null
Plugin default: true
Declared by:
plugins.smear-cursor.settings.smear_to_cmd
Smear cursor when entering or leaving command line mode.
Type: null or boolean or raw lua code
Default:
null
Plugin default: true
Declared by:
plugins.smear-cursor.settings.stiffness
How fast the smear’s head moves towards the target.
0: no movement, 1: instantaneous
Type: null or integer or floating point number between 0.0 and 1.0 (both inclusive) or raw lua code
Default:
null
Plugin default: 0.6
Declared by:
plugins.smear-cursor.settings.time_interval
Sets animation framerate (in milliseconds).
Type: null or unsigned integer, meaning >=0, or raw lua code
Default:
null
Plugin default: 17
Declared by:
plugins.smear-cursor.settings.trailing_exponent
Controls if middle points are closer to the head or the tail.
< 1: closer to the tail, > 1: closer to the head
Type: null or signed integer or floating point number or raw lua code
Default:
null
Plugin default: 2
Declared by:
plugins.smear-cursor.settings.trailing_stiffness
How fast the smear’s tail moves towards the target.
0: no movement, 1: instantaneous
Type: null or integer or floating point number between 0.0 and 1.0 (both inclusive) or raw lua code
Default:
null
Plugin default: 0.3
Declared by:
plugins.smear-cursor.settings.transparent_bg_fallback_color
Set when the background is transparent and when not using legacy computing symbols.
Type: null or string or (unsigned integer, meaning >=0)
Default:
null
Plugin default: "303030"
Declared by:
plugins.smear-cursor.settings.vertical_bar_cursor
Set to true if your cursor is a vertical bar in normal mode.
Use with matrix_pixel_threshold = 0.3
Type: null or boolean or raw lua code
Default:
null
Plugin default: false
Declared by:
plugins.smear-cursor.settings.volume_reduction_exponent
0: no reduction, 1: full reduction
Type: null or integer or floating point number between 0.0 and 1.0 (both inclusive) or raw lua code
Default:
null
Plugin default: 0.3
Declared by:
plugins.smear-cursor.settings.windows_zindex
Adjust to have the smear appear above or below other floating windows.
Type: null or unsigned integer, meaning >=0, or raw lua code
Default:
null
Plugin default: 300
Declared by: