Class RGBLuminanceSource

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.

author: dswitkin@google.com (Daniel Switkin)
author: Betaminos

Hierarchy

LuminanceSource
- RGBLuminanceSource

Index

Constructors

constructor

Properties

Methods

Constructors

constructor

new RGBLuminanceSource(luminances: Uint8ClampedArray | Int32Array, width: number, height: number, dataWidth?: number, dataHeight?: number, left?: number, top?: number): RGBLuminanceSource

Overrides LuminanceSource.constructor
- Defined in src/core/RGBLuminanceSource.ts:59
Parameters
- luminances: Uint8ClampedArray | Int32Array
- width: number
- height: number
- Optional dataWidth: number
- Optional dataHeight: number
- Optional left: number
- Optional top: number
Returns RGBLuminanceSource

Properties

Private Optional dataHeight

dataHeight: number

Private Optional dataWidth

dataWidth: number

Private Optional left

left: number

Private luminances

luminances: Uint8ClampedArray

Private Optional top

top: number

Methods

crop

crop(left: number, top: number, width: number, height: number): LuminanceSource

Overrides LuminanceSource.crop
- Defined in src/core/RGBLuminanceSource.ts:154
Parameters
- left: number
- top: number
- width: number
- height: number
Returns LuminanceSource

getHeight

getHeight(): number

Inherited from LuminanceSource.getHeight
- Defined in src/core/LuminanceSource.ts:70
Returns number

The height of the bitmap.

getMatrix

getMatrix(): Uint8ClampedArray

Overrides LuminanceSource.getMatrix
- Defined in src/core/RGBLuminanceSource.ts:118
Returns Uint8ClampedArray

getRow

getRow(y: number, row?: Uint8ClampedArray): Uint8ClampedArray

Overrides LuminanceSource.getRow
- Defined in src/core/RGBLuminanceSource.ts:104
Parameters
- y: number
- Optional row: Uint8ClampedArray
Returns Uint8ClampedArray

getWidth

getWidth(): number

Inherited from LuminanceSource.getWidth
- Defined in src/core/LuminanceSource.ts:63
Returns number

The width of the bitmap.

invert

invert(): LuminanceSource

Overrides LuminanceSource.invert
- Defined in src/core/RGBLuminanceSource.ts:164
Returns LuminanceSource

isCropSupported

isCropSupported(): boolean

Overrides LuminanceSource.isCropSupported
- Defined in src/core/RGBLuminanceSource.ts:149
Returns boolean

isRotateSupported

isRotateSupported(): boolean

Inherited from LuminanceSource.isRotateSupported
- Defined in src/core/LuminanceSource.ts:98
Returns boolean

Whether this subclass supports counter-clockwise rotation.

rotateCounterClockwise

rotateCounterClockwise(): LuminanceSource

Inherited from LuminanceSource.rotateCounterClockwise
- Defined in src/core/LuminanceSource.ts:114
Returns a new object with rotated image data by 90 degrees counterclockwise. Only callable if {@link #isRotateSupported()} is true.

Returns LuminanceSource

A rotated version of this object.

rotateCounterClockwise45

rotateCounterClockwise45(): LuminanceSource

Inherited from LuminanceSource.rotateCounterClockwise45
- Defined in src/core/LuminanceSource.ts:124
Returns a new object with rotated image data by 45 degrees counterclockwise. Only callable if {@link #isRotateSupported()} is true.

Returns LuminanceSource

A rotated version of this object.

toString

toString(): string

Inherited from LuminanceSource.toString
- Defined in src/core/LuminanceSource.ts:129
Returns string

Generated using TypeDoc