# OfficePngWriter

Dependency-free PNG encoder for RGBA raster images.

Class 

`OfficeIMO.Drawing`

**Namespace**

`OfficeIMO.Drawing`

**Assembly**

`OfficeIMO.Core`

**Source revision**

`ba882f6b0d07` with working tree changes

**Source**

[OfficePngWriter.cs:36](https://github.com/EvotecIT/OfficeIMO/blob/ba882f6b0d07acddd884b5e7d3086b0cfff0a05a/OfficeIMO.Core/Png/OfficePngWriter.cs#L36)

**Modifiers**

static

Dependency-free PNG encoder for RGBA raster images.

## Inheritance

- object
- OfficePngWriter

Filter members 

Show inherited

## Methods

`public static byte[] CreateFromCompressedScanlines(int width, int height, int bitDepth, int colorType, byte[] compressedScanlines)` [#](#method-createfromcompressedscanlines-int32-int32-int32-int32-byte)

[OfficePngWriter.cs:329](https://github.com/EvotecIT/OfficeIMO/blob/ba882f6b0d07acddd884b5e7d3086b0cfff0a05a/OfficeIMO.Core/Png/OfficePngWriter.cs#L329)

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)` [#](#method-encode-officeimo-drawing-officerasterimage-officeimo-drawing-officepngcompression)

[OfficePngWriter.cs:36](https://github.com/EvotecIT/OfficeIMO/blob/ba882f6b0d07acddd884b5e7d3086b0cfff0a05a/OfficeIMO.Core/Png/OfficePngWriter.cs#L36)

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)` [#](#method-encode-officeimo-drawing-officerasterimage-threading-cancellationtoken-officeimo-drawing-officepngcompression)

[OfficePngWriter.cs:46](https://github.com/EvotecIT/OfficeIMO/blob/ba882f6b0d07acddd884b5e7d3086b0cfff0a05a/OfficeIMO.Core/Png/OfficePngWriter.cs#L46)

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)` [#](#method-encode-officeimo-drawing-officerasterimage-officeimo-drawing-officepngencodeoptions)

[OfficePngWriter.cs:62](https://github.com/EvotecIT/OfficeIMO/blob/ba882f6b0d07acddd884b5e7d3086b0cfff0a05a/OfficeIMO.Core/Png/OfficePngWriter.cs#L62)

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)` [#](#method-encodergba-int32-int32-byte-officeimo-drawing-officepngcompression)

[OfficePngWriter.cs:73](https://github.com/EvotecIT/OfficeIMO/blob/ba882f6b0d07acddd884b5e7d3086b0cfff0a05a/OfficeIMO.Core/Png/OfficePngWriter.cs#L73)

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)` [#](#method-encodergba-int32-int32-byte-officeimo-drawing-officepngencodeoptions)

[OfficePngWriter.cs:80](https://github.com/EvotecIT/OfficeIMO/blob/ba882f6b0d07acddd884b5e7d3086b0cfff0a05a/OfficeIMO.Core/Png/OfficePngWriter.cs#L80)

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)` [#](#method-encodergba64-int32-int32-uint16-officeimo-drawing-officepngencodeoptions-threading-cancellationtoken)

[OfficePngWriter.Unsigned16.cs:11](https://github.com/EvotecIT/OfficeIMO/blob/ba882f6b0d07acddd884b5e7d3086b0cfff0a05a/OfficeIMO.Core/Png/OfficePngWriter.Unsigned16.cs#L11)

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)` [#](#method-encodescanlines-int32-int32-int32-int32-byte-officeimo-drawing-officepngcompression)

[OfficePngWriter.cs:111](https://github.com/EvotecIT/OfficeIMO/blob/ba882f6b0d07acddd884b5e7d3086b0cfff0a05a/OfficeIMO.Core/Png/OfficePngWriter.cs#L111)

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)` [#](#method-encodeto-officeimo-drawing-officerasterimage-io-stream-officeimo-drawing-officepngcompression)

[OfficePngWriter.Streaming.cs:17](https://github.com/EvotecIT/OfficeIMO/blob/ba882f6b0d07acddd884b5e7d3086b0cfff0a05a/OfficeIMO.Core/Png/OfficePngWriter.Streaming.cs#L17)

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)` [#](#method-encodeto-officeimo-drawing-officerasterimage-io-stream-threading-cancellationtoken-officeimo-drawing-officepngcompression)

[OfficePngWriter.Streaming.cs:36](https://github.com/EvotecIT/OfficeIMO/blob/ba882f6b0d07acddd884b5e7d3086b0cfff0a05a/OfficeIMO.Core/Png/OfficePngWriter.Streaming.cs#L36)

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)` [#](#method-encodeto-officeimo-drawing-officerasterimage-io-stream-officeimo-drawing-officepngencodeoptions)

[OfficePngWriter.Streaming.cs:54](https://github.com/EvotecIT/OfficeIMO/blob/ba882f6b0d07acddd884b5e7d3086b0cfff0a05a/OfficeIMO.Core/Png/OfficePngWriter.Streaming.cs#L54)

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)` [#](#method-encodeto-officeimo-drawing-officerasterimage-io-stream-officeimo-drawing-officepngencodeoptions-threading-cancellationtoken)

[OfficePngWriter.Streaming.cs:64](https://github.com/EvotecIT/OfficeIMO/blob/ba882f6b0d07acddd884b5e7d3086b0cfff0a05a/OfficeIMO.Core/Png/OfficePngWriter.Streaming.cs#L64)

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)` [#](#method-encodeto-officeimo-drawing-officerasterimage-buffers-ibufferwriter-system-byte-officeimo-drawing-officepngcompression)

[OfficePngWriter.Streaming.cs:95](https://github.com/EvotecIT/OfficeIMO/blob/ba882f6b0d07acddd884b5e7d3086b0cfff0a05a/OfficeIMO.Core/Png/OfficePngWriter.Streaming.cs#L95)

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)` [#](#method-encodeto-officeimo-drawing-officerasterimage-buffers-ibufferwriter-system-byte-officeimo-drawing-officepngencodeoptions)

[OfficePngWriter.Streaming.cs:105](https://github.com/EvotecIT/OfficeIMO/blob/ba882f6b0d07acddd884b5e7d3086b0cfff0a05a/OfficeIMO.Core/Png/OfficePngWriter.Streaming.cs#L105)

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**

## Inherited Methods

`public virtual bool Equals(object? obj)` [#](#method-equals-object)

Inherited from object

Parameters

**obj object? required**

Returns

`bool`

`public virtual int GetHashCode()` [#](#method-gethashcode)

Inherited from object

Returns

`int`

`public Type GetType()` [#](#method-gettype)

Inherited from object

Returns

`Type`

`public virtual string? ToString()` [#](#method-tostring)

Inherited from object

Returns

`string?`

<!-- PowerForge markdown artifact sha256:B3A90D27E9AAD774DC6683A97E14F1306C2F61DF515CF40314C34F6D874DB606 -->
