From a19e389f4f353133c6ff28a89c446c8e59a5ed87 Mon Sep 17 00:00:00 2001 From: Hugo Locurcio Date: Thu, 3 Nov 2022 18:37:21 +0100 Subject: Hide Antialiasing import option on DynamicFonts with MSDF enabled Antialiasing cannot be adjusted on fonts rendered with MSDF. Internally, Godot always uses grayscale antialiasing for those fonts. This also tweaks property hints for consistency, and renames uses of "sub-pixel" to the more commonly used "subpixel". --- doc/classes/CanvasItem.xml | 2 +- doc/classes/EditorSettings.xml | 2 +- doc/classes/FontFile.xml | 2 +- doc/classes/ProjectSettings.xml | 4 ++-- doc/classes/SystemFont.xml | 2 +- doc/classes/TextServer.xml | 18 +++++++++--------- 6 files changed, 15 insertions(+), 15 deletions(-) (limited to 'doc') diff --git a/doc/classes/CanvasItem.xml b/doc/classes/CanvasItem.xml index ee09b016ac..a2859552a9 100644 --- a/doc/classes/CanvasItem.xml +++ b/doc/classes/CanvasItem.xml @@ -114,7 +114,7 @@ - Draws a textured rectangle region of the font texture with LCD sub-pixel anti-aliasing at a given position, optionally modulated by a color. + Draws a textured rectangle region of the font texture with LCD subpixel anti-aliasing at a given position, optionally modulated by a color. Texture is drawn using the following blend operation, blend mode of the [CanvasItemMaterial] is ignored: [codeblock] dst.r = texture.r * modulate.r * modulate.a + dst.r * (1.0 - texture.r * modulate.a); diff --git a/doc/classes/EditorSettings.xml b/doc/classes/EditorSettings.xml index 799bd45cee..07457387a0 100644 --- a/doc/classes/EditorSettings.xml +++ b/doc/classes/EditorSettings.xml @@ -516,7 +516,7 @@ If set to [b]Auto[/b], the font hinting mode will be set to match the current operating system in use. This means the [b]Light[/b] hinting mode will be used on Windows and Linux, and the [b]None[/b] hinting mode will be used on macOS. - The subpixel positioning mode to use when rendering editor font glyphs. This affects both the main and code fonts. [b]Disabled[/b] is the fastest to render and uses the least memory. [b]Auto[/b] only uses subpixel positioning for small font sizes (where the benefit is the most noticeable). [b]One half of a pixel[/b] and [b]One quarter of a pixel[/b] force the same subpixel positioning mode for all editor fonts, regardless of their size (with [b]One quarter of a pixel[/b] being the highest-quality option). + The subpixel positioning mode to use when rendering editor font glyphs. This affects both the main and code fonts. [b]Disabled[/b] is the fastest to render and uses the least memory. [b]Auto[/b] only uses subpixel positioning for small font sizes (where the benefit is the most noticeable). [b]One Half of a Pixel[/b] and [b]One Quarter of a Pixel[/b] force the same subpixel positioning mode for all editor fonts, regardless of their size (with [b]One Quarter of a Pixel[/b] being the highest-quality option). The amount of sleeping between frames when the low-processor usage mode is enabled (in microseconds). Higher values will result in lower CPU/GPU usage, which can improve battery life on laptops. However, higher values will result in a less responsive editor. The default value is set to allow for maximum smoothness on monitors up to 144 Hz. See also [member interface/editor/unfocused_low_processor_mode_sleep_usec]. diff --git a/doc/classes/FontFile.xml b/doc/classes/FontFile.xml index 1528045a6a..271f6a13e0 100644 --- a/doc/classes/FontFile.xml +++ b/doc/classes/FontFile.xml @@ -588,7 +588,7 @@ Font style name. - Font glyph sub-pixel positioning mode. Subpixel positioning provides shaper text and better kerning for smaller font sizes, at the cost of memory usage and font rasterization speed. Use [constant TextServer.SUBPIXEL_POSITIONING_AUTO] to automatically enable it based on the font size. + Font glyph subpixel positioning mode. Subpixel positioning provides shaper text and better kerning for smaller font sizes, at the cost of memory usage and font rasterization speed. Use [constant TextServer.SUBPIXEL_POSITIONING_AUTO] to automatically enable it based on the font size. diff --git a/doc/classes/ProjectSettings.xml b/doc/classes/ProjectSettings.xml index 376994f0b5..fae88a401b 100644 --- a/doc/classes/ProjectSettings.xml +++ b/doc/classes/ProjectSettings.xml @@ -726,14 +726,14 @@ [b]Note:[/b] This setting does not affect custom [Font]s used within the project. - Default font glyph sub-pixel positioning mode. See [member FontFile.subpixel_positioning]. + Default font glyph subpixel positioning mode. See [member FontFile.subpixel_positioning]. The default scale factor for [Control]s, when not overridden by a [Theme]. [b]Note:[/b] This property is only read when the project starts. To change the default scale at runtime, set [member ThemeDB.fallback_base_scale] instead. - LCD sub-pixel layout used for font anti-aliasing. See [enum TextServer.FontLCDSubpixelLayout]. + LCD subpixel layout used for font anti-aliasing. See [enum TextServer.FontLCDSubpixelLayout]. Timer setting for incremental search in [Tree], [ItemList], etc. controls (in milliseconds). diff --git a/doc/classes/SystemFont.xml b/doc/classes/SystemFont.xml index c235843f3b..b47d6ded7d 100644 --- a/doc/classes/SystemFont.xml +++ b/doc/classes/SystemFont.xml @@ -41,7 +41,7 @@ Font oversampling factor, if set to [code]0.0[/code] global oversampling factor is used instead. - Font glyph sub-pixel positioning mode. Subpixel positioning provides shaper text and better kerning for smaller font sizes, at the cost of memory usage and font rasterization speed. Use [constant TextServer.SUBPIXEL_POSITIONING_AUTO] to automatically enable it based on the font size. + Font glyph subpixel positioning mode. Subpixel positioning provides shaper text and better kerning for smaller font sizes, at the cost of memory usage and font rasterization speed. Use [constant TextServer.SUBPIXEL_POSITIONING_AUTO] to automatically enable it based on the font size. diff --git a/doc/classes/TextServer.xml b/doc/classes/TextServer.xml index 3682908124..f4d92ab9b6 100644 --- a/doc/classes/TextServer.xml +++ b/doc/classes/TextServer.xml @@ -380,7 +380,7 @@ - Returns font sub-pixel glyph positioning mode. + Returns font subpixel glyph positioning mode. @@ -804,7 +804,7 @@ - Sets font sub-pixel glyph positioning mode. + Sets font subpixel glyph positioning mode. @@ -1547,23 +1547,23 @@ Font glyphs are rasterized for LCD screens. - LCD sub-pixel layout is determined by the value of [code]gui/theme/lcd_subpixel_layout[/code] project settings. - LCD sub-pixel anti-aliasing mode is suitable only for rendering horizontal, unscaled text in 2D. + LCD subpixel layout is determined by the value of [code]gui/theme/lcd_subpixel_layout[/code] project settings. + LCD subpixel anti-aliasing mode is suitable only for rendering horizontal, unscaled text in 2D. - Unknown or unsupported sub-pixel layout, LCD sub-pixel anti-aliasing is disabled. + Unknown or unsupported subpixel layout, LCD subpixel antialiasing is disabled. - Horizontal RGB sub-pixel layout. + Horizontal RGB subpixel layout. - Horizontal BGR sub-pixel layout. + Horizontal BGR subpixel layout. - Vertical RGB sub-pixel layout. + Vertical RGB subpixel layout. - Vertical BGR sub-pixel layout. + Vertical BGR subpixel layout. -- cgit v1.2.3