> ## Documentation Index
> Fetch the complete documentation index at: https://docs.xbox.com/llms.txt
> Use this file to discover all available pages before exploring further.

# XBOX GDK 主机开发 NDA 主题索引

> 在一个标签页中汇集的受 NDA 保护的 XBOX GDK 主机开发主题索引，供作者与已获得 NDA 授权的读者通过 GDKX 门户访问。

> [!NOTE]
>
> 本索引中的每个页面都需要有效的 XBOX GDK 主机开发 NDA。所有页面均在主侧边栏导航中隐藏。以下条目仅按标题列出，未提供链接；已获得 NDA 授权的读者可通过 GDKX 或页面内直接交叉引用访问它们。

## 关于本节

**NDA Topics** 选项卡将每个机密的 XBOX GDK 主机开发页面集中到一个选项卡中，方便有 NDA 访问权限的作者和读者一览全貌。页面按分组组织，这些分组与文档其他部分中承载相关主题的选项卡保持一致：

* **Home** — 开发套件设置、开发套件配置以及工作室范围的配置。
* **Build** — 主机功能（音频、内存、存储）、核心图形功能、游戏原则和 ATG 协作。
* **Optimize** — PIX、着色器编译器、命令行、DevHome、hix 以及其他主机工具页面。
* **API References** — GDK 图形 API 参考头文件以及隐藏的系统/工具 API 分组。

***

## Home

来自文档 **Home** 选项卡的机密页面，涵盖设置、激活和配置 XBOX 开发套件所需的全部内容。

### 设置与安装

#### 概念

| 页面 | 说明 |
| - | - |
| Product permissions | 通过 Partner Center 沙盒授予用户、组和开发套件对产品的访问权限。 |
| Deployment | 部署类型（Push、Run from PC、流式安装）和工具（XBOX Manager、xbapp、Visual Studio）。 |
| Emergency Offline Updates | 当开发套件无法启动时，通过 USB 执行 EOU 出厂重置。 |
| Unexpected reboots | 诊断 XBOX 开发套件意外重启或关机的原因。 |
| Universal Error Messages | XBOX 开发套件上常见的通用错误消息 (UEM) 及其解决方法。 |
| Remove Gold Sharing | 重置主机权限以清除开发套件上的 Gold Sharing。 |
| XBOX One X Dev Kit tips | 有关 XBOX One X 开发套件的工具、更新、脚本和前面板使用技巧。 |
| Console modes | 通过主机模式切换来近似模拟其他 XBOX 平台。 |

#### 开发套件设置

| 页面 | 说明 |
| - | - |
| Retail ↔ Developer Mode | 在零售模式与开发者模式之间切换 XBOX 开发套件。 |
| Configure settings | 通过 DevHome、xbconfig 或 XBOX Manager 配置 Profiling Mode、Sandbox ID 和空闲超时。 |
| Flash OS recovery | 注册自动 OS 恢复更新，或手动应用恢复镜像。 |
| Set a host name | 为开发套件设置友好的主机名，使工具在 IP 变更后仍可正常工作。 |

#### 工作室范围的配置

| 页面 | 说明 |
| - | - |
| Recover multiple consoles | 从一台 PC 对多个开发套件并行执行 OS 恢复。 |
| Automatic recovery updates | 自动 OS 恢复更新的工作原理，以及如何更改更新策略。 |
| Unattended setup script | 为 OOBE、每次启动配置或临时运行编写无人值守设置脚本。 |

***

## Build

来自文档 **Build** 选项卡的机密页面，涵盖主机功能、核心图形功能、游戏原则以及 Microsoft 协作检查清单。

### 主机功能

位于原本公开的 Build 分组内的隐藏 NDA 页面。每行给出该分组的入口页面；分组内的各个 NDA 页面可从该入口页面或通过直接链接访问。

