CodeGlyphX logo
CodeGlyphX

API Reference

Class

OtpQrSafety

Edit on GitHub
Namespace CodeGlyphX
Assembly CodeGlyphX
Source CodeGlyphX/OtpQrSafety.cs:27
Modifiers static

Safety checks for OTP QR rendering parameters.

Inheritance

  • Object
  • OtpQrSafety

Methods

public static OtpQrSafetyReport Evaluate(QrCode qr, QrPngRenderOptions opts, Boolean requireHighEcc = true) #
CodeGlyphX/OtpQrSafety.cs:43
Returns: OtpQrSafetyReport

Evaluates OTP scan safety for a rendered QR code.

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/OtpQrSafety.cs:27
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