# OfficeRasterResampler

Dependency-free RGBA image resampling shared by document renderers.

Class 

`OfficeIMO.Drawing`

**Namespace**

`OfficeIMO.Drawing`

**Assembly**

`OfficeIMO.Core`

**Source revision**

`ba882f6b0d07` with working tree changes

**Source**

[OfficeRasterResampler.cs:53](https://github.com/EvotecIT/OfficeIMO/blob/ba882f6b0d07acddd884b5e7d3086b0cfff0a05a/OfficeIMO.Core/Raster/OfficeRasterResampler.cs#L53)

**Modifiers**

static

Dependency-free RGBA image resampling shared by document renderers.

## Inheritance

- object
- OfficeRasterResampler

Filter members 

Show inherited

## Methods

`public static long GetResizeWorkingSetBytes(int sourceWidth, int sourceHeight, int width, int height, OfficeRasterResamplingMode mode = Bilinear, CancellationToken cancellationToken = default)` [#](#method-getresizeworkingsetbytes-int32-int32-int32-int32-officeimo-drawing-officerasterresamplingmode-threading-cancellationtoken)

[OfficeRasterResampler.Planning.cs:15](https://github.com/EvotecIT/OfficeIMO/blob/ba882f6b0d07acddd884b5e7d3086b0cfff0a05a/OfficeIMO.Core/Raster/OfficeRasterResampler.Planning.cs#L15)

Plans the managed working-set bytes required to resize an image without allocating its pixel buffers.

Parameters

**sourceWidth int required**

Source width in pixels.

**sourceHeight int required**

Source height in pixels.

**width int required**

Destination width in pixels.

**height int required**

Destination height in pixels.

**mode OfficeIMO.Drawing.OfficeRasterResamplingMode = Bilinear optional**

The sampling kernel used by the resize operation.

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

Observes cancellation during contribution planning.

Returns

`long` The planned managed working-set bytes for this operation.

`public static OfficeRasterResizePlan PlanResize(int sourceWidth, int sourceHeight, OfficeRasterResizeOptions options, CancellationToken cancellationToken = default)` [#](#method-planresize-int32-int32-officeimo-drawing-officerasterresizeoptions-threading-cancellationtoken)

[OfficeRasterResampler.ResizePlan.cs:6](https://github.com/EvotecIT/OfficeIMO/blob/ba882f6b0d07acddd884b5e7d3086b0cfff0a05a/OfficeIMO.Core/Raster/OfficeRasterResampler.ResizePlan.cs#L6)

Captures fit, pixel rounding, crop and peak storage before allocating raster pixels.

Parameters

**sourceWidth int required**

**sourceHeight int required**

**options OfficeIMO.Drawing.OfficeRasterResizeOptions required**

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

Returns

`OfficeRasterResizePlan`

Resize 5 overloads

`public static OfficeRasterImage Resize(OfficeRasterImage source, int width, int height, OfficeRasterResamplingMode mode = Bilinear)` [#](#method-resize-officeimo-drawing-officerasterimage-int32-int32-officeimo-drawing-officerasterresamplingmode)

[OfficeRasterResampler.cs:53](https://github.com/EvotecIT/OfficeIMO/blob/ba882f6b0d07acddd884b5e7d3086b0cfff0a05a/OfficeIMO.Core/Raster/OfficeRasterResampler.cs#L53)

Resizes an RGBA image to exact pixel dimensions.

Parameters

**source OfficeIMO.Drawing.OfficeRasterImage required**

**width int required**

**height int required**

**mode OfficeIMO.Drawing.OfficeRasterResamplingMode = Bilinear optional**

Returns

`OfficeRasterImage`

`public static OfficeRasterImage Resize(OfficeRasterImage source, int width, int height, OfficeRasterResamplingMode mode, OfficeRasterResamplingColorSpace colorSpace)` [#](#method-resize-officeimo-drawing-officerasterimage-int32-int32-officeimo-drawing-officerasterresamplingmode-officeimo-drawing-officerasterresamplingcolorspace)

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

Resizes an RGBA image to exact pixel dimensions using an explicit filtering color space.

Parameters

**source OfficeIMO.Drawing.OfficeRasterImage required**

**width int required**

**height int required**

**mode OfficeIMO.Drawing.OfficeRasterResamplingMode required**

**colorSpace OfficeIMO.Drawing.OfficeRasterResamplingColorSpace required**

Returns

`OfficeRasterImage`

`public static OfficeRasterImage Resize(OfficeRasterImage source, int width, int height, OfficeRasterResamplingMode mode, OfficeRasterResamplingColorSpace colorSpace, CancellationToken cancellationToken)` [#](#method-resize-officeimo-drawing-officerasterimage-int32-int32-officeimo-drawing-officerasterresamplingmode-officeimo-drawing-officerasterresamplingcolorspace-threading-cancellationtoken)

[OfficeRasterResampler.cs:67](https://github.com/EvotecIT/OfficeIMO/blob/ba882f6b0d07acddd884b5e7d3086b0cfff0a05a/OfficeIMO.Core/Raster/OfficeRasterResampler.cs#L67)

Resizes an image while observing cancellation during contribution planning and pixel filtering.

Parameters

**source OfficeIMO.Drawing.OfficeRasterImage required**

**width int required**

**height int required**

**mode OfficeIMO.Drawing.OfficeRasterResamplingMode required**

**colorSpace OfficeIMO.Drawing.OfficeRasterResamplingColorSpace required**

**cancellationToken System.Threading.CancellationToken required**

Returns

`OfficeRasterImage`

`public static OfficeRasterImage Resize(OfficeRasterImage source, OfficeRasterResizeOptions options, CancellationToken cancellationToken = default)` [#](#method-resize-officeimo-drawing-officerasterimage-officeimo-drawing-officerasterresizeoptions-threading-cancellationtoken)

[OfficeRasterResampler.ResizePlan.cs:46](https://github.com/EvotecIT/OfficeIMO/blob/ba882f6b0d07acddd884b5e7d3086b0cfff0a05a/OfficeIMO.Core/Raster/OfficeRasterResampler.ResizePlan.cs#L46)

Returns independently resized pixels using requested fit bounds and sampling.

Parameters

**source OfficeIMO.Drawing.OfficeRasterImage required**

**options OfficeIMO.Drawing.OfficeRasterResizeOptions required**

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

Returns

`OfficeRasterImage`

`public static OfficeRasterImage Resize(OfficeRasterImage source, OfficeRasterResizePlan plan, CancellationToken cancellationToken = default)` [#](#method-resize-officeimo-drawing-officerasterimage-officeimo-drawing-officerasterresizeplan-threading-cancellationtoken)

[OfficeRasterResampler.ResizePlan.cs:53](https://github.com/EvotecIT/OfficeIMO/blob/ba882f6b0d07acddd884b5e7d3086b0cfff0a05a/OfficeIMO.Core/Raster/OfficeRasterResampler.ResizePlan.cs#L53)

Executes an immutable resize plan against its required source dimensions, without modifying the source.

Parameters

**source OfficeIMO.Drawing.OfficeRasterImage required**

**plan OfficeIMO.Drawing.OfficeRasterResizePlan required**

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

Returns

`OfficeRasterImage`

`public static OfficeRasterImage Transform(OfficeRasterImage source, OfficeTransform sourceToDestination, int width, int height, OfficeColor? background = null, CancellationToken cancellationToken = default)` [#](#method-transform-officeimo-drawing-officerasterimage-officeimo-drawing-officetransform-int32-int32-nullable-officeimo-officecolor-threading-cancellationtoken)

[OfficeRasterResampler.Transform.cs:8](https://github.com/EvotecIT/OfficeIMO/blob/ba882f6b0d07acddd884b5e7d3086b0cfff0a05a/OfficeIMO.Core/Raster/OfficeRasterResampler.Transform.cs#L8)

Resamples an affine-transformed image into a bounded canvas, filling uncovered pixels with the background.

Parameters

**source OfficeIMO.Drawing.OfficeRasterImage required**

**sourceToDestination OfficeIMO.Drawing.OfficeTransform required**

**width int required**

**height int required**

**background OfficeIMO.OfficeColor? = null optional**

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

Returns

`OfficeRasterImage`

## 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:688BC8D2FC7B9C4CA88B2AA41BE2C5E3EE0E2AD81E17E11EC8DA826C31D0D56B -->
