Sirv.SirvImage 2.0.0

Sirv Image Transformation - .NET (C#)

A fluent builder for constructing Sirv image transformation URLs in .NET.

Requirements

• .NET 6.0 or later

Installation

Add the SirvImage.cs source file to your project, or reference the project directly.

Quick Start

using Sirv;

var url = new SirvImage("https://demo.sirv.com/photo.jpg")
    .Resize(400, 300)
    .Format("webp")
    .Quality(80)
    .ToUrl();

// https://demo.sirv.com/photo.jpg?w=400&h=300&format=webp&q=80

Constructors

From a full URL

var img = new SirvImage("https://demo.sirv.com/photo.jpg");

Any existing query parameters on the URL are preserved.

From base URL and path

var img = new SirvImage("https://demo.sirv.com", "/photos/landscape.jpg");

API Reference

All methods return the SirvImage instance for chaining. Call .ToUrl() or .ToString() to get the final URL string.

Resize

new SirvImage(url).Resize(400, 300, "fill").ToUrl();
new SirvImage(url).Width(800).ToUrl();
new SirvImage(url).Thumbnail(150).ToUrl();

Crop

new SirvImage(url).Crop(width: 300, height: 300, type: "face").ToUrl();

Rotation

new SirvImage(url).Rotate(90).Flip().ToUrl();

Format

new SirvImage(url).Format("webp").Quality(85).ToUrl();

Color Adjustments

new SirvImage(url).Brightness(10).Contrast(20).Grayscale().ToUrl();

Color Effects

new SirvImage(url).Colortone("sepia").ToUrl();
new SirvImage(url).Colorize("ff0000", 30).ToUrl();

Effects

new SirvImage(url).Blur(5).Sharpen(10).Vignette(50, "333333").ToUrl();

Text Overlays

Add text overlays with the Text method. Call multiple times for multiple layers.

var url = new SirvImage("https://demo.sirv.com/photo.jpg")
    .Text("Title", new TextOptions
    {
        Size = 48,
        Color = "ffffff",
        FontFamily = "Arial",
        FontWeight = "bold",
        Position = "center",
        PositionGravity = "north",
        BackgroundColor = "000000",
        BackgroundOpacity = 60
    })
    .Text("Subtitle", new TextOptions
    {
        Size = 24,
        Color = "cccccc",
        PositionGravity = "south"
    })
    .ToUrl();

TextOptions Properties

Watermarks

Add watermark overlays with the Watermark method. Call multiple times for multiple watermarks.

var url = new SirvImage("https://demo.sirv.com/photo.jpg")
    .Watermark("/logos/logo.png", new WatermarkOptions
    {
        Position = "southeast",
        Opacity = 70,
        Scale = "20"
    })
    .Watermark("/logos/badge.png", new WatermarkOptions
    {
        Position = "northeast",
        Width = 100
    })
    .ToUrl();

WatermarkOptions Properties

Canvas

new SirvImage(url).Canvas(new CanvasOptions
{
    Width = 800,
    Height = 600,
    Color = "f5f5f5",
    Position = "center",
    BorderWidth = 2,
    BorderColor = "000000"
}).ToUrl();

CanvasOptions Properties

Frame

new SirvImage(url).Frame(new FrameOptions
{
    Style = "solid",
    Color = "333333",
    Width = 10,
    RimColor = "ffffff",
    RimWidth = 2
}).ToUrl();

FrameOptions Properties

Other

new SirvImage("https://demo.sirv.com/doc.pdf").Page(3).Width(800).Format("jpg").ToUrl();

Method Chaining

All transformation methods return the SirvImage instance, enabling fluent chaining:

var url = new SirvImage("https://demo.sirv.com/photo.jpg")
    .Resize(800, 600, "fill")
    .Crop(width: 800, height: 600, type: "face")
    .Format("webp")
    .Quality(85)
    .Sharpen(3)
    .Brightness(5)
    .Watermark("/logos/brand.png", new WatermarkOptions { Position = "southeast", Opacity = 60 })
    .Text("Copyright", new TextOptions { Size = 14, Color = "ffffff", Opacity = 50 })
    .ToUrl();

URL Output

• .ToUrl() -- returns the complete URL as a string
• .ToString() -- override that calls ToUrl(), so you can use SirvImage directly in string interpolation

var img = new SirvImage("https://demo.sirv.com/photo.jpg").Thumbnail(200);
Console.WriteLine($"URL: {img}");

Running Tests

dotnet test

License

See the repository root for license information.