Class ImageProcessingOptions
Specifies the options for processing images with an ImageProcessor.
Implements
Namespace: FulcrumFS.Images
Assembly: FulcrumFS.Images.dll
Syntax
public sealed record ImageProcessingOptions : IEquatable<ImageProcessingOptions>Properties
| Name | Description |
|---|---|
| BackgroundColor | Gets or initializes the background color to use for the image. Default is white |
| CompressionLevel | Gets or initializes the compression level to use when encoding images. This setting only affects the computational effort of compression (and thus the resulting file size), not the visual quality. The setting has no effect on formats that do not support compression. The default setting is High. |
| Formats | Gets or initializes the collection of image format mappings. |
| MaxFrames | Gets or initializes the maximum number of frames to process in a multi-frame image (e.g., animated GIFs). Default is MaxValue, meaning all frames will be processed. |
| MetadataStrippingMode | Gets or initializes the metadata stripping mode. Default is ThumbnailOnly. |
| Preserve | Gets an options instance that maps all supported image formats to themselves, preserving the original format the source image. All remaining options are left to their default values. |
| Quality | Gets or initializes the quality setting to use when encoding images. This setting has no effect on lossless formats. When source image quality can be determined, the result quality is capped to the source quality to avoid unnecessarily increasing file size. The default setting is High. |
| ReencodeMode | Gets or initializes the mode for re-encoding images. Default setting is SelectSmallest. |
| ReorientMode | Gets or initializes a value indicating if the image should be reoriented to normal orientation based on its EXIF data. Default is None. |
| Resize | Gets or initializes the options for resizing the image. A value of null indicates that the image will not be resized. Default is null. |
| SourceValidation | Gets or initializes the options for validating the source image before processing. |