Skip to content

Commit 8481203

Browse files
timfoxtimfox
committed
feat(vulkan): enhance Vulkan renderer with descriptor batch management and new shaders
- Added a new descriptor batch management system to optimize Vulkan resource updates, improving performance during rendering. - Introduced multiple new shaders, including enhanced ACES filmic tone mapping, volumetric clouds, and advanced cinematic color grading, enriching visual fidelity. - Implemented batch reset functionality for command buffers, enhancing efficiency in command buffer management. - Updated existing Vulkan files to integrate new features and improve overall rendering capabilities. - Enhanced documentation and comments to clarify the new systems and shader functionalities. This commit significantly advances the Vulkan renderer's performance and visual quality, contributing to a more robust rendering pipeline.
1 parent 2ebb8bd commit 8481203

96 files changed

Lines changed: 6518 additions & 11077 deletions

File tree

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

‎CMakeLists.txt‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1548,6 +1548,7 @@ SET(RENDERER_VK_SRCS
15481548
src/renderers/vulkan/vk_commands.c
15491549
src/renderers/vulkan/vk_resource_state.c
15501550
src/renderers/vulkan/vk_secondary_buffers.c
1551+
src/renderers/vulkan/vk_descriptor_batch.c
15511552
src/renderers/vulkan/vk_pipeline.c
15521553
src/renderers/vulkan/vk_shader_manager.cpp
15531554
src/renderers/vulkan/vk_shader_validation.c

‎docs/ANDROID_BUILD_STATUS.md‎

Lines changed: 123 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,123 @@
1+
# Android Build Status
2+
3+
## Summary
4+
5+
**Status**: ⚠️ **Cannot build APK - Java version incompatible**
6+
7+
The Android project is configured but cannot build an APK because:
8+
9+
### Current Issue:
10+
- **Java Version**: System has Java 8 (OpenJDK 1.8.0_472)
11+
- **Required**: Java 11+ (Android Gradle Plugin 7.4+ and 8.0+ require Java 11)
12+
- **Android SDK**: Not configured (ANDROID_HOME not set)
13+
14+
### What's Working:
15+
✅ Android project structure (`platform/android/`)
16+
✅ Gradle wrapper script (`gradlew`) - created and functional
17+
✅ Gradle wrapper JAR - downloaded successfully
18+
✅ Gradle 8.0 - downloads and runs correctly
19+
✅ Build configuration files (build.gradle, settings.gradle)
20+
✅ Java source files and native code structure
21+
22+
### What's Missing:
23+
❌ Java 11 or higher
24+
❌ Android SDK (ANDROID_HOME environment variable)
25+
❌ Android build tools
26+
27+
### To Build APK:
28+
29+
**Step 1: Install Java 11+**
30+
```bash
31+
sudo apt install openjdk-11-jdk
32+
# or
33+
sudo apt install openjdk-17-jdk
34+
```
35+
36+
**Step 2: Set JAVA_HOME**
37+
```bash
38+
export JAVA_HOME=/usr/lib/jvm/java-11-openjdk-amd64
39+
# or for Java 17:
40+
export JAVA_HOME=/usr/lib/jvm/java-17-openjdk-amd64
41+
```
42+
43+
**Step 3: Install Android SDK**
44+
```bash
45+
# Option A: Install via Android Studio
46+
# Download from https://developer.android.com/studio
47+
# Install and set:
48+
export ANDROID_HOME=$HOME/Android/Sdk
49+
export PATH=$PATH:$ANDROID_HOME/tools:$ANDROID_HOME/platform-tools
50+
51+
# Option B: Install command-line tools only
52+
mkdir -p $HOME/Android/Sdk
53+
cd $HOME/Android/Sdk
54+
wget https://dl.google.com/android/repository/commandlinetools-linux-9477386_latest.zip
55+
unzip commandlinetools-linux-9477386_latest.zip
56+
mkdir -p cmdline-tools/latest
57+
mv cmdline-tools/* cmdline-tools/latest/ 2>/dev/null || true
58+
export ANDROID_HOME=$HOME/Android/Sdk
59+
export PATH=$PATH:$ANDROID_HOME/cmdline-tools/latest/bin:$ANDROID_HOME/platform-tools
60+
61+
# Accept licenses and install SDK
62+
yes | sdkmanager --licenses
63+
sdkmanager "platform-tools" "platforms;android-33" "build-tools;33.0.0"
64+
```
65+
66+
**Step 4: Build APK**
67+
```bash
68+
cd platform/android
69+
export JAVA_HOME=/usr/lib/jvm/java-11-openjdk-amd64 # or java-17
70+
export ANDROID_HOME=$HOME/Android/Sdk
71+
./gradlew assembleDebug # Debug APK
72+
./gradlew assembleRelease # Release APK (requires signing)
73+
```
74+
75+
**Step 5: Find APK**
76+
```bash
77+
# Debug APK location:
78+
platform/android/app/build/outputs/apk/debug/app-debug.apk
79+
80+
# Release APK location:
81+
platform/android/app/build/outputs/apk/release/app-release.apk
82+
```
83+
84+
### Alternative: Use Android Studio
85+
1. Install Android Studio
86+
2. Open `platform/android/` directory
87+
3. Let Android Studio sync Gradle and download dependencies
88+
4. Build -> Build Bundle(s) / APK(s) -> Build APK(s)
89+
90+
### Project Structure:
91+
```
92+
platform/android/
93+
├── app/
94+
│ ├── build.gradle
95+
│ └── src/
96+
│ ├── main/
97+
│ │ ├── AndroidManifest.xml
98+
│ │ ├── java/com/idtech3/
99+
│ │ │ ├── MainActivity.java
100+
│ │ │ └── EngineSurfaceRenderer.java
101+
│ │ └── cpp/
102+
│ │ ├── CMakeLists.txt
103+
│ │ └── native-lib.cpp
104+
├── build.gradle
105+
├── settings.gradle
106+
├── gradlew (executable)
107+
└── gradle/wrapper/
108+
├── gradle-wrapper.jar
109+
└── gradle-wrapper.properties
110+
```
111+
112+
### Current Configuration:
113+
- **Gradle Version**: 8.0
114+
- **Android Gradle Plugin**: 7.4.2 (compatible with Java 11+)
115+
- **Compile SDK**: 33
116+
- **Min SDK**: 21
117+
- **Target SDK**: 33
118+
- **ABIs**: arm64-v8a, armeabi-v7a, x86_64
119+
120+
### Next Steps:
121+
1. Install Java 11 or 17
122+
2. Install Android SDK
123+
3. Run `./gradlew assembleDebug` to build APK

‎docs/DXR_VULKAN_PARITY.md‎

Lines changed: 201 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,201 @@
1+
# DirectX 12 DXR vs Vulkan RTX Feature Parity Analysis
2+
3+
## Executive Summary
4+
5+
**Current Status: DXR does NOT reach parity with Vulkan RTX**
6+
7+
The DirectX 12 DXR implementation is significantly behind the Vulkan RTX implementation. While basic ray tracing infrastructure exists, many advanced features are missing.
8+
9+
## Feature Comparison Matrix
10+
11+
| Feature | Vulkan RTX | DirectX 12 DXR | Status |
12+
|---------|------------|----------------|--------|
13+
| **Core Ray Tracing** |
14+
| Hardware ray tracing support | ✅ Full | ✅ Basic | ⚠️ Partial |
15+
| Acceleration structures (BLAS/TLAS) | ✅ Complete | 🔄 Framework only | ❌ Missing |
16+
| Shader binding table | ✅ Complete | ✅ Basic | ⚠️ Partial |
17+
| Ray generation shader | ✅ Complete | ✅ Basic | ⚠️ Partial |
18+
| Closest hit shader | ✅ Complete | ✅ Basic | ⚠️ Partial |
19+
| Miss shader | ✅ Complete | ✅ Basic | ⚠️ Partial |
20+
| **Advanced Features** |
21+
| ASVGF Denoising | ✅ Complete (CPU + GPU) | ❌ None | ❌ Missing |
22+
| Path Tracing | ✅ Complete | ❌ None | ❌ Missing |
23+
| Blue Noise Textures | ✅ Complete (128 layers) | ❌ None | ❌ Missing |
24+
| ReLAX Denoising | ✅ Complete | ❌ None | ❌ Missing |
25+
| Temporal Accumulation | ✅ Complete | ❌ None | ❌ Missing |
26+
| Gradient Reconstruction | ✅ Complete | ❌ None | ❌ Missing |
27+
| Atrous Filtering | ✅ Complete | ❌ None | ❌ Missing |
28+
| **Lighting** |
29+
| Cluster-based light culling | ✅ Complete | ❌ None | ❌ Missing |
30+
| Light visibility buffers | ✅ Complete | ❌ None | ❌ Missing |
31+
| Area light sampling | ✅ Complete | ❌ None | ❌ Missing |
32+
| **Integration** |
33+
| Denoiser integration | ✅ Complete | ❌ None | ❌ Missing |
34+
| Composite with raster | ✅ Complete | ❌ None | ❌ Missing |
35+
| G-buffer integration | ✅ Complete | ❌ None | ❌ Missing |
36+
| Motion vectors | ✅ Complete | ❌ None | ❌ Missing |
37+
| **Quality Settings** |
38+
| Quality presets | ✅ Complete | ❌ None | ❌ Missing |
39+
| Sample count control | ✅ Complete | ❌ None | ❌ Missing |
40+
| Bounce depth control | ✅ Complete | ❌ None | ❌ Missing |
41+
42+
## Detailed Analysis
43+
44+
### ✅ Implemented in Both
45+
46+
1. **Basic Ray Tracing Infrastructure**
47+
- DXR capability detection
48+
- Device interface acquisition
49+
- Command list interface
50+
- Basic shader compilation framework
51+
52+
### ⚠️ Partial Implementation (DXR)
53+
54+
1. **Acceleration Structures**
55+
- Vulkan: Full BLAS/TLAS building with geometry upload
56+
- DXR: Framework exists but geometry building not implemented
57+
- **Gap**: No actual geometry acceleration structure creation
58+
59+
2. **Ray Tracing Pipeline**
60+
- Vulkan: Complete pipeline with all shader stages
61+
- DXR: Basic shader compilation but pipeline state incomplete
62+
- **Gap**: Pipeline state object creation is placeholder
63+
64+
3. **Shader Binding Table**
65+
- Vulkan: Complete SBT with proper shader identifiers
66+
- DXR: Buffer created but not populated with shader identifiers
67+
- **Gap**: SBT not properly initialized
68+
69+
### ❌ Missing in DXR
70+
71+
1. **ASVGF Denoising System**
72+
- Vulkan has complete ASVGF implementation:
73+
- `vk_denoiser.cpp` - CPU-side denoising
74+
- `asvgf_grad.comp` - Gradient reconstruction shader
75+
- `asvgf_temporal.comp` - Temporal accumulation shader
76+
- `asvgf_atrous.comp` - Atrous filtering shader
77+
- DXR has: **Nothing**
78+
79+
2. **Path Tracing**
80+
- Vulkan has `vk_path_tracer.cpp` with:
81+
- Multiple bounces
82+
- Russian roulette
83+
- Sample accumulation
84+
- DXR has: **Nothing**
85+
86+
3. **Blue Noise Textures**
87+
- Vulkan loads 128-layer blue noise texture array
88+
- Used for better sampling patterns
89+
- DXR has: **Nothing**
90+
91+
4. **ReLAX Denoising**
92+
- Vulkan has `rt_relax.comp` compute shader
93+
- Advanced temporal-spatial denoising
94+
- DXR has: **Nothing**
95+
96+
5. **Light Sampling System**
97+
- Vulkan has `rt_light_sampling.glsl` with:
98+
- Cluster-based culling
99+
- Light visibility buffers
100+
- Area light sampling
101+
- DXR has: **Nothing**
102+
103+
6. **Integration Features**
104+
- Vulkan has complete integration:
105+
- `vk_rt_denoise()` - Denoising dispatch
106+
- `vk_rt_composite()` - Composite with raster
107+
- G-buffer integration
108+
- Motion vector support
109+
- DXR has: **Nothing**
110+
111+
## Code Evidence
112+
113+
### Vulkan RTX Features (Present)
114+
115+
```cpp
116+
// Denoising
117+
src/renderers/vulkan/rtx/vk_denoiser.cpp // ASVGF denoising
118+
src/renderers/vulkan/shaders/glsl/asvgf_grad.comp // Gradient shader
119+
src/renderers/vulkan/shaders/glsl/asvgf_temporal.comp // Temporal shader
120+
src/renderers/vulkan/shaders/glsl/asvgf_atrous.comp // Atrous shader
121+
122+
// Path Tracing
123+
src/renderers/vulkan/rtx/vk_path_tracer.cpp // Path tracer
124+
125+
// Blue Noise
126+
vk_rt_load_blue_noise_array() in vk_raytracing.cpp
127+
128+
// Light Sampling
129+
src/renderers/vulkan/shaders/glsl/rt_light_sampling.glsl
130+
131+
// Integration
132+
vk_rt_denoise(), vk_rt_composite() in vk_rtx_main.cpp
133+
```
134+
135+
### DirectX 12 DXR Features (Missing)
136+
137+
```cpp
138+
// Only basic infrastructure exists:
139+
src/renderers/d3d12/d3d12_raytracing.c // Basic framework only
140+
src/renderers/d3d12/shaders/rt_raygen.hlsl // Basic shader
141+
src/renderers/d3d12/shaders/rt_closesthit.hlsl // Basic shader
142+
src/renderers/d3d12/shaders/rt_miss.hlsl // Basic shader
143+
144+
// Missing:
145+
- No denoising implementation
146+
- No path tracing
147+
- No blue noise loading
148+
- No light sampling system
149+
- No integration with rendering pipeline
150+
```
151+
152+
## Recommendations
153+
154+
### Priority 1: Core Functionality
155+
1. **Complete Acceleration Structure Building**
156+
- Implement BLAS creation from geometry
157+
- Implement TLAS creation with instances
158+
- Add geometry upload and management
159+
160+
2. **Complete Ray Tracing Pipeline**
161+
- Finish pipeline state object creation
162+
- Populate shader binding table with identifiers
163+
- Integrate with rendering pipeline
164+
165+
### Priority 2: Advanced Features
166+
3. **ASVGF Denoising (HLSL Compute Shaders)**
167+
- Port `asvgf_grad.comp` → HLSL compute shader
168+
- Port `asvgf_temporal.comp` → HLSL compute shader
169+
- Port `asvgf_atrous.comp` → HLSL compute shader
170+
- Create D3D12 denoiser implementation
171+
172+
4. **Blue Noise Texture Loading**
173+
- Port `vk_rt_load_blue_noise_array()` to D3D12
174+
- Create 2D array texture in D3D12
175+
- Upload texture layers
176+
177+
5. **Path Tracing**
178+
- Port `vk_path_tracer.cpp` to D3D12
179+
- Add HLSL path tracing shaders
180+
181+
### Priority 3: Integration
182+
6. **Light Sampling System**
183+
- Port `rt_light_sampling.glsl` to HLSL
184+
- Implement cluster-based culling in D3D12
185+
186+
7. **Pipeline Integration**
187+
- Add denoising dispatch
188+
- Add composite pass
189+
- Integrate with G-buffer
190+
191+
## Conclusion
192+
193+
The DirectX 12 DXR implementation is approximately **20-30% complete** compared to Vulkan RTX. While the basic infrastructure exists, all advanced features (denoising, path tracing, blue noise, light sampling) are missing. To reach parity, significant development work is needed, particularly:
194+
195+
1. Complete the core ray tracing pipeline
196+
2. Port all denoising shaders to HLSL
197+
3. Implement blue noise texture loading
198+
4. Add path tracing support
199+
5. Integrate with the rendering pipeline
200+
201+
The q3rtx reference implementation is Vulkan-only, so DXR features would need to be ported from the existing Vulkan implementation.

0 commit comments

Comments
 (0)