\ZxingRGBLuminanceSource

This class is used to help decode images from files which arrive as RGB data from an ARGB pixel array. It does not support rotation.

Summary

Methods
Properties
Constants
__construct()
getRow()
getMatrix()
getWidth()
getHeight()
isCropSupported()
crop()
isRotateSupported()
invert()
rotateCounterClockwise()
rotateCounterClockwise45()
toString()
RGBLuminanceSource_()
grayscale()
getPixel()
getMiddleBrightnessPerArea()
grayScaleToBitmap()
$luminances
No constants found
No protected methods found
No protected properties found
N/A
No private methods found
$width
$height
$dataWidth
$dataHeight
$left
$top
$pixels
N/A

Properties

$luminances

$luminances : 

Type

$width

$width : 

Type

$height

$height : 

Type

$dataWidth

$dataWidth : 

Type

$dataHeight

$dataHeight : 

Type

$left

$left : 

Type

$top

$top : 

Type

$pixels

$pixels : 

Type

Methods

__construct()

__construct(  $pixels,   $dataWidth,   $dataHeight,   $left = null,   $top = null,   $width = null,   $height = null) 

Parameters

$pixels
$dataWidth
$dataHeight
$left
$top
$width
$height

getRow()

getRow(  $y,   $row = null) : 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
$row

Returns

array —

An array containing the luminance data.

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() : \Zxing\Whether

Returns

\Zxing\Whether —

this subclass supports cropping.

crop()

crop(  $left,   $top,   $width,   $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

$left
$top
$width
$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 \Zxing#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 \Zxing#isRotateSupported() is true.

Returns

\Zxing\A —

rotated version of this object.

toString()

toString() 

RGBLuminanceSource_()

RGBLuminanceSource_(  $width,   $height,   $pixels) 

Parameters

$width
$height
$pixels

grayscale()

grayscale() 

getPixel()

getPixel(  $x,   $y,   $width,   $height) 

Parameters

$x
$y
$width
$height

getMiddleBrightnessPerArea()

getMiddleBrightnessPerArea(  $image) 

Parameters

$image

grayScaleToBitmap()

grayScaleToBitmap(  $grayScale) 

Parameters

$grayScale