CodeGlyphX logo
CodeGlyphX

API Reference

Class

ImageDecodeOptions

Edit on GitHub
Namespace CodeGlyphX
Assembly CodeGlyphX
Source CodeGlyphX/ImageDecodeOptions.cs:55
Modifiers sealed

Options for decoding from image sources (non-QR). Use Int32)/Int32) or set explicit limits for untrusted inputs.

Inheritance

  • Object
  • ImageDecodeOptions

Usage

This type appears in these public API surfaces even when no hand-authored example is attached directly to the page.

Returned or exposed by

Accepted by parameters

Constructors

public ImageDecodeOptions() #

Methods

public static ImageDecodeOptions Safe(Int32 maxBytes = 67108864, Int64 maxPixels = 20000000, Int32 maxAnimationFrames = 120, Int32 maxAnimationDurationMs = 60000, Int64 maxAnimationFramePixels = 20000000, Int32 maxDimension = 0) #
CodeGlyphX/ImageDecodeOptions.cs:71
Returns: ImageDecodeOptions

Safe preset for untrusted images (caps bytes, pixels, and animation limits).

Parameters

maxBytes System.Int32 = 67108864 optionalposition: 0
maxPixels System.Int64 = 20000000 optionalposition: 1
maxAnimationFrames System.Int32 = 120 optionalposition: 2
maxAnimationDurationMs System.Int32 = 60000 optionalposition: 3
maxAnimationFramePixels System.Int64 = 20000000 optionalposition: 4
maxDimension System.Int32 = 0 optionalposition: 5
public static ImageDecodeOptions Screen(Int32 maxMilliseconds = 300, Int32 maxDimension = 1200) #
CodeGlyphX/ImageDecodeOptions.cs:55
Returns: ImageDecodeOptions

Screen preset (budgeted decode for UI capture scenarios).

Parameters

maxMilliseconds System.Int32 = 300 optionalposition: 0
maxDimension System.Int32 = 1200 optionalposition: 1
public static ImageDecodeOptions UltraSafe(Int32 maxBytes = 8388608, Int64 maxPixels = 8000000, Int32 maxAnimationFrames = 60, Int32 maxAnimationDurationMs = 15000, Int64 maxAnimationFramePixels = 8000000, Int32 maxDimension = 0) #
CodeGlyphX/ImageDecodeOptions.cs:93
Returns: ImageDecodeOptions

Ultra-safe preset for untrusted images (tighter caps for hostile inputs).

Parameters

maxBytes System.Int32 = 8388608 optionalposition: 0
maxPixels System.Int64 = 8000000 optionalposition: 1
maxAnimationFrames System.Int32 = 60 optionalposition: 2
maxAnimationDurationMs System.Int32 = 15000 optionalposition: 3
maxAnimationFramePixels System.Int64 = 8000000 optionalposition: 4
maxDimension System.Int32 = 0 optionalposition: 5
public ImageDecodeOptions WithBudget(Int32 maxMilliseconds, Int32 maxDimension = 0) #
CodeGlyphX/ImageDecodeOptions.Fluent.cs:26
Returns: ImageDecodeOptions

Sets the time+dimension budget in one call.

Parameters

maxMilliseconds System.Int32 requiredposition: 0
maxDimension System.Int32 = 0 optionalposition: 1
WithJpegOptions 2 overloads
public ImageDecodeOptions WithJpegOptions(JpegDecodeOptions options) #
CodeGlyphX/ImageDecodeOptions.Fluent.cs:83
Returns: ImageDecodeOptions

Sets JPEG decoding options.

Parameters

options CodeGlyphX.Rendering.Jpeg.JpegDecodeOptions requiredposition: 0

Examples


var options = new ImageDecodeOptions()
    .WithJpegOptions(highQualityChroma: true, allowTruncated: true);
public ImageDecodeOptions WithJpegOptions(Boolean highQualityChroma = false, Boolean allowTruncated = false) #
CodeGlyphX/ImageDecodeOptions.Fluent.cs:97
Returns: ImageDecodeOptions

Sets JPEG decoding options.

Parameters

