Skip to main content

Search OfficeIMO

Enter a topic, API type, or PowerShell command.

Documentation Search all OfficeIMO/
Class

OfficeWebpCodec

OfficeIMO.Drawing

Namespace
OfficeIMO.Drawing
Assembly
OfficeIMO.Core
Source revision
ba882f6b0d07 with working tree changes
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) #

Encodes an RGBA image as a lossless VP8L WebP image.

Parameters

image OfficeIMO.Drawing.OfficeRasterImage required

Returns

byte[]
public static byte[] Encode(OfficeRasterImage image, double dpiX, double dpiY) #

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

Parameters

image OfficeIMO.Drawing.OfficeRasterImage required
dpiX double required
dpiY double required

Returns

byte[]
public static byte[] Encode(OfficeRasterImage image, OfficeWebpEncodeOptions options) #

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

Parameters

image OfficeIMO.Drawing.OfficeRasterImage required
options OfficeIMO.Drawing.OfficeWebpEncodeOptions required

Returns

byte[]
public static byte[] Encode(OfficeRasterImage image, OfficeWebpEncodeOptions options, CancellationToken cancellationToken) #

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

Parameters

image OfficeIMO.Drawing.OfficeRasterImage required
options OfficeIMO.Drawing.OfficeWebpEncodeOptions required
cancellationToken System.Threading.CancellationToken required

Returns

byte[]
EncodeTo 6 overloads
public static void EncodeTo(OfficeRasterImage image, Stream destination, OfficeWebpEncodeOptions options, CancellationToken cancellationToken = default) #

Encodes WebP to a caller-owned writable stream.

Parameters

image OfficeIMO.Drawing.OfficeRasterImage required
destination System.IO.Stream required
options OfficeIMO.Drawing.OfficeWebpEncodeOptions required
cancellationToken System.Threading.CancellationToken = default optional
public static void EncodeTo(OfficeRasterImage image, IBufferWriter<byte> destination, OfficeWebpEncodeOptions options, CancellationToken cancellationToken = default) #

Encodes WebP to a caller-owned buffer writer.

Parameters

image OfficeIMO.Drawing.OfficeRasterImage required
destination System.Buffers.IBufferWriter<byte> required
options OfficeIMO.Drawing.OfficeWebpEncodeOptions required
cancellationToken System.Threading.CancellationToken = default optional
public static void EncodeTo(OfficeRasterImage image, Stream destination) #

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

Parameters

image OfficeIMO.Drawing.OfficeRasterImage required
destination System.IO.Stream required
public static void EncodeTo(OfficeRasterImage image, Stream destination, double dpiX, double dpiY) #

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

Parameters

image OfficeIMO.Drawing.OfficeRasterImage required
destination System.IO.Stream required
dpiX double required
dpiY double required
public static void EncodeTo(OfficeRasterImage image, IBufferWriter<byte> destination) #

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

Parameters

image OfficeIMO.Drawing.OfficeRasterImage required
destination System.Buffers.IBufferWriter<byte> required
public static void EncodeTo(OfficeRasterImage image, IBufferWriter<byte> destination, double dpiX, double dpiY) #

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

Parameters

image OfficeIMO.Drawing.OfficeRasterImage required
destination System.Buffers.IBufferWriter<byte> required
dpiX double required
dpiY double required
public static bool IsWebp(byte[]? encodedBytes) #

Returns whether the payload is a RIFF WebP container.

Parameters

encodedBytes byte[]? required

Returns

bool
public static bool TryDecode(byte[]? encodedBytes, out OfficeRasterImage? image) #

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 byte[]? required
image OfficeIMO.Drawing.OfficeRasterImage? required

Returns

bool