Skip to main content

Search OfficeIMO

Enter a topic, API type, or PowerShell command.

Documentation Search all OfficeIMO/
Class

OfficeTiffCodec

OfficeIMO.Drawing

Namespace
OfficeIMO.Drawing
Assembly
OfficeIMO.Core
Source revision
ba882f6b0d07 with working tree changes
Modifiers
static

Dependency-free classic TIFF encoder for single-page RGBA images.

Inheritance

  • object
  • OfficeTiffCodec

Methods

public static byte[] Encode(OfficeRasterImage image, OfficeTiffEncodeOptions? options = null) #

Encodes a single RGBA image as a little-endian baseline TIFF.

Parameters

image OfficeIMO.Drawing.OfficeRasterImage required
options OfficeIMO.Drawing.OfficeTiffEncodeOptions? = null optional

Returns

byte[]
EncodePages 2 overloads
public static byte[] EncodePages(IReadOnlyList<OfficeRasterImage> pages, OfficeTiffEncodeOptions? options = null) #

Encodes one or more RGBA pages as a bounded classic TIFF IFD chain.

Parameters

pages System.Collections.Generic.IReadOnlyList<OfficeIMO.Drawing.OfficeRasterImage> required
options OfficeIMO.Drawing.OfficeTiffEncodeOptions? = null optional

Returns

byte[]
public static byte[] EncodePages(IReadOnlyList<OfficeRasterImage> pages, OfficeTiffEncodeOptions? options, CancellationToken cancellationToken) #

Encodes bounded TIFF pages while observing cancellation during planning, compression, and copying.

Parameters

pages System.Collections.Generic.IReadOnlyList<OfficeIMO.Drawing.OfficeRasterImage> required
options OfficeIMO.Drawing.OfficeTiffEncodeOptions? required
cancellationToken System.Threading.CancellationToken required

Returns

byte[]
EncodePagesTo 2 overloads
public static void EncodePagesTo(IReadOnlyList<OfficeRasterImage> pages, Stream destination, OfficeTiffEncodeOptions? options = null) #

Encodes one or more RGBA pages to a caller-owned writable stream.

Parameters

pages System.Collections.Generic.IReadOnlyList<OfficeIMO.Drawing.OfficeRasterImage> required
destination System.IO.Stream required
options OfficeIMO.Drawing.OfficeTiffEncodeOptions? = null optional
public static void EncodePagesTo(IReadOnlyList<OfficeRasterImage> pages, Stream destination, OfficeTiffEncodeOptions? options, CancellationToken cancellationToken) #

Encodes TIFF pages to a writable stream while observing cancellation during encoding and writes.

Parameters

pages System.Collections.Generic.IReadOnlyList<OfficeIMO.Drawing.OfficeRasterImage> required
destination System.IO.Stream required
options OfficeIMO.Drawing.OfficeTiffEncodeOptions? required
cancellationToken System.Threading.CancellationToken required
EncodeTo 2 overloads
public static void EncodeTo(OfficeRasterImage image, Stream destination, OfficeTiffEncodeOptions? options = null) #

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

Parameters

image OfficeIMO.Drawing.OfficeRasterImage required
destination System.IO.Stream required
options OfficeIMO.Drawing.OfficeTiffEncodeOptions? = null optional
public static void EncodeTo(OfficeRasterImage image, IBufferWriter<byte> destination, OfficeTiffEncodeOptions? options = null) #

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

Parameters

image OfficeIMO.Drawing.OfficeRasterImage required
destination System.Buffers.IBufferWriter<byte> required
options OfficeIMO.Drawing.OfficeTiffEncodeOptions? = null optional
public static bool IsTiff(byte[]? encodedBytes) #

Returns whether the payload starts with a TIFF byte-order marker and magic value.

Parameters

encodedBytes byte[]? required

Returns

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

Attempts to decode classic grayscale, RGB, RGBA, or device-CMYK TIFF with unsigned 8/12/16-bit or finite floating 16/24/32/64-bit samples, or packed 1/4-bit grayscale and 1/4/8-bit palette TIFF using chunky or planar strips or tiles with uncompressed, LZW, PackBits, or Deflate payloads. Bilevel CCITT, baseline eight-bit, extended-sequential eight/twelve-bit and Huffman/arithmetic lossless two-through-sixteen-bit JPEG TIFF are supported, including bounded legacy compression-6 layouts. Floating samples are normalized device components; BigTIFF payloads remain caller-codec responsibilities.

Parameters

encodedBytes byte[]? required
image OfficeIMO.Drawing.OfficeRasterImage? required

Returns

bool
public static bool TryDecodePage(byte[]? encodedBytes, int pageIndex, out OfficeRasterImage? image) #

Attempts to decode one zero-based page from a bounded classic TIFF container.

Parameters

encodedBytes byte[]? required
pageIndex int required
image OfficeIMO.Drawing.OfficeRasterImage? required

Returns

bool
public static bool TryGetPageCount(byte[]? encodedBytes, out int pageCount) #

Reads the number of top-level images from a bounded classic TIFF IFD chain.

Parameters

encodedBytes byte[]? required
pageCount int required

Returns

bool