highQualityChroma System.Boolean = false optionalposition: 0
allowTruncated System.Boolean = false optionalposition: 1

Examples


var options = new ImageDecodeOptions()
    .WithJpegOptions(highQualityChroma: true);
public ImageDecodeOptions WithMaxAnimationDurationMs(Int32 maxDurationMs) #
CodeGlyphX/ImageDecodeOptions.Fluent.cs:61
Returns: ImageDecodeOptions

Sets the maximum total animation duration (milliseconds) allowed for decoding.

Parameters

maxDurationMs System.Int32 requiredposition: 0
public ImageDecodeOptions WithMaxAnimationFramePixels(Int64 maxPixels) #
CodeGlyphX/ImageDecodeOptions.Fluent.cs:69
Returns: ImageDecodeOptions

Sets the maximum pixel count allowed per animation frame.

Parameters

maxPixels System.Int64 requiredposition: 0
public ImageDecodeOptions WithMaxAnimationFrames(Int32 maxFrames) #
CodeGlyphX/ImageDecodeOptions.Fluent.cs:53
Returns: ImageDecodeOptions

Sets the maximum animation frame count allowed for decoding.

Parameters

maxFrames System.Int32 requiredposition: 0
public ImageDecodeOptions WithMaxBytes(Int32 maxBytes) #
CodeGlyphX/ImageDecodeOptions.Fluent.cs:45
Returns: ImageDecodeOptions

Sets the maximum input size in bytes for decoding.

Parameters

maxBytes System.Int32 requiredposition: 0
public ImageDecodeOptions WithMaxDimension(Int32 maxDimension) #
CodeGlyphX/ImageDecodeOptions.Fluent.cs:10
Returns: ImageDecodeOptions

Sets maximum image dimension (pixels) for decoding.

Parameters

maxDimension System.Int32 requiredposition: 0
public ImageDecodeOptions WithMaxMilliseconds(Int32 maxMilliseconds) #
CodeGlyphX/ImageDecodeOptions.Fluent.cs:18
Returns: ImageDecodeOptions

Sets the maximum decode time budget (milliseconds).

Parameters

maxMilliseconds System.Int32 requiredposition: 0
public ImageDecodeOptions WithMaxPixels(Int64 maxPixels) #
CodeGlyphX/ImageDecodeOptions.Fluent.cs:37
Returns: ImageDecodeOptions

Sets the maximum pixel count allowed for decoding.

Parameters

maxPixels System.Int64 requiredposition: 0

Properties

public Int32 MaxDimension { get; set; } #
CodeGlyphX/ImageDecodeOptions.cs:14

Maximum image dimension (pixels) for decoding. Larger inputs will be downscaled. Set to 0 to disable.

public Int64 MaxPixels { get; set; } #
CodeGlyphX/ImageDecodeOptions.cs:19

Maximum pixel count allowed for decoding (width * height). Set to 0 to disable.

public Int32 MaxBytes { get; set; } #
CodeGlyphX/ImageDecodeOptions.cs:24

Maximum input size in bytes for decoding. Set to 0 to disable.

public Int32 MaxMilliseconds { get; set; } #
CodeGlyphX/ImageDecodeOptions.cs:29

Maximum milliseconds to spend decoding (best effort). Set to 0 to disable.

public Int32 MaxAnimationFrames { get; set; } #
CodeGlyphX/ImageDecodeOptions.cs:34

Maximum animation frame count allowed for decoding. Set to 0 to use global defaults.

public Int32 MaxAnimationDurationMs { get; set; } #
CodeGlyphX/ImageDecodeOptions.cs:39

Maximum total animation duration (milliseconds) allowed for decoding. Set to 0 to use global defaults.

public Int64 MaxAnimationFramePixels { get; set; } #
CodeGlyphX/ImageDecodeOptions.cs:44

Maximum pixel count allowed per animation frame. Set to 0 to use global defaults.

public Nullable<JpegDecodeOptions> JpegOptions { get; set; } #
CodeGlyphX/ImageDecodeOptions.cs:49

Optional JPEG decoding options (chroma upsampling, truncated handling).