API Reference
Class
MatrixWebpRenderer
Renders generic 2D matrices to WebP images.
Inheritance
- Object
- MatrixWebpRenderer
Methods
Render 2 overloads
public static Byte[] Render(BitMatrix modules, MatrixPngRenderOptions opts) #Returns:
Byte[]Renders the matrix to a WebP byte array (lossless VP8L).
Parameters
- modules CodeGlyphX.BitMatrix
- opts CodeGlyphX.Rendering.Png.MatrixPngRenderOptions
public static Byte[] Render(BitMatrix modules, MatrixPngRenderOptions opts, Int32 quality = 100) #Returns:
Byte[]Renders the matrix to a WebP byte array (lossy VP8 when possible).
Parameters
- modules CodeGlyphX.BitMatrix
- Matrix modules.
- opts CodeGlyphX.Rendering.Png.MatrixPngRenderOptions
- Rendering options.
- quality System.Int32 = 100
- Quality (0-100). Values >= 100 use lossless VP8L.
RenderAnimation 2 overloads
public static Byte[] RenderAnimation(BitMatrix[] frames, MatrixPngRenderOptions opts, Int32 durationMs, WebpAnimationOptions options = null, Int32 quality = 100) #Returns:
Byte[]Renders an animated WebP from multiple matrix frames.
Parameters
- frames CodeGlyphX.BitMatrix[]
- opts CodeGlyphX.Rendering.Png.MatrixPngRenderOptions
- durationMs System.Int32
- options CodeGlyphX.Rendering.Webp.WebpAnimationOptions = null
- quality System.Int32 = 100
public static Byte[] RenderAnimation(BitMatrix[] frames, MatrixPngRenderOptions opts, Int32[] durationsMs, WebpAnimationOptions options = null, Int32 quality = 100) #Returns:
Byte[]Renders an animated WebP from multiple matrix frames with per-frame durations.
Parameters
- frames CodeGlyphX.BitMatrix[]
- opts CodeGlyphX.Rendering.Png.MatrixPngRenderOptions
- durationsMs System.Int32[]
- options CodeGlyphX.Rendering.Webp.WebpAnimationOptions = null
- quality System.Int32 = 100
RenderAnimationToFile 4 overloads
public static String RenderAnimationToFile(BitMatrix[] frames, MatrixPngRenderOptions opts, Int32 durationMs, String path, WebpAnimationOptions options = null, Int32 quality = 100) #Returns:
StringRenders an animated WebP to a file from multiple matrix frames.
Parameters
- frames CodeGlyphX.BitMatrix[]
- opts CodeGlyphX.Rendering.Png.MatrixPngRenderOptions
- durationMs System.Int32
- path System.String
- options CodeGlyphX.Rendering.Webp.WebpAnimationOptions = null
- quality System.Int32 = 100
public static String RenderAnimationToFile(BitMatrix[] frames, MatrixPngRenderOptions opts, Int32[] durationsMs, String path, WebpAnimationOptions options = null, Int32 quality = 100) #Returns:
StringRenders an animated WebP to a file from multiple matrix frames with per-frame durations.
Parameters
- frames CodeGlyphX.BitMatrix[]
- opts CodeGlyphX.Rendering.Png.MatrixPngRenderOptions
- durationsMs System.Int32[]
- path System.String
- options CodeGlyphX.Rendering.Webp.WebpAnimationOptions = null
- quality System.Int32 = 100
public static String RenderAnimationToFile(BitMatrix[] frames, MatrixPngRenderOptions opts, Int32 durationMs, String directory, String fileName, WebpAnimationOptions options = null, Int32 quality = 100) #Returns:
StringRenders an animated WebP to a file under the specified directory.
Parameters
- frames CodeGlyphX.BitMatrix[]
- opts CodeGlyphX.Rendering.Png.MatrixPngRenderOptions
- durationMs System.Int32
- directory System.String
- fileName System.String
- options CodeGlyphX.Rendering.Webp.WebpAnimationOptions = null
- quality System.Int32 = 100
public static String RenderAnimationToFile(BitMatrix[] frames, MatrixPngRenderOptions opts, Int32[] durationsMs, String directory, String fileName, WebpAnimationOptions options = null, Int32 quality = 100) #Returns:
StringRenders an animated WebP to a file under the specified directory with per-frame durations.
Parameters
- frames CodeGlyphX.BitMatrix[]
- opts CodeGlyphX.Rendering.Png.MatrixPngRenderOptions
- durationsMs System.Int32[]
- directory System.String
- fileName System.String
- options CodeGlyphX.Rendering.Webp.WebpAnimationOptions = null
- quality System.Int32 = 100
RenderAnimationToStream 2 overloads
public static Void RenderAnimationToStream(BitMatrix[] frames, MatrixPngRenderOptions opts, Int32 durationMs, Stream stream, WebpAnimationOptions options = null, Int32 quality = 100) #Returns:
VoidRenders an animated WebP to a stream from multiple matrix frames.
Parameters
- frames CodeGlyphX.BitMatrix[]
- opts CodeGlyphX.Rendering.Png.MatrixPngRenderOptions
- durationMs System.Int32
- stream System.IO.Stream
- options CodeGlyphX.Rendering.Webp.WebpAnimationOptions = null
- quality System.Int32 = 100
public static Void RenderAnimationToStream(BitMatrix[] frames, MatrixPngRenderOptions opts, Int32[] durationsMs, Stream stream, WebpAnimationOptions options = null, Int32 quality = 100) #Returns:
VoidRenders an animated WebP to a stream from multiple matrix frames with per-frame durations.
Parameters
- frames CodeGlyphX.BitMatrix[]
- opts CodeGlyphX.Rendering.Png.MatrixPngRenderOptions
- durationsMs System.Int32[]
- stream System.IO.Stream
- options CodeGlyphX.Rendering.Webp.WebpAnimationOptions = null
- quality System.Int32 = 100
RenderToFile 4 overloads
public static String RenderToFile(BitMatrix modules, MatrixPngRenderOptions opts, String path) #Returns:
StringRenders the matrix to a WebP file.
Parameters
- modules CodeGlyphX.BitMatrix
- opts CodeGlyphX.Rendering.Png.MatrixPngRenderOptions
- path System.String
public static String RenderToFile(BitMatrix modules, MatrixPngRenderOptions opts, String path, Int32 quality = 100) #Returns:
StringRenders the matrix to a WebP file (lossy VP8 when possible).
Parameters
- modules CodeGlyphX.BitMatrix
- Matrix modules.
- opts CodeGlyphX.Rendering.Png.MatrixPngRenderOptions
- Rendering options.
- path System.String
- Output file path.
- quality System.Int32 = 100
- Quality (0-100). Values >= 100 use lossless VP8L.
Returns
The output file path.
public static String RenderToFile(BitMatrix modules, MatrixPngRenderOptions opts, String directory, String fileName) #Returns:
StringRenders the matrix to a WebP file under the specified directory.
Parameters
- modules CodeGlyphX.BitMatrix
- opts CodeGlyphX.Rendering.Png.MatrixPngRenderOptions
- directory System.String
- fileName System.String
public static String RenderToFile(BitMatrix modules, MatrixPngRenderOptions opts, String directory, String fileName, Int32 quality = 100) #Returns:
StringRenders the matrix to a WebP file under the specified directory (lossy VP8 when possible).
Parameters
- modules CodeGlyphX.BitMatrix
- Matrix modules.
- opts CodeGlyphX.Rendering.Png.MatrixPngRenderOptions
- Rendering options.
- directory System.String
- Output directory.
- fileName System.String
- Output file name.
- quality System.Int32 = 100
- Quality (0-100). Values >= 100 use lossless VP8L.
Returns
The output file path.
RenderToStream 2 overloads
public static Void RenderToStream(BitMatrix modules, MatrixPngRenderOptions opts, Stream stream) #Returns:
VoidRenders the matrix to a WebP stream.
Parameters
- modules CodeGlyphX.BitMatrix
- opts CodeGlyphX.Rendering.Png.MatrixPngRenderOptions
- stream System.IO.Stream
public static Void RenderToStream(BitMatrix modules, MatrixPngRenderOptions opts, Stream stream, Int32 quality = 100) #Returns:
VoidRenders the matrix to a WebP stream (lossy VP8 when possible).
Parameters
- modules CodeGlyphX.BitMatrix
- Matrix modules.
- opts CodeGlyphX.Rendering.Png.MatrixPngRenderOptions
- Rendering options.
- stream System.IO.Stream
- Target stream.
- quality System.Int32 = 100
- Quality (0-100). Values >= 100 use lossless VP8L.