Gorgon
Show / Hide Table of Contents

Class GorgonJpegEncodingOptions

Options used when encoding an image to a stream as a JPEG file.

Inheritance
object
GorgonJpegEncodingOptions
Implements
IGorgonWicEncodingOptions
IGorgonImageCodecEncodingOptions
Inherited Members
object.ToString()
object.Equals(object)
object.Equals(object, object)
object.ReferenceEquals(object, object)
object.GetHashCode()
object.GetType()
Namespace: Gorgon.Graphics.Imaging.Codecs
Assembly: Gorgon.Graphics.Imaging.dll
Syntax
public sealed class GorgonJpegEncodingOptions : IGorgonWicEncodingOptions, IGorgonImageCodecEncodingOptions

Constructors

| Edit this page View Source

GorgonJpegEncodingOptions()

Initializes a new instance of the GorgonJpegEncodingOptions class.

Declaration
public GorgonJpegEncodingOptions()

Properties

| Edit this page View Source

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.

| Edit this page View Source

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.

| Edit this page View Source

ImageQuality

Property to set or return the quality of an image compressed with lossy compression.

Declaration
public float ImageQuality { get; set; }
Property Value
Type Description
float
Remarks

Use this property to control the fidelity of an image compressed with lossy compression. A value of 0.0f will give the lowest quality and 1.0f will give the highest.

| Edit this page View Source

Options

Property to return the list of options available to the codec.

Declaration
public IGorgonOptionBag Options { get; }
Property Value
Type Description
IGorgonOptionBag

Implements

IGorgonWicEncodingOptions
IGorgonImageCodecEncodingOptions

Extension Methods

GorgonDebugExtensions.ValidateObject<T>(T, string)
GorgonNullExtensions.AsNullable<T>(object)
GorgonNullExtensions.IfNull<T>(object, T)
GorgonNullExtensions.IsNull(object)
  • Edit this page
  • View Source
In this article
Back to top Copyright 2023 - Licensed under the MIT license by Michael Winsor (Tape_Worm).
Send comments on this topic to the author