Color

Class

Represents one ARGB color and provides color sampling/comparison helpers.

Syntax

Color(value, /)

Constructor parameters

Name	Description
`valueString \| Number`	Hex string (`#AARRGGBB`/`#RRGGBB`) or raw ARGB number. Required · Positional only No default

Returns

Color

Example

cursor = Point(540, 920)
picked = Color.get(cursor)
if picked == "#FFFFFFFF":
    click(cursor, random=6)

Fields

Name	Description
`argbNumber`	Raw ARGB integer value.
`aInt`	Alpha channel 0-255.
`rInt`	Red channel 0-255.
`gInt`	Green channel 0-255.
`bInt`	Blue channel 0-255.
`hexString`	Hex string `#AARRGGBB`.

Constructor example

c1 = Color("#FFFFFFFF")
c2 = Color(4294967295)

Methods

7 methods

Color.get

Static Method

Read color(s) from screen: Point -> Color, Region -> 2D Color array, list[Point] -> Color list. This is an immediate one-shot sample; if no frame is available or a sample is missing, returns the default color instead of retrying or stopping the script.

Syntax

Color.get(target, interval=3, default="#00000000")

Parameters

Name	Description
`targetPoint \| Region \| list[Point]`	Sampling target. Required · Positional or named No default
`intervalNumber`	Grid step (pixels) when target is Region. Optional · Positional or named Default: `3`
`defaultColor \| String \| Number`	Fallback color returned when screen capture or pixel sampling is unavailable. Optional · Positional or named Default: `#00000000`

Returns

Color | list[list[Color]] | list[Color] — Sampled color payload based on target type, with missing samples filled by default.

Example

c = Color.get(Point(100, 200), default="#FF000000")
grid = Color.get(Region(120, 240, 90, 60), interval=3, default="#00000000")
batch = Color.get([Point(10, 10), Point(20, 20)])

Color.compare

Static Method

Compare two colors by per-channel RGB tolerance. Match passes only when |R1-R2|, |G1-G2|, and |B1-B2| are all <= tolerance.

Syntax

Color.compare(a, b, tolerance=0)

Parameters

Name	Description
`aColor \| String \| Number`	First color. Required · Positional or named No default
`bColor \| String \| Number`	Second color. Required · Positional or named No default
`toleranceNumber`	Allowed per-channel difference (0-255). Practical start: 4-8 for near-identical UI shades, 10-16 for anti-alias/compression variation. Optional · Positional or named Default: `0`

Returns

Boolean — true when all RGB channels are within tolerance. Quick guide: 0 = exact, 4-8 = almost same, 10-16 = tolerant match, >24 = very loose.

Example

base = Color(\"#FF4CAF50\")
sample = Color.get(Point(620, 340))
is_same = Color.compare(base, sample, tolerance=8)  # same-ish UI shade

Color.distance_rgb

Static Method

Compute Euclidean distance in RGB space between two colors.

Syntax

Color.distance_rgb(a, b)

Parameters

Name	Description
`aColor \| String \| Number`	First color. Required · Positional or named No default
`bColor \| String \| Number`	Second color. Required · Positional or named No default

Returns

Number — RGB-space distance in range 0 -> 441.67 (0 = exact). Practical guide: <=8 almost same, 9-20 close, 21-40 visibly different, >40 far apart.

Example

actual = Color.get(Point(620, 340))
rgb_gap = Color.distance_rgb(\"#FF4CAF50\", actual)
if rgb_gap <= 15:
    print(\"close in RGB\")

Color.delta_e

Static Method

Compute CIE76 Delta E between two colors for perceptual difference.

Syntax

Color.delta_e(a, b)

Parameters

Name	Description
`aColor \| String \| Number`	First color. Required · Positional or named No default
`bColor \| String \| Number`	Second color. Required · Positional or named No default

Returns

Number — Perceptual difference score. Rule of thumb: <1 imperceptible, 1-2 barely noticeable, 2-5 noticeable, 5-10 clearly different, >10 different colors.

Example

actual = Color.get(Point(620, 340))
d = Color.delta_e(\"#FF4CAF50\", actual)
if d <= 3:
    print(\"looks similar to human eye\")

Color.compare

Method

Instance version of RGB tolerance compare. Useful when you already sampled one color and compare against target shades.

Syntax

color.compare(other, tolerance=0)

Parameters

Name	Description
`otherColor \| String \| Number`	Color to compare. Required · Positional or named No default
`toleranceNumber`	Allowed per-channel difference (0-255). Typical same-ish range: 4-8; use 10-16 for noisy/compressed captures. Optional · Positional or named Default: `0`

Returns

Boolean — Comparison result. 0 means exact match; larger tolerance makes matching more permissive.

Example

picked = Color.get(Point(540, 920))
if picked.compare(\"#FFFFFFFF\", tolerance=5):
    click(Point(540, 920))

Color.distance_rgb

Method

Compute Euclidean distance in RGB space from this color to another color.

Syntax

color.distance_rgb(other)

Parameters

Name	Description
`otherColor \| String \| Number`	Color to compare. Required · Positional or named No default

Returns

Number — RGB-space distance (0 -> 441.67). Quick read: <=8 almost same, 9-20 close, 21-40 visibly different, >40 far apart.

Example

base = Color(\"#FF4CAF50\")
actual = Color.get(Point(620, 340))
rgb_gap = base.distance_rgb(actual)
if rgb_gap <= 20:
    print(\"close enough in RGB\")

Color.delta_e

Method

Compute CIE76 Delta E from this color to another color for perceptual comparison.

Syntax

color.delta_e(other)

Parameters

Name	Description
`otherColor \| String \| Number`	Color to compare. Required · Positional or named No default

Returns

Number — Perceptual color difference score. Practical guide: <1 imperceptible, 1-2 barely visible, 2-5 noticeable, 5-10 clear difference, >10 very different.

Example

base = Color(\"#FF4CAF50\")
actual = Color.get(Point(620, 340))
perceptual_gap = base.delta_e(actual)
if perceptual_gap <= 2:
    print(\"looks almost the same\")