CodeGlyphX logo
CodeGlyphX

API Reference

Class

QrWebpRenderer

Edit on GitHub
Namespace CodeGlyphX.Rendering.Webp
Assembly CodeGlyphX
Source CodeGlyphX/Rendering/Webp/QrWebpRenderer.cs:16
Modifiers static

Renders QR modules to WebP images.

Inheritance

  • Object
  • QrWebpRenderer

Methods

Render 2 overloads
public static Byte[] Render(BitMatrix modules, QrPngRenderOptions opts) #
CodeGlyphX/Rendering/Webp/QrWebpRenderer.cs:16
Returns: Byte[]

Renders the QR module matrix to a WebP byte array (lossless VP8L).

Parameters

modules CodeGlyphX.BitMatrix requiredposition: 0
opts CodeGlyphX.Rendering.Png.QrPngRenderOptions requiredposition: 1
public static Byte[] Render(BitMatrix modules, QrPngRenderOptions opts, Int32 quality = 100) #
CodeGlyphX/Rendering/Webp/QrWebpRenderer.cs:27
Returns: Byte[]

Renders the QR module matrix to a WebP byte array (lossy VP8 when possible).

Parameters

modules CodeGlyphX.BitMatrix requiredposition: 0
QR modules.
opts CodeGlyphX.Rendering.Png.QrPngRenderOptions requiredposition: 1
Rendering options.
quality System.Int32 = 100 optionalposition: 2
Quality (0-100). Values >= 100 use lossless VP8L.
RenderAnimation 2 overloads
public static Byte[] RenderAnimation(BitMatrix[] frames, QrPngRenderOptions opts, Int32[] durationsMs, WebpAnimationOptions options = null, Int32 quality = 100) #
CodeGlyphX/Rendering/Webp/QrWebpRenderer.cs:130
Returns: Byte[]

Renders an animated WebP from multiple QR module frames.

Parameters

frames CodeGlyphX.BitMatrix[] requiredposition: 0
QR module frames.
opts CodeGlyphX.Rendering.Png.QrPngRenderOptions requiredposition: 1
Rendering options.
durationMs System.Int32 requiredposition: 2
Per-frame duration in milliseconds.
options CodeGlyphX.Rendering.Webp.WebpAnimationOptions = null optionalposition: 3
Animation options.
quality System.Int32 = 100 optionalposition: 4
Quality (0-100). Values >= 100 use lossless VP8L.
RenderAnimation(CodeGlyphX.BitMatrix[] frames, CodeGlyphX.Rendering.Png.QrPngRenderOptions opts, System.Int32[] durationsMs, CodeGlyphX.Rendering.Webp.WebpAnimationOptions options, System.Int32 quality) #

Renders an animated WebP from multiple QR module frames with per-frame durations.

Parameters

frames CodeGlyphX.BitMatrix[] required
opts CodeGlyphX.Rendering.Png.QrPngRenderOptions required
durationsMs System.Int32[] required
options CodeGlyphX.Rendering.Webp.WebpAnimationOptions required
quality System.Int32 required
RenderAnimationToFile 4 overloads
public static String RenderAnimationToFile(BitMatrix[] frames, QrPngRenderOptions opts, Int32[] durationsMs, String path, WebpAnimationOptions options = null, Int32 quality = 100) #
CodeGlyphX/Rendering/Webp/QrWebpRenderer.cs:186
Returns: String

Renders an animated WebP to a file from multiple QR module frames.

Parameters

frames CodeGlyphX.BitMatrix[] requiredposition: 0
opts CodeGlyphX.Rendering.Png.QrPngRenderOptions requiredposition: 1
durationMs System.Int32 requiredposition: 2
path System.String requiredposition: 3
options CodeGlyphX.Rendering.Webp.WebpAnimationOptions = null optionalposition: 4
quality System.Int32 = 100 optionalposition: 5
RenderAnimationToFile(CodeGlyphX.BitMatrix[] frames, CodeGlyphX.Rendering.Png.QrPngRenderOptions opts, System.Int32[] durationsMs, System.String path, CodeGlyphX.Rendering.Webp.WebpAnimationOptions options, System.Int32 quality) #

Renders an animated WebP to a file from multiple QR module frames with per-frame durations.

Parameters

frames CodeGlyphX.BitMatrix[] required
opts CodeGlyphX.Rendering.Png.QrPngRenderOptions required
durationsMs System.Int32[] required
path System.String required
options CodeGlyphX.Rendering.Webp.WebpAnimationOptions required
quality System.Int32 required
public static String RenderAnimationToFile(BitMatrix[] frames, QrPngRenderOptions opts, Int32[] durationsMs, String directory, String fileName, WebpAnimationOptions options = null, Int32 quality = 100) #
CodeGlyphX/Rendering/Webp/QrWebpRenderer.cs:202
Returns: String

Renders an animated WebP to a file under the specified directory.

Parameters

frames CodeGlyphX.BitMatrix[] requiredposition: 0
opts CodeGlyphX.Rendering.Png.QrPngRenderOptions requiredposition: 1
durationMs System.Int32 requiredposition: 2
directory System.String requiredposition: 3
fileName System.String requiredposition: 4
options CodeGlyphX.Rendering.Webp.WebpAnimationOptions = null optionalposition: 5
quality System.Int32 = 100 optionalposition: 6
RenderAnimationToFile(CodeGlyphX.BitMatrix[] frames, CodeGlyphX.Rendering.Png.QrPngRenderOptions opts, System.Int32[] durationsMs, System.String directory, System.String fileName, CodeGlyphX.Rendering.Webp.WebpAnimationOptions options, System.Int32 quality) #

