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

OfficeWebpCodec

Edit on GitHub
Namespace OfficeIMO.Drawing
Assembly OfficeIMO.Core
Source OfficeWebpCodec.cs:20
Modifiers static

Managed WebP encoding and decoding for RGBA images.

Inheritance

  • Object
  • OfficeWebpCodec

Remarks

Lossless encoding deterministically selects between a literal VP8L stream and a bounded prediction, subtract-green, and LZ77 stream. Explicit lossy encoding uses VP8 YUV 4:2:0 and exact alpha. Decoding supports bounded VP8 keyframes with optional raw or lossless-compressed alpha and lossless VP8L; animation remains a caller-codec responsibility.

Methods

Encode 4 overloads
public static Byte[] Encode(OfficeRasterImage image) #
OfficeWebpCodec.cs:25
Returns: Byte[]

Encodes an RGBA image as a lossless VP8L WebP image.

Parameters

image OfficeIMO.Drawing.OfficeRasterImage requiredposition: 0
public static Byte[] Encode(OfficeRasterImage image, Double dpiX, Double dpiY) #
OfficeWebpCodec.cs:30
Returns: Byte[]

Encodes an RGBA image as a lossless VP8L WebP image with Exif resolution metadata.

Parameters

image OfficeIMO.Drawing.OfficeRasterImage requiredposition: 0
dpiX System.Double requiredposition: 1
dpiY System.Double requiredposition: 2
public static Byte[] Encode(OfficeRasterImage image, OfficeWebpEncodeOptions options) #
OfficeWebpCodec.Lossy.cs:14
Returns: Byte[]

Encodes an image with an explicit lossless or lossy WebP compression mode.

Parameters

image OfficeIMO.Drawing.OfficeRasterImage requiredposition: 0
options OfficeIMO.Drawing.OfficeWebpEncodeOptions requiredposition: 1
public static Byte[] Encode(OfficeRasterImage image, OfficeWebpEncodeOptions options, CancellationToken cancellationToken) #
OfficeWebpCodec.Lossy.cs:20
Returns: Byte[]

Encodes an image with cancellation and an explicit WebP compression mode.

Parameters

image OfficeIMO.Drawing.OfficeRasterImage requiredposition: 0
options OfficeIMO.Drawing.OfficeWebpEncodeOptions requiredposition: 1
cancellationToken System.Threading.CancellationToken requiredposition: 2
EncodeTo 6 overloads
public static Void EncodeTo(OfficeRasterImage image, Stream destination, OfficeWebpEncodeOptions options, CancellationToken cancellationToken = default) #
OfficeWebpCodec.Lossy.cs:42
Returns: Void

Encodes WebP to a caller-owned writable stream.

Parameters

image OfficeIMO.Drawing.OfficeRasterImage requiredposition: 0
destination System.IO.Stream requiredposition: 1
options OfficeIMO.Drawing.OfficeWebpEncodeOptions requiredposition: 2
cancellationToken System.Threading.CancellationToken = default optionalposition: 3
public static Void EncodeTo(OfficeRasterImage image, IBufferWriter<Byte> destination, OfficeWebpEncodeOptions options, CancellationToken cancellationToken = default) #
OfficeWebpCodec.Lossy.cs:53
Returns: Void

Encodes WebP to a caller-owned buffer writer.

Parameters

image OfficeIMO.Drawing.OfficeRasterImage requiredposition: 0
destination System.Buffers.IBufferWriter<System.Byte> requiredposition: 1
options OfficeIMO.Drawing.OfficeWebpEncodeOptions requiredposition: 2
cancellationToken System.Threading.CancellationToken = default optionalposition: 3
public static Void EncodeTo(OfficeRasterImage image, Stream destination) #
OfficeWebpCodec.Streaming.cs:15
Returns: Void

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

Parameters

image OfficeIMO.Drawing.OfficeRasterImage requiredposition: 0
destination System.IO.Stream requiredposition: 1
public static Void EncodeTo(OfficeRasterImage image, Stream destination, Double dpiX, Double dpiY) #
OfficeWebpCodec.Streaming.cs:25
Returns: Void

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

Parameters

image OfficeIMO.Drawing.OfficeRasterImage requiredposition: 0
destination System.IO.Stream requiredposition: 1
dpiX System.Double requiredposition: 2
dpiY System.Double requiredposition: 3
public static Void EncodeTo(OfficeRasterImage image, IBufferWriter<Byte> destination) #
OfficeWebpCodec.Streaming.cs:48
Returns: Void

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

Parameters

image OfficeIMO.Drawing.OfficeRasterImage requiredposition: 0
destination System.Buffers.IBufferWriter<System.Byte> requiredposition: 1
public static Void EncodeTo(OfficeRasterImage image, IBufferWriter<Byte> destination, Double dpiX, Double dpiY) #
OfficeWebpCodec.Streaming.cs:59
Returns: Void

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

Parameters

image OfficeIMO.Drawing.OfficeRasterImage requiredposition: 0
destination System.Buffers.IBufferWriter<System.Byte> requiredposition: 1
dpiX System.Double requiredposition: 2
dpiY System.Double requiredposition: 3
public static Boolean IsWebp(Byte[]? encodedBytes) #
OfficeWebpCodec.cs:20
Returns: Boolean

Returns whether the payload is a RIFF WebP container.

Parameters

encodedBytes System.Byte[]? requiredposition: 0
public static Boolean TryDecode(Byte[]? encodedBytes, out OfficeRasterImage? image) #
OfficeWebpCodec.cs:204
Returns: Boolean

Attempts to decode bounded ordinary lossless VP8L, including prediction, color, subtract-green, palette, LZ77, color-cache, and Huffman features. VP8 keyframes with raw or lossless-compressed alpha are also decoded; animation remains an optional caller-codec responsibility.

Parameters

encodedBytes System.Byte[]? requiredposition: 0
image OfficeIMO.Drawing.OfficeRasterImage? requiredposition: 1