| 1 |
// dear imgui: Renderer Backend for DirectX12 |
| 2 |
// This needs to be used along with a Platform Backend (e.g. Win32) |
| 3 |
|
| 4 |
// Implemented features: |
| 5 |
// [X] Renderer: User texture binding. Use 'D3D12_GPU_DESCRIPTOR_HANDLE' as ImTextureID. Read the FAQ about ImTextureID! |
| 6 |
// [X] Renderer: Large meshes support (64k+ vertices) even with 16-bit indices (ImGuiBackendFlags_RendererHasVtxOffset). |
| 7 |
// [X] Renderer: Expose selected render state for draw callbacks to use. Access in '(ImGui_ImplXXXX_RenderState*)GetPlatformIO().Renderer_RenderState'. |
| 8 |
|
| 9 |
// The aim of imgui_impl_dx12.h/.cpp is to be usable in your engine without any modification. |
| 10 |
// IF YOU FEEL YOU NEED TO MAKE ANY CHANGE TO THIS CODE, please share them and your feedback at https://github.com/ocornut/imgui/ |
| 11 |
|
| 12 |
// You can use unmodified imgui_impl_* files in your project. See examples/ folder for examples of using this. |
| 13 |
// Prefer including the entire imgui/ repository into your project (either as a copy or as a submodule), and only build the backends you need. |
| 14 |
// Learn about Dear ImGui: |
| 15 |
// - FAQ https://dearimgui.com/faq |
| 16 |
// - Getting Started https://dearimgui.com/getting-started |
| 17 |
// - Documentation https://dearimgui.com/docs (same as your local docs/ folder). |
| 18 |
// - Introduction, links and more at the top of imgui.cpp |
| 19 |
|
| 20 |
#pragma once |
| 21 |
#include "imgui.h" // IMGUI_IMPL_API |
| 22 |
#ifndef IMGUI_DISABLE |
| 23 |
#include <dxgiformat.h> // DXGI_FORMAT |
| 24 |
#include <d3d12.h> // D3D12_CPU_DESCRIPTOR_HANDLE |
| 25 |
|
| 26 |
// Initialization data, for ImGui_ImplDX12_Init() |
| 27 |
struct ImGui_ImplDX12_InitInfo |
| 28 |
{ |
| 29 |
ID3D12Device* Device; |
| 30 |
ID3D12CommandQueue* CommandQueue; |
| 31 |
int NumFramesInFlight; |
| 32 |
DXGI_FORMAT RTVFormat; // RenderTarget format. |
| 33 |
DXGI_FORMAT DSVFormat; // DepthStencilView format. |
| 34 |
void* UserData; |
| 35 |
|
| 36 |
// Allocating SRV descriptors for textures is up to the application, so we provide callbacks. |
| 37 |
// (current version of the backend will only allocate one descriptor, future versions will need to allocate more) |
| 38 |
ID3D12DescriptorHeap* SrvDescriptorHeap; |
| 39 |
void (*SrvDescriptorAllocFn)(ImGui_ImplDX12_InitInfo* info, D3D12_CPU_DESCRIPTOR_HANDLE* out_cpu_desc_handle, D3D12_GPU_DESCRIPTOR_HANDLE* out_gpu_desc_handle); |
| 40 |
void (*SrvDescriptorFreeFn)(ImGui_ImplDX12_InitInfo* info, D3D12_CPU_DESCRIPTOR_HANDLE cpu_desc_handle, D3D12_GPU_DESCRIPTOR_HANDLE gpu_desc_handle); |
| 41 |
#ifndef IMGUI_DISABLE_OBSOLETE_FUNCTIONS |
| 42 |
D3D12_CPU_DESCRIPTOR_HANDLE LegacySingleSrvCpuDescriptor; // To facilitate transition from single descriptor to allocator callback, you may use those. |
| 43 |
D3D12_GPU_DESCRIPTOR_HANDLE LegacySingleSrvGpuDescriptor; |
| 44 |
#endif |
| 45 |
|
| 46 |
ImGui_ImplDX12_InitInfo() { memset(this, 0, sizeof(*this)); } |
| 47 |
}; |
| 48 |
|
| 49 |
// Follow "Getting Started" link and check examples/ folder to learn about using backends! |
| 50 |
IMGUI_IMPL_API bool ImGui_ImplDX12_Init(ImGui_ImplDX12_InitInfo* info); |
| 51 |
IMGUI_IMPL_API void ImGui_ImplDX12_Shutdown(); |
| 52 |
IMGUI_IMPL_API void ImGui_ImplDX12_NewFrame(); |
| 53 |
IMGUI_IMPL_API void ImGui_ImplDX12_RenderDrawData(ImDrawData* draw_data, ID3D12GraphicsCommandList* graphics_command_list); |
| 54 |
|
| 55 |
#ifndef IMGUI_DISABLE_OBSOLETE_FUNCTIONS |
| 56 |
// Legacy initialization API Obsoleted in 1.91.5 |
| 57 |
// font_srv_cpu_desc_handle and font_srv_gpu_desc_handle are handles to a single SRV descriptor to use for the internal font texture, they must be in 'srv_descriptor_heap' |
| 58 |
IMGUI_IMPL_API bool ImGui_ImplDX12_Init(ID3D12Device* device, int num_frames_in_flight, DXGI_FORMAT rtv_format, ID3D12DescriptorHeap* srv_descriptor_heap, D3D12_CPU_DESCRIPTOR_HANDLE font_srv_cpu_desc_handle, D3D12_GPU_DESCRIPTOR_HANDLE font_srv_gpu_desc_handle); |
| 59 |
#endif |
| 60 |
|
| 61 |
// Use if you want to reset your rendering device without losing Dear ImGui state. |
| 62 |
IMGUI_IMPL_API bool ImGui_ImplDX12_CreateDeviceObjects(); |
| 63 |
IMGUI_IMPL_API void ImGui_ImplDX12_InvalidateDeviceObjects(); |
| 64 |
|
| 65 |
// [BETA] Selected render state data shared with callbacks. |
| 66 |
// This is temporarily stored in GetPlatformIO().Renderer_RenderState during the ImGui_ImplDX12_RenderDrawData() call. |
| 67 |
// (Please open an issue if you feel you need access to more data) |
| 68 |
struct ImGui_ImplDX12_RenderState |
| 69 |
{ |
| 70 |
ID3D12Device* Device; |
| 71 |
ID3D12GraphicsCommandList* CommandList; |
| 72 |
}; |
| 73 |
|
| 74 |
#endif // #ifndef IMGUI_DISABLE |