SceneImageOptions Class

The options of SceneImageRenderer.

public sealed class SceneImageOptions

Constructors

NameDescription
SceneImageOptions()

SceneImageOptions()

SceneImageOptions.cs
public SceneImageOptions()

No documentation is available.

Properties

NameDescription
BoldFontGets or sets the font of the bold texts (the titles), or null for SceneFonts.SansBold when SceneImageOptions.Font is not set, and SceneImageOptions.Font otherwise.
BoldItalicFontGets or sets the font of the bold italic texts, or null for SceneFonts.SansBoldItalic when SceneImageOptions.Font is not set, and otherwise SceneImageOptions.BoldFont, then SceneImageOptions.ItalicFont, then SceneImageOptions.Font.
FontGets or sets the font of the regular texts, or null for SceneFonts.Sans. The layout measures the texts with it.
FontsGets or sets the fonts of the texts, or null to use SceneImageOptions.Font, SceneImageOptions.BoldFont, SceneImageOptions.ItalicFont and SceneImageOptions.BoldItalicFont. The layout measures the texts with them, and each text is drawn with the face of its family (SceneFont.Family). The fonts of a scene (Scene.Fonts) take precedence over them.
ItalicFontGets or sets the font of the italic texts, or null for SceneFonts.SansItalic when SceneImageOptions.Font is not set, and SceneImageOptions.Font otherwise.
ScaleGets or sets the number of pixels per unit of the drawing: 2 draws a drawing of 640 by 400 as an image of 1280 by 800, for high-density screens. The default is 1.

Gets or sets the font of the bold texts (the titles), or null for SceneFonts.SansBold when SceneImageOptions.Font is not set, and SceneImageOptions.Font otherwise.

public Font? BoldFont { get; set; }

Property value

Font?

BoldItalicFont

SceneImageOptions.cs

Gets or sets the font of the bold italic texts, or null for SceneFonts.SansBoldItalic when SceneImageOptions.Font is not set, and otherwise SceneImageOptions.BoldFont, then SceneImageOptions.ItalicFont, then SceneImageOptions.Font.

public Font? BoldItalicFont { get; set; }

Property value

Font?

Gets or sets the font of the regular texts, or null for SceneFonts.Sans. The layout measures the texts with it.

public Font? Font { get; set; }

Property value

Font?

Gets or sets the fonts of the texts, or null to use SceneImageOptions.Font, SceneImageOptions.BoldFont, SceneImageOptions.ItalicFont and SceneImageOptions.BoldItalicFont. The layout measures the texts with them, and each text is drawn with the face of its family (SceneFont.Family). The fonts of a scene (Scene.Fonts) take precedence over them.

public SceneFontCollection? Fonts { get; set; }

Property value

SceneFontCollection?

Gets or sets the font of the italic texts, or null for SceneFonts.SansItalic when SceneImageOptions.Font is not set, and SceneImageOptions.Font otherwise.

public Font? ItalicFont { get; set; }

Property value

Font?

Gets or sets the number of pixels per unit of the drawing: 2 draws a drawing of 640 by 400 as an image of 1280 by 800, for high-density screens. The default is 1.

public double Scale { get; set; }

Property value

double

Exceptions

ArgumentOutOfRangeException
The value is not a positive finite number.