Table of Contents

Namespace PaintDotNet.Imaging

Classes

BadHeaderException
BadImageException
BadMetadataHeaderException
BadStreamDataException
BitmapAlreadyLockedException
BitmapEncoderExtensions
BitmapExtensions
BitmapFrameChainWriterExtensions
BitmapFrameEncodeExtensions
BitmapLockExtensions
BitmapSourceBase
BitmapSourceBase<TPixel>
BitmapSourceExtensions
BitmapUtil
BmpEncoderOptions

The keys in this class are used to set property values in an IPropertyBag2 when working with the BMP IBitmapEncoder's options.

See BMP Format Overview for more information.

CicpColorPrimariesExtensions
CicpColorSpaces

Provides the CicpColorSpace code points for well-known color spaces.

CodecNoThumbnailException
CodecPresentException
CodecTooManyScanlinesException
ColorComponentUtil
ColorContextExtensions
ContainerFormats
DuplicateMetadataPresentException
ExifConverter
ExifHelpers
ExifOrientationUtil
ExifPropertyItem
ExifPropertyItemExtensions
ExifPropertyKeys
ExifPropertyKeys.GpsInfo
ExifPropertyKeys.Image
ExifPropertyKeys.Interop
ExifPropertyKeys.Photo
ExifPropertyKeysTable
ExifValue
FrameMissingException
HeifEncoderOptions

The keys in this class are used to set property values in an IPropertyBag2 when working with the HEIF IBitmapEncoder's options.

ImageSizeOutOfRangeException
ImagingComponentInitializeFailureException
ImagingComponentNotFoundException
ImagingException
ImagingFactory
ImagingFactoryExtensions
ImagingObjectRefExtensions
InvalidColorSpaceException
InvalidJpegScanIndexException
InvalidProfileException
InvalidProgressiveLevelException
InvalidQueryCharacterException
InvalidQueryRequestException
InvalidRegistrationException
IptcByteArrayValue
IptcPropertyItem
IptcPropertyItemSerializer
IptcStringArrayValue
IptcStringValue
IptcValue
JpegEncoderOptions

The keys in this class are used to set property values in an IPropertyBag2 when working with the JPEG IBitmapEncoder's options.

See JPEG Format Overview for more information.

JpegXREncoderOptions

The keys in this class are used to set property values in an IPropertyBag2 when working with the JPEG XR (aka WMP, aka HD Photo) IBitmapEncoder's options.

See JPEG XR Codec Overview and HD Photo format overview for more information.

JpegXREncoderOptions.CodecOptions

Codec-specific options. To use these, set the UseCodecOptions property to true.

KnownColorSpaceExtensions
LinearColors

Provides predefined colors in the scRGB color space, which uses linear (1.0) gamma.

ManagedColor

Encapsulates an RGBA color value and the color space that it is defined within, along with methods for retrieving the color while transforming it to a target color space. This removes color space ambiguity for color values, enabling them to maintain the correct visual color when moving through a larger system.

ManagedColorExtensions
ManagedColorListExtensions
ManagedColors

Provides predefined colors of type ManagedColor.

MetadataBlockReaderExtensions
MetadataBlockWriterExtensions
MetadataFormats
MetadataItem
MetadataQueryReaderExtensions
MetadataQueryWriterExtensions
MetadataReaderExtensions
MetadataWriterExtensions
PaletteUnavailableException
PixelFormatExtensions
PixelFormats

Contains properties for getting the documented, built-in pixel formats, as well as methods for obtaining information about the supported pixel formats.

PngEncoderOptions

The keys in this class are used to set property values in an IPropertyBag2 when working with the PNG IBitmapEncoder's options.

See PNG Format Overview for more information.

PropertyNotFoundException
PropertyNotSupportedException
PropertySizeException
PropertyUnexpectedTypeException
RequestOnlyValidAtMetadataRootException
SourceRectDoesNotMatchDimensionsException
SrgbColors

Provides predefined colors in the sRGB color space, which uses approximately 2.2 gamma.

StreamNotAvailableException
StreamReadException
StreamWriteException
TiffEncoderOptions

The keys in this class are used to set property values in an IPropertyBag2 when working with the TIFF IBitmapEncoder's options.

See TIFF Format Overview for more information.

TooMuchMetadataException
UnexpectedMetadataTypeException
UnexpectedSizeException
UnknownImageFormatException
UnsupportedPixelFormatException
UnsupportedSdkVersionException
UnsupportedToneMappingException
ValueOutOfRangeException
VendorIDs
Win32ErrorException

Windows Codecs received an error from the Win32 system.

XmpConstants
XmpPacket

Encapsulates an immutable XMP packet. The root node is an xmpmeta element that contains a single RDF element.

Structs

