eDosStation/lib/RCWPF/2026.3.1007.462/Telerik.Windows.Documents.JpxDecodeUtils.xml
2026-10-08 16:25:43 +02:00

66 lines
3.7 KiB
XML

<?xml version="1.0"?>
<doc>
<assembly>
<name>Telerik.Windows.Documents.JpxDecodeUtils</name>
</assembly>
<members>
<member name="T:Telerik.Documents.JpxDecodeUtils.JpxImageDecoder">
<summary>
Decodes JPEG 2000 (JPX) image bytes to raw interleaved component data.
</summary>
</member>
<member name="M:Telerik.Documents.JpxDecodeUtils.JpxImageDecoder.#ctor">
<summary>
Initializes a new instance of the <see cref="T:Telerik.Documents.JpxDecodeUtils.JpxImageDecoder"/> class.
</summary>
</member>
<member name="P:Telerik.Documents.JpxDecodeUtils.JpxImageDecoder.MaximumDecodedBytes">
<summary>
Gets or sets the maximum number of decoded bytes allowed for one image.
</summary>
<value>The maximum decoded byte count. The default is 256 MB.</value>
<remarks>
This limit is enforced against an estimate of peak decode memory (final output size multiplied
by <see cref="F:Telerik.Documents.JpxDecodeUtils.JpxImageDecoder.PeakMemoryMultiplier"/>), not just the final interleaved output size, because
The decode path allocates intermediate per-component buffers substantially larger than
the final output.
</remarks>
</member>
<member name="M:Telerik.Documents.JpxDecodeUtils.JpxImageDecoder.TryDecodeJpxImageData(System.Byte[],System.Threading.CancellationToken,System.Boolean,Telerik.Documents.Extensibility.JpxImageDecodeResult@)">
<summary>
Attempt to decode JPX-encoded image bytes and return decoded data with metadata.
</summary>
<param name="imageData">The encoded JPX image data.</param>
<param name="cancellationToken">Token used to cancel the decode operation.</param>
<param name="useEmbeddedColorSpace">Whether the decoder should apply color information embedded in the JPX data.</param>
<param name="result">Decoded image data and metadata.</param>
<returns><c>true</c> if decoding succeeds; otherwise <c>false</c>.</returns>
</member>
<member name="T:Telerik.Documents.JpxDecodeUtils.IJpxCodec">
<summary>
Binds to the configured decoder API and exposes a single decode operation.
Implementations isolate decoder-specific access from <see cref="T:Telerik.Documents.JpxDecodeUtils.JpxImageDecoder"/>.
</summary>
</member>
<member name="M:Telerik.Documents.JpxDecodeUtils.IJpxCodec.Decode(System.Byte[],System.Threading.CancellationToken,System.Boolean)">
<summary>
Decode JPX-encoded image bytes using the underlying decoder API.
</summary>
<param name="imageData">The encoded JPX image data.</param>
<param name="cancellationToken">Token used to cancel the decode operation.</param>
<param name="useEmbeddedColorSpace">Whether to apply color information embedded in the JPX data.</param>
<returns>The decoded image, or <c>null</c> if the underlying decoder returned no image.</returns>
</member>
<member name="T:Telerik.Documents.JpxDecodeUtils.DecodedJpxImage">
<summary>
Codec-agnostic view of a decoded JPX image: dimensions, component count, and per-component sample access.
Wraps the underlying decoder image instance so callers never depend on decoder-specific types.
</summary>
</member>
<member name="T:Telerik.Documents.JpxDecodeUtils.DirectCoreJ2KCodec">
<summary>
Decodes JPX images by calling the CoreJ2K API directly.
</summary>
</member>
</members>
</doc>