Class SvgImage

Namespace

Egami.Svg

Assembly

Egami.Svg.dll

An image: a raster drawn into a rectangle, or another SVG document drawn as a group.

public sealed record SvgImage : SvgNode, IEquatable<SvgNode>, IEquatable<SvgImage>

Inheritance

object

SvgNode

SvgImage

Implements

IEquatable<SvgNode>

IEquatable<SvgImage>

Inherited Members

SvgNode.Element

SvgNode.Id

SvgNode.Classes

SvgNode.Transform

SvgNode.Opacity

SvgNode.BlendMode

SvgNode.Isolated

SvgNode.Clip

SvgNode.Mask

SvgNode.Filter

SvgNode.Bounds

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.ReferenceEquals(object, object)

object.ToString()

Examples

// The resolved tree: groups, paths with their paints and strokes, images; styles applied and units in pixels.
static void Walk(SvgNode node, int depth)
{
    string what = node switch
    {
        SvgPath path => $"path {path.Path.Bounds} fill {path.Fill}",
        SvgGroup group => $"group of {group.Children.Count}",
        SvgImage image => $"image {image.Destination}",
        _ => node.GetType().Name,
    };
    Console.WriteLine($"{new string(' ', depth * 2)}{node.Id} {what} opacity {node.Opacity}");
    if (node is SvgGroup g)
    {
        foreach (SvgNode child in g.Children)
        {
            Walk(child, depth + 1);
        }
    }
}

Walk(document.RenderTree, 0);

Properties

ClipRect

Gets a rectangle the image is clipped to (the image element's viewport), or null.

public RectF? ClipRect { get; init; }

Property Value

RectF?

Destination

Gets where the image's view is drawn, after preserveAspectRatio, in this node's coordinates.

public RectF Destination { get; init; }

Property Value

RectF

Document

Gets the SVG document, or null for a raster image.

public SvgDocument? Document { get; init; }

Property Value

SvgDocument

Raster

Gets the raster, still encoded, or null for an SVG image.

public EncodedImage? Raster { get; init; }

Property Value

EncodedImage

Sampling

Gets how the raster is sampled (image-rendering).

public SamplingOptions? Sampling { get; init; }

Property Value

SamplingOptions

Source

Gets the part of the image drawn into Destination, in the image's pixels (or the document's user units).

public RectF Source { get; init; }

Property Value

RectF