LuminanceSourceInterface
in
Interface for the luminance sources
Table of Contents
Methods
- fromBlob() : static
- Creates a LuminanceSource instance from the given data blob
- fromFile() : static
- Creates a LuminanceSource instance from the given file
- getHeight() : int
- getLuminances() : array<string|int, int>
- Fetches luminance data for the underlying bitmap. Values should be fetched using: `int luminance = array[y * width + x] & 0xff`
- getRow() : array<string|int, int>
- Fetches one row of luminance data from the underlying platform's bitmap. Values range from 0 (black) to 255 (white). Because Java does not have an unsigned byte type, callers will have to bitwise and with 0xff for each value. It is preferable for implementations of this method to only fetch this row rather than the whole image, since no 2D Readers may be installed and getLuminances() may never be called.
- getWidth() : int
Methods
fromBlob()
Creates a LuminanceSource instance from the given data blob
public
static fromBlob(string $blob[, SettingsContainerInterface|QROptions $options = new QROptions() ]) : static
Parameters
- $blob : string
- $options : SettingsContainerInterface|QROptions = new QROptions()
Return values
staticfromFile()
Creates a LuminanceSource instance from the given file
public
static fromFile(string $path[, SettingsContainerInterface|QROptions $options = new QROptions() ]) : static
Parameters
- $path : string
- $options : SettingsContainerInterface|QROptions = new QROptions()
Return values
staticgetHeight()
public
getHeight() : int
Return values
int —The height of the bitmap.
getLuminances()
Fetches luminance data for the underlying bitmap. Values should be fetched using: `int luminance = array[y * width + x] & 0xff`
public
getLuminances() : array<string|int, int>
Return values
array<string|int, int> —A row-major 2D array of luminance values. Do not use result $length as it may be larger than $width * $height bytes on some platforms. Do not modify the contents of the result.
getRow()
Fetches one row of luminance data from the underlying platform's bitmap. Values range from 0 (black) to 255 (white). Because Java does not have an unsigned byte type, callers will have to bitwise and with 0xff for each value. It is preferable for implementations of this method to only fetch this row rather than the whole image, since no 2D Readers may be installed and getLuminances() may never be called.
public
getRow(int $y) : array<string|int, int>
Parameters
- $y : int
-
The row to fetch, which must be in [0,getHeight())
Tags
Return values
array<string|int, int> —An array containing the luminance data.
getWidth()
public
getWidth() : int
Return values
int —The width of the bitmap.