Please check the build logs for more information.
See Builds for ideas on how to fix a failed build, or Metadata for how to configure docs.rs builds.
If you believe this is docs.rs' fault, open an issue.
pixhunt
快速、低依赖的屏幕找图库:截一帧屏幕,在其中定位一张小图(模板)的坐标。 纯 Rust,无需 OpenCV。适合自动化测试、脚本辅助、UI 定位等。
它做什么
给一张小图 template.png,pixhunt 告诉你在当前屏幕的哪个位置、有多像:
use ;
let tpl = load?;
let mut finder = builder
.capture // 截图后端
.matcher // 找法
.build?;
if let Some = finder.find_on_screen?
设计:两个可插拔"插座"
Capture负责"怎么拿到画面"。Matcher负责"怎么找模板"。
上层只跟"插座"打交道,新增后端/算法不改上层代码。
功能开关 (Cargo features)
| feature | 提供 | 平台 |
|---|---|---|
| (默认) | ScreenshotsCapture + RgbMatcher |
跨平台 |
capture-gdi |
GdiCapture(复用 DC + BitBlt,输出 BGRA) |
仅 Windows |
capture-dxgi |
DxgiCapture(桌面复制,GPU 取帧) |
仅 Windows |
capture-window |
WindowCapture(PrintWindow 截单个窗口客户区,遮挡也可截) |
仅 Windows |
match-corr |
CorrMatcher(corrmatch 的 ZNCC,灰度) |
跨平台 |
parallel |
RgbMatcher 按行并行(find / find_all,rayon) |
跨平台 |
tracing |
trace 级诊断事件(截图耗时、缓存跳过、命中与否);关闭零开销 | 跨平台 |
[]
= { = "0.4", = ["capture-dxgi", "capture-gdi", "match-corr", "parallel"] }
启用后 CaptureKind 多出 Gdi / Dxgi / Auto(Auto 依次试 DXGI → GDI → screenshots),
MatchKind 多出 Corr:
let mut finder = builder
.capture // 自动选最快可用的截图后端
.matcher
.build?;
后端与算法怎么选
| 截图后端 | 特点 | 相对成本 |
|---|---|---|
Screenshots |
跨平台保底 | 高(每帧重建对象 + 多次全帧拷贝) |
Gdi |
复用对象 + BitBlt + 免翻转 | 中(约为 screenshots 的一半) |
Dxgi |
桌面复制,GPU 取帧 | 低(纯读回可到个位数 ms) |
| 匹配算法 | 适合 | 特点 |
|---|---|---|
Rgb |
屏幕内容与模板几乎一致、追求速度 | 不转灰度、锚点 + 逐像素早失败,通道序自适应(RGBA/BGRA) |
Corr |
有光照/轻微缩放变化、追求稳 | 灰度 ZNCC + 金字塔,较慢但鲁棒 |
更多用法 (v0.2)
use ;
// 1) 限定区域:只在该矩形内找,返回的仍是屏幕绝对坐标
let finder = builder
.capture
.matcher
.region
.build?;
// 2) 多结果:找全部不重叠匹配(重叠自动去重),max=0 表示不限
let all = finder.find_all_on_screen?;
// 3) 批量:只截一屏,一次匹配多张模板(省掉重复截图)
let hits = finder.find_many_on_screen?;
匹配器层面也可直接调用 trait 方法:
[Matcher::find] 整帧单个、[Matcher::find_in] 区域内单个、
[Matcher::find_all] 区域内多个。开启 parallel 后,RgbMatcher 用 rayon 把
扫描按行分到多核,全屏 find / find_all 在大分辨率下更快(结果与串行完全一致)。
等待与窗口 (v0.3)
use Duration;
use ;
// 4) 轮询等待:等按钮出现(命中即返回,超时返回 None);等遮罩消失同理。
// 配合 DXGI 后端的"静态帧跳过",等待期间几乎零开销。
let m = finder.find_until?;
let gone = finder.wait_gone?;
// 5) 窗口级截图(Windows, feature `capture-window`):PrintWindow 渲染客户区,
// 窗口被遮挡也能截;返回坐标为窗口相对。也可用 CaptureKind::Window(hwnd)。
let cap = from_title?;
let mut finder = new;
let m = finder.find_on_screen?; // 相对该窗口客户区的坐标
与键鼠操作的关系(生态分工)
pixhunt 专注做眼睛(截图 + 定位),不做"手"——点击/输入交给 enigo、rdev 等成熟跨平台库,坐标就是两者的接口:
let m = finder.find_until?.unwrap;
enigo.move_mouse?;
enigo.button?;
完整可运行示例见 examples/wait_and_click.rs(Windows,--features capture-gdi)。
颜色搜索与诊断 (v0.4)
use ;
// 6) 颜色范围搜索:没有模板、只有"大概这个颜色"的场景(血条/状态灯/高亮区)。
// 返回 8-连通色块(包围盒+面积),按 (y,x) 排序,min_area 过滤碎点。
let red_lights = finder.find_color_on_screen?;
for b in red_lights
// 也可离线对任意帧用:pixhunt::color::find_blobs(&frame, &spec, region, min_area)
开 tracing feature 后,pixhunt 在 pixhunt target 下输出 trace 级事件:
后端名、截图耗时、静态帧缓存是否命中、扫描结果等——"为什么找不到"先看日志:
// 用户侧接一个 subscriber 即可看到
fmt.with_max_level.init;
finder.find_on_screen?; // trace: op="find_on_screen" backend="dxgi" changed=false cache_hit=true ...
性能(参考)
以下数字来自同仓库的 benchmark(1920x1200 / release / 全屏),用来说明各后端的 相对量级,并非所有后端都已内置于当前发布版本:
| 组合 | 纯匹配 | 截图 | 端到端(截图+匹配) |
|---|---|---|---|
| RGB + screenshots | ~5ms | ~54ms | ~57ms |
| RGB + GDI | ~5ms | ~29ms | ~34ms |
| RGB + DXGI | ~5ms | ~7ms | ~12ms |
要点:找图瓶颈主要在截图,换更快的后端收益最大;RgbMatcher 本身已是毫秒级。
运行示例
# 默认(screenshots 后端)
# 用 Windows 快后端 + 自动选择
注意
- 分辨率 / DPI:模板与截图需同一分辨率尺度,否则找不到。
- 截图 ≠ 匹配:两者是分开计时/分开的步骤,别把截图耗时算进算法。
- DXGI 限制:RDP / 锁屏 / 无 GPU 时不可用,
CaptureKind::Auto会自动回退。 - 帧字节序:GDI / DXGI 产出 BGRA,screenshots 产出 RGBA;
RgbMatcher按帧的PixelFormat自动映射通道,无需你手动转换。
许可
Licensed under either of MIT or Apache License, Version 2.0 at your option.
See LICENSE-MIT and LICENSE-APACHE.