| 分组 | 说明 | 入口页面 |
| - | - | - |
| Audio | XBOX GDK 的 XAudio2 概述及相关音频指导。 | XAudio2 overview |
| Memory | XBOX 主机的内核和系统内存使用、虚拟内存分配器、可写文件映射以及移植与诊断。 | System memory overview |
| Storage — DirectStorage | 机密的 DirectStorage 指南：压缩、shuffle 以及白皮书。 | DirectStorage overview |

### 核心功能

#### 图形

Core Features → Graphics 树的大部分内容受 NDA 保护。每行代表 `build/core-features/graphics/` 下的一个隐藏子分组或一组隐藏的顶级页面。

| 分组 | 说明 | 入口页面 |
| - | - | - |
| D3D12X | XBOX Direct3D 12 (D3D12X) 概述、与 PC 的差异、ATOC 以及 XMemAlloc 对象类型。 | D3D12X overview |
| DirectX (console specifics) | 仅限主机的 DirectX 主题：颜色与深度压缩、创建标志、帧调度、硬件覆盖、原生资源管理、off-chip 曲面细分、挂起与恢复。 | Color and depth compression |
| Graphics overviews | 机密的图形概述页面（GPU overview、enhanced barriers、Scarlett 上的 GPU 同步、HDR 支持、120 Hz、CMask 解码、屏幕区域）。 | GPU overview |
| Graphics presentations — XDD 2024 | XDD 2024 图形深度讲解。 | Presentations |
| Graphics presentations — XFEST 2019 | XFEST 2019 图形演示。 | Presentations |
| Graphics presentations — XFEST 2022 | XFEST 2022 图形演示。 | Presentations |
| New features — Mesh shaders | 网格着色器的 API 设计、meshlet culling 与渲染、Scarlett 支持、用法与原理。 | Mesh shaders overview |
| New features — Raytracing | XDXR 概述、BVH builders、压缩、硬件设计、KDOP、离线 RT PSO、standalone、最佳实践。 | Raytracing overview |
| New features — Sampler Feedback / SFS | Sampler Feedback Streaming API 与 GPU 设计、概述、用法与原理。 | SFS overview |
| New features — VRS | Variable Rate Shading API、功能、概述与原理。 | VRS overview |
| New features — XBTC | XBOX Texture Compressor、归档格式、JSON 批处理配置及用法。 | XBOX Texture Compressor |
| Whitepapers | 机密的图形白皮书（棋盘渲染、缓存与一致性、VMEM 指令、Series S 优化、动态分辨率、ESRAM manager、GPU 计算单元、GPU 内存访问、occupancy 快速参考、GPU 概述）。 | XBOX One GPU overview |
| Graphics — top-level | 其他隐藏的顶级图形页面：Dolby Vision、图像处理、Scarlett 纹理布局、graphics memory overview、graphics PSO overview 以及 graphics-newfeatures TOC。 | Graphics memory overview |

### 游戏原则

#### 可持续性

| 页面 | 说明 |
| - | - |
| Sustainability overview | 面向 GDK 游戏的 XBOX 可持续性指南机密概述。 |

#### 安全性

| 页面 | 说明 |
| - | - |
| Communication security overview | 网络通信的机密性、完整性和身份认证要求。 |
| Game security concepts | 安全概念和常见攻击类别的概述。 |
| Dev tool security | 自定义游戏开发工具的安全性指导。 |
| General game security | 设计层面的安全性：PII 保护与安全测试。 |
| Secure game communication | GDK 游戏中按流量类型推荐的安全通信方案。 |
| Secure game mesh | 点对点和客户端/服务器安全通信指南。 |
| Secure communication samples | 面向安全通信的 GDK 与 XBOX 服务示例。 |
| Secure web requests | 用于 HTTPS 和 WebSockets 的推荐 API、身份认证和 TLS。 |

### ATG 协作

| 页面 | 说明 |
| - | - |
| ATG engagement | 与 Microsoft 的 Advanced Technology Group 协作以获取平台支持。 |
| Graphics engagement | 就 GPU 性能问题与 ATG 协作的检查清单。 |
| Systems engagement | 就 CPU、系统、内存和加载问题与 ATG 协作的检查清单。 |

***

## Optimize

