• Articles
  • API Documentation
Search Results for

    Show / Hide Table of Contents
    • SixLabors.Fonts
      • ColorFontSupport
      • Font
      • FontCollection
      • FontDescription
      • FontFamily
      • FontFamilyCollectionExtensions
      • FontInstance
      • FontRectangle
      • FontStyle
      • Glyph
      • GlyphColor
      • GlyphInstance
      • GlyphMetric
      • GlyphRendererParameters
      • GlyphType
      • HorizontalAlignment
      • IColorGlyphRenderer
      • IFontCollection
      • IFontInstance
      • IGlyphRenderer
      • IGlyphRendererExtensions
      • IReadOnlyFontCollection
      • IReadonlyFontCollectionExtensions
      • RendererOptions
      • SystemFonts
      • TextMeasurer
      • TextRenderer
      • VerticalAlignment
    • SixLabors.Fonts.Exceptions
      • FontException
      • FontFamilyNotFoundException
      • GlyphMissingException
      • InvalidFontFileException
      • InvalidFontTableException
      • MissingFontTableException

    Class RendererOptions

    The font style to render onto a peice of text.

    Inheritance
    Object
    RendererOptions
    Inherited Members
    Object.Equals(Object)
    Object.Equals(Object, Object)
    Object.GetHashCode()
    Object.GetType()
    Object.MemberwiseClone()
    Object.ReferenceEquals(Object, Object)
    Object.ToString()
    Namespace: SixLabors.Fonts
    Assembly: SixLabors.Fonts.dll
    Syntax
    public sealed class RendererOptions

    Constructors

    | Improve this Doc View Source

    RendererOptions(Font)

    Initializes a new instance of the RendererOptions class.

    Declaration
    public RendererOptions(Font font)
    Parameters
    Type Name Description
    Font font

    The font.

    | Improve this Doc View Source

    RendererOptions(Font, Vector2)

    Initializes a new instance of the RendererOptions class.

    Declaration
    public RendererOptions(Font font, Vector2 origin)
    Parameters
    Type Name Description
    Font font

    The font.

    Vector2 origin

    The origin location.

    | Improve this Doc View Source

    RendererOptions(Font, Single)

    Initializes a new instance of the RendererOptions class.

    Declaration
    public RendererOptions(Font font, float dpi)
    Parameters
    Type Name Description
    Font font

    The font.

    Single dpi

    The dpi.

    | Improve this Doc View Source

    RendererOptions(Font, Single, Vector2)

    Initializes a new instance of the RendererOptions class.

    Declaration
    public RendererOptions(Font font, float dpi, Vector2 origin)
    Parameters
    Type Name Description
    Font font

    The font.

    Single dpi

    The dpi.

    Vector2 origin

    The origin location.

    | Improve this Doc View Source

    RendererOptions(Font, Single, Single)

    Initializes a new instance of the RendererOptions class.

    Declaration
    public RendererOptions(Font font, float dpiX, float dpiY)
    Parameters
    Type Name Description
    Font font

    The font.

    Single dpiX

    The X dpi.

    Single dpiY

    The Y dpi.

    | Improve this Doc View Source

    RendererOptions(Font, Single, Single, Vector2)

    Initializes a new instance of the RendererOptions class.

    Declaration
    public RendererOptions(Font font, float dpiX, float dpiY, Vector2 origin)
    Parameters
    Type Name Description
    Font font

    The font.

    Single dpiX

    The X dpi.

    Single dpiY

    The Y dpi.

    Vector2 origin

    The origin location.

    Properties

    | Improve this Doc View Source

    ApplyKerning

    Gets or sets a value indicating whether [apply kerning].

    Declaration
    public bool ApplyKerning { get; set; }
    Property Value
    Type Description
    Boolean

    true if [apply kerning]; otherwise, false.

    | Improve this Doc View Source

    ColorFontSupport

    Gets or sets a value indicating whether we enable various color font formats.

    Declaration
    public ColorFontSupport ColorFontSupport { get; set; }
    Property Value
    Type Description
    ColorFontSupport
    | Improve this Doc View Source

    DpiX

    Gets or sets the the current X DPI to render/measure the text at.

    Declaration
    public float DpiX { get; set; }
    Property Value
    Type Description
    Single
    | Improve this Doc View Source

    DpiY

    Gets or sets the the current Ys DPI to render/measure the text at.

    Declaration
    public float DpiY { get; set; }
    Property Value
    Type Description
    Single
    | Improve this Doc View Source

    FallbackFontFamilies

    Gets or sets the collection of Fallback fontfamiles to try and use when enspecific glyph is missing.

    Declaration
    public IEnumerable<FontFamily> FallbackFontFamilies { get; set; }
    Property Value
    Type Description
    IEnumerable<FontFamily>
    | Improve this Doc View Source

    Font

    Gets the font.

    Declaration
    public Font Font { get; }
    Property Value
    Type Description
    Font

    The font.

    | Improve this Doc View Source

    HorizontalAlignment

    Gets or sets the Horizontal alignment of the text.

    Declaration
    public HorizontalAlignment HorizontalAlignment { get; set; }
    Property Value
    Type Description
    HorizontalAlignment
    | Improve this Doc View Source

    LineSpacing

    Gets or sets the line spacing. Applied as a multiple of the line height.

    Declaration
    public float LineSpacing { get; set; }
    Property Value
    Type Description
    Single
    | Improve this Doc View Source

    Origin

    Gets or sets the rendering origin.

    Declaration
    public Vector2 Origin { get; set; }
    Property Value
    Type Description
    Vector2
    | Improve this Doc View Source

    TabWidth

    Gets or sets the width of the tab.

    Declaration
    public float TabWidth { get; set; }
    Property Value
    Type Description
    Single

    The width of the tab.

    | Improve this Doc View Source

    VerticalAlignment

    Gets or sets the Vertical alignment of the text.

    Declaration
    public VerticalAlignment VerticalAlignment { get; set; }
    Property Value
    Type Description
    VerticalAlignment
    | Improve this Doc View Source

    WrappingWidth

    Gets or sets the width relative to the current DPI at which text will automatically wrap onto a newline

    Declaration
    public float WrappingWidth { get; set; }
    Property Value
    Type Description
    Single

    if value is -1 then wrapping is disabled.

    • Improve this Doc
    • View Source
    In This Article
    Back to top Generated by DocFX