Skip to content

Commit 0c37c33

Browse files
committed
文档更新
1 parent a216885 commit 0c37c33

File tree

4 files changed

+1590
-1949
lines changed

4 files changed

+1590
-1949
lines changed

docs/rhino/advanced/colors.md

Lines changed: 147 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,147 @@
1+
# colors 颜色
2+
3+
> 稳定性: 稳定
4+
5+
在 Auto.js 有两种方式表示一个颜色。
6+
7+
一种是使用一个字符串"#AARRGGBB"或"#RRGGBB",其中 AA 是 Alpha 通道(透明度)的值,RR 是 R 通道(红色)的值,GG 是 G 通道(绿色)的值,BB 是 B 通道(蓝色)的值。例如"#ffffff"表示白色, "#7F000000"表示半透明的黑色。
8+
9+
另一种是使用一个 16 进制的"32 位整数" 0xAARRGGBB 来表示一个颜色,例如 `0xFF112233`表示颜色"#112233", `0x11223344`表示颜色"#11223344"。
10+
11+
可以通过`colors.toString()`把颜色整数转换为字符串,通过`colors.parseColor()`把颜色字符串解析为颜色整数。
12+
13+
## colors.toString(color)
14+
15+
- `color` \{number} 整数 RGB 颜色值
16+
- 返回 \{string}
17+
18+
返回颜色值的字符串,格式为 "#AARRGGBB"。
19+
20+
## colors.red(color)
21+
22+
- `color` \{number} | \{string} 颜色值
23+
- 返回 \{number}
24+
25+
返回颜色 color 的 R 通道的值,范围 0~255.
26+
27+
## colors.green(color)
28+
29+
- `color` \{number} | \{string} 颜色值
30+
- 返回 \{number}
31+
32+
返回颜色 color 的 G 通道的值,范围 0~255.
33+
34+
## colors.blue(color)
35+
36+
- `color` \{number} | \{string} 颜色值
37+
- 返回 \{number}
38+
39+
返回颜色 color 的 B 通道的值,范围 0~255.
40+
41+
## colors.alpha(color)
42+
43+
- `color` \{number} | \{string} 颜色值
44+
- 返回 \{number}
45+
46+
返回颜色 color 的 Alpha 通道的值,范围 0~255.
47+
48+
## colors.rgb(red, green, blue)
49+
50+
- red \{number} 颜色的 R 通道的值
51+
- blue \{number} 颜色的 G 通道的值
52+
- green \{number} 颜色的 B 通道的值
53+
- 返回 \{number}
54+
55+
返回这些颜色通道构成的整数颜色值。Alpha 通道将是 255(不透明)。
56+
57+
## colors.argb(alpha, red, green, blue)
58+
59+
- `alpha` \{number} 颜色的 Alpha 通道的值
60+
- `red` \{number} 颜色的 R 通道的值
61+
- `green` \{number} 颜色的 G 通道的值
62+
- `blue` \{number} 颜色的 B 通道的值
63+
- 返回 \{number}
64+
65+
返回这些颜色通道构成的整数颜色值。
66+
67+
## colors.parseColor(colorStr)
68+
69+
- `colorStr` \{string} 表示颜色的字符串,例如"#112233"
70+
- 返回 \{number}
71+
72+
返回颜色的整数值。
73+
74+
## colors.isSimilar(color2, color2[, threshold, algorithm])
75+
76+
- `color1` \{number} | \{string} 颜色值 1
77+
- `color1` \{number} | \{string} 颜色值 2
78+
- `threshold` \{number} 颜色相似度临界值,默认为 4。取值范围为 0~255。这个值越大表示允许的相似程度越小,如果这个值为 0,则两个颜色相等时该函数才会返回 true。
79+
- `algorithm` \{string} 颜色匹配算法,默认为"diff", 包括:
80+
- "diff": 差值匹配。与给定颜色的 R、G、B 差的绝对值之和小于 threshold 时匹配。
81+
- "rgb": rgb 欧拉距离相似度。与给定颜色 color 的 rgb 欧拉距离小于等于 threshold 时匹配。
82+
- "rgb+": 加权 rgb 欧拉距离匹配([LAB Delta E](https://en.wikipedia.org/wiki/Color_difference))。
83+
- "hs": hs 欧拉距离匹配。hs 为 HSV 空间的色调值。
84+
- 返回 \{Boolean}
85+
86+
返回两个颜色是否相似。
87+
88+
## colors.equals(color1, color2)
89+
90+
- `color1` \{number} | \{string} 颜色值 1
91+
- `color1` \{number} | \{string} 颜色值 2
92+
- 返回 \{Boolean}
93+
94+
返回两个颜色是否相等。\*_注意该函数会忽略 Alpha 通道的值进行比较_
95+
96+
```js
97+
log(colors.equals("#112233", "#112234"));
98+
log(colors.equals(0xff112233, 0xff223344));
99+
```
100+
101+
## colors.BLACK
102+
103+
黑色,颜色值 #FF000000
104+
105+
## colors.DKGRAY
106+
107+
深灰色,颜色值 #FF444444
108+
109+
## colors.GRAY
110+
111+
灰色,颜色值 #FF888888
112+
113+
## colors.LTGRAY
114+
115+
亮灰色,颜色值 #FFCCCCCC
116+
117+
## colors.WHITE
118+
119+
白色,颜色值 #FFFFFFFF
120+
121+
## colors.RED
122+
123+
红色,颜色值 #FFFF0000
124+
125+
## colors.GREEN
126+
127+
绿色,颜色值 #FF00FF00
128+
129+
## colors.BLUE
130+
131+
蓝色,颜色值 #FF0000FF
132+
133+
## colors.YELLOW
134+
135+
黄色,颜色值 #FFFFFF00
136+
137+
## colors.CYAN
138+
139+
青色,颜色值 #FF00FFFF
140+
141+
## colors.MAGENTA
142+
143+
品红色,颜色值 #FFFF00FF
144+
145+
## colors.TRANSPARENT
146+
147+
透明,颜色值 #00000000

docs/rhino/advanced/images.md

Lines changed: 19 additions & 149 deletions
Original file line numberDiff line numberDiff line change
@@ -1,152 +1,4 @@
1-
# Images 图片与颜色
2-
3-
> 稳定性: 稳定
4-
5-
在 Auto.js 有两种方式表示一个颜色。
6-
7-
一种是使用一个字符串"#AARRGGBB"或"#RRGGBB",其中 AA 是 Alpha 通道(透明度)的值,RR 是 R 通道(红色)的值,GG 是 G 通道(绿色)的值,BB 是 B 通道(蓝色)的值。例如"#ffffff"表示白色, "#7F000000"表示半透明的黑色。
8-
9-
另一种是使用一个 16 进制的"32 位整数" 0xAARRGGBB 来表示一个颜色,例如 `0xFF112233`表示颜色"#112233", `0x11223344`表示颜色"#11223344"。
10-
11-
可以通过`colors.toString()`把颜色整数转换为字符串,通过`colors.parseColor()`把颜色字符串解析为颜色整数。
12-
13-
# colors
14-
15-
## colors.toString(color)
16-
17-
- `color` \{number} 整数 RGB 颜色值
18-
- 返回 \{string}
19-
20-
返回颜色值的字符串,格式为 "#AARRGGBB"。
21-
22-
## colors.red(color)
23-
24-
- `color` \{number} | \{string} 颜色值
25-
- 返回 \{number}
26-
27-
返回颜色 color 的 R 通道的值,范围 0~255.
28-
29-
## colors.green(color)
30-
31-
- `color` \{number} | \{string} 颜色值
32-
- 返回 \{number}
33-
34-
返回颜色 color 的 G 通道的值,范围 0~255.
35-
36-
## colors.blue(color)
37-
38-
- `color` \{number} | \{string} 颜色值
39-
- 返回 \{number}
40-
41-
返回颜色 color 的 B 通道的值,范围 0~255.
42-
43-
## colors.alpha(color)
44-
45-
- `color` \{number} | \{string} 颜色值
46-
- 返回 \{number}
47-
48-
返回颜色 color 的 Alpha 通道的值,范围 0~255.
49-
50-
## colors.rgb(red, green, blue)
51-
52-
- red \{number} 颜色的 R 通道的值
53-
- blue \{number} 颜色的 G 通道的值
54-
- green \{number} 颜色的 B 通道的值
55-
- 返回 \{number}
56-
57-
返回这些颜色通道构成的整数颜色值。Alpha 通道将是 255(不透明)。
58-
59-
## colors.argb(alpha, red, green, blue)
60-
61-
- `alpha` \{number} 颜色的 Alpha 通道的值
62-
- `red` \{number} 颜色的 R 通道的值
63-
- `green` \{number} 颜色的 G 通道的值
64-
- `blue` \{number} 颜色的 B 通道的值
65-
- 返回 \{number}
66-
67-
返回这些颜色通道构成的整数颜色值。
68-
69-
## colors.parseColor(colorStr)
70-
71-
- `colorStr` \{string} 表示颜色的字符串,例如"#112233"
72-
- 返回 \{number}
73-
74-
返回颜色的整数值。
75-
76-
## colors.isSimilar(color2, color2[, threshold, algorithm])
77-
78-
- `color1` \{number} | \{string} 颜色值 1
79-
- `color1` \{number} | \{string} 颜色值 2
80-
- `threshold` \{number} 颜色相似度临界值,默认为 4。取值范围为 0~255。这个值越大表示允许的相似程度越小,如果这个值为 0,则两个颜色相等时该函数才会返回 true。
81-
- `algorithm` \{string} 颜色匹配算法,默认为"diff", 包括:
82-
- "diff": 差值匹配。与给定颜色的 R、G、B 差的绝对值之和小于 threshold 时匹配。
83-
- "rgb": rgb 欧拉距离相似度。与给定颜色 color 的 rgb 欧拉距离小于等于 threshold 时匹配。
84-
- "rgb+": 加权 rgb 欧拉距离匹配([LAB Delta E](https://en.wikipedia.org/wiki/Color_difference))。
85-
- "hs": hs 欧拉距离匹配。hs 为 HSV 空间的色调值。
86-
- 返回 \{Boolean}
87-
88-
返回两个颜色是否相似。
89-
90-
## colors.equals(color1, color2)
91-
92-
- `color1` \{number} | \{string} 颜色值 1
93-
- `color1` \{number} | \{string} 颜色值 2
94-
- 返回 \{Boolean}
95-
96-
返回两个颜色是否相等。\*_注意该函数会忽略 Alpha 通道的值进行比较_
97-
98-
```js
99-
log(colors.equals("#112233", "#112234"));
100-
log(colors.equals(0xff112233, 0xff223344));
101-
```
102-
103-
## colors.BLACK
104-
105-
黑色,颜色值 #FF000000
106-
107-
## colors.DKGRAY
108-
109-
深灰色,颜色值 #FF444444
110-
111-
## colors.GRAY
112-
113-
灰色,颜色值 #FF888888
114-
115-
## colors.LTGRAY
116-
117-
亮灰色,颜色值 #FFCCCCCC
118-
119-
## colors.WHITE
120-
121-
白色,颜色值 #FFFFFFFF
122-
123-
## colors.RED
124-
125-
红色,颜色值 #FFFF0000
126-
127-
## colors.GREEN
128-
129-
绿色,颜色值 #FF00FF00
130-
131-
## colors.BLUE
132-
133-
蓝色,颜色值 #FF0000FF
134-
135-
## colors.YELLOW
136-
137-
黄色,颜色值 #FFFFFF00
138-
139-
## colors.CYAN
140-
141-
青色,颜色值 #FF00FFFF
142-
143-
## colors.MAGENTA
144-
145-
品红色,颜色值 #FFFF00FF
146-
147-
## colors.TRANSPARENT
148-
149-
透明,颜色值 #00000000
1+
# Images 图片处理
1502

1513
# Images
1524

@@ -579,6 +431,24 @@ toast(colors.toString(color));
579431

580432
该函数不会返回任何值。该函数也可以作为全局函数使用。
581433

434+
## images.registerAsyncCapture(listener)
435+
436+
**[v7.1.6 新增]**
437+
438+
- `listener : (image: Image) => void `回调函数,参数为一个 Image 对象
439+
- `return : () => void ` 返回一个函数,用于取消监听
440+
441+
注册一个截图监听函数,每当手机画面有变化时才会传回新的图像,而不必通过传统方法重复处理相同的图片,
442+
回调函数会在后台线程中运行,需要注意线程安全。
443+
444+
```js
445+
var cancel = images.registerAsyncCapture((img) => {
446+
log("新截图:", img);
447+
});
448+
//5秒后停止监听
449+
setTimeout(cancel, 5000);
450+
```
451+
582452
## images.pixel(image, x, y)
583453

584454
- `image` \{Image} 图片

0 commit comments

Comments
 (0)