summaryrefslogtreecommitdiffstats
path: root/Imgui/interface/ImGuiImplDiligent.hpp
blob: bb059a7e537566a60fcffbcaba61195dca774d78 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
/*
 *  Copyright 2019-2021 Diligent Graphics LLC
 *  Copyright 2015-2019 Egor Yusov
 *
 *  Licensed under the Apache License, Version 2.0 (the "License");
 *  you may not use this file except in compliance with the License.
 *  You may obtain a copy of the License at
 *
 *      http://www.apache.org/licenses/LICENSE-2.0
 *
 *  Unless required by applicable law or agreed to in writing, software
 *  distributed under the License is distributed on an "AS IS" BASIS,
 *  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 *  See the License for the specific language governing permissions and
 *  limitations under the License.
 *
 *  In no event and under no legal theory, whether in tort (including negligence),
 *  contract, or otherwise, unless required by applicable law (such as deliberate
 *  and grossly negligent acts) or agreed to in writing, shall any Contributor be
 *  liable for any damages, including any direct, indirect, special, incidental,
 *  or consequential damages of any character arising as a result of this License or
 *  out of the use or inability to use the software (including but not limited to damages
 *  for loss of goodwill, work stoppage, computer failure or malfunction, or any and
 *  all other commercial damages or losses), even if such Contributor has been advised
 *  of the possibility of such damages.
 */

#pragma once

#include <memory>
#include "../../../DiligentCore/Primitives/interface/BasicTypes.h"

namespace Diligent
{

struct IRenderDevice;
struct IDeviceContext;
enum TEXTURE_FORMAT : Uint16;
enum SURFACE_TRANSFORM : Uint32;

class ImGuiDiligentRenderer;

class ImGuiImplDiligent
{
public:
    static constexpr Uint32 DefaultInitialVBSize = 1024;
    static constexpr Uint32 DefaultInitialIBSize = 2048;

    ImGuiImplDiligent(IRenderDevice* pDevice,
                      TEXTURE_FORMAT BackBufferFmt,
                      TEXTURE_FORMAT DepthBufferFmt,
                      Uint32         InitialVertexBufferSize = DefaultInitialVBSize,
                      Uint32         InitialIndexBufferSize  = DefaultInitialIBSize);
    virtual ~ImGuiImplDiligent();

    // clang-format off
    ImGuiImplDiligent             (const ImGuiImplDiligent&)  = delete;
    ImGuiImplDiligent             (      ImGuiImplDiligent&&) = delete;
    ImGuiImplDiligent& operator = (const ImGuiImplDiligent&)  = delete;
    ImGuiImplDiligent& operator = (      ImGuiImplDiligent&&) = delete;
    // clang-format on


    /// Begins new frame

    /// \param [in] RenderSurfaceWidth  - Render surface width not accounting for pre-transform.
    ///                                   Most of the time this is the actual swap chain width.
    /// \param [in] RenderSurfaceHeight - Render surface height not accounting for pre-transform.
    ///                                   Most of the time this is the actual swap chain height.
    /// \param [in] SurfacePreTransform - Render surface pre-transform.
    ///                                   Most of the time this is the swap chain pre-transform.
    virtual void NewFrame(Uint32            RenderSurfaceWidth,
                          Uint32            RenderSurfaceHeight,
                          SURFACE_TRANSFORM SurfacePreTransform);

    virtual void EndFrame();
    virtual void Render(IDeviceContext* pCtx);

    // Use if you want to reset your rendering device without losing ImGui state.
    void InvalidateDeviceObjects();
    void CreateDeviceObjects();

    void UpdateFontsTexture();

private:
    std::unique_ptr<ImGuiDiligentRenderer> m_pRenderer;
};

} // namespace Diligent