CaptureRequest record
A request to capture the screen to a file.
public record CaptureRequestPublic Members
Section titled “Public Members”| name | description |
|---|---|
| CaptureRequest() | The default constructor. |
| ApplyReShade { get; set; } | Draw ReShade’s active effects into the photo when ReShade is available and enabled (default true). In a non-screen Aspect, techniques that use depth are skipped for this photo. When an active technique only works at screen size (SizeLocked) and the photo is not screen-sized, the photo is drawn in a separate ReShade runtime of its own size (ReShade bridge 1.1.0+; depth techniques are left out there, and a window-shaped photo notes it). If that fails, a window-shaped photo is taken at 1× instead of Scale (the result’s size says so) and a shaped photo skips that technique; either way Notes explains it. |
| Aspect { get; set; } | The photo’s shape (for example 9:16 portrait); null = the window’s own shape (the default, unchanged behaviour). The camera renders straight into a target of that shape — never a crop. Its long side is the window’s long side × Scale and the short side follows the shape (see OutputSize). The photo frames the largest rectangle of the shape centred in the on-screen view, so a frame guide drawn with GuideRect shows exactly what will be in the photo. Must be a valid shape (IsValid), or the capture fails with a readable error. |
| Directory { get; set; } | Target folder; created if missing. |
| FileStem { get; set; } | File name without extension. |
| Format { get; set; } | Output format. |
| HideDuringCapture { get; set; } | Layers hidden for the capture frame only. |
| JpgQuality { get; set; } | JPEG quality 1–100 (ignored for PNG). |
| Scale { get; set; } | Supersampling factor: 1, 2 or 4. |
See Also
Section titled “See Also”- namespace Stellar.Abstractions.Domain