# OfficeRasterImageEncoder

Shared dependency-free encoder for raster export formats.

Class 

`OfficeIMO.Drawing`

**Namespace**

`OfficeIMO.Drawing`

**Assembly**

`OfficeIMO.Core`

**Source revision**

`ba882f6b0d07` with working tree changes

**Source**

[OfficeRasterImageEncoder.cs:20](https://github.com/EvotecIT/OfficeIMO/blob/ba882f6b0d07acddd884b5e7d3086b0cfff0a05a/OfficeIMO.Core/Raster/OfficeRasterImageEncoder.cs#L20)

**Modifiers**

static

Shared dependency-free encoder for raster export formats.

## Inheritance

- object
- OfficeRasterImageEncoder

Filter members 

Show inherited

## Methods

Encode 2 overloads

`public static byte[] Encode(OfficeRasterImage image, OfficeImageExportFormat format, OfficeRasterEncodingOptions? options = null)` [#](#method-encode-officeimo-drawing-officerasterimage-officeimo-drawing-officeimageexportformat-officeimo-drawing-officerasterencodingoptions)

[OfficeRasterImageEncoder.cs:79](https://github.com/EvotecIT/OfficeIMO/blob/ba882f6b0d07acddd884b5e7d3086b0cfff0a05a/OfficeIMO.Core/Raster/OfficeRasterImageEncoder.cs#L79)

Encodes an RGBA image using the requested raster format.

Parameters

**image OfficeIMO.Drawing.OfficeRasterImage required**

**format OfficeIMO.Drawing.OfficeImageExportFormat required**

**options OfficeIMO.Drawing.OfficeRasterEncodingOptions? = null optional**

Returns

`byte[]`

`public static byte[] Encode(OfficeRasterImage image, OfficeImageExportFormat format, OfficeRasterEncodingOptions? options, long maximumEncodedBytes, CancellationToken cancellationToken = default)` [#](#method-encode-officeimo-drawing-officerasterimage-officeimo-drawing-officeimageexportformat-officeimo-drawing-officerasterencodingoptions-int64-threading-cancellationtoken)

[OfficeRasterImageEncoder.cs:109](https://github.com/EvotecIT/OfficeIMO/blob/ba882f6b0d07acddd884b5e7d3086b0cfff0a05a/OfficeIMO.Core/Raster/OfficeRasterImageEncoder.cs#L109)

Encodes an RGBA image while observing cancellation and enforcing an encoded-byte ceiling as bytes are produced.

Parameters

**image OfficeIMO.Drawing.OfficeRasterImage required**

**format OfficeIMO.Drawing.OfficeImageExportFormat required**

**options OfficeIMO.Drawing.OfficeRasterEncodingOptions? required**

**maximumEncodedBytes long required**

**cancellationToken System.Threading.CancellationToken = default optional**

Returns

`byte[]`

EncodeTo 3 overloads

`public static void EncodeTo(OfficeRasterImage image, OfficeImageExportFormat format, Stream destination, OfficeRasterEncodingOptions? options = null)` [#](#method-encodeto-officeimo-drawing-officerasterimage-officeimo-drawing-officeimageexportformat-io-stream-officeimo-drawing-officerasterencodingoptions)

[OfficeRasterImageEncoder.Streaming.cs:24](https://github.com/EvotecIT/OfficeIMO/blob/ba882f6b0d07acddd884b5e7d3086b0cfff0a05a/OfficeIMO.Core/Raster/OfficeRasterImageEncoder.Streaming.cs#L24)

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

Parameters

**image OfficeIMO.Drawing.OfficeRasterImage required**

**format OfficeIMO.Drawing.OfficeImageExportFormat required**

**destination System.IO.Stream required**

**options OfficeIMO.Drawing.OfficeRasterEncodingOptions? = null optional**

`public static void EncodeTo(OfficeRasterImage image, OfficeImageExportFormat format, Stream destination, OfficeRasterEncodingOptions? options, long maximumEncodedBytes, CancellationToken cancellationToken = default)` [#](#method-encodeto-officeimo-drawing-officerasterimage-officeimo-drawing-officeimageexportformat-io-stream-officeimo-drawing-officerasterencodingoptions-int64-threading-cancellationtoken)

[OfficeRasterImageEncoder.Streaming.cs:39](https://github.com/EvotecIT/OfficeIMO/blob/ba882f6b0d07acddd884b5e7d3086b0cfff0a05a/OfficeIMO.Core/Raster/OfficeRasterImageEncoder.Streaming.cs#L39)

Encodes an RGBA image directly to a caller-owned writable stream while observing cancellation and enforcing an encoded-byte ceiling as bytes are produced.

Parameters

**image OfficeIMO.Drawing.OfficeRasterImage required**

**format OfficeIMO.Drawing.OfficeImageExportFormat required**

**destination System.IO.Stream required**

**options OfficeIMO.Drawing.OfficeRasterEncodingOptions? required**

**maximumEncodedBytes long required**

**cancellationToken System.Threading.CancellationToken = default optional**

`public static void EncodeTo(OfficeRasterImage image, OfficeImageExportFormat format, IBufferWriter<byte> destination, OfficeRasterEncodingOptions? options = null)` [#](#method-encodeto-officeimo-drawing-officerasterimage-officeimo-drawing-officeimageexportformat-buffers-ibufferwriter-system-byte-officeimo-drawing-officerasterencodingoptions)

[OfficeRasterImageEncoder.Streaming.cs:147](https://github.com/EvotecIT/OfficeIMO/blob/ba882f6b0d07acddd884b5e7d3086b0cfff0a05a/OfficeIMO.Core/Raster/OfficeRasterImageEncoder.Streaming.cs#L147)

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

Parameters

**image OfficeIMO.Drawing.OfficeRasterImage required**

**format OfficeIMO.Drawing.OfficeImageExportFormat required**

**destination System.Buffers.IBufferWriter<byte> required**

**options OfficeIMO.Drawing.OfficeRasterEncodingOptions? = null optional**

EncodeWithMetadata 2 overloads

`public static OfficeRasterEncodingResult EncodeWithMetadata(OfficeRasterImage image, OfficeImageExportFormat format, OfficeImageMetadata metadata, OfficeRasterEncodingOptions? options = null, long maximumEncodedBytes = 134217728, CancellationToken cancellationToken = default)` [#](#member-903b85795c2cdfca7ae7f88e)

[OfficeRasterImageEncoder.Metadata.cs:12](https://github.com/EvotecIT/OfficeIMO/blob/ba882f6b0d07acddd884b5e7d3086b0cfff0a05a/OfficeIMO.Core/Raster/OfficeRasterImageEncoder.Metadata.cs#L12)

Encodes pixels and applies supported primary-image metadata, reporting supplied profile families omitted by the output container.

Parameters

**image OfficeIMO.Drawing.OfficeRasterImage required**

**format OfficeIMO.Drawing.OfficeImageExportFormat required**

**metadata OfficeIMO.Drawing.OfficeImageMetadata required**

**options OfficeIMO.Drawing.OfficeRasterEncodingOptions? = null optional**

**maximumEncodedBytes long = 134217728 optional**

**cancellationToken System.Threading.CancellationToken = default optional**

Returns

`OfficeRasterEncodingResult`

`public static OfficeRasterEncodingResult EncodeWithMetadata(OfficeRasterFrames frames, OfficeImageExportFormat format, OfficeImageMetadata metadata, OfficeRasterEncodingOptions? options = null, long maximumEncodedBytes = 134217728, CancellationToken cancellationToken = default)` [#](#member-baa5bf147bd970b568096e84)

[OfficeRasterImageEncoder.Metadata.cs:33](https://github.com/EvotecIT/OfficeIMO/blob/ba882f6b0d07acddd884b5e7d3086b0cfff0a05a/OfficeIMO.Core/Raster/OfficeRasterImageEncoder.Metadata.cs#L33)

Encodes a single still frame, TIFF pages, or icon entries with primary-image metadata and omission evidence.

Parameters

**frames OfficeIMO.Drawing.OfficeRasterFrames required**

**format OfficeIMO.Drawing.OfficeImageExportFormat required**

**metadata OfficeIMO.Drawing.OfficeImageMetadata required**

**options OfficeIMO.Drawing.OfficeRasterEncodingOptions? = null optional**

**maximumEncodedBytes long = 134217728 optional**

**cancellationToken System.Threading.CancellationToken = default optional**

Returns

`OfficeRasterEncodingResult`

`public static int GetMaximumDimension(OfficeImageExportFormat format)` [#](#method-getmaximumdimension-officeimo-drawing-officeimageexportformat)

[OfficeRasterImageEncoder.cs:20](https://github.com/EvotecIT/OfficeIMO/blob/ba882f6b0d07acddd884b5e7d3086b0cfff0a05a/OfficeIMO.Core/Raster/OfficeRasterImageEncoder.cs#L20)

Returns the maximum supported pixel width or height for a raster format.

Parameters

**format OfficeIMO.Drawing.OfficeImageExportFormat required**

Returns

`int`

`public static long GetMaximumPixelCount(OfficeImageExportFormat format)` [#](#method-getmaximumpixelcount-officeimo-drawing-officeimageexportformat)

[OfficeRasterImageEncoder.cs:33](https://github.com/EvotecIT/OfficeIMO/blob/ba882f6b0d07acddd884b5e7d3086b0cfff0a05a/OfficeIMO.Core/Raster/OfficeRasterImageEncoder.cs#L33)

Returns the maximum source pixel count accepted by a raster encoder.

Parameters

**format OfficeIMO.Drawing.OfficeImageExportFormat required**

Returns

`long`

## 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:B110B521F74DE6E3BE37886A92B43217C2C1CA6F2D73845CBA548B8D7A834052 -->
