| AnimatedImage |
An in-memory, fully-decoded (or to-be-encoded) animated image: an ordered sequence of composited AnimatedImageFrames plus loop count. Codec-agnostic, mirroring Image: Load(Stream, DecoderOptions) and Save(Stream, string, EncoderOptions) dispatch to whichever of Image’s built-in codecs also support animation (GIF today), rather than any single format’s animation API being called directly. |
| AnimatedImageFrame |
A single decoded (or to-be-encoded) frame of an AnimatedImage: a fully composited canvas plus timing/disposal metadata. |
| DecoderOptions |
Base class for format-specific decode options. Format codecs derive their own options from this (JpegDecoderOptions, PngDecoderOptions, etc.) to add format-specific knobs, but the base class itself is directly constructible: when the only thing a caller needs is TargetPixelFormat — the common case for a format-agnostic Load(Stream, DecoderOptions) call, where the stream’s actual format isn’t known up front — construct a plain new DecoderOptions { TargetPixelFormat = ... } rather than guessing at an arbitrary concrete subtype. See TargetPixelFormat for the guarantee that makes this safe. |
| EncoderOptions |
Base class for format-specific encode options. Format codecs derive their own options from this. |
| IccColorProfile |
A parsed ICC color profile, exposing PeachImage’s optimized, colorimetric device→sRGB conversion to library consumers directly — the same engine JPEG decode already uses automatically for a CMYK source with an embedded profile (see GetIccColorProfile() and ConvertToSrgb() for the common case of converting an already-decoded Image). Supports Gray, RGB, and CMYK device color spaces — whatever the profile itself declares via DataColorSpace. |
| IccProfileException |
Thrown when IccColorProfile is given bytes that are too short, malformed, or resolve to a device color space or transform PeachImage’s ICC engine doesn’t support. Not derived from ImageFormatException — an ICC profile isn’t an image container format, and can be used independent of any decoded Image (e.g. loaded from a standalone .icc/.icm file). |
| Image |
An in-memory, single-frame, tightly-packed pixel buffer decoded from (or destined for) an image file. |
| ImageDecoder |
Decodes images into memory the caller owns, so a hot loop (a thumbnailer, a tile server) decodes into one reusable buffer instead of getting a fresh Image per call. Create one per thread; an instance is not safe for concurrent use. |
| ImageFormatException |
Base type for all exceptions PeachImage throws while identifying, decoding, or encoding images. |
| ImageMetadata |
Format-agnostic metadata associated with an Image. |
| ImageTooLargeException |
Thrown when an image would exceed a limit the caller set in DecoderOptions (MaxPixels or MaxExpansionRatio), before the memory for it is allocated or as soon as the limit is crossed. |
| PixelFormatExtensions |
Helper methods for reasoning about PixelFormat values. |
| RawMetadataProfile |
A raw, un-parsed metadata segment captured verbatim during decode so it can be inspected or re-emitted on encode without the core library needing to understand its internal structure. |
| ResizeOptions |
Options controlling Resize(int, int, ResizeOptions) and Resize(int, int, ResizeOptions). |
| UnknownImageFormatException |
Thrown when no registered codec recognizes an image’s format. |
| UnsupportedFormatException |
Thrown when an image is in a format PeachImage recognises but the caller’s AllowedFormats does not permit. It is thrown right after the format is recognised from the file’s signature and before any decoder for that format runs. |