Skip to content

Commit dc173a7

Browse files
committed
修复入门的交叉引用
1 parent a0dbca4 commit dc173a7

18 files changed

Lines changed: 232 additions & 298 deletions

docs/index.md

Lines changed: 3 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -43,12 +43,11 @@ title: 主页
4343
* [参考](./optimization/Reference/Reference.md)
4444

4545

46-
47-
4846
## 参考
4947

50-
* [引擎优化仓库 UnrealEngineVite-PhysX](https://github.com/GapingPixel/UnrealEngineVite-PhysX)
51-
* [UnrealEngineVite 文档](https://vitestudio-tech.github.io/UnrealEngineVite-Docs)
48+
* [引擎优化仓库 UnrealEngineVite-PhysX](https://github.com/GapingPixel/UnrealEngineVite-PhysX)[UnrealEngineVite 文档](https://vitestudio-tech.github.io/UnrealEngineVite-Docs)
49+
* [AMD GPUOpen 引擎分支](https://github.com/GPUOpenSoftware/UnrealEngine/tree/EngineOpt-4.24)[Unreal Engine 性能指南 - GPUOpen](https://gpuopen.com/unreal-engine/)
50+
* [NvRTX 4.27](https://github.com/NvRTX/UnrealEngine/tree/NvRTX_Caustics-4.27)
5251

5352

5453

docs/optimization/Contributing/Backporting.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -101,12 +101,12 @@ Vite 是一款 NvRTX 4.27 Plus 分叉,与最新引擎开发的技术保持同
101101

102102
## 资产向后移植
103103

104-
从 UE5 向后移植*资产*是一个不同的问题,由资产降级器而不是代码处理。请参阅[从 UE5 迁移](Migration-From-UE5.md)[建议的插件](Proposed-Plugins.md)
104+
从 UE5 向后移植*资产*是一个不同的问题,由资产降级器而不是代码处理。请参阅[从 UE5 迁移](../GettingStarted/Migrating-From-UE5.md)[建议的插件](../Plugins/Proposed-Plugins.md)
105105

106106
## 另请参阅
107107

108108
- [贡献](Contributing.md)
109109
- [编码指南](Coding-Guidelines.md)
110110
- [提交约定](Commit-Conventions.md)
111-
- [编译时开关](Compile-Time-Switches.md)
112-
- [从 UE5 迁移](Migrating-From-UE5.md)
111+
- [编译时开关](../Performance/Compile-Time-Switches.md)
112+
- [从 UE5 迁移](../GettingStarted/Migrating-From-UE5.md)

docs/optimization/Contributing/Coding-Guidelines.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -46,7 +46,7 @@
4646

4747
### 大量模板模式
4848

49-
避免使用模板,除非它们提供明确的性能或架构优势。不要引入会增加编译时间、二进制大小或代码复杂性的模式。请参阅[Shader 编译和 PSO](Shader-Compilation-And-PSO.md) 了解为什么这里要认真对待编译时间。
49+
避免使用模板,除非它们提供明确的性能或架构优势。不要引入会增加编译时间、二进制大小或代码复杂性的模式。请参阅[Shader 编译和 PSO](../Performance/Shader-Compilation-And-PSO.md) 了解为什么这里要认真对待编译时间。
5050

5151
### 破坏 ABI 的修改
5252

docs/optimization/Contributing/Commit-Conventions.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -99,7 +99,7 @@ The subject line says what changed. The body should say why, and what a reviewer
9999
- Anything deliberately left undone
100100

101101
Measured impact matters. A commit prefixed `[Optimization]` with no numbers is an assertion, not a result.
102-
See [Profiling](Profiling.md) for how to produce a credible before-and-after.
102+
See [Profiling](../Performance/Profiling.md) for how to produce a credible before-and-after.
103103

104104
## Branches
105105

@@ -130,7 +130,7 @@ Compile-time switches use the `VITE_` prefix and must be defined with a default
130130
#endif
131131
```
132132

133-
Document any new switch in [Compile-Time Switches](Compile-Time-Switches.md) in the same change. A switch
133+
Document any new switch in [Compile-Time Switches](../Performance/Compile-Time-Switches.md) in the same change. A switch
134134
that is not documented will be discovered by someone debugging a console variable that silently does
135135
nothing — which is exactly the failure mode `VITE_RT_PSO_DEBLOAT` caused before it was written up.
136136

@@ -139,4 +139,4 @@ nothing — which is exactly the failure mode `VITE_RT_PSO_DEBLOAT` caused b
139139
- [Contributing](Contributing.md)
140140
- [Coding Guidelines](Coding-Guidelines.md)
141141
- [Backporting](Backporting.md)
142-
- [Compile-Time Switches](Compile-Time-Switches.md)
142+
- [Compile-Time Switches](../Performance/Compile-Time-Switches.md)

docs/optimization/Contributing/Contributing.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,7 @@ Vite的存在是因为UE 4.27可以变得又快又稳定。妥协的贡献要么
2121

2222
1. 阅读<a href="Coding-Guidelines.md">编码指南</a>。几种常见的 C++ 模式被彻底禁止,并且在编写代码后发现的成本很高。
2323

24-
2. 检查更改是否已被覆盖。 <a href="Compile-Time-Switches.md">编译时开关</a>和<a href="Engine-Defaults.md">引擎默认更改</a>页面记录了大量现有工作。
24+
2. 检查更改是否已被覆盖。 <a href="../Performance/Compile-Time-Switches.md">编译时开关</a>和<a href="../Performance/Engine-Defaults.md">引擎默认更改</a>页面记录了大量现有工作。
2525

2626
3. 在分支中写代码。将正在进行的工作推送到替代分支,并注明剩余内容,并让其他分叉者意识到这一点。
2727

@@ -39,7 +39,7 @@ Vite的存在是因为UE 4.27可以变得又快又稳定。妥协的贡献要么
3939

4040
* 性能基线
4141

42-
更改是根据 ARM 级 ~1 GHz CPU 基准进行评估的。在桌面上进行测量并快速找到它并不能清除障碍。请参阅<a href="Performance-Targets.md">性能目标</a>。
42+
更改是根据 ARM 级 ~1 GHz CPU 基准进行评估的。在桌面上进行测量并快速找到它并不能清除障碍。请参阅<a href="../EngineOverview/Performance-Targets.md">性能目标</a>。
4343

4444
* 版权清洁度
4545

@@ -51,18 +51,18 @@ Vite的存在是因为UE 4.27可以变得又快又稳定。妥协的贡献要么
5151
适合 Vite 的贡献往往有一个共同的特征:
5252

5353
- **可测量。** 对代表性内容的前后分析捕获胜过争论。
54-
- **被守护。** 交付中不需要的任何内容都位于[编译时开关](Compile-Time-Switches.md) 或控制台变量后面,并且在需要花费一些代价时默认关闭。
54+
- **被守护。** 交付中不需要的任何内容都位于[编译时开关](../Performance/Compile-Time-Switches.md) 或控制台变量后面,并且在需要花费一些代价时默认关闭。
5555
- **范围小。** 涉及一个子系统的变更是可以审查的。涉及渲染器、物理层和构建系统的更改则不然。
5656
- **记录在案。** 新的控制台变量、开关和默认值需要文档页面或现有页面中的一个部分。
5757

5858
## 准备工作
5959

60-
请参阅[从源代码构建](Build-From-Source.md)[工具链要求](Toolchain-Requirements.md)。请注意,引擎开发需要源构建 -[已安装的构建](Installed-Builds.md) 无法编译引擎 C++。
60+
请参阅[从源代码构建](../GettingStarted/Build-From-Source.md)[工具链要求](../GettingStarted/Toolchain-Requirements.md)。请注意,引擎开发需要源构建 -[已安装的构建](../Tools/Installed-Builds.md) 无法编译引擎 C++。
6161

6262
## 另请参阅
6363

6464
- [编码指南](Coding-Guidelines.md)
6565
- [提交约定](Commit-Conventions.md)
6666
- [向后移植](Backporting.md)
67-
- [从源代码构建](Build-From-Source.md)
68-
- [性能目标](Performance-Targets.md)
67+
- [从源代码构建](../GettingStarted/Build-From-Source.md)
68+
- [性能目标](../EngineOverview/Performance-Targets.md)

docs/optimization/Contributing/Documentation-Contributions.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -81,7 +81,7 @@ Inside `<tldr>`, `<note>`, `<warning>` and `<def>`, use HTML rather than Markdow
8181
- State the answer, then the reasoning. Not the reverse.
8282
- Say what something costs, not only what it does.
8383
- Where a feature is unavailable by default, say so at the top of the page, not in a footnote. The
84-
[RTXDI](RTXDI.md) and [path tracing](Path-Tracing.md) pages are the pattern to follow.
84+
[RTXDI](../Rendering/RTXDI.md) and [path tracing](../Rendering/Path-Tracing.md) pages are the pattern to follow.
8585
- Tables for enumerable facts, prose for explanation. Do not put explanations in table cells.
8686

8787
### Accuracy
@@ -124,11 +124,11 @@ If your engine change affects any of the following, update the documentation in
124124
| Change | Page to update |
125125
|---|---|
126126
| New or changed console variable | The relevant feature page |
127-
| New `VITE_*` switch | [Compile-Time Switches](Compile-Time-Switches.md) |
128-
| Changed engine default | [Engine Defaults](Engine-Defaults.md) |
129-
| New or updated plugin | [Bundled Plugins](Bundled-Plugins.md) |
130-
| New tool or script | The [Tools](Tools.md) section |
131-
| A feature becoming unavailable in default builds | The feature's page, and [Ray Tracing](Ray-Tracing.md) if applicable |
127+
| New `VITE_*` switch | [Compile-Time Switches](../Performance/Compile-Time-Switches.md) |
128+
| Changed engine default | [Engine Defaults](../Performance/Engine-Defaults.md) |
129+
| New or updated plugin | [Bundled Plugins](../Plugins/Bundled-Plugins.md) |
130+
| New tool or script | The [Tools](../Tools/Tools.md) section |
131+
| A feature becoming unavailable in default builds | The feature's page, and [Ray Tracing](../Rendering/Ray-Tracing.md) if applicable |
132132

133133
## See also
134134

Lines changed: 36 additions & 52 deletions
Original file line numberDiff line numberDiff line change
@@ -1,76 +1,60 @@
11
# 引擎概述
22

3-
<tldr>
4-
<p>
5-
Vite is Unreal Engine 4.27.2 (<code>++UE4+Release-4.27</code>) forked from NvRTX 4.27 Caustics merged fully with UE 4.27
6-
Plus, NvRTX 5.0 and AMD branch features merged in, plus 300+ backports from UE 5.0&ndash;5.8.
7-
</p>
8-
</tldr>
3+
Vite 是基于虚幻引擎 4.27.2 (`++UE4+Release-4.27`) 的分支版本,它完全融合了 NvRTX 4.27 的焦散效果,并整合了 NvRTX 5.0 和 AMD 分支的特性,此外还移植了 300 多个来自 UE 5.0 至 5.8 的组件。
94

10-
This section explains the reasoning behind Vite's architecture: why the fork is based on Unreal Engine 4.27
11-
rather than UE5, what performance envelope it is designed for, and where the measured cost differences
12-
between the two engine generations come from.
5+
本节将解释 Vite 架构背后的原因:为什么该分支版本基于虚幻引擎 4.27 而非 UE5,它的设计性能范围,以及两个引擎版本之间实际成本差异的来源。
136

14-
If you just want to get the engine running, go to [Getting Started](Getting-Started.md) instead.
7+
如果您只想运行引擎,请前往[入门指南](../GettingStarted/Getting-Started.md)部分。
158

16-
## Base version
179

18-
| Property | Value |
10+
## 基础版本
11+
12+
| 属性 ||
1913
|--------------------|------------------------------------------------------|
20-
| Engine version | 4.27.2 |
21-
| Repo name | `UnrealEngineVite-PhysX` |
22-
| Upstream base | NvRTX 4.27 Caustics |
23-
| Merged branches | UE 4.27 Plus, NvRTX 5.0, AMD GPUOpen engine branches |
24-
| UE5 backports | 300+ in release, 1,000+ in internal staging |
25-
| Physics backend | Vite PhysX |
26-
| Main Path Renderer | Deferred, agnostic DXR Ray Tracing pipeline |
14+
| 引擎版本 | 4.27.2 |
15+
| 仓库名称 | `UnrealEngineVite-PhysX` |
16+
| 上游基础版本 | NvRTX 4.27 Caustics(焦散) |
17+
| 已合并的分支 | UE 4.27 Plus, NvRTX 5.0, [AMD GPUOpen 引擎分支](https://github.com/GPUOpenSoftware/UnrealEngine/tree/EngineOpt-4.24) |
18+
| UE5 向后移植 | 发布版本超过 300 个,内部测试版本超过 1000 个 |
19+
| 物理后端 | Vite PhysX |
20+
| 主路径渲染器 | 延迟的、与技术无关的DXR光线追踪管线 |
21+
22+
## 章节内容
23+
24+
### [为何选择 NvRTX 4.27](Why-NvRTX-427.md)
25+
26+
基础版本的技术论证:UE 5.1 光线追踪场景构建的改变、Lumen 耦合为何会使其他全局光照集成更加困难,以及移除 PhysX 为何至关重要。
2727

28-
## Section contents
28+
### [性能目标](Performance-Targets.md)
2929

30-
### [Why NvRTX 4.27](Why-NvRTX-427.md)
30+
Vite 针对四种 PS5 级配置进行了优化,从 4K120p 风格化到 1440p30(开启完整光线追踪效果套件)。
3131

32-
The technical argument for the base version: what changed in UE 5.1's ray tracing scene construction, why
33-
Lumen coupling makes alternative GI integrations harder, and why PhysX removal matters.
32+
### [UE4 与 UE5 成本分析](UE4-Versus-UE5-Cost-Analysis.md)
3433

35-
### [Performance Targets](Performance-Targets.md)
34+
帧时间实际消耗在哪里:着色器指令数、物理效果、角色移动、内存、Slate、骨骼网格、tick 成本、渲染线程开销、蓝图原生化和体积渲染。
3635

37-
The four PS5-class configurations Vite is tuned against, from 4K120 stylised through to 1440p30 with the
38-
full ray tracing effect suite.
3936

40-
### [UE4 versus UE5 Cost Analysis](UE4-Versus-UE5-Cost-Analysis.md)
37+
### [发布说明](Release-Notes.md)
4138

42-
Where the frame time actually goes: shader instruction counts, physics, character movement, memory,
43-
Slate, skeletal meshes, tick cost, render thread overhead, Blueprint nativization and volumetrics.
39+
当前版本分支包含哪些内容、正在进行哪些开发以及未来计划包含哪些内容。
4440

45-
### [Release Notes](Release-Notes.md)
41+
## 设计原则
4642

47-
What is in the current release branch, what is in progress, and what is planned.
43+
代码库中几乎所有决策都受到三项承诺的影响,值得明确阐述,因为它们解释了那些看似保守的选择。
4844

49-
## Design principles
5045

51-
Three commitments shape almost every decision in the codebase, and they are worth stating explicitly
52-
because they explain choices that otherwise look conservative.
46+
**久经考验的技术优于自研技术。** Epic Games 为 UE5 构建了一套全新的系统,而 Vite 则更倾向于采用行业标准解决方案,这些方案广泛应用于 AAA 级游戏中:PhysX 而非 Chaos,DDGI 而非 Lumen,硬件曲面细分而非 Nanite,TressFX 而非 Groom。这些选择并非出于怀旧,而是基于对已在众多游戏中得到验证的解决方案的考量。
5347

54-
**Battle-tested technology over in-house technology.** Where Epic built a new system for UE5, Vite prefers
55-
the industry-standard solutions that are widely shipped in AAA titles: PhysX rather than Chaos, DDGI rather than
56-
Lumen, HW Tessellation rather than Nanite, TressFX rather than Groom. These are not nostalgic choices; they are choices
57-
about which solutions has been through the most shipped games.
48+
**原生分辨率优于重建。** Vite 的性能目标设定为原生 4K 和原生 1440p。虽然支持并集成了升频器(Upscalers),但升频器被视为超越目标速度的手段,而非达到目标的途径。
5849

59-
**Native resolution over reconstruction.** Vite's performance targets are stated at native 4K and native
60-
1440p. Upscalers are supported and integrated, but they are treated as a way to go faster than the target,
61-
not as a way to reach it.
50+
**帧时间预算是设计约束,而非优化阶段。** 性能目标决定了产品的最终功能集和用户体验质量。 Vite 为其引入的每个主要功能都制定了迭代优化计划,而不是将优化推迟到项目后期。
6251

63-
**Frame-time budgets are a design constraint, not an optimisation phase.** Performance targets define a
64-
product's end feature set and the quality of the user experience. Vite maintains an iterative optimisation
65-
plan for every major feature it introduces, rather than deferring optimisation to the end of a project.
52+
[引擎编码指南](../Contributing/Coding-Guidelines.md)将这些原则转化为具体的规则,供贡献者参考:禁止递归、禁止无理由创建新的虚函数、禁止破坏 ABI 的更改,以及严格遵守 Clang 规范,并以 ARM 级 CPU 为基准性能目标。
6653

67-
The [Engine Coding Guidelines](Coding-Guidelines.md) encode these principles as concrete rules for
68-
contributors: no recursion, no new virtuals without justification, no ABI-breaking changes, and strict
69-
Clang compliance with an ARM-class CPU as the baseline performance target.
7054

71-
## See also
55+
## 另请参阅
7256

73-
- [Introduction to Vite](Introduction-to-Vite.md)
74-
- [Rendering](Rendering.md)
75-
- [Physics](Physics.md)
76-
- [Engine Coding Guidelines](Coding-Guidelines.md)
57+
- [Vite 简介](../GettingStarted/Introduction-to-Vite.md)
58+
- [渲染](../Rendering/Rendering.md)
59+
- [物理](../Physics/Physics.md)
60+
- [引擎编码指南](../Contributing/Coding-Guidelines.md)

docs/optimization/EngineOverview/Performance-Targets.md

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@ Vite的性能目标不是理想的营销数字;它们是引擎调整的配置
1616

1717
这四款设备的参考硬件均为 PlayStation 5 级别,在台式机上大致意味着 RDNA2 RX 6700/RTX 2080
1818

19-
代码库中还提供实时路径追踪,使用《黑神话:悟空》中的 NVIDIA 路径追踪技术。 — 请参阅[路径跟踪](Path-Tracing.md)
19+
代码库中还提供实时路径追踪,使用《黑神话:悟空》中的 NVIDIA 路径追踪技术。 — 请参阅[路径跟踪](../Rendering/Path-Tracing.md)
2020

2121
## 正在进行比较
2222

@@ -39,15 +39,15 @@ Epic 的 UE 5.7 和 5.8 的目标是在 PS5 上以 720p–1080p 的动态内部
3939
| 角色移动和碰撞 | 4.27 基线 | 5.6 | 4.27 上速度提高了 2.2–2.8 倍 |
4040
| 典型的多人游戏地图内存 | ~1 GB 小于 5.7 | &mdash; | &mdash; |
4141

42-
DDGI对比是最有代表性的渲染争论;物理比较是最有代表性的CPU参数。基准测试场景本身可以从[项目和演示](ProjectsAndDemos.md)下载。
42+
DDGI对比是最有代表性的渲染争论;物理比较是最有代表性的CPU参数。基准测试场景本身可以从[项目和演示](../ProjectsAndDemos.md)下载。
4343

4444
## 为什么原生分辨率是制约因素
4545

4646
时间重建、去噪和随机采样会引入噪声、重影、时间不稳定和模糊。即使帧速率数字匹配,重构为 4K 的动态 720p–1080p 内部分辨率下的 60 FPS 目标与原生 4K 下的 60 FPS 目标是不同的产品。
4747

4848
Vite 的立场是,图像清晰度和游戏响应能力是最先降低且最难恢复的因素,因此帧时间预算应用于保持原始分辨率并使用构造上无噪音的照明技术。 DDGI 使用球谐函数来存储和过滤探头体积中的辐照度,这正是它无需降噪器即可产生稳定结果的原因。
4949

50-
升级器得到全面支持 -DLSS 4.5、FSR 2 和 4、XeSS 和 NIS 均随引擎一起提供。它们被定位为在较弱的硬件上超越目标的一种方式,而不是在参考硬件上达到目标的一种方式。请参阅[Upscalers 和帧生成](Upscalers.md)
50+
升级器得到全面支持 -DLSS 4.5、FSR 2 和 4、XeSS 和 NIS 均随引擎一起提供。它们被定位为在较弱的硬件上超越目标的一种方式,而不是在参考硬件上达到目标的一种方式。请参阅[Upscalers 和帧生成](../Rendering/Upscalers.md)
5151

5252
## 设定目标
5353

@@ -57,18 +57,18 @@ Vite 的立场是,图像清晰度和游戏响应能力是最先降低且最难
5757

5858
1. 从上表中选择与你的游戏类型相匹配的行。竞技多人游戏几乎总是意味着选择“风格化 4K120”目标;叙事型单人游戏通常可以使用“高保真”目标。
5959

60-
2. 配置相应的功能集,无需其他操作。Vite 默认启用大多数光线追踪效果,因此通常需要将其关闭。请参阅[光线追踪](Ray-Tracing.md)部分。
60+
2. 配置相应的功能集,无需其他操作。Vite 默认启用大多数光线追踪效果,因此通常需要将其关闭。请参阅[光线追踪](../Rendering/Ray-Tracing.md)部分。
6161

6262
3. 为每个系统(全局光照、反射、阴影、几何体、后期处理)设定帧时间预算,并从第一个可玩场景开始使用 `stat gpu` 命令进行测试。
6363

64-
4. 定期在你的测试矩阵中配置最低的硬件上进行测试,而不是在最后才进行测试。请参阅[系统要求](System-Requirements.md)以获取参考硬件列表。
64+
4. 定期在你的测试矩阵中配置最低的硬件上进行测试,而不是在最后才进行测试。请参阅[系统要求](../GettingStarted/System-Requirements.md)以获取参考硬件列表。
6565

66-
5. 使用[可扩展性](Engine-Defaults.md)设置来降低配置,而不是先针对配置最低的机器进行设计,然后再进行扩展。
66+
5. 使用[可扩展性](../Performance/Engine-Defaults.md)设置来降低配置,而不是先针对配置最低的机器进行设计,然后再进行扩展。
6767

6868

6969
## 另请参阅
7070

7171
- [UE4 与 UE5 成本分析](UE4-Versus-UE5-Cost-Analysis.md)
72-
- [性能分析和基准测试](Profiling.md)
73-
- [可扩展性](Engine-Defaults.md)
72+
- [性能分析和基准测试](../Performance/Profiling.md)
73+
- [可扩展性](../Performance/Engine-Defaults.md)
7474
- [项目和演示](../ProjectsAndDemos.md)

0 commit comments

Comments
 (0)