API Reference
RasterImageDecoder
Decodes dependency-free raster image formats into RGBA pixels.
Inheritance
- Object
- RasterImageDecoder
Methods
public static RgbaImage Decode(Byte[] data) #RgbaImageDecodes raster image bytes into RGBA pixels.
Parameters
- data System.Byte[]
- The encoded image bytes.
Returns
The decoded RGBA image.
public static RgbaImage Decode(Byte[] data, RasterDecodeOptions? options) #RgbaImageDecodes raster bytes with explicit encoded-input and pixel limits.
Parameters
- data System.Byte[]
- options ChartForgeX.Raster.RasterDecodeOptions?
public static RgbaImage Read(String path) #RgbaImageReads and decodes a raster image file.
Parameters
- path System.String
- The source image path.
Returns
The decoded RGBA image.
public static RgbaImage Read(String path, RasterDecodeOptions? options) #RgbaImageReads a raster file with explicit encoded-input and pixel limits.
Parameters
- path System.String
- options ChartForgeX.Raster.RasterDecodeOptions?
public static RgbaImage Read(Stream stream) #RgbaImageReads and decodes a raster image stream.
Parameters
- stream System.IO.Stream
- The source image stream.
Returns
The decoded RGBA image.
public static RgbaImage Read(Stream stream, RasterDecodeOptions? options) #RgbaImageReads a raster stream with explicit limits without closing the caller's stream.
Parameters
- stream System.IO.Stream
- options ChartForgeX.Raster.RasterDecodeOptions?
public static Boolean TryDecode(Byte[]? data, out RgbaImage image) #BooleanAttempts to decode raster image bytes.
Parameters
- data System.Byte[]?
- The encoded image bytes.
- image ChartForgeX.Raster.RgbaImage
- The decoded RGBA image when successful.
Returns
true when the image could be decoded.
public static Boolean TryDecode(Byte[]? data, RasterDecodeOptions? options, out RgbaImage image) #BooleanAttempts to decode bytes within explicit raster limits.
Parameters
- data System.Byte[]?
- options ChartForgeX.Raster.RasterDecodeOptions?
- image ChartForgeX.Raster.RgbaImage
public static Boolean TryRead(String? path, out RgbaImage image) #BooleanAttempts to read and decode a raster image file.
Parameters
- path System.String?
- The source image path.
- image ChartForgeX.Raster.RgbaImage
- The decoded RGBA image when successful.
Returns
true when the image could be decoded.
public static Boolean TryRead(String? path, RasterDecodeOptions? options, out RgbaImage image) #BooleanAttempts to decode a file within explicit raster limits.
Parameters
- path System.String?
- options ChartForgeX.Raster.RasterDecodeOptions?
- image ChartForgeX.Raster.RgbaImage
public static Boolean TryRead(Stream? stream, out RgbaImage image) #BooleanAttempts to read and decode a raster image stream.
Parameters
- stream System.IO.Stream?
- The source image stream.
- image ChartForgeX.Raster.RgbaImage
- The decoded RGBA image when successful.
Returns
true when the image could be decoded.
public static Boolean TryRead(Stream? stream, RasterDecodeOptions? options, out RgbaImage image) #BooleanAttempts to decode a stream within explicit raster limits without closing it.
Parameters
- stream System.IO.Stream?
- options ChartForgeX.Raster.RasterDecodeOptions?
- image ChartForgeX.Raster.RgbaImage
Inherited Methods
public virtual Boolean Equals(Object? obj) #BooleanParameters
- obj Object?