xash3d-fwgs/ref_vk/TODO.md

# Next
- [ ] (RTX; common) Staging vs on-GPU buffers
- [ ] (RTX) BLAS construction on buffer unlock
- [ ] (RTX) ray trace compute shader
- [ ] (RTX) geometry indexing
- [ ] (RTX) textures

# Planned
- [ ] restore render debug labels
- [ ] make 2nd commad buffer for resource upload
- [ ] fix sprite blending; there are commented out functions that we really need (see tunnel before the helicopter in the very beginning)
- [ ] RTX: make projection matrix independent render global/current/static state
- [ ] fix projection matrix differences w/ gl render
- [ ] bad condition for temp vs map-permanent buffer error message
- [ ] draw more types of beams
- [ ] fix brush blending
- [ ] sprite depth offset
- [ ] fix incorrect viewport sprite culling
- [ ] improve g_camera handling; trace SetViewPass vs RenderScene ...
- [ ] loading to the same map breaks geometry
- [ ] studio model lighting
- [ ] move all consts to vk_const
- [ ] what is GL_Backend*/GL_RenderFrame ???
- [ ] particles
- [ ] decals
- [ ] issue: transparent brushes are too transparent (train ride)
- [ ] render skybox
- [ ] mipmaps
- [ ] lightmap dynamic styles
- [ ] flashlight
- [ ] screenshot
- [ ] fog
- [ ] RTX
- [ ] studio models survive NewMap; need to compactify buffers after removing all brushes
- [ ] sometimes it gets very slow (1fps) when ran under lldb (only on stream?)
- [ ] optimize perf: cmdbuf managements and semaphores, upload to gpu, ...
- [ ] RTX: studio models should not pre-transform vertices with modelView matrix

# Someday
- [ ] start building command buffers in beginframe
- [ ] multiple frames in flight (#nd cmdbuf, ...)
- [ ] cleanup unused stuff in vk_studio.c
- [ ] (helps with RTX?) unified rendering (brush/studio models/...), each model is instance, instance data is read from storage buffers, gives info about vertex format, texture bindings, etc; which are read from another set of storage buffers, ..
- [ ] waf shader build step -- get from upstream
- [ ] embed shaders into binary
- [ ] verify resources lifetime: make sure we don't leak and delete all textures, brushes, models, etc between maps
- [ ] custom allocator for vulkan
- [ ] stats
- [ ] better 2d renderer: fill DRAWQUAD(texture, color, ...) command into storage buffer instead of 4 vertices
- [ ] auto-atlas lots of smol textures: most of model texture are tiny (64x64 or less), can we not rebind them all the time? alt: bindless texture array
- [ ] can we also try to coalesce sprite draw calls?
- [ ] not visibly watertight map brushes
- [ ] collect render_draw_t w/o submitting them to cmdbuf, then sort by render_mode, trans depth, and other parameters, trying to batch as much stuff as possible; only then submit

# Previously

## 2021-02-06
- [x] alpha test
- [x] compare w/ gl R_SetRendeMode
	- [x] raster state
	- [x] color constants
- [x] culling
- [x] shaders s/map/brush/
- [x] pipeline cache
- [x] swapchain getting stale
- [x] HUD sprites
- [x] issue: lightmap sometimes gets corrupted on map load

## 2021-02-08
- [x] move entity rendering-enumeration into vk_scene

## 2021-02-10
- [x] refactor brush into brushes and separate rendering/buffer management
- [x] animated textures (accept PR)

## 2021-02-13
- [x] move pipelines from brush to render
- [x] render temp buffer api
- [x] draw studio models somehow
- [x] studio models vk debug markers
- [x] studio models white texture as lightmap
- [x] studio models fixes

## 2021-02-15
- [x] weapon models -- viewmodel
- [x] coalesce studio model draw calls
- [x] initual sprite support

## 2021-02-17
- [x] draw some beams

## 2021-02-20
- [x] refactor vk_render interface:
	- [x] move uniform_data_t to global render state ~inside render_draw_t, remove any mentions of uniform/slots from api; alt: global render state?~
	- [x] rename RenderDraw to SubmitDraw
	- [x] ~add debug label to render_draw_t?;~ alt: VK_RenderDebugNameBegin/End
	- [x] perform 3d rendering on corresponding refapi calls, not endframe
- [x] fix sprite blending

## 2021-02-22
- [x] RTX: load extensions with -rtx arg
- [x] vk_render: buffer-alloc-centric upload and draw api
improve blending; add alpha test Set blending modes according to existing GL renderer. Cull back faces. Implement alpha test. Add TODO.md file 2021-02-06 20:07:00 +01:00			`# Next`
separate buffer space allocation from buffer uploading Now each geometry is first allocated a slot with VK_RenderBufferAlloc, and then VK_RenderBufferLock/Unlock are used to upload buffer contents. This allow for two things: 1. Uploading buffer data to GPU memory on/after Unlock. 2. (Re)building BLAS for RTX on/after Unlock. These buffers are now directly referenced by render_draw_t, which also will be helpful in the future for both renderers. 2021-02-23 03:54:13 +01:00			`- [ ] (RTX; common) Staging vs on-GPU buffers`
			`- [ ] (RTX) BLAS construction on buffer unlock`
			`- [ ] (RTX) ray trace compute shader`
			`- [ ] (RTX) geometry indexing`
			`- [ ] (RTX) textures`
improve blending; add alpha test Set blending modes according to existing GL renderer. Cull back faces. Implement alpha test. Add TODO.md file 2021-02-06 20:07:00 +01:00
			`# Planned`
separate buffer space allocation from buffer uploading Now each geometry is first allocated a slot with VK_RenderBufferAlloc, and then VK_RenderBufferLock/Unlock are used to upload buffer contents. This allow for two things: 1. Uploading buffer data to GPU memory on/after Unlock. 2. (Re)building BLAS for RTX on/after Unlock. These buffers are now directly referenced by render_draw_t, which also will be helpful in the future for both renderers. 2021-02-23 03:54:13 +01:00			`- [ ] restore render debug labels`
engage scene rendering in VK_RenderFrame and not in EndFrame Rework a bit how matrices are computed. More global state dependencies ;_; Buffer-up draw commands, and only schedule them for drawing at EndFrame. 2021-02-20 23:54:57 +01:00			`- [ ] make 2nd commad buffer for resource upload`
			`- [ ] fix sprite blending; there are commented out functions that we really need (see tunnel before the helicopter in the very beginning)`
add VK_RenderDebugLabelBegin/End calls; fix studio model labeling 2021-02-20 21:35:04 +01:00			`- [ ] RTX: make projection matrix independent render global/current/static state`
remove ubo management from "public" vk_render api Now rendering submodules specify their colors and matrices using VK_RenderState global stat api. This is a trade-off between making all submodules track their state on their own, or managing that state centrally. 2021-02-20 21:00:31 +01:00			`- [ ] fix projection matrix differences w/ gl render`
			`- [ ] bad condition for temp vs map-permanent buffer error message`
add beams rendering not all beam types are supported yet also changes studio api init sequence, fixes missing cvars vertex type struct is no longer names as brush-specific uniform buffer allocation is now in vk_render blending issues still remain 2021-02-17 22:26:09 +01:00			`- [ ] draw more types of beams`
			`- [ ] fix brush blending`
			`- [ ] sprite depth offset`
			`- [ ] fix incorrect viewport sprite culling`
add initial sprite rendering alpha blending is broken animations are weird, but we do draw them nonetheless somehow 2021-02-15 21:20:25 +01:00			`- [ ] improve g_camera handling; trace SetViewPass vs RenderScene ...`
add view(weapon) models 2021-02-15 18:55:42 +01:00			`- [ ] loading to the same map breaks geometry`
			`- [ ] studio model lighting`
move entity enumeration from vk_brush to vk_scene 2021-02-08 19:57:27 +01:00			`- [ ] move all consts to vk_const`
draw HUD sprites 2021-02-06 22:13:08 +01:00			`- [ ] what is GL_Backend*/GL_RenderFrame ???`
			`- [ ] particles`
			`- [ ] decals`
			`- [ ] issue: transparent brushes are too transparent (train ride)`
improve blending; add alpha test Set blending modes according to existing GL renderer. Cull back faces. Implement alpha test. Add TODO.md file 2021-02-06 20:07:00 +01:00			`- [ ] render skybox`
			`- [ ] mipmaps`
rename map to brush 2021-02-06 20:38:08 +01:00			`- [ ] lightmap dynamic styles`
			`- [ ] flashlight`
draw HUD sprites 2021-02-06 22:13:08 +01:00			`- [ ] screenshot`
move buffer allocation to vk_render.c from vk_bruh.c 2021-02-10 19:33:44 +01:00			`- [ ] fog`
draw HUD sprites 2021-02-06 22:13:08 +01:00			`- [ ] RTX`
move buffer allocation to vk_render.c from vk_bruh.c 2021-02-10 19:33:44 +01:00			`- [ ] studio models survive NewMap; need to compactify buffers after removing all brushes`
add view(weapon) models 2021-02-15 18:55:42 +01:00			`- [ ] sometimes it gets very slow (1fps) when ran under lldb (only on stream?)`
add beams rendering not all beam types are supported yet also changes studio api init sequence, fixes missing cvars vertex type struct is no longer names as brush-specific uniform buffer allocation is now in vk_render blending issues still remain 2021-02-17 22:26:09 +01:00			`- [ ] optimize perf: cmdbuf managements and semaphores, upload to gpu, ...`
remove ubo management from "public" vk_render api Now rendering submodules specify their colors and matrices using VK_RenderState global stat api. This is a trade-off between making all submodules track their state on their own, or managing that state centrally. 2021-02-20 21:00:31 +01:00			`- [ ] RTX: studio models should not pre-transform vertices with modelView matrix`
improve blending; add alpha test Set blending modes according to existing GL renderer. Cull back faces. Implement alpha test. Add TODO.md file 2021-02-06 20:07:00 +01:00
			`# Someday`
engage scene rendering in VK_RenderFrame and not in EndFrame Rework a bit how matrices are computed. More global state dependencies ;_; Buffer-up draw commands, and only schedule them for drawing at EndFrame. 2021-02-20 23:54:57 +01:00			`- [ ] start building command buffers in beginframe`
			`- [ ] multiple frames in flight (#nd cmdbuf, ...)`
add initial sprite rendering alpha blending is broken animations are weird, but we do draw them nonetheless somehow 2021-02-15 21:20:25 +01:00			`- [ ] cleanup unused stuff in vk_studio.c`
move entity enumeration from vk_brush to vk_scene 2021-02-08 19:57:27 +01:00			`- [ ] (helps with RTX?) unified rendering (brush/studio models/...), each model is instance, instance data is read from storage buffers, gives info about vertex format, texture bindings, etc; which are read from another set of storage buffers, ..`
rename map to brush 2021-02-06 20:38:08 +01:00			`- [ ] waf shader build step -- get from upstream`
			`- [ ] embed shaders into binary`
draw HUD sprites 2021-02-06 22:13:08 +01:00			`- [ ] verify resources lifetime: make sure we don't leak and delete all textures, brushes, models, etc between maps`
			`- [ ] custom allocator for vulkan`
			`- [ ] stats`
			`- [ ] better 2d renderer: fill DRAWQUAD(texture, color, ...) command into storage buffer instead of 4 vertices`
add view(weapon) models 2021-02-15 18:55:42 +01:00			`- [ ] auto-atlas lots of smol textures: most of model texture are tiny (64x64 or less), can we not rebind them all the time? alt: bindless texture array`
add initial sprite rendering alpha blending is broken animations are weird, but we do draw them nonetheless somehow 2021-02-15 21:20:25 +01:00			`- [ ] can we also try to coalesce sprite draw calls?`
add beams rendering not all beam types are supported yet also changes studio api init sequence, fixes missing cvars vertex type struct is no longer names as brush-specific uniform buffer allocation is now in vk_render blending issues still remain 2021-02-17 22:26:09 +01:00			`- [ ] not visibly watertight map brushes`
add plan for stream 2021-02-20 08:07:45 +01:00			`- [ ] collect render_draw_t w/o submitting them to cmdbuf, then sort by render_mode, trans depth, and other parameters, trying to batch as much stuff as possible; only then submit`
add beams rendering not all beam types are supported yet also changes studio api init sequence, fixes missing cvars vertex type struct is no longer names as brush-specific uniform buffer allocation is now in vk_render blending issues still remain 2021-02-17 22:26:09 +01:00
separate buffer space allocation from buffer uploading Now each geometry is first allocated a slot with VK_RenderBufferAlloc, and then VK_RenderBufferLock/Unlock are used to upload buffer contents. This allow for two things: 1. Uploading buffer data to GPU memory on/after Unlock. 2. (Re)building BLAS for RTX on/after Unlock. These buffers are now directly referenced by render_draw_t, which also will be helpful in the future for both renderers. 2021-02-23 03:54:13 +01:00			`# Previously`
move entity enumeration from vk_brush to vk_scene 2021-02-08 19:57:27 +01:00
			`## 2021-02-06`
			`- [x] alpha test`
			`- [x] compare w/ gl R_SetRendeMode`
			`- [x] raster state`
			`- [x] color constants`
			`- [x] culling`
			`- [x] shaders s/map/brush/`
			`- [x] pipeline cache`
			`- [x] swapchain getting stale`
			`- [x] HUD sprites`
			`- [x] issue: lightmap sometimes gets corrupted on map load`
move buffer allocation to vk_render.c from vk_bruh.c 2021-02-10 19:33:44 +01:00
			`## 2021-02-08`
			`- [x] move entity rendering-enumeration into vk_scene`
add broken studio models drawing there are several issues with it: - there are holes in models - movement is jerky - no lighting applied 2021-02-14 02:19:59 +01:00
			`## 2021-02-10`
			`- [x] refactor brush into brushes and separate rendering/buffer management`
			`- [x] animated textures (accept PR)`

			`## 2021-02-13`
			`- [x] move pipelines from brush to render`
			`- [x] render temp buffer api`
			`- [x] draw studio models somehow`
			`- [x] studio models vk debug markers`
			`- [x] studio models white texture as lightmap`
add view(weapon) models 2021-02-15 18:55:42 +01:00			`- [x] studio models fixes`
add beams rendering not all beam types are supported yet also changes studio api init sequence, fixes missing cvars vertex type struct is no longer names as brush-specific uniform buffer allocation is now in vk_render blending issues still remain 2021-02-17 22:26:09 +01:00
			`## 2021-02-15`
			`- [x] weapon models -- viewmodel`
			`- [x] coalesce studio model draw calls`
			`- [x] initual sprite support`

			`## 2021-02-17`
			`- [x] draw some beams`

separate buffer space allocation from buffer uploading Now each geometry is first allocated a slot with VK_RenderBufferAlloc, and then VK_RenderBufferLock/Unlock are used to upload buffer contents. This allow for two things: 1. Uploading buffer data to GPU memory on/after Unlock. 2. (Re)building BLAS for RTX on/after Unlock. These buffers are now directly referenced by render_draw_t, which also will be helpful in the future for both renderers. 2021-02-23 03:54:13 +01:00			`## 2021-02-20`
			`- [x] refactor vk_render interface:`
			`- [x] move uniform_data_t to global render state ~inside render_draw_t, remove any mentions of uniform/slots from api; alt: global render state?~`
			`- [x] rename RenderDraw to SubmitDraw`
			`- [x] ~add debug label to render_draw_t?;~ alt: VK_RenderDebugNameBegin/End`
			`- [x] perform 3d rendering on corresponding refapi calls, not endframe`
			`- [x] fix sprite blending`

			`## 2021-02-22`
			`- [x] RTX: load extensions with -rtx arg`
			`- [x] vk_render: buffer-alloc-centric upload and draw api`