font_sdf_spread

This function is used to change the spread value of an SDF-enabled font. The spread limits how much font effects can spread from a glyph's edge.

The spread value is the distance (in pixels) that the signed distance field extends from the edge of each glyph. The spread can be between 2 and 32 pixels (inclusive), and the default is 8.

This is also useful for running custom shaders on your text, as a larger spread value will allow for effects with larger radii (such as glows). However a larger spread value will mean that the font will take up more space on the texture page. In contrast, a smaller spread value will save texture space, and also improve rendering precision.

 

Syntax:

font_sdf_spread(ind, spread);

ArgumentTypeDescription
indFont AssetThe index of the font (must be SDF-enabled)
spreadRealThe new spread value, between 2 and 32 pixels (inclusive)

 

Returns:

N/A

 

Example:

new_font = font_add("STENCIL.TTF", 32, false, false, 32, 128);
font_enable_sdf(new_font, true);
font_sdf_spread(new_font, 16);

This will load a font from an included TTF file, enable SDF for it and set its spread value to 16 pixels.