Vyntek 文档
四类入口:接口参考、设计规格、使用指南、概念与术语。
机器视觉 / ToolGroup C++ 库。实现真相在本仓库公开头与源码;规格正文见本站。
| 版本 | 0.1.0(VYNTEK_VERSION_*,伞头唯一来源) |
| 标准 | C++17 |
| 命名空间 | vyntek::toolgroup / vyntek::imaging |
| CMake 目标 | vyntek_toolgroup + vyntek_imaging(可选 INTERFACE vyntek) |
| ABI | NON-STABLE(VYNTEK_ABI_UNSTABLE);有头 ≠ 验收完成 |
| 许可证 | MIT |
四类入口
| 分类 | 内容 | 入口 |
|---|---|---|
| 接口参考 | 对照 include/ 公开头的逐符号参考(函数、类型、枚举、宏、C API) | API 参考 |
| 设计规格 | 规范性契约:架构决策、行为规定、验收口径(含 TC-*) | 设计规格 |
| 使用指南 | 任务导向:本地预览、宿主集成、示例构建与运行 | 本地预览 · 宿主集成 · 示例 |
| 概念与术语 | 解释性:术语终检、图像模型、控件现状对照 | 术语 · 图像模型 · 控件对照 |
公开模块
| 模块 | 头文件 | 状态 |
|---|---|---|
| ToolGroup | vyntek/toolgroup/*.hpp | 编排核心语义已实现;真实算法 stub;NON-STABLE |
| Imaging | vyntek/imaging/*.hpp | 外形齐;部分实现;STUB 标 |
| Memory | vyntek/memory.hpp → imaging buffer | 便利转发 + BufferView 占位 |
| Session | vyntek/session.hpp → run_session.hpp | 编排 RunSession 与采集停流已实现;扁平 Session 占位 |
状态摘要
| 维度 | 本仓现状 |
|---|---|
| Include 树 | 嵌套子树已落地;扁平头为便利转发 |
| 库边界 | 已分 vyntek_toolgroup / vyntek_imaging |
| 类型外形 | 声明与核心语义已实现;真实算法仍 stub(Reed 职责);公开头标 NON-STABLE |
| 测试契约 | 94 条均有单测断言覆盖,但尚未作为验收闭环(需供应商实机与真实渲染) |
构建与预览见 使用指南;仓库构建细节见根 README。