API 文档
本项目的 API 文档由 mkdocstrings 从源码
自动生成——页面上看到的就是代码里的文档字符串。
怎么读
- 标题形如
tkdeft.engines · 绘制引擎层入口，正文按 模块 → 类 → 方法 展开； - 每个条目的参数、返回值、异常都写在文档字符串里，与代码一起维护；
- 右上角的搜索框支持跨页搜索；
- 想直接看实现，点开
源码折叠块。
分组
| 分组 | 内容 |
|---|---|
| 顶层 | tkdeft 的汇总入口（各子模块的常用名字） |
| 绘制引擎 | 引擎注册表、规格对象、缓存、颜色解析，以及三个栅格引擎 |
| 图形与画布 | SVG 形状助手、画布、绘制后端、交互控件基类 |
| 效果 | tkdeft.extra 里可复用的涟漪（给任意控件加半透明扩散） |
| 基础 | DObject 配置容器、字体等工具 |
从哪读起
| 你在做什么 | 先看 |
|---|---|
| 画图元 / 写组件 | tkdeft.windows.canvas 的 draw_roundrect 一族 |
| 换引擎 / 调缓存 | tkdeft.engines |
| 自己写一个引擎 | tkdeft.engines.base 的 DrawEngine |
| 拼 SVG | tkdeft.svg |
| 组件的属性容器 | tkdeft.object 的 DObject |
| 给控件加涟漪 | tkdeft.extra.ripple 的 Ripple 与 ripple_layer() |
