Class GorgonDdsDecodingOptions

Options used when decoding an image from a stream as a DDS file.

Inheritance
object
GorgonDdsDecodingOptions
Implements
Inherited Members
Namespace: Gorgon.Graphics.Imaging.Codecs
Assembly: Gorgon.Graphics.Imaging.dll
Syntax
public class GorgonDdsDecodingOptions : IGorgonImageCodecDecodingOptions

Constructors

| Edit this page View Source

GorgonDdsDecodingOptions()

Initializes a new instance of the GorgonDdsDecodingOptions class.

Declaration
public GorgonDdsDecodingOptions()

Properties

| Edit this page View Source

LegacyFormatConversionFlags

Property to set or return flags used when decoding a file encoded with a legacy DDS format specification.

Declaration
public DdsLegacyFlags LegacyFormatConversionFlags { get; set; }
Property Value
Type Description
DdsLegacyFlags
Remarks

Older versions of the DDS format specification (or just bugs in general) have made files written with those specifications unreadable by a standardized DDS reader without extra processing. These flags define how to handle a legacy encoded file.

warning

Gorgon will make no attempt to identify if a file is "legacy" or not. It is up to the end user to identify which files are legacy, and in what way and provide the appropriate flags to the decoder. The best course of action is to use the decoder to decode the file, and then save it again with the proper DDS standard. The codec will write out DDS files in a standardized, modern format.

The default value is None.

| 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
| Edit this page View Source

Palette

Property to set or return a custom color palette to apply to the DDS file that uses an indexed 8 bit per pixel format.

Declaration
public IList<GorgonColor> Palette { get; set; }
Property Value
Type Description
IList<GorgonColor>
Remarks

Use this to define a new palette for the 8 bit indexed image in the DDS file during decoding.

This value does not remap the pixel values to the corresponding palette color, therefore, palettes assigned to the image may not give the desired results without careful palette selection.

The default value is an empty list.

Implements

Extension Methods