BitmapPattern
CicpColorSpace

The four "coding-independent code points" (CICP) that describe the colour encoding of an image, as defined by ITU-T H.273. This is the payload of the PNG cICP chunk: four 8-bit values, in this field order.

ColorAlpha16
ColorAlpha16Half
ColorAlpha32Float
ColorAlpha8
ColorBgr24
ColorBgr32
ColorBgr48
ColorBgra32
ColorBgra64
ColorCmyk32
ColorCmyk64
ColorCmyka40
ColorCmyka80
ColorGenericXY16
ColorGenericXY32
ColorGenericXY32Half
ColorGenericXY64Float
ColorGray16
ColorGray16Half
ColorGray32Float
ColorGray8
ColorHsv96Float
ColorIndexed8
ColorPbgra32
ColorPbgra64
ColorPrgba128Float
ColorPrgba32
ColorPrgba64
ColorPrgba64Half
ColorRgb128Float
ColorRgb24
ColorRgb32
ColorRgb48
ColorRgb48Half
ColorRgb64
ColorRgb64Half
ColorRgb96Float
ColorRgba128Float
ColorRgba32
ColorRgba64
ColorRgba64Half
ContainerFormat
ExifPropertyKey
ExifPropertyPath
HdrToneMapStatistics

The luminance statistics of a linear HDR image needed to tone-map it, in nits (cd/m²). Produced by Gather(IBitmapSource<ColorRgba128Float>, double, float, bool), which measures the pixels, or by FromNits(float) from known metadata such as a MaxCLL value.

ImageParameters

This defines parameters that you can use to override the default parameters normally used when encoding an image.
WICImageParameters

ImagingComponentID
IptcPropertyKey
KelvinRangeInfo

Represents information about a range of color temperatures in kelvins, including the minimum, maximum, and step values that are supported by a raw image or codec. This struct is returned by KelvinRangeInfo.

LinearColor
LinearColorA
MetadataFormat
MetadataHeader
MetadataPattern
PixelFormat
RawCapabilitiesInfo

Contains information about the capabilities and supported features of a raw image codec. For more information, see: WICRawCapabilitiesInfo

RawToneCurvePoint

Represents a raw image tone curve point. For more information, see: WICRawToneCurvePoint

RgbPrimariesXY

The CIE 1931 (x, y) chromaticity coordinates of a set of RGB primaries and the white point. Each component carries the chromaticity in its X (x) and Y (y) fields.

SrgbColor
SrgbColorA
VendorID
WhitePointRgb

Encapsulates white point RGB values. This struct is used by the WhitePointRgb property.

Interfaces

IBitmap
IBitmapCodecInfo
IBitmapDecoder
IBitmapDecoderInfo
IBitmapEncoder

Defines methods for setting an encoder's properties such as thumbnails, frames, and palettes.
IWICBitmapEncoder

IBitmapEncoderInfo
IBitmapFrameChainReader

Provides access to frames that are linked to the current frame through chains of different types.
Use CreateRef<TInterface>(IObjectRef) to retrieve this interface from an IBitmapFrameDecode object.
For more information, see: IWICBitmapFrameChainReader

IBitmapFrameChainWriter

Links frames together in chains of different types.
Use CreateRef<TInterface>(IObjectRef) to retrieve this interface from an IBitmapFrameEncode object.
For more information, see: IWICBitmapFrameChainWriter.

IBitmapFrameDecode
IBitmapFrameEncode

Represents an encoder's individual image frames.
IWICBitmapFrameEncode

IBitmapLock
IBitmapLock<TPixel>
IBitmapSource

Exposes methods that refers to a source from which pixels are retrieved, but cannot be written back to.

See IWICBitmapSource for more information.

IBitmapSource<TPixel>

Exposes methods that refers to a source from which pixels are retrieved, but cannot be written back to.

See IWICBitmapSource for more information.

IBitmap<TPixel>
IColorContext

Exposes methods for color management.
See IWICColorContext for more information.

IDevelopRaw

Exposes methods that provide access to the capabilities of a raw codec format.

For more information, see: IWICDevelopRaw

IDevelopRawNotificationCallback

Provides a callback interface for receiving notifications about changes in the raw image development process.
For more information, see: IWICDevelopRawNotificationCallback

IFastMetadataEncoder
IFormatConverterInfo
IImageEncoder
IImagingComponentFactory
IImagingComponentInfo
IImagingFactory

Exposes methods used to create components for the Windows Imaging Component (WIC) such as decoders, encoders and pixel format converters.
See also: IWICImagingFactory IWICImagingFactory2

IJpegFrameDecode

Exposes methods for decoding JPEG images. Enables indexing for efficient random access.
To access this interface, call CreateRef<TInterface>(IObjectRef) on the IBitmapFrameDecode object.
For more information, see: IWICJpegFrameDecode

