Class ARGB

Hierarchy

Int32
- ARGB

Implements

TypedColor<ARGB>

Indexable

[id: number]: number

Index

Constructors

constructor

Properties

Accessors

Methods

Constructors

constructor

new ARGB(buf?: number[] | TypedArray, offset?: number, stride?: number): ARGB

Inherited from Int32.constructor
- Defined in packages/color/src/int/int.ts:28
Parameters
- Optional buf: number[] | TypedArray
- offset: number = 0
- stride: number = 1
Returns ARGB

Properties

argb

argb: number

buf

buf: number[] | TypedArray

Backing array / memory

offset

offset: number = 0

Start index in array

stride

stride: number = 1

Step size between channels

value

value: number

Accessors

alpha

get alpha(): number
set alpha(a: number): void

- Defined in packages/color/src/int/int.ts:42
Returns number
- Defined in packages/color/src/int/int.ts:46
Parameters
- a: number
Returns void

length

get length(): number

Implementation of TypedColor.length
- Defined in packages/color/src/int/int.ts:34
Returns number

mode

get mode(): ColorMode

Implementation of TypedColor.mode
- Defined in packages/color/src/int/int.ts:82
Returns ColorMode

range

get range(): [ReadonlyVec, ReadonlyVec]

Implementation of TypedColor.range
- Defined in packages/color/src/int/int.ts:38
A tuple of [min, max] where both are vectors specifying the min/max channel ranges for this color type.
remarks
Even though there're several color spaces which do not impose limits on at least some of their axes, the limits returned by this function indicate RGB "safe" colors and were determined by projecting all RGB colors into the color space used by this type.
Returns [ReadonlyVec, ReadonlyVec]

Methods

[Symbol.iterator]

[Symbol.iterator](): Generator<number, void, unknown>

Implementation of TypedColor.[Symbol.iterator]
Inherited from Int32.[Symbol.iterator]
- Defined in packages/color/src/int/int.ts:50
Returns Generator<number, void, unknown>

clamp

clamp(): ARGB

Implementation of TypedColor.clamp
Inherited from Int32.clamp
- Defined in packages/color/src/int/int.ts:64
Clamps all color channels so that colors is inside RGB gamut.
remarks
Note: This is not a 100% guarantee, due to each channel being clamped individually based on pre-determined limits.
Returns ARGB

copy

copy(): ARGB

Implementation of TypedColor.copy
- Defined in packages/color/src/int/int.ts:86
Returns a copy of this instance. Shallow or deep copies are implementation specific.
Returns ARGB

copyView

copyView(): ARGB

Implementation of TypedColor.copyView
- Defined in packages/color/src/int/int.ts:90
Returns ARGB

deref

deref(): number[]

Implementation of TypedColor.deref
Inherited from Int32.deref
- Defined in packages/color/src/int/int.ts:54
Returns wrapped value.
Returns number[]

empty

empty(): ARGB

Implementation of TypedColor.empty
- Defined in packages/color/src/int/int.ts:94
Returns an empty/blank instance of same type (with possibly same config, if any).
Returns ARGB

eqDelta

eqDelta(o: ARGB, eps?: number): boolean

- Defined in packages/color/src/int/int.ts:98
Parameters
- o: ARGB
- eps: number = 0
Returns boolean

randomize

randomize(rnd?: IRandom): ARGB

Implementation of TypedColor.randomize
Inherited from Int32.randomize
- Defined in packages/color/src/int/int.ts:58
Randomizes all color channels based on channel ranges defined for this color type (usually [0..1] interval). Alpha channel will remain untouched.
Parameters
- rnd: IRandom = ...
Returns ARGB

set

set(src: ArrayLikeIterable<number>): ARGB

Inherited from Int32.set
- Defined in packages/color/src/int/int.ts:68
Parameters
- src: ArrayLikeIterable<number>
Returns ARGB

toJSON

toJSON(): number[]

Implementation of TypedColor.toJSON
Inherited from Int32.toJSON
- Defined in packages/color/src/int/int.ts:73
For memory mapped colors, this ensures only the elements used by this color are being serialized (as array) by JSON.stringify().
Returns number[]

Generated using TypeDoc