\ZxingLuminanceSource

The purpose of this class hierarchy is to abstract different bitmap implementations across platforms into a standard interface for requesting greyscale luminance values. The interface only provides immutable methods; therefore crop and rotation create copies. This is to ensure that one Reader does not modify the original luminance source and leave it in an unknown state for other Readers in the chain.

Summary

Methods
Properties
Constants
__construct()
getMatrix()
getWidth()
getHeight()
isCropSupported()
crop()
isRotateSupported()
invert()
rotateCounterClockwise()
rotateCounterClockwise45()
toString()
getRow()
No public properties found
No constants found
No protected methods found
No protected properties found
N/A
No private methods found
$width
$height
N/A

Properties

$width

$width

$height

$height

Methods

__construct()

__construct(mixed  $width, mixed  $height) : mixed

Parameters

mixed $width
mixed $height

Returns

mixed —

getMatrix()

getMatrix() : \Zxing\A

Fetches luminance data for the underlying bitmap. Values should be fetched using: {@code int luminance = array[y * width + x] & 0xff}

Returns

\Zxing\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.

getWidth()

getWidth() : \Zxing\The

Returns

\Zxing\The —

width of the bitmap.

getHeight()

getHeight() : \Zxing\The

Returns

\Zxing\The —

height of the bitmap.

isCropSupported()

isCropSupported() : bool

Returns

bool —

Whether this subclass supports cropping.

crop()

crop(mixed  $left, mixed  $top, mixed  $width, mixed  $height) : \Zxing\A

Returns a new object with cropped image data. Implementations may keep a reference to the original data rather than a copy. Only callable if isCropSupported() is true.

Parameters

mixed $left
mixed $top
mixed $width
mixed $height

Returns

\Zxing\A —

cropped version of this object.

isRotateSupported()

isRotateSupported() : \Zxing\Whether

Returns

\Zxing\Whether —

this subclass supports counter-clockwise rotation.

invert()

invert() : \Zxing\a

Returns

\Zxing\a —

wrapper of this {@code LuminanceSource} which inverts the luminances it returns -- black becomes white and vice versa, and each value becomes (255-value).

rotateCounterClockwise()

rotateCounterClockwise() : \Zxing\A

Returns a new object with rotated image data by 90 degrees counterclockwise.

Only callable if {@link #isRotateSupported()} is true.

Returns

\Zxing\A —

rotated version of this object.

rotateCounterClockwise45()

rotateCounterClockwise45() : \Zxing\A

Returns a new object with rotated image data by 45 degrees counterclockwise.

Only callable if {@link #isRotateSupported()} is true.

Returns

\Zxing\A —

rotated version of this object.

toString()

toString() : mixed

Returns

mixed —

getRow()

getRow( $y,  $row) : array

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 getMatrix() may never be called.

Parameters

$y

; The row to fetch, which must be in [0,getHeight())

$row

; An optional preallocated array. If null or too small, it will be ignored. Always use the returned object, and ignore the .length of the array.

Returns

array —

An array containing the luminance data.