IManagedColorList

Represents a list of colors associated with a color profile, along with methods to retrieve those colors after transforming them to a destination color profile.

IMetadataBlockReader
IMetadataBlockWriter
IMetadataHandlerInfo
IMetadataItem
IMetadataQueryReader
IMetadataQueryWriter
IMetadataReader
IMetadataReaderInfo
IMetadataWriter
IMetadataWriterInfo
INaturalPixelInfo
INaturalPixelInfo<TPixel>
IPalette

IWICPalette
IPixelFormatInfo



Corresponds to the following native interfaces: IWICPixelFormatInfo, IWICPixelFormatInfo2

IPixelInfo

Enums

BitmapAllocationOptions
BitmapAlphaChannelOption

WICBitmapAlphaChannelOption
BitmapChainType

Defines constants that specify a type of chain. The frames that are in each chain don't need to have the same dimensions as the primary frame.
For more information, see: https://learn.microsoft.com/en-us/windows/win32/api/wincodec/ne-wincodec-wicbitmapchaintype

BitmapCreateCacheOption

Specifies the desired cache usage. https://docs.microsoft.com/en-us/windows/win32/api/wincodec/ne-wincodec-wicbitmapcreatecacheoption

BitmapDecodeOptions
BitmapDecoderCapabilities
BitmapDitherType
BitmapExtendMode
BitmapInterpolationMode
BitmapInterpolationMode2

This enum provides additional resampling options.

BitmapLockOptions
BitmapPaletteType
BitmapTransformOptions
CicpColorPrimaries

Identifies the chromaticity coordinates of the source primaries (red, green, blue) and the white point. These are the "ColourPrimaries" code points defined by ITU-T H.273 (Table 2) and used by the PNG cICP chunk.

CicpMatrixCoefficients

Identifies the matrix coefficients used to derive luma and chroma signals from the source RGB primaries. These are the "MatrixCoefficients" code points defined by ITU-T H.273 (Table 4) and used by the PNG cICP chunk.

CicpTransferCharacteristics

Identifies the opto-electronic / electro-optical transfer characteristic (the "gamma" or EOTF) of the source. These are the "TransferCharacteristics" code points defined by ITU-T H.273 (Table 3) and used by the PNG cICP chunk.

CicpVideoFullRangeFlag

Indicates the black level and range of the luma and chroma signals. This is the "VideoFullRangeFlag" defined by ITU-T H.273 and used by the PNG cICP chunk.

ColorContextType
ColorQuantizationAlgorithm
ExifColorSpace
ExifOrientation
ExifSection
ExifValueType
ImagingComponentEnumerateOptions
ImagingComponentSigning
ImagingComponentType
ImagingError
IptcValueType
JpegIndexingOptions
JpegXRAlphaDataDiscardOption

Sets the amount of alpha frequency data to discard during a compressed domain transcode.

JpegXRChromaSubsamplingOption

Specifies additional compression in the chroma space. In this way, you can preserve luminance detail at the expense of color detail.

JpegXRImageDataDiscardOption

Sets the amount of image frequency data to discard during a compressed domain transcode.

JpegXROverlapProcessingOption

Sets the level of overlap filtering. With overlap filtering, transform coefficients are applied across block and macroblock boundaries. This can reduce blocking artifacts.

JpegYCrCbSubsamplingOption

KnownColorSpace

Provides a list of known color spaces that can be used to create IColorContext and IDeviceColorContext instances.

MetadataCreationOptions

Specifies metadata creation options.
WICMetadataCreationOptions

MetadataPersistOptions

Specifies options that are used when initializing a component with a stream.
WICPersistOptions

NamedWhitePoint

Specifies named white balances for raw images.

See https://learn.microsoft.com/en-us/windows/win32/api/wincodec/ne-wincodec-wicnamedwhitepoint>WICNamedWhitePoint for more info.

PixelFormatNumericRepresentation
PngFilterOption

Specifies the Portable Network Graphics (PNG) filters available for compression optimization.
WICPngFilterOption

PremultipliedAdapterOptions
RawCapabilities

Specifies the level of support for a particular raw image processing capability.
For more information, see: WICRawCapabilities

RawChangeNotification

Specifies notifications for changes to raw image development parameters. For more information, see: WICRawChangeNotification

RawParameterSet

Specifies the parameter set used by a raw codec. For more information, see: WICRawParameterSet

RawRenderMode

Specifies the render intent of the next CopyPixels(void*, int, uint, in RectInt32?) call. For more information, see: WICRawRenderMode

RawRotationCapabilities

Specifies the rotation capabilities of the codec. For more information, see: WICRawRotationCapabilities

TiffCompressionOption
XmpPacketWrapperType