CodeGlyphX logo
CodeGlyphX

API Reference

Class

MatrixJpegRenderer

Edit on GitHub
Namespace CodeGlyphX.Rendering.Jpeg
Assembly CodeGlyphX
Source CodeGlyphX/Rendering/Jpeg/MatrixJpegRenderer.cs:16
Modifiers static

Renders generic 2D matrices to a JPEG image.

Inheritance

  • Object
  • MatrixJpegRenderer

Methods

Render 2 overloads
public static Byte[] Render(BitMatrix modules, MatrixPngRenderOptions opts, JpegEncodeOptions options) #
CodeGlyphX/Rendering/Jpeg/MatrixJpegRenderer.cs:24
Returns: Byte[]

Renders the matrix to a JPEG byte array.

Parameters

modules CodeGlyphX.BitMatrix requiredposition: 0
opts CodeGlyphX.Rendering.Png.MatrixPngRenderOptions requiredposition: 1
quality System.Int32 = 85 requiredposition: 2
Render(CodeGlyphX.BitMatrix modules, CodeGlyphX.Rendering.Png.MatrixPngRenderOptions opts, CodeGlyphX.Rendering.Jpeg.JpegEncodeOptions options) #

Renders the matrix to a JPEG byte array.

Parameters

modules CodeGlyphX.BitMatrix required
opts CodeGlyphX.Rendering.Png.MatrixPngRenderOptions required
options CodeGlyphX.Rendering.Jpeg.JpegEncodeOptions required
RenderToFile 4 overloads
public static String RenderToFile(BitMatrix modules, MatrixPngRenderOptions opts, String path, JpegEncodeOptions options) #
CodeGlyphX/Rendering/Jpeg/MatrixJpegRenderer.cs:74
Returns: String

Renders the matrix to a JPEG file.

Parameters

modules CodeGlyphX.BitMatrix requiredposition: 0
Matrix modules.
opts CodeGlyphX.Rendering.Png.MatrixPngRenderOptions requiredposition: 1
Rendering options.
path System.String requiredposition: 2
Output file path.
quality System.Int32 = 85 requiredposition: 3
JPEG quality (1-100).

Returns

The output file path.

RenderToFile(CodeGlyphX.BitMatrix modules, CodeGlyphX.Rendering.Png.MatrixPngRenderOptions opts, System.String path, CodeGlyphX.Rendering.Jpeg.JpegEncodeOptions options) #

Renders the matrix to a JPEG file.

Parameters

modules CodeGlyphX.BitMatrix required
Matrix modules.
opts CodeGlyphX.Rendering.Png.MatrixPngRenderOptions required
Rendering options.
path System.String required
Output file path.
options CodeGlyphX.Rendering.Jpeg.JpegEncodeOptions required
JPEG encoding options.

Returns

The output file path.

public static String RenderToFile(BitMatrix modules, MatrixPngRenderOptions opts, String directory, String fileName, JpegEncodeOptions options) #
CodeGlyphX/Rendering/Jpeg/MatrixJpegRenderer.cs:102
Returns: String

Renders the matrix to a JPEG file under the specified directory.

Parameters

modules CodeGlyphX.BitMatrix requiredposition: 0
Matrix modules.
opts CodeGlyphX.Rendering.Png.MatrixPngRenderOptions requiredposition: 1
Rendering options.
directory System.String requiredposition: 2
Output directory.
fileName System.String requiredposition: 3
Output file name.
quality System.Int32 = 85 requiredposition: 4
JPEG quality (1-100).

Returns

The output file path.

RenderToFile(CodeGlyphX.BitMatrix modules, CodeGlyphX.Rendering.Png.MatrixPngRenderOptions opts, System.String directory, System.String fileName, CodeGlyphX.Rendering.Jpeg.JpegEncodeOptions options) #

Renders the matrix to a JPEG file under the specified directory.

Parameters

modules CodeGlyphX.BitMatrix required
Matrix modules.
opts CodeGlyphX.Rendering.Png.MatrixPngRenderOptions required
Rendering options.
directory System.String required
Output directory.
fileName System.String required
Output file name.
options CodeGlyphX.Rendering.Jpeg.JpegEncodeOptions required
JPEG encoding options.

Returns

The output file path.

RenderToStream 2 overloads
public static Void RenderToStream(BitMatrix modules, MatrixPngRenderOptions opts, Stream stream, JpegEncodeOptions options) #
CodeGlyphX/Rendering/Jpeg/MatrixJpegRenderer.cs:48
Returns: Void

Renders the matrix to a JPEG stream.

Parameters

modules CodeGlyphX.BitMatrix requiredposition: 0
Matrix modules.
opts CodeGlyphX.Rendering.Png.MatrixPngRenderOptions requiredposition: 1
Rendering options.
stream System.IO.Stream requiredposition: 2
Target stream.
quality System.Int32 = 85 requiredposition: 3
JPEG quality (1-100).
RenderToStream(CodeGlyphX.BitMatrix modules, CodeGlyphX.Rendering.Png.MatrixPngRenderOptions opts, System.IO.Stream stream, CodeGlyphX.Rendering.Jpeg.JpegEncodeOptions options) #

Renders the matrix to a JPEG stream.

Parameters

modules CodeGlyphX.BitMatrix required
Matrix modules.
opts CodeGlyphX.Rendering.Png.MatrixPngRenderOptions required
Rendering options.
stream System.IO.Stream required
Target stream.
options CodeGlyphX.Rendering.Jpeg.JpegEncodeOptions required
JPEG encoding options.