CodeGlyphX logo
CodeGlyphX

API Reference

Class

BarcodeWebpRenderer

Namespace CodeGlyphX.Rendering.Webp
Assembly CodeGlyphX
Modifiers static

Renders 1D barcodes to WebP images.

Inheritance

  • Object
  • BarcodeWebpRenderer

Methods

Render 2 overloads
public static Byte[] Render(Barcode1D barcode, BarcodePngRenderOptions opts) #
Returns: Byte[]

Renders the barcode to a WebP byte array (lossless VP8L).

Parameters

barcode CodeGlyphX.Barcode1D requiredposition: 0
opts CodeGlyphX.Rendering.Png.BarcodePngRenderOptions requiredposition: 1
public static Byte[] Render(Barcode1D barcode, BarcodePngRenderOptions opts, Int32 quality = 100) #
Returns: Byte[]

Renders the barcode to a WebP byte array (lossy VP8 when possible).

Parameters

barcode CodeGlyphX.Barcode1D requiredposition: 0
Barcode data.
opts CodeGlyphX.Rendering.Png.BarcodePngRenderOptions 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(Barcode1D[] frames, BarcodePngRenderOptions opts, Int32[] durationsMs, WebpAnimationOptions options = null, Int32 quality = 100) #
Returns: Byte[]

Renders an animated WebP from multiple barcode frames.

Parameters

frames CodeGlyphX.Barcode1D[] requiredposition: 0
opts CodeGlyphX.Rendering.Png.BarcodePngRenderOptions requiredposition: 1
durationMs System.Int32 requiredposition: 2
options CodeGlyphX.Rendering.Webp.WebpAnimationOptions = null optionalposition: 3
quality System.Int32 = 100 optionalposition: 4
RenderAnimation(CodeGlyphX.Barcode1D[] frames, CodeGlyphX.Rendering.Png.BarcodePngRenderOptions opts, System.Int32[] durationsMs, CodeGlyphX.Rendering.Webp.WebpAnimationOptions options, System.Int32 quality) #

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

Parameters

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

Renders an animated WebP to a file from multiple barcode frames.

Parameters

frames CodeGlyphX.Barcode1D[] requiredposition: 0
opts CodeGlyphX.Rendering.Png.BarcodePngRenderOptions 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.Barcode1D[] frames, CodeGlyphX.Rendering.Png.BarcodePngRenderOptions opts, System.Int32[] durationsMs, System.String path, CodeGlyphX.Rendering.Webp.WebpAnimationOptions options, System.Int32 quality) #

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

Parameters

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

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

Parameters

frames CodeGlyphX.Barcode1D[] requiredposition: 0
opts CodeGlyphX.Rendering.Png.BarcodePngRenderOptions 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.Barcode1D[] frames, CodeGlyphX.Rendering.Png.BarcodePngRenderOptions 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.Barcode1D[] required
opts CodeGlyphX.Rendering.Png.BarcodePngRenderOptions 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(Barcode1D[] frames, BarcodePngRenderOptions opts, Int32[] durationsMs, Stream stream, WebpAnimationOptions options = null, Int32 quality = 100) #
Returns: Void

Renders an animated WebP to a stream from multiple barcode frames.

Parameters

frames CodeGlyphX.Barcode1D[] requiredposition: 0
opts CodeGlyphX.Rendering.Png.BarcodePngRenderOptions 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.Barcode1D[] frames, CodeGlyphX.Rendering.Png.BarcodePngRenderOptions 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 barcode frames with per-frame durations.

Parameters

frames CodeGlyphX.Barcode1D[] required
opts CodeGlyphX.Rendering.Png.BarcodePngRenderOptions 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(Barcode1D barcode, BarcodePngRenderOptions opts, String path) #
Returns: String

Renders the barcode to a WebP file.

Parameters

barcode CodeGlyphX.Barcode1D requiredposition: 0
opts CodeGlyphX.Rendering.Png.BarcodePngRenderOptions requiredposition: 1
path System.String requiredposition: 2
public static String RenderToFile(Barcode1D barcode, BarcodePngRenderOptions opts, String directory, String fileName) #
Returns: String

Renders the barcode to a WebP file (lossy VP8 when possible).

Parameters

barcode CodeGlyphX.Barcode1D requiredposition: 0
Barcode data.
opts CodeGlyphX.Rendering.Png.BarcodePngRenderOptions 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.Barcode1D barcode, CodeGlyphX.Rendering.Png.BarcodePngRenderOptions opts, System.String directory, System.String fileName) #

Renders the barcode to a WebP file under the specified directory.

Parameters

barcode CodeGlyphX.Barcode1D required
opts CodeGlyphX.Rendering.Png.BarcodePngRenderOptions required
directory System.String required
fileName System.String required
public static String RenderToFile(Barcode1D barcode, BarcodePngRenderOptions opts, String directory, String fileName, Int32 quality = 100) #
Returns: String

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

Parameters

barcode CodeGlyphX.Barcode1D requiredposition: 0
Barcode data.
opts CodeGlyphX.Rendering.Png.BarcodePngRenderOptions 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(Barcode1D barcode, BarcodePngRenderOptions opts, Stream stream) #
Returns: Void

Renders the barcode to a WebP stream.

Parameters

barcode CodeGlyphX.Barcode1D requiredposition: 0
opts CodeGlyphX.Rendering.Png.BarcodePngRenderOptions requiredposition: 1
stream System.IO.Stream requiredposition: 2
public static Void RenderToStream(Barcode1D barcode, BarcodePngRenderOptions opts, Stream stream, Int32 quality = 100) #
Returns: Void

Renders the barcode to a WebP stream (lossy VP8 when possible).

Parameters

barcode CodeGlyphX.Barcode1D requiredposition: 0
Barcode data.
opts CodeGlyphX.Rendering.Png.BarcodePngRenderOptions 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.