Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Add option for clear type text #3846

Closed
wants to merge 1 commit into from
Closed

Add option for clear type text #3846

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 7 additions & 0 deletions src/ScottPlot5/ScottPlot5/Primitives/Label.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -32,6 +32,12 @@ public class Label
public bool AntiAliasBackground { get; set; } = true;
public bool AntiAliasText { get; set; } = true;

/// <summary>
/// To make use of ClearType text, you must also set the SKSurfaceProperties
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I believe this is something that has to be enabled on the control, and I don't like the idea of having AA flags being placed in two very different places. I think the solution is probably making some TextAntialiasType a global field which is read in both places (maybe on the Plot class?). And if necessary we can preserve some way for the user to mix unantialiased text with AA text. But I'm not convinced that the user would want something like that.

Copy link
Contributor Author

@bforlgreen bforlgreen May 19, 2024 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yes, the problem is that you have to be able to set SKSurfaceProperties when creating the SKSurface, which you can only do by implementing your own SKElement class (SKElement is implemented in SkiaSharp)

The only clean way I can see to do it would be to have a copy of the SkiaSharp SKElement class inside of the ScottPlot library itself. But appreciate you won't want to do that just for this use case.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We already use SKElement on (most of) the controls. For example, see https://github.com/ScottPlot/ScottPlot/blob/main/src/ScottPlot5/ScottPlot5%20Controls/ScottPlot.WPF/Themes/Generic.xaml

Worst case scenario, we can subclass SKElement to provide our own OnRender function (relevant code for WPF is here: https://github.com/mono/SkiaSharp/blob/main/source/SkiaSharp.Views/SkiaSharp.Views.WPF/SKElement.cs). But I'm admittedly not that pleased at the idea of duplicating most of the function just to allow a slightly different SKSurface.Create call. Granted it doesn't look like these views are changed much, but it doesn't fill me with joy. I do also see some private methods and fields which we'd need to copy-paste for this to work.

This could also be achieved by copying , but that's not ideal, one of the big benefits of ScottPlot 5 is we don't normally need to copy bitmaps between the plot and the controls.

/// of your SKSurface to be something other than SKPixelGeometry.Unknown
/// </summary>
public bool SubPixelAntiAliasText { get; set; }
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Wonder if we should make this an enum, since setting LcdRenderText to true has no effect unless paint.IsAntialias is also true.

I'm thinking something along the lines of

enum TextAntialiasType {
  None,
  Antialias,
  SubpixelAntialias,
}

Then we can set the booleans but allow a simpler API. But we'll need to keep AntiAliasText to keep backwards compatibility. I think we should use getters and setters to enforce the current behaviour (if AntiAliasText is set to true we get the current AA behaviour, if it's false we get no AA). Not sure if setting it to true while subpixel AA is on should have no effect or if it should be set to non-subpixel AA.


// TODO: use a class for cached typeface management

private SKTypeface? CachedTypeface = null;
Expand Down Expand Up @@ -170,6 +176,7 @@ private void ApplyTextPaint(SKPaint paint)
paint.TextSize = FontSize;
paint.Color = ForeColor.ToSKColor();
paint.IsAntialias = AntiAliasText;
paint.LcdRenderText = SubPixelAntiAliasText;
paint.Shader = null;
}

Expand Down
Loading