DiligentSamples

This module contains tutorials and sample applications intended to demonstrate the usage of Diligent Engine. The module depends on the Core, Tools, and FX submodules.

To build and run the applications in the module, please follow the instructions in the master repository.

Platform	Build Status
Windows
Universal Windows
Linux
Android
MacOS
iOS
tvOS
Emscripten

Tutorials

Tutorial 01 - Hello Triangle

This tutorial shows how to render simple triangle using Diligent Engine API.

Tutorial 02 - Cube

This tutorial demonstrates how to render an actual 3D object, a cube. It shows how to load shaders from files, create and use vertex, index and uniform buffers.

Tutorial 03 - Texturing

This tutorial demonstrates how to apply a texture to a 3D object. It shows how to load a texture from file, create shader resource binding object and how to sample a texture in the shader.

Tutorial 03 - Texturing-C

This tutorial is identical to Tutorial03, but is implemented using C API.

Tutorial 04 - Instancing

This tutorial demonstrates how to use instancing to render multiple copies of one object using unique transformation matrix for every copy.

Tutorial 05 - Texture Array

This tutorial demonstrates how to combine instancing with texture arrays to use unique texture for every instance.

Tutorial 06 - Multithreading

This tutorial shows how to generate command lists in parallel from multiple threads.

Tutorial 07 - Geometry Shader

This tutorial shows how to use geometry shader to render smooth wireframe.

Tutorial 08 - Tessellation

This tutorial shows how to use hardware tessellation to implement simple adaptive terrain rendering algorithm.

Tutorial 09 - Quads

This tutorial shows how to render multiple 2D quads, frequently switching textures and blend modes.

Tutorial 10 - Data Streaming

This tutorial shows dynamic buffer mapping strategy using MAP_FLAG_DISCARD and MAP_FLAG_DO_NOT_SYNCHRONIZE flags to efficiently stream varying amounts of data to GPU.

Tutorial 11 - Resource Updates

This tutorial demonstrates different ways to update buffers and textures in Diligent Engine and explains important internal details and performance implications related to each method.

Tutorial 12 - Render Target

This tutorial demonstrates how to render a 3d cube into an offscreen render target and do a simple post-processing effect.

Tutorial 13 - Shadow Map

This tutorial demonstrates how to render basic shadows using a shadow map.

Tutorial 14 - Compute Shader

This tutorial shows how to implement a simple particle simulation system using compute shaders.

Tutorial 15 - Multiple Windows

This tutorial demonstrates how to use Diligent Engine to render to multiple windows.

Tutorial 16 - Bindless Resources

This tutorial shows how to implement bindless resources, a technique that leverages dynamic shader resource indexing feature enabled by the next-gen APIs to significantly improve rendering performance.

Tutorial 17 - MSAA

This tutorial demonstrates how to use multisample anti-aliasing (MSAA) to make geometrical edges look smoother and more temporarily stable.

Tutorial 18 - Queries

This tutorial demonstrates how to use queries to retrieve various information about the GPU operation, such as the number of primitives rendered, command processing duration, etc.

Tutorial 19 - Render passes

This tutorial demonstrates how to use the render passes API to implement simple deferred shading.

Tutorial 20 - Mesh Shader

This tutorial demonstrates how to use amplification and mesh shaders, the new programmable stages, to implement view frustum culling and object LOD calculation on the GPU.

Tutorial 21 - Ray Tracing

This tutorial demonstrates the basics of using ray tracing API in Diligent Engine.

Tutorial 22 - Hybrid Rendering

This tutorial demonstrates how to implement a simple hybrid renderer that combines rasterization with ray tracing.

Tutorial 23 - Command Queues

This tutorial demonstrates how to use multiple command queues to perform rendering in parallel with copy and compute operations.

Tutorial 24 - Variable Rate Shading

This tutorial demonstrates how to use variable rate shading to reduce the pixel shading load.

Tutorial 25 - Render State Packager

This tutorial shows how to create and archive pipeline states with the render state packager off-line tool on the example of a simple path tracer.

Tutorial 26 - Render State Cache

This tutorial expands the path tracing technique implemented in previous tutorial and demonstrates how to use the render state cache to save pipeline states created at run time and load them when the application starts.

Samples

Atmospheric Light Scattering sample

This sample demonstrates how to integrate Epipolar Light Scattering post-processing effect into an application to render physically-based atmosphere.

GLFW Demo

This simple maze mini-game demonstrates how to use GLFW to create window and handle keyboard and mouse input.

GLTF Viewer

This sample demonstrates how to use the Asset Loader and GLTF PBR Renderer to load and render GLTF models.

Shadows

This sample demonstrates how to integrate the Shadowing component into an application to render high-quality shadows.

Dear ImGui Demo

This sample demonstrates the integration of the engine with dear imgui UI library.

Nuklear Demo

This sample demonstrates the integration of the engine with nuklear UI library.

Hello AR

This sample demonstrates how to use Diligent Engine in a basic Android AR application.

Asteroids

This sample is designed to be a performance benchmark and is based on this demo developed by Intel. It renders 50,000 unique textured asteroids. Every asteroid is a combination of one of 1000 unique meshes and one of 10 unique textures. The sample uses original D3D11 and D3D12 native implementations, and adds implementations using Diligent Engine API to allow comparing performance of different rendering modes.

Unity Plugin

This project demonstrates integration of Diligent Engine with Unity.

Build and Run Instructions

Please refer to Build and Run Instructions section in the master repository's readme.

Command line options:

--mode, -m {d3d11|d3d12|vk|gl} - select rendering back-end (example: --mode d3d12, -m vk).
--width, -w value - set desired window width (example: --width 1024, -w 1280).
--height, -h value - set desired window height (example: --height 768, -h 1024).
--capture_path path - path to the folder where screen captures will be saved. Specifying this parameter enables screen capture (example: --capture_path .).
--capture_name name - screen capture file name. Specifying this parameter enables screen capture (example: --capture_name frame).
--capture_fps fps - recording fps when capturing frame sequence (example: --capture_fps 10). Default value: 15.
--capture_frames value - number of frames to capture after the app starts (example: --capture_frames 50).
--capture_format {jpg|png} - image file format (example: --capture_format jpg). Default value: jpg.
--capture_quality value - jpeg quality (example: --capture_quality 80). Default value: 95.
--capture_alpha value - when saving png, whether to write alpha channel (example: --capture_alpha 1). Default value: false.
--validation value - set validation level (example: --validation 1). Default value: 1 in debug build; 0 in release builds.
--adapter value - select GPU adapter, if there are more than one installed on the system (example: --adapter 1). Default value: 0.
--adapters_dialog value - whether to show adapters dialog (example: --adapters_dialog 0). Default value: 1.
--show_ui value - whether to show user interface (example: --show_ui 0). Default value: 1.
--golden_image_mode {none|capture|compare|compare_update} - golden image capture mode. Default value: none.
--golden_image_tolerance value - golden image comparison tolerance. Default value: 0.
--non_separable_progs value - force non-separable programs in GL

When image capture is enabled the following hot keys are available:

F2 starts frame capture recording.
F3 finishes frame capture recroding.
F4 saves single screenshot.

To record multiple frames after the app starts, use command line like this:

--mode d3d12 --capture_path . --capture_fps 15 --capture_name frame --width 640 --height 480 --capture_format png --capture_frames 50

License

See Apache 2.0 license.

This project has some third-party dependencies, each of which may have independent licensing:

nuklear: A single-header ANSI C gui library (MIT or Public domain license).
glfw: A multi-platform library for OpenGL, OpenGL ES, Vulkan, window and input (zlib License).

Contributing

To contribute your code, submit a Pull Request to this repository. Diligent Engine is licensed under the Apache 2.0 license that guarantees that content in the DiligentSamples repository is free of Intellectual Property encumbrances. In submitting any content to this repository, you license that content under the same terms, and you agree that the content is free of any Intellectual Property claims and you have the right to license it under those terms.

Diligent Engine uses clang-format to ensure consistent source code style throughout the code base. The format is validated by CI for each commit and pull request, and the build will fail if any code formatting issue is found. Please refer to this page for instructions on how to set up clang-format and automatic code formatting.

diligentgraphics.com