Skip to main content
SearchCtrl K
Community

Source code

OfficeIMO.NET libraries, CLI, Studio and browser tools 571 stars PSWriteOfficePowerShell module 164 stars

Talk and help

DiscordQuestions, ideas and show and tell Report an issueBugs and feature requests SponsorFund ongoing development

Mode

Background

Search OfficeIMO

Enter a topic, API type, or PowerShell command.

Search the whole siteOpen search page →
Documentation Search all OfficeIMO/

API Reference

Class

OfficeRasterResampler

Edit on GitHub
Namespace OfficeIMO.Drawing
Assembly OfficeIMO.Core
Source OfficeRasterResampler.cs:56
Modifiers static

Dependency-free RGBA image resampling shared by document renderers.

Inheritance

  • Object
  • OfficeRasterResampler

Methods

public static Int64 GetResizeWorkingSetBytes(Int32 sourceWidth, Int32 sourceHeight, Int32 width, Int32 height, OfficeRasterResamplingMode mode = Bilinear, CancellationToken cancellationToken = default) #
OfficeRasterResampler.Planning.cs:18
Returns: Int64

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

Parameters

sourceWidth System.Int32 requiredposition: 0
Source width in pixels.
sourceHeight System.Int32 requiredposition: 1
Source height in pixels.
width System.Int32 requiredposition: 2
Destination width in pixels.
height System.Int32 requiredposition: 3
Destination height in pixels.
mode OfficeIMO.Drawing.OfficeRasterResamplingMode = Bilinear optionalposition: 4
The sampling kernel used by the resize operation.
cancellationToken System.Threading.CancellationToken = default optionalposition: 5
Observes cancellation during contribution planning.

Returns

The planned managed working-set bytes for this operation.

public static OfficeRasterResizePlan PlanResize(Int32 sourceWidth, Int32 sourceHeight, OfficeRasterResizeOptions options, CancellationToken cancellationToken = default) #
OfficeRasterResampler.ResizePlan.cs:9
Returns: OfficeRasterResizePlan

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

Parameters

sourceWidth System.Int32 requiredposition: 0
sourceHeight System.Int32 requiredposition: 1
options OfficeIMO.Drawing.OfficeRasterResizeOptions requiredposition: 2
cancellationToken System.Threading.CancellationToken = default optionalposition: 3
Resize 5 overloads
public static OfficeRasterImage Resize(OfficeRasterImage source, Int32 width, Int32 height, OfficeRasterResamplingMode mode = Bilinear) #
OfficeRasterResampler.cs:56
Returns: OfficeRasterImage

Resizes an RGBA image to exact pixel dimensions.

Parameters

source OfficeIMO.Drawing.OfficeRasterImage requiredposition: 0
width System.Int32 requiredposition: 1
height System.Int32 requiredposition: 2
mode OfficeIMO.Drawing.OfficeRasterResamplingMode = Bilinear optionalposition: 3
public static OfficeRasterImage Resize(OfficeRasterImage source, Int32 width, Int32 height, OfficeRasterResamplingMode mode, OfficeRasterResamplingColorSpace colorSpace) #
OfficeRasterResampler.cs:65
Returns: OfficeRasterImage

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

Parameters

source OfficeIMO.Drawing.OfficeRasterImage requiredposition: 0
width System.Int32 requiredposition: 1
height System.Int32 requiredposition: 2
mode OfficeIMO.Drawing.OfficeRasterResamplingMode requiredposition: 3
colorSpace OfficeIMO.Drawing.OfficeRasterResamplingColorSpace requiredposition: 4
public static OfficeRasterImage Resize(OfficeRasterImage source, Int32 width, Int32 height, OfficeRasterResamplingMode mode, OfficeRasterResamplingColorSpace colorSpace, CancellationToken cancellationToken) #
OfficeRasterResampler.cs:70
Returns: OfficeRasterImage

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

Parameters

source OfficeIMO.Drawing.OfficeRasterImage requiredposition: 0
width System.Int32 requiredposition: 1
height System.Int32 requiredposition: 2
mode OfficeIMO.Drawing.OfficeRasterResamplingMode requiredposition: 3
colorSpace OfficeIMO.Drawing.OfficeRasterResamplingColorSpace requiredposition: 4
cancellationToken System.Threading.CancellationToken requiredposition: 5
public static OfficeRasterImage Resize(OfficeRasterImage source, OfficeRasterResizeOptions options, CancellationToken cancellationToken = default) #
OfficeRasterResampler.ResizePlan.cs:49
Returns: OfficeRasterImage

Returns independently resized pixels using requested fit bounds and sampling.

Parameters

source OfficeIMO.Drawing.OfficeRasterImage requiredposition: 0
options OfficeIMO.Drawing.OfficeRasterResizeOptions requiredposition: 1
cancellationToken System.Threading.CancellationToken = default optionalposition: 2
public static OfficeRasterImage Resize(OfficeRasterImage source, OfficeRasterResizePlan plan, CancellationToken cancellationToken = default) #
OfficeRasterResampler.ResizePlan.cs:56
Returns: OfficeRasterImage

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

Parameters

source OfficeIMO.Drawing.OfficeRasterImage requiredposition: 0
plan OfficeIMO.Drawing.OfficeRasterResizePlan requiredposition: 1
cancellationToken System.Threading.CancellationToken = default optionalposition: 2
public static OfficeRasterImage Transform(OfficeRasterImage source, OfficeTransform sourceToDestination, Int32 width, Int32 height, OfficeColor? background = null, CancellationToken cancellationToken = default) #
OfficeRasterResampler.Transform.cs:11
Returns: OfficeRasterImage

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

Parameters

source OfficeIMO.Drawing.OfficeRasterImage requiredposition: 0
sourceToDestination OfficeIMO.Drawing.OfficeTransform requiredposition: 1
width System.Int32 requiredposition: 2
height System.Int32 requiredposition: 3
background OfficeIMO.Drawing.OfficeColor? = null optionalposition: 4
cancellationToken System.Threading.CancellationToken = default optionalposition: 5