来自文档 **Optimize** 选项卡的机密页面，即位于原本公开的 Tools 分组内的隐藏主机工具页面。每行给出该分组的入口页面；分组内的各个隐藏页面可从入口页面或通过直接链接访问。

### 工具（主机）

| 分组 | 说明 | 入口页面 |
| - | - | - |
| PIX | PIX for XBOX 工具链：顶层 UI 与工作流，以及 GPU、GPU Trace、可扩展性和着色器浏览器子分组。 | PIX |
| Command-line tools | 机密命令行工具：`xbconfig`、`xbperf`、`xbttd` 以及相关实用工具。 | xbconfig |
| DevHome | 机密的 DevHome 页面（Performance 视图）。 | DevHome performance |
| hix | `hix` 着色器检查工具及其实时调试工作流。 | hix |
| Shader compiler (DXC) | XBOX DXC 的用法、扩展、intrinsic、宏定义、从 FXC 的移植以及着色器编译器概述。 | Shader compiler |
| titleperfoverlay | `titleperfoverlay` 屏幕内性能覆盖层。 | titleperfoverlay |
| xhit | `xhit` 硬件指令工具。 | xhit tool |

***

## API References

来自文档 **API References** 选项卡的机密页面，即隐藏的 GDK 图形 API 参考头文件以及隐藏的系统与工具 API 分组。本节下的每个分组和页面均在侧边栏中隐藏。每个头文件的 members 页面是其接口、结构体、枚举和函数的入口。

### 图形

| 分组 | 说明 | 入口页面 |
| - | - | - |
| Graphics reference TOC | 机密 GDK 图形 API 参考的目录。 | Graphics reference TOC |

### 图形 API

| 头文件 | 说明 | 成员页面 |
| - | - | - |
| d3d12\_x | 面向 XBOX One 系列的 Direct3D 12：接口、结构体、枚举和函数。 | d3d12\_x members |
| d3d12shader\_x | XBOX D3D12 的着色器反射接口。 | d3d12shader\_x members |
| d3d12video\_x | 硬件视频解码、编码和处理。 | d3d12video\_x members |
| d3dx12\_x | 面向 XBOX One 系列的仅头文件 D3D12 辅助库。 | d3dx12\_x members |
| d3dx12\_xs | 面向 XBOX Series 系列的仅头文件 D3D12 辅助库。 | d3dx12\_xs members |
| XG reference | 辅助图形库：资源布局、tile 与 mip 元数据。 | XG members |
| XGMemory reference | XBOX One 系列上的动态 ESRAM / 系统内存映射。 | XGMemory members |
| XBTC | 面向 GDK 管线的离线 BC1–BC7 块压缩。 | XBTC members |
| xg\_xs | XG 辅助图形库的 XBOX Series 变体。 | xg\_xs members |
| DXCApi | DirectX Shader Compiler API：将 HLSL 编译为 DXIL。 | DXCApi members |

### 系统 API

| 分组 | 说明 | 入口页面 |
| - | - | - |
| XMem | 机密的 XMem 参考：members 页面以及枚举、函数、宏和结构体。 | XMem members |

### 工具 API

| 分组 | 说明 | 入口页面 |
| - | - | - |
| PIX3 | 机密的 PIX3 页面（GPU captures、power metrics 函数与结构体）。 | PIX3 GPU captures |


## Related topics

- [XBOX 主机开发者工具 (GDK)](https://docs.xbox.com/zh-CN/tools/tools-console/index.md)
- [NDA 主题目录 - Microsoft Learn 在线链接](https://docs.xbox.com/zh-CN/nda/nda-topic-directory.md)
- [面向主机开发的 Visual Studio](https://docs.xbox.com/zh-CN/tools/tools-console/visualstudio/visualstudio.md)
- [沙盒](https://docs.xbox.com/zh-CN/services/xbox-services/fundamentals/sandboxes/live-sandboxes-nav.md)
- [面向主机开发的命令行工具](https://docs.xbox.com/zh-CN/tools/tools-console/commandlinetools/commandlinetools.md)