CodeGlyphX logo
CodeGlyphX

API Reference

Class

OtpQrHeuristics

Edit on GitHub
Namespace CodeGlyphX
Assembly CodeGlyphX
Source ../../../../_/CodeGlyphX/OtpQrHeuristics.cs:28
Modifiers static

Static heuristic checks for OTP QR rendering parameters. These checks do not render or decode the output.

Inheritance

  • Object
  • OtpQrHeuristics

Methods

public static OtpQrHeuristicReport Evaluate(QrCode qr, QrPngRenderOptions opts, Boolean requireHighEcc = true) #
../../../../_/CodeGlyphX/OtpQrHeuristics.cs:44
Returns: OtpQrHeuristicReport

Evaluates static OTP QR heuristics for an encoded QR code and render options.

Parameters

qr CodeGlyphX.QrCode requiredposition: 0
opts CodeGlyphX.Rendering.Png.QrPngRenderOptions requiredposition: 1
requireHighEcc System.Boolean = true optionalposition: 2
public static Double GetContrastRatio(Rgba32 foreground, Rgba32 background) #
../../../../_/CodeGlyphX/OtpQrHeuristics.cs:28
Returns: Double

Computes a contrast ratio between two colors (1.0..21.0).

Parameters

foreground CodeGlyphX.Rendering.Png.Rgba32 requiredposition: 0
background CodeGlyphX.Rendering.Png.Rgba32 requiredposition: 1

Fields

public const Int32 RecommendedQuietZone #

Recommended quiet zone size in modules.

Value: 4
public const Int32 RecommendedModuleSize #

Recommended module size in pixels.

Value: 6
public const Double MinimumContrastRatio #

Minimum recommended contrast ratio between foreground and background.

Value: 4