Class GorgonPngEncodingOptions
Options used when encoding an image to a stream as a PNG file..
Inherited Members
Namespace: Gorgon.Graphics.Imaging.Codecs
Assembly: Gorgon.Graphics.Imaging.dll
Syntax
public sealed class GorgonPngEncodingOptions : IGorgonWicEncodingOptions, IGorgonImageCodecEncodingOptions
Constructors
| Edit this page View SourceGorgonPngEncodingOptions()
Initializes a new instance of the GorgonPngEncodingOptions class.
Declaration
public GorgonPngEncodingOptions()
Properties
| Edit this page View SourceDithering
Property to set or return the type of ImageDithering to use.
Declaration
public ImageDithering Dithering { get; set; }
Property Value
Type | Description |
---|---|
ImageDithering |
Remarks
This flag is used to determine which type of dithering algorithm should be used when converting the bit depth for a pixel format to a lower bit depth. If the pixel format of the image is supported natively by the codec, then this value will be ignored.
With dithering applied, the image will visually appear closer to the original by using patterns to simulate a greater number of colors.
The default value is None.
DpiX
Property to set or return the horizontal dots-per-inch for the encoded image.
Declaration
public double DpiX { get; set; }
Property Value
Type | Description |
---|---|
double |
Remarks
This information is metadata only, no action is taken with this value.
The default value is 72.
DpiY
Property to set or return the vertical dots-per-index for the encoded image.
Declaration
public double DpiY { get; set; }
Property Value
Type | Description |
---|---|
double |
Remarks
This information is metadata only, no action is taken with this value.
The default value is 72.
Filter
Property to set or return the type of filter to use when when compressing the PNG file.
Declaration
public PngFilter Filter { get; set; }
Property Value
Type | Description |
---|---|
PngFilter |
Remarks
The default value is DontCare.
Interlacing
Property to set or return whether to use interlacing when encoding an image as a PNG file.
Declaration
public bool Interlacing { get; set; }
Property Value
Type | Description |
---|---|
bool |
Remarks
The default value is false.
Options
Property to return the list of options available to the codec.
Declaration
public IGorgonOptionBag Options { get; }
Property Value
Type | Description |
---|---|
IGorgonOptionBag |