DevKit.Screenshot.Sharp
0.1.2
.NET 8.0
This package targets .NET 8.0. The package is compatible with this framework or higher.
.NET Standard 2.0
This package targets .NET Standard 2.0. The package is compatible with this framework or higher.
dotnet add package DevKit.Screenshot.Sharp --version 0.1.2
NuGet\Install-Package DevKit.Screenshot.Sharp -Version 0.1.2
This command is intended to be used within the Package Manager Console in Visual Studio, as it uses the NuGet module's version of Install-Package.
<PackageReference Include="DevKit.Screenshot.Sharp" Version="0.1.2" />
For projects that support PackageReference, copy this XML node into the project file to reference the package.
<PackageVersion Include="DevKit.Screenshot.Sharp" Version="0.1.2" />
<PackageReference Include="DevKit.Screenshot.Sharp" />
For projects that support Central Package Management (CPM), copy this XML node into the solution Directory.Packages.props file to version the package.
paket add DevKit.Screenshot.Sharp --version 0.1.2
The NuGet Team does not provide support for this client. Please contact its maintainers for support.
#r "nuget: DevKit.Screenshot.Sharp, 0.1.2"
#r directive can be used in F# Interactive and Polyglot Notebooks. Copy this into the interactive tool or source code of the script to reference the package.
#:package DevKit.Screenshot.Sharp@0.1.2
#:package directive can be used in C# file-based apps starting in .NET 10 preview 4. Copy this into a .cs file before any lines of code to reference the package.
#addin nuget:?package=DevKit.Screenshot.Sharp&version=0.1.2
#tool nuget:?package=DevKit.Screenshot.Sharp&version=0.1.2
The NuGet Team does not provide support for this client. Please contact its maintainers for support.
DevKit.Screenshot.Sharp
Framework-agnostic contract for capturing app-window screenshots — built for CI pipelines, visual testing and dev tooling. Pair it with an implementation package:
| Package | Framework |
|---|---|
DevKit.Screenshot.Avalonia.Sharp |
Avalonia 12 |
DevKit.Screenshot.WinUi3.Sharp |
WinUI 3 (Windows App SDK) |
What's inside
public interface IScreenshot
{
Task<ScreenshotResult> CaptureMainWindowAsync(
ScreenshotOptions options, CancellationToken cancellationToken = default);
}
public sealed class ScreenshotOptions
{
public string? OutputPath { get; init; } // PNG path
public bool CopyToClipboard { get; init; } // system clipboard instead of file
public TimeSpan Delay { get; init; } // settle delay, default 150 ms
public bool ExitAfterCapture { get; init; } // used by AttachScreenshot hooks
public bool IsEnabled { get; }
}
public readonly record struct ScreenshotResult(
string? OutputPath, int PixelWidth, int PixelHeight, bool CopiedToClipboard = false);
CLI parsing
ScreenshotArgs.ParseAndRemove(ref args) understands the switch family below and removes the
tokens from args, so your app never sees them:
| Switch | Meaning |
|---|---|
--devkit-screenshot <path> |
enable capture, write PNG to <path> |
--devkit-screenshot-clipboard |
enable capture, copy PNG to the system clipboard |
--devkit-screenshot-exit |
close the app after the capture |
--devkit-screenshot-delay <ms> |
settle delay before capture (default 150) |
var options = ScreenshotArgs.ParseAndRemove(ref args);
Capture failures in the AttachScreenshot hooks exit with code
ScreenshotExitCodes.CaptureFailed (70), so CI can tell "no screenshot" from success.
Part of the DevKit.Sharp family. MIT licensed.
| Product | Versions Compatible and additional computed target framework versions. |
|---|---|
| .NET | net5.0 was computed. net5.0-windows was computed. net6.0 was computed. net6.0-android was computed. net6.0-ios was computed. net6.0-maccatalyst was computed. net6.0-macos was computed. net6.0-tvos was computed. net6.0-windows was computed. net7.0 was computed. net7.0-android was computed. net7.0-ios was computed. net7.0-maccatalyst was computed. net7.0-macos was computed. net7.0-tvos was computed. net7.0-windows was computed. net8.0 is compatible. net8.0-android was computed. net8.0-browser was computed. net8.0-ios was computed. net8.0-maccatalyst was computed. net8.0-macos was computed. net8.0-tvos was computed. net8.0-windows was computed. net9.0 was computed. net9.0-android was computed. net9.0-browser was computed. net9.0-ios was computed. net9.0-maccatalyst was computed. net9.0-macos was computed. net9.0-tvos was computed. net9.0-windows was computed. net10.0 was computed. net10.0-android was computed. net10.0-browser was computed. net10.0-ios was computed. net10.0-maccatalyst was computed. net10.0-macos was computed. net10.0-tvos was computed. net10.0-windows was computed. |
| .NET Core | netcoreapp2.0 was computed. netcoreapp2.1 was computed. netcoreapp2.2 was computed. netcoreapp3.0 was computed. netcoreapp3.1 was computed. |
| .NET Standard | netstandard2.0 is compatible. netstandard2.1 was computed. |
| .NET Framework | net461 was computed. net462 was computed. net463 was computed. net47 was computed. net471 was computed. net472 was computed. net48 was computed. net481 was computed. |
| MonoAndroid | monoandroid was computed. |
| MonoMac | monomac was computed. |
| MonoTouch | monotouch was computed. |
| Tizen | tizen40 was computed. tizen60 was computed. |
| Xamarin.iOS | xamarinios was computed. |
| Xamarin.Mac | xamarinmac was computed. |
| Xamarin.TVOS | xamarintvos was computed. |
| Xamarin.WatchOS | xamarinwatchos was computed. |
Compatible target framework(s)
Included target framework(s) (in package)
Learn more about Target Frameworks and .NET Standard.
-
.NETStandard 2.0
- No dependencies.
-
net8.0
- No dependencies.
NuGet packages (2)
Showing the top 2 NuGet packages that depend on DevKit.Screenshot.Sharp:
| Package | Downloads |
|---|---|
|
DevKit.Screenshot.Avalonia.Sharp
Main-window screenshot capture for Avalonia apps: AttachScreenshot one-liner for CI captures driven by --devkit-screenshot, plus IScreenshot and VisualScreenshotCapture for arbitrary elements. |
|
|
DevKit.Screenshot.WinUi3.Sharp
Main-window screenshot capture for WinUI 3 apps: AttachScreenshot one-liner for CI captures driven by --devkit-screenshot, plus IScreenshot and ElementScreenshotCapture for arbitrary elements. |
GitHub repositories
This package is not used by any popular GitHub repositories.