DXViewer

Overview

DXViewer is a DirectX 12 framework for physics simulation. This viewer makes it easy to visualize your simulation.

Usage

Use the contents in the DXViewer-x.x.x folder. The files in the example folder show how to use them.

int WINAPI WinMain(HINSTANCE hInstance, HINSTANCE prevInstance, PSTR cmdLine, int showCmd)
{
    // Simulation init
    AdhocSimulation* fluidsim = new AdhocSimulation();

    // DirectX init
    DX12App* dxapp = new DX12App();
    dxapp->setCameraProperties(
        PROJ::PERSPECTIVE, 
        2.0f, 0.0f, 0.0f);  // radius, theta, phi
    /*dxapp->setCameraProperties(
        PROJ::ORTHOGRAPHIC,
        0.0032f,               // orthogonal distance
        2.0f, 0.0f, 0.0f);  // radius, theta, phi     */
    dxapp->setBackgroundColor(DirectX::Colors::LightSlateGray);
    dxapp->setLightPosition(1.0f, 1.0f, 1.0f);

    // Window init
    Win32App winApp(500, 500);
    winApp.setWinName(L"Adhoc Simulation");
    winApp.setWinOffset(400, 200);
    winApp.initialize(hInstance, dxapp, fluidsim);

    return winApp.run();
}

ISimulation

ISimulation is an interface that makes your simulation class compatible with DXViewer. You should implement this interface using your simulation class. The following is the abstract methods that should be implemented. More details are described in ISimulation.h and example files.

Simulation methods

• void iUpdate()
• void iResetSimulationState(std::vector& constantBuffer)

Mesh methods

• std::vector& iGetVertices()
• std::vector& iGetIndices()
• UINT iGetVertexBufferSize()
• UINT iGetIndexBufferSize()
• DirectX::XMINT3 iGetObjectCount()
• DirectX::XMFLOAT3 iGetObjectSize()
• DirectX::XMFLOAT3 iGetObjectPositionOffset()

DirectX methods

• void iCreateObject(std::vector& constantBuffer)
• void iUpdateConstantBuffer(std::vector& constantBuffer, int i)
• void iDraw(Microsoft::WRL::ComPtr& mCommandList, int size, UINT indexCount, int i)
• void iSetDXApp(DX12App* dxApp)
• UINT iGetConstantBufferSize()
• bool iIsUpdated()

WndProc methods

• void iWMCreate(HWND hwnd, HINSTANCE hInstance)
• void iWMCommand(HWND hwnd, UINT msg, WPARAM wParam, LPARAM lParam, HINSTANCE hInstance)
• void iWMHScroll(HWND hwnd, WPARAM wParam, LPARAM lParam, HINSTANCE hInstance)
• void iWMTimer(HWND hwnd)
• void iWMDestory(HWND hwnd)

Build

This repo was developed in the following environment:

• Windows 10 64-bit
• Microsoft Visual Studio 2019 on x64 platform (C++14)
• CMake 3.19.0

There are already built files(.lib, .dll and .cso) in the DXViewer-x.x.x folder, so use them.

Application

GridLiquid2D

FLIPEngine3D

CrystalGrowth

PBDEnergyProjection

Reference

• Frank Luna. 2016. Introduction to 3D Game Programming with DirectX 12. Mercury Learning and Information.