Renders an animated WebP to a file under the specified directory with per-frame durations.

Parameters

frames CodeGlyphX.BitMatrix[] required
opts CodeGlyphX.Rendering.Png.QrPngRenderOptions required
durationsMs System.Int32[] required
directory System.String required
fileName System.String required
options CodeGlyphX.Rendering.Webp.WebpAnimationOptions required
quality System.Int32 required
RenderAnimationToStream 2 overloads
public static Void RenderAnimationToStream(BitMatrix[] frames, QrPngRenderOptions opts, Int32[] durationsMs, Stream stream, WebpAnimationOptions options = null, Int32 quality = 100) #
CodeGlyphX/Rendering/Webp/QrWebpRenderer.cs:169
Returns: Void

Renders an animated WebP to a stream from multiple QR module frames.

Parameters

frames CodeGlyphX.BitMatrix[] requiredposition: 0
opts CodeGlyphX.Rendering.Png.QrPngRenderOptions requiredposition: 1
durationMs System.Int32 requiredposition: 2
stream System.IO.Stream requiredposition: 3
options CodeGlyphX.Rendering.Webp.WebpAnimationOptions = null optionalposition: 4
quality System.Int32 = 100 optionalposition: 5
RenderAnimationToStream(CodeGlyphX.BitMatrix[] frames, CodeGlyphX.Rendering.Png.QrPngRenderOptions opts, System.Int32[] durationsMs, System.IO.Stream stream, CodeGlyphX.Rendering.Webp.WebpAnimationOptions options, System.Int32 quality) #

Renders an animated WebP to a stream from multiple QR module frames with per-frame durations.

Parameters

frames CodeGlyphX.BitMatrix[] required
opts CodeGlyphX.Rendering.Png.QrPngRenderOptions required
durationsMs System.Int32[] required
stream System.IO.Stream required
options CodeGlyphX.Rendering.Webp.WebpAnimationOptions required
quality System.Int32 required
RenderToFile 4 overloads
public static String RenderToFile(BitMatrix modules, QrPngRenderOptions opts, String path) #
CodeGlyphX/Rendering/Webp/QrWebpRenderer.cs:55
Returns: String

Renders the QR module matrix to a WebP file.

Parameters

modules CodeGlyphX.BitMatrix requiredposition: 0
opts CodeGlyphX.Rendering.Png.QrPngRenderOptions requiredposition: 1
path System.String requiredposition: 2
public static String RenderToFile(BitMatrix modules, QrPngRenderOptions opts, String directory, String fileName) #
CodeGlyphX/Rendering/Webp/QrWebpRenderer.cs:76
Returns: String

Renders the QR module matrix to a WebP file (lossy VP8 when possible).

Parameters

modules CodeGlyphX.BitMatrix requiredposition: 0
QR modules.
opts CodeGlyphX.Rendering.Png.QrPngRenderOptions requiredposition: 1
Rendering options.
path System.String requiredposition: 2
Output file path.
quality System.Int32 = 100 requiredposition: 3
Quality (0-100). Values >= 100 use lossless VP8L.

Returns

The output file path.

RenderToFile(CodeGlyphX.BitMatrix modules, CodeGlyphX.Rendering.Png.QrPngRenderOptions opts, System.String directory, System.String fileName) #

Renders the QR module matrix to a WebP file under the specified directory.

Parameters

modules CodeGlyphX.BitMatrix required
opts CodeGlyphX.Rendering.Png.QrPngRenderOptions required
directory System.String required
fileName System.String required
public static String RenderToFile(BitMatrix modules, QrPngRenderOptions opts, String directory, String fileName, Int32 quality = 100) #
CodeGlyphX/Rendering/Webp/QrWebpRenderer.cs:90
Returns: String

Renders the QR module matrix to a WebP file under the specified directory (lossy VP8 when possible).

Parameters

modules CodeGlyphX.BitMatrix requiredposition: 0
QR modules.
opts CodeGlyphX.Rendering.Png.QrPngRenderOptions requiredposition: 1
Rendering options.
directory System.String requiredposition: 2
Output directory.
fileName System.String requiredposition: 3
Output file name.
quality System.Int32 = 100 optionalposition: 4
Quality (0-100). Values >= 100 use lossless VP8L.

Returns

The output file path.

RenderToStream 2 overloads
public static Void RenderToStream(BitMatrix modules, QrPngRenderOptions opts, Stream stream) #
CodeGlyphX/Rendering/Webp/QrWebpRenderer.cs:35
Returns: Void

Renders the QR module matrix to a WebP stream.

Parameters

modules CodeGlyphX.BitMatrix requiredposition: 0
opts CodeGlyphX.Rendering.Png.QrPngRenderOptions requiredposition: 1
stream System.IO.Stream requiredposition: 2
public static Void RenderToStream(BitMatrix modules, QrPngRenderOptions opts, Stream stream, Int32 quality = 100) #
CodeGlyphX/Rendering/Webp/QrWebpRenderer.cs:47
Returns: Void

Renders the QR module matrix to a WebP stream (lossy VP8 when possible).

Parameters

modules CodeGlyphX.BitMatrix requiredposition: 0
QR modules.
opts CodeGlyphX.Rendering.Png.QrPngRenderOptions requiredposition: 1
Rendering options.
stream System.IO.Stream requiredposition: 2
Target stream.
quality System.Int32 = 100 optionalposition: 3
Quality (0-100). Values >= 100 use lossless VP8L.