GPU-Reshape icon indicating copy to clipboard operation
GPU-Reshape copied to clipboard
verified publisher icon GPUOpen-Tools

Documentation effort

Open miguel-petersen opened this issue 2 years ago • 5 comments

Code is great, when people can understand it. So, let's make an effort to improve documentation.

The following list will be extended over time:

  • [ ] Instruction set exposed
  • [ ] Resource tokens / PRMT
  • [ ] PRMT descriptor data uploading
  • [ ] Shader program hosts
  • [ ] Shader data hosts
  • [ ] User command buffers / hooking
  • [ ] SVOX
  • [ ] Networking architecture (pretty important one)
  • [ ] SPIRV compilation passes (write-up)
  • [ ] DXIL compilation passes (write-up), many pages
  • [ ] Versioning system
  • [ ] Chunked messages
  • [ ] Export streaming (multiple buffers)
  • [ ] Shader instrumentation propagation / keys
  • [ ] Instrumentation strategy (block vistation, nested instrumentation, etc...)
  • [ ] Basic block instruction memory (not a simple thing)
  • [ ] Plugin setup (everything is written as a plugin really)
  • [ ] DX12 descriptor injection
  • [ ] DX12 bootstrapping
  • [ ] DX12 root register mapping
  • [ ] DX12 gpu address tracking
  • [ ] Vulkan SE descriptor set mapping and update-after-bind stuff
  • [ ] Vulkan / DX12 code generation
  • [ ] Patch command list
  • [ ] Vulkan PRMT heap emulation
  • [ ] Startup environments

Feel free to add as you see fit.

miguel-petersen avatar Jan 31 '23 00:01 miguel-petersen

@aurolou I am aware that documentation is an issue, please feel free to add as much as you see fit.

miguel-petersen avatar Jan 31 '23 00:01 miguel-petersen

I started to do some documentation on the documentation branch. Right now it's end-user focused and incomplete, but it's on my TODO list to finish.

aurolou avatar Feb 02 '23 11:02 aurolou

That's a great point.

miguel-petersen avatar Feb 03 '23 20:02 miguel-petersen

Documentation can list supported GPU vendors? Or is GPUReshape agnostic to that?

GPUOpen says:

To use GPU Reshape, if you are using an AMD GPU, please make sure you have the AMD Software: Adrenalin Edition™ application software drivers 23.10.2 or newer installed.

Despite the "if", it at least makes one wonder which other vendors are supported.

Ocasio-J avatar May 15 '24 03:05 Ocasio-J

Hi @Ocasio-J ,

GPU Reshape is agnostic to the vendor, as long as it supports either DX12 or Vulkan.

A little further down the product page it details the vendor support, though, I suppose that could be moved up to clarify things.

I'll bring it up on my end. Thanks!

miguel-petersen avatar May 15 '24 22:05 miguel-petersen