CodeGlyphX logo
CodeGlyphX

API Reference

Class

QrPngLogoOptions

Namespace CodeGlyphX.Rendering.Png
Assembly CodeGlyphX
Modifiers sealed

Options and pixel data for a centered logo overlay in a QR PNG.

Inheritance

  • Object
  • QrPngLogoOptions

Usage

This type appears in these public API surfaces even when no hand-authored example is attached directly to the page.

Accepted by parameters

Constructors

public QrPngLogoOptions(Byte[] rgba, Int32 width, Int32 height) #

Creates a logo option with a packed RGBA buffer.

Parameters

rgba System.Byte[] requiredposition: 0
width System.Int32 requiredposition: 1
height System.Int32 requiredposition: 2

Methods

public static QrPngLogoOptions FromPixels(Byte[] pixels, Int32 width, Int32 height, Int32 stride, PixelFormat fmt) #
Returns: QrPngLogoOptions

Creates a logo option from a raw pixel buffer in BGRA/RGBA.

Parameters

pixels System.Byte[] requiredposition: 0
width System.Int32 requiredposition: 1
height System.Int32 requiredposition: 2
stride System.Int32 requiredposition: 3
fmt CodeGlyphX.PixelFormat requiredposition: 4
public static QrPngLogoOptions FromPng(Byte[] png) #
Returns: QrPngLogoOptions

Creates a logo option from a PNG (RGBA or RGB, non-interlaced).

Parameters

png System.Byte[] requiredposition: 0
public static QrPngLogoOptions FromPngFile(String path) #
Returns: QrPngLogoOptions

Creates a logo option from a PNG file.

Parameters

path System.String requiredposition: 0
PNG file path.

Returns

Logo options.

Properties

public Byte[] Rgba { get; } #

Logo pixels in RGBA order, row-major, tightly packed.

public Int32 Width { get; } #

Logo width in pixels.

public Int32 Height { get; } #

Logo height in pixels.

public Double Scale { get; set; } #

Maximum logo size relative to the QR area (excluding quiet zone).

public Int32 PaddingPx { get; set; } #

Padding in pixels around the logo (filled with Background when DrawBackground is true).

public Boolean DrawBackground { get; set; } #

Whether to draw a background plate behind the logo.

public Rgba32 Background { get; set; } #

Background color for the logo plate.

public Int32 CornerRadiusPx { get; set; } #

Optional corner radius for the background plate.