Skip to main content

Search OfficeIMO

Enter a topic, API type, or PowerShell command.

Documentation Search all OfficeIMO/
Class

OfficePngWriter

OfficeIMO.Drawing

Namespace
OfficeIMO.Drawing
Assembly
OfficeIMO.Core
Source revision
ba882f6b0d07 with working tree changes
Modifiers
static

Dependency-free PNG encoder for RGBA raster images.

Inheritance

  • object
  • OfficePngWriter

Methods

public static byte[] CreateFromCompressedScanlines(int width, int height, int bitDepth, int colorType, byte[] compressedScanlines) #

Wraps zlib-compressed, already-filtered PNG scanlines in a PNG file.

Parameters

width int required
height int required
bitDepth int required
colorType int required
compressedScanlines byte[] required

Returns

byte[]
Encode 3 overloads
public static byte[] Encode(OfficeRasterImage image, OfficePngCompression compression = Optimal) #

Encodes an RGBA image as PNG bytes.

Parameters

image OfficeIMO.Drawing.OfficeRasterImage required
compression OfficeIMO.Drawing.OfficePngCompression = Optimal optional

Returns

byte[]
public static byte[] Encode(OfficeRasterImage image, CancellationToken cancellationToken, OfficePngCompression compression = Optimal) #

Encodes an RGBA image as PNG bytes with cooperative cancellation between scanlines.

Parameters

image OfficeIMO.Drawing.OfficeRasterImage required
cancellationToken System.Threading.CancellationToken required
compression OfficeIMO.Drawing.OfficePngCompression = Optimal optional

Returns

byte[]
public static byte[] Encode(OfficeRasterImage image, OfficePngEncodeOptions options) #

Encodes an RGBA image with explicit compression and physical-resolution metadata.

Parameters

image OfficeIMO.Drawing.OfficeRasterImage required
options OfficeIMO.Drawing.OfficePngEncodeOptions required

Returns

byte[]
EncodeRgba 2 overloads
public static byte[] EncodeRgba(int width, int height, byte[] rgba, OfficePngCompression compression = Optimal) #

Encodes raw RGBA pixels as PNG bytes.

Parameters

width int required
height int required
rgba byte[] required
compression OfficeIMO.Drawing.OfficePngCompression = Optimal optional

Returns

byte[]
public static byte[] EncodeRgba(int width, int height, byte[] rgba, OfficePngEncodeOptions options) #

Encodes raw RGBA pixels with explicit compression and physical-resolution metadata.

Parameters

width int required
height int required
rgba byte[] required
options OfficeIMO.Drawing.OfficePngEncodeOptions required

Returns

byte[]
public static byte[] EncodeRgba64(int width, int height, ushort[] rgba, OfficePngEncodeOptions? options = null, CancellationToken cancellationToken = default) #

Encodes tightly packed straight-alpha 16-bit RGBA samples without reducing precision.

Parameters

width int required
height int required
rgba ushort[] required
options OfficeIMO.Drawing.OfficePngEncodeOptions? = null optional
cancellationToken System.Threading.CancellationToken = default optional

Returns

byte[]
public static byte[] EncodeScanlines(int width, int height, int bitDepth, int colorType, byte[] scanlines, OfficePngCompression compression = Optimal) #

Encodes already-filtered PNG scanlines into a PNG file.

Parameters

width int required
height int required
bitDepth int required
colorType int required
scanlines byte[] required
compression OfficeIMO.Drawing.OfficePngCompression = Optimal optional

Returns

byte[]
EncodeTo 6 overloads
public static void EncodeTo(OfficeRasterImage image, Stream destination, OfficePngCompression compression = Optimal) #

Encodes an RGBA image directly to a caller-owned writable stream.

Parameters

image OfficeIMO.Drawing.OfficeRasterImage required
destination System.IO.Stream required
compression OfficeIMO.Drawing.OfficePngCompression = Optimal optional
public static void EncodeTo(OfficeRasterImage image, Stream destination, CancellationToken cancellationToken, OfficePngCompression compression = Optimal) #

Encodes an RGBA image directly to a writable stream with cooperative cancellation.

Parameters

image OfficeIMO.Drawing.OfficeRasterImage required
destination System.IO.Stream required
cancellationToken System.Threading.CancellationToken required
compression OfficeIMO.Drawing.OfficePngCompression = Optimal optional
public static void EncodeTo(OfficeRasterImage image, Stream destination, OfficePngEncodeOptions options) #

Encodes an RGBA image with physical-resolution metadata directly to a writable stream.

Parameters

image OfficeIMO.Drawing.OfficeRasterImage required
destination System.IO.Stream required
options OfficeIMO.Drawing.OfficePngEncodeOptions required
public static void EncodeTo(OfficeRasterImage image, Stream destination, OfficePngEncodeOptions options, CancellationToken cancellationToken) #

Encodes an RGBA image with physical-resolution metadata and cooperative cancellation.

Parameters

image OfficeIMO.Drawing.OfficeRasterImage required
destination System.IO.Stream required
options OfficeIMO.Drawing.OfficePngEncodeOptions required
cancellationToken System.Threading.CancellationToken required
public static void EncodeTo(OfficeRasterImage image, IBufferWriter<byte> destination, OfficePngCompression compression = Optimal) #

Encodes an RGBA image directly to a caller-owned buffer writer.

Parameters

image OfficeIMO.Drawing.OfficeRasterImage required
destination System.Buffers.IBufferWriter<byte> required
compression OfficeIMO.Drawing.OfficePngCompression = Optimal optional
public static void EncodeTo(OfficeRasterImage image, IBufferWriter<byte> destination, OfficePngEncodeOptions options) #

Encodes an RGBA image with physical-resolution metadata directly to a buffer writer.

Parameters

image OfficeIMO.Drawing.OfficeRasterImage required
destination System.Buffers.IBufferWriter<byte> required
options OfficeIMO.Drawing.OfficePngEncodeOptions required