imgui_impl_dx11.h 2.3 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647
  1. // dear imgui: Renderer Backend for DirectX11
  2. // This needs to be used along with a Platform Backend (e.g. Win32)
  3. // Implemented features:
  4. // [X] Renderer: User texture binding. Use 'ID3D11ShaderResourceView*' as ImTextureID. Read the FAQ about ImTextureID!
  5. // [X] Renderer: Large meshes support (64k+ vertices) even with 16-bit indices (ImGuiBackendFlags_RendererHasVtxOffset).
  6. // [X] Renderer: Expose selected render state for draw callbacks to use. Access in '(ImGui_ImplXXXX_RenderState*)GetPlatformIO().Renderer_RenderState'.
  7. // You can use unmodified imgui_impl_* files in your project. See examples/ folder for examples of using this.
  8. // Prefer including the entire imgui/ repository into your project (either as a copy or as a submodule), and only build the backends you need.
  9. // Learn about Dear ImGui:
  10. // - FAQ https://dearimgui.com/faq
  11. // - Getting Started https://dearimgui.com/getting-started
  12. // - Documentation https://dearimgui.com/docs (same as your local docs/ folder).
  13. // - Introduction, links and more at the top of imgui.cpp
  14. #pragma once
  15. #include "imgui.h" // IMGUI_IMPL_API
  16. #ifndef IMGUI_DISABLE
  17. struct ID3D11Device;
  18. struct ID3D11DeviceContext;
  19. struct ID3D11SamplerState;
  20. struct ID3D11Buffer;
  21. // Follow "Getting Started" link and check examples/ folder to learn about using backends!
  22. IMGUI_IMPL_API bool ImGui_ImplDX11_Init(ID3D11Device* device, ID3D11DeviceContext* device_context);
  23. IMGUI_IMPL_API void ImGui_ImplDX11_Shutdown();
  24. IMGUI_IMPL_API void ImGui_ImplDX11_NewFrame();
  25. IMGUI_IMPL_API void ImGui_ImplDX11_RenderDrawData(ImDrawData* draw_data);
  26. // Use if you want to reset your rendering device without losing Dear ImGui state.
  27. IMGUI_IMPL_API bool ImGui_ImplDX11_CreateDeviceObjects();
  28. IMGUI_IMPL_API void ImGui_ImplDX11_InvalidateDeviceObjects();
  29. // [BETA] Selected render state data shared with callbacks.
  30. // This is temporarily stored in GetPlatformIO().Renderer_RenderState during the ImGui_ImplDX11_RenderDrawData() call.
  31. // (Please open an issue if you feel you need access to more data)
  32. struct ImGui_ImplDX11_RenderState
  33. {
  34. ID3D11Device* Device;
  35. ID3D11DeviceContext* DeviceContext;
  36. ID3D11SamplerState* SamplerDefault;
  37. ID3D11Buffer* VertexConstantBuffer;
  38. };
  39. #endif // #ifndef IMGUI_DISABLE