主题
API 速查
教程页回答「为什么、怎么写」,速查页回答「这个东西叫什么、有哪些参数、返回什么」。每一页都是按对象分组的完整清单,配合页面顶部的筛选框使用。
八个速查页
| 页面 | 覆盖内容 | 适合查什么 |
|---|---|---|
| HTML / DOM 速查 | HTML 元素与全局属性、input 类型、常用 Web API 索引、DOM 事件总表 | 「这个需求该用哪个元素/API」「这个事件叫什么」 |
| SVG 元素与属性速查 | SVG 元素清单、通用/演示属性、滤镜图元、动画元素、DOM 接口方法 | 「画圆弧用哪个元素」「stroke-dasharray 怎么写」 |
| Canvas 2D 速查 | CanvasRenderingContext2D 全部方法与属性、渐变/图案、Path2D、ImageData、OffscreenCanvas、事件 | 「填充规则参数」「drawImage 有几种重载」 |
| WebGL 1.0 速查 | WebGLRenderingContext 全部方法(按用途分组)、各类 GL 对象、常量表、扩展 | 「哪个函数设置深度」「这个常量值是多少」 |
| WebGL 2.0 速查 | 相对 WebGL1 的增量:新方法、新对象、新常量与可用的 ES 3.0 特性 | 「实例化怎么调」「哪些 WebGL1 扩展已内建」 |
| GLSL ES 速查 | 1.00 与 3.00 的限定符、类型、内置变量、内置函数、精度与语法差异 | 「有没有 mix」「#version 怎么写」 |
| WebGPU 速查 | navigator.gpu 与全部接口的方法/成员、描述符字段、limits/features、错误模型 | 「管线描述符有哪些字段」「绑定组怎么建」 |
| WGSL 速查 | 类型、内置变量与函数、属性(@group/@location/…)、语句与运算符 | 「这个内置函数叫什么」「@builtin 有哪些」 |
三种查法,按你的习惯挑
- 站内搜索(右上角
/或点击搜索框):全文索引,跨页面搜「createBuffer」也能命中速查表与教程正文。 - 页面筛选框:进入某一页后用顶部输入框即时过滤表格行,适合「我记得是 GPU 的东西,但不确定在哪」。
- 浏览器
Ctrl+F:速查页是纯表格,原生查找同样好用。
速查表的阅读约定
| 记号 | 含义 |
|---|---|
| ★ | 高频使用,建议优先记住;速查页里没标星的通常是进阶或很少直接调用的项 |
| 斜体参数 | 参数可选;参数 = 默认值 表示默认值 |
→ 类型 | 返回值类型;void 表示无返回值 |
| 教程列 | 点击可跳到讲解该 API 的教程页(速查页只列清单,原理与坑在教程里) |
每页结构一致:对象总览 → 按用途分组的方法 → 属性/字段 → 常量或枚举 → 事件 → 易错点 → 相关教程。
命名规律(知道规律能猜出名字)
| 前缀 / 后缀 | 出现场景 | 例子 |
|---|---|---|
createXxx / deleteXxx | 显式资源生命周期(WebGL / WebGPU) | createBuffer / deleteBuffer、createTexture / destroy |
getXxx / setXxx | 查询与设置状态 | getError、getParameter、setTransform |
bindXxx | 把对象变为「当前状态」(WebGL 的状态机特色) | bindBuffer、bindTexture、bindVertexArray |
enable / disable | 开关式能力(大写常量作为参数) | enable(gl.DEPTH_TEST) |
XxxBuffer / XxxTexture / XxxPipeline | 资源与管线对象 | GPUBuffer、GPUTexture、GPURenderPipeline |
beginXxx / endXxx | 成对的作用域(pass、录制块) | beginRenderPass / end、beginPath / stroke |
drawXxx / dispatchXxx | 触发 GPU 工作 | drawElements、drawArraysInstanced、dispatchWorkgroups |
*Encoder | 录制命令(WebGPU 的显式模型) | GPUCommandEncoder、GPURenderPassEncoder |
版本与兼容性约定
- 速查页描述的是当前主流浏览器实现(HTML Living Standard / SVG 2 / Canvas 2D 现行规范 / OpenGL ES 2.0 与 3.0 / WebGPU 现行规范 / WGSL 与 GLSL ES 1.00、3.00)。
- 标注为「实验性」「未实现」的条目,请以 MDN 与 caniuse 为准;本站在教程页里也给了具体兼容性结论。
- WebGPU 目前属 Limited availability(Firefox 尚未默认启用),相关示例在不支持的环境会给出可读提示。
速查与教程怎么配合
遇到问题
├─ 不确定用哪个技术 → 指南 / 六大图形技术选型
├─ 知道用什么,忘了名字 → 本板块(速查)
├─ 会用但不懂为什么/踩坑 → 对应板块的教程页(速查表的「教程」列可直达)
└─ 想看能跑的完整代码 → 示例总览,或教程页里的在线示例1
2
3
4
5
2
3
4
5
速查表不能替代教程
速查页刻意省略了「为什么这样设计」「性能代价」「浏览器差异」这些内容——这些正是教程页的重点。比如 drawElements 的参数在速查表里一行就能查到,但「为什么索引缓冲能省显存、UNSIGNED_SHORT 的顶点上限是多少」要去 缓冲区与属性 看。