Sven Balzer
107 lines
6.2 KiB
C
107 lines
6.2 KiB
C
// THIS FILE HAS BEEN AUTO-GENERATED BY THE 'DEAR BINDINGS' GENERATOR.
|
|
// **DO NOT EDIT DIRECTLY**
|
|
// https://github.com/dearimgui/dear_bindings
|
|
|
|
// dear imgui: Renderer Backend for DirectX12
|
|
// Auto-generated forward declarations for C header
|
|
typedef struct ImGui_ImplDX12_InitInfo_t ImGui_ImplDX12_InitInfo;
|
|
typedef struct ImGui_ImplDX12_RenderState_t ImGui_ImplDX12_RenderState;
|
|
// ImDrawIdx: vertex index. [Compile-time configurable type]
|
|
// - To use 16-bit indices + allow large meshes: backend need to set 'io.BackendFlags |= ImGuiBackendFlags_RendererHasVtxOffset' and handle ImDrawCmd::VtxOffset (recommended).
|
|
// - To use 32-bit indices: override with '#define ImDrawIdx unsigned int' in your imconfig.h file.
|
|
#ifndef ImDrawIdx
|
|
typedef unsigned short ImDrawIdx; // Default: 16-bit (for maximum compatibility with renderer backends)
|
|
#endif // #ifndef ImDrawIdx
|
|
// This needs to be used along with a Platform Backend (e.g. Win32)
|
|
|
|
// Implemented features:
|
|
// [X] Renderer: User texture binding. Use 'D3D12_GPU_DESCRIPTOR_HANDLE' as texture identifier. Read the FAQ about ImTextureID/ImTextureRef!
|
|
// [X] Renderer: Large meshes support (64k+ vertices) even with 16-bit indices (ImGuiBackendFlags_RendererHasVtxOffset).
|
|
// [X] Renderer: Texture updates support for dynamic font atlas (ImGuiBackendFlags_RendererHasTextures).
|
|
// [X] Renderer: Expose selected render state for draw callbacks to use. Access in '(ImGui_ImplXXXX_RenderState*)GetPlatformIO().Renderer_RenderState'.
|
|
// [X] Renderer: Multi-viewport support (multiple windows). Enable with 'io.ConfigFlags |= ImGuiConfigFlags_ViewportsEnable'.
|
|
|
|
// The aim of imgui_impl_dx12.h/.cpp is to be usable in your engine without any modification.
|
|
// IF YOU FEEL YOU NEED TO MAKE ANY CHANGE TO THIS CODE, please share them and your feedback at https://github.com/ocornut/imgui/
|
|
|
|
// You can use unmodified imgui_impl_* files in your project. See examples/ folder for examples of using this.
|
|
// Prefer including the entire imgui/ repository into your project (either as a copy or as a submodule), and only build the backends you need.
|
|
// Learn about Dear ImGui:
|
|
// - FAQ https://dearimgui.com/faq
|
|
// - Getting Started https://dearimgui.com/getting-started
|
|
// - Documentation https://dearimgui.com/docs (same as your local docs/ folder).
|
|
// - Introduction, links and more at the top of imgui.cpp
|
|
|
|
#pragma once
|
|
|
|
#ifdef __cplusplus
|
|
extern "C"
|
|
{
|
|
#endif
|
|
#include "dcimgui.h"
|
|
#ifndef IMGUI_DISABLE
|
|
#include <dxgiformat.h>
|
|
#include <d3d12.h>
|
|
// Clang/GCC warnings with -Weverything
|
|
#if defined(__clang__)
|
|
#pragma clang diagnostic push
|
|
#pragma clang diagnostic ignored "-Wold-style-cast" // warning: use of old-style cast
|
|
#endif // #if defined(__clang__)
|
|
typedef struct ImGui_ImplDX12_InitInfo_ImDrawData_t ImGui_ImplDX12_InitInfo_ImDrawData;
|
|
// Initialization data, for ImGui_ImplDX12_Init()
|
|
struct ImGui_ImplDX12_InitInfo_t
|
|
{
|
|
ID3D12Device* Device;
|
|
ID3D12CommandQueue* CommandQueue; // Command queue used for queuing texture uploads.
|
|
int NumFramesInFlight;
|
|
DXGI_FORMAT RTVFormat; // RenderTarget format.
|
|
DXGI_FORMAT DSVFormat; // DepthStencilView format.
|
|
void* UserData;
|
|
|
|
// Allocating SRV descriptors for textures is up to the application, so we provide callbacks.
|
|
// (current version of the backend will only allocate one descriptor, from 1.92 the backend will need to allocate more)
|
|
ID3D12DescriptorHeap* SrvDescriptorHeap;
|
|
void (*SrvDescriptorAllocFn)(ImGui_ImplDX12_InitInfo* info, D3D12_CPU_DESCRIPTOR_HANDLE* out_cpu_desc_handle, D3D12_GPU_DESCRIPTOR_HANDLE* out_gpu_desc_handle);
|
|
void (*SrvDescriptorFreeFn)(ImGui_ImplDX12_InitInfo* info, D3D12_CPU_DESCRIPTOR_HANDLE cpu_desc_handle, D3D12_GPU_DESCRIPTOR_HANDLE gpu_desc_handle);
|
|
#ifndef IMGUI_DISABLE_OBSOLETE_FUNCTIONS
|
|
D3D12_CPU_DESCRIPTOR_HANDLE LegacySingleSrvCpuDescriptor; // To facilitate transition from single descriptor to allocator callback, you may use those.
|
|
D3D12_GPU_DESCRIPTOR_HANDLE LegacySingleSrvGpuDescriptor;
|
|
#endif // #ifndef IMGUI_DISABLE_OBSOLETE_FUNCTIONS
|
|
};
|
|
|
|
// Follow "Getting Started" link and check examples/ folder to learn about using backends!
|
|
CIMGUI_IMPL_API bool cImGui_ImplDX12_Init(ImGui_ImplDX12_InitInfo* info);
|
|
CIMGUI_IMPL_API void cImGui_ImplDX12_Shutdown(void);
|
|
CIMGUI_IMPL_API void cImGui_ImplDX12_NewFrame(void);
|
|
CIMGUI_IMPL_API void cImGui_ImplDX12_RenderDrawData(ImDrawData* draw_data, ID3D12GraphicsCommandList* graphics_command_list);
|
|
|
|
#ifndef IMGUI_DISABLE_OBSOLETE_FUNCTIONS
|
|
// Legacy initialization API Obsoleted in 1.91.5
|
|
// - 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'
|
|
// - When we introduced the ImGui_ImplDX12_InitInfo struct we also added a 'ID3D12CommandQueue* CommandQueue' field.
|
|
CIMGUI_IMPL_API bool cImGui_ImplDX12_InitID3D12DevicePtr(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);
|
|
#endif // #ifndef IMGUI_DISABLE_OBSOLETE_FUNCTIONS
|
|
// Use if you want to reset your rendering device without losing Dear ImGui state.
|
|
CIMGUI_IMPL_API bool cImGui_ImplDX12_CreateDeviceObjects(void);
|
|
CIMGUI_IMPL_API void cImGui_ImplDX12_InvalidateDeviceObjects(void);
|
|
|
|
// (Advanced) Use e.g. if you need to precisely control the timing of texture updates (e.g. for staged rendering), by setting ImDrawData::Textures = nullptr to handle this manually.
|
|
CIMGUI_IMPL_API void cImGui_ImplDX12_UpdateTexture(ImTextureData* tex);
|
|
|
|
// [BETA] Selected render state data shared with callbacks.
|
|
// This is temporarily stored in GetPlatformIO().Renderer_RenderState during the ImGui_ImplDX12_RenderDrawData() call.
|
|
// (Please open an issue if you feel you need access to more data)
|
|
struct ImGui_ImplDX12_RenderState_t
|
|
{
|
|
ID3D12Device* Device;
|
|
ID3D12GraphicsCommandList* CommandList;
|
|
};
|
|
|
|
#if defined(__clang__)
|
|
#pragma clang diagnostic pop
|
|
#endif // #if defined(__clang__)
|
|
#endif// #ifndef IMGUI_DISABLE
|
|
#ifdef __cplusplus
|
|
} // End of extern "C" block
|
|
#endif
|