docs: 重构 API 文档结构并修正源码准确性
- 重组文档目录结构: 每个模块的概述页移动到模块子目录 - 重命名 index.md 为 main.md - 修正所有模块文档中的错误: - math: FromEuler→FromEulerAngles, TransformDirection 包含缩放, Box 是 OBB, Color::ToRGBA 格式 - containers: 新增 operator==/!= 文档, 补充 std::hash DJB 算法细节 - core: 修复 types 链接错误 - debug: LogLevelToString 返回大写, timestamp 是秒, Profiler 空实现标注, Windows API vs ANSI - memory: 修复头文件路径, malloc vs operator new, 新增方法文档 - resources: 修复 Shader/Texture 链接错误 - threading: TaskSystem::Wait 空实现标注, ReadWriteLock 重入描述, LambdaTask 链接 - 验证: fix_links.py 确认 0 个断裂引用
This commit is contained in:
35
docs/api/threading/spinlock/lock.md
Normal file
35
docs/api/threading/spinlock/lock.md
Normal file
@@ -0,0 +1,35 @@
|
||||
# SpinLock::Lock
|
||||
|
||||
```cpp
|
||||
void Lock()
|
||||
```
|
||||
|
||||
获取自旋锁。如果锁已被其他线程持有,则使用忙等待(spin)持续轮询,直到获取到锁。
|
||||
|
||||
**参数:** 无
|
||||
|
||||
**返回:** 无
|
||||
|
||||
**复杂度:** 平均 O(1),最坏情况取决于竞争程度
|
||||
|
||||
**注意:**
|
||||
- 适用于临界区极短(几个 CPU 指令)的场景,避免线程切换开销。
|
||||
- 在锁持有时间较长或多核竞争激烈时,会浪费大量 CPU 周期,此时应使用 Mutex。
|
||||
- 同一线程不可重复 Lock 同一个 SpinLock。
|
||||
|
||||
**示例:**
|
||||
|
||||
```cpp
|
||||
Threading::SpinLock spinLock;
|
||||
int64_t fastCounter = 0;
|
||||
|
||||
void IncrementFast() {
|
||||
spinLock.Lock();
|
||||
++fastCounter;
|
||||
spinLock.Unlock();
|
||||
}
|
||||
```
|
||||
|
||||
## 相关文档
|
||||
|
||||
- [SpinLock 总览](spinlock.md) - 返回类总览
|
||||
Reference in New Issue
Block a user