Lumo

Lumo is a realtime lab software arount 3D models

why this name ?

Lumo is "Light" in Esperanto, its a short and pretty word to me :)

Goals :

• Implement all realtime rendering Algo used in Games / realtime Presentation softwares
• Mastering all theses tech for learning purposes
• Implement my own idea ( by ex related to SubSurface Scatering, or Shadows )
• Implement a modern use of 3D vulkan Api, and Node Graph related stuff
• Can Render mesh's or sdf's in the same way
• And finally can export rendering to picture, video, and maybe a self little portable binary form to be used everywhere
• Implement some specific VFX algo by plugigns like (compute based mesh sim, morphogenesis, sdf meshing)
• all these algos at max as possible in GPU only (include mesh generation)

at least, support all rendering features and result of the SketchFab Renderer (yes im loving it haha)

Gettings Started

• Create a new project (automatically saved when you quit the soft for the moment for easier dev)
• Click right in the graph and add nodes.
• Left mouse double click on a texture slot (Orange) of nodes for show the result in the 3d viewport
• Middle mouse double click on a texture slot (Orange) of nodes for show the result in the 2d viewport
• select a node and you can tune it in the tuning pane

thats all

How to build

Build dependencies

• Vulkan SDK 1.2 at least : latest and a compatible GPU
• Python 3.7 at least : latest

Succesfully Tested with Vulkan SDK 1.3.224.1

Cmake

You need to use cMake. You can use the gui (my prefered way). but, if you run cmake by command line, For the 3 Os (Win, Linux, MacOs), the cMake usage is exactly the same,

Choose a build directory. (called here my_build_directory for instance) and
Choose a Build Mode : "Release" / "MinSizeRel" / "RelWithDebInfo" / "Debug" (called here BuildMode for instance)
Run cMake in console : (the first for generate cmake build files, the second for build the binary)

cmake -B my_build_directory -DCMAKE_BUILD_TYPE=BuildMode cmake --build my_build_directory --config BuildMode

Some cMake version need Build mode define via the directive CMAKE_BUILD_TYPE or via --Config when we launch the build. This is why i put the boths possibilities

Platforms Support

all libs and code used here are cross platform, so compatible (win, linux).

The mac platform is not supported for the moment, due to the vulkan driver. Could be tested at some stage with the Molten-VK implementation..

Build Status Matrix

Target	Win (x64)	Linux (x64)	MacOs (x64)
Lumo			-
Plugin AudiArt			-
Plugin CodeGenerator			-
Plugin Landscape			-
Plugin Lighting			-
Plugin MeshGen			-
Plugin Misc			-
Plugin Particles			-
Plugin Planet System			-
Plugin Post Processing			-
Plugin Screen Space			-
Plugin Simulation			-
Plugin Smoke			-
Plugin RTX			-

Lumo Native Nodes :

Category	Name	status	Description
Assets/Loader	Cube Map		load a cube amp texture
Assets/Loader	Model		load a model
Assets/Loader	Texture 2D		Load a texture
Assets/Saver	Model Exporter		Export model to file. support sketchfab animations
Assets/Saver	Texture Exporter		Export texture to file
Assets/Misc	Grid		-
Assets/Misc	Scene Merger		Meerge many node in the same FBO target
Assets/Renderer	MatCap Renderer		Render a matcap on the model
Assets/Renderer	Model Renderer		-
Assets/Utils	Math		-
Assets/Utils	Mesh Attribute		extract mesh attribute (pos, nor, tan, btan, col, depth)
Assets/Widgets	Variable		-
Assets/Widgets	Color		-

Lumo Plugins :

AudiArt Plugin :

Description :

Audio Manipulation for Art

Status :

Published	Open Source	Free	status
✔️	✔️	✔️

Nodes:

Published	Node	status
✔️	Effects / FFT Node
✔️	Operations / Historize Node
✔️	Sources / Speacker Node
✔️	Viewers / Source Preview Node
✔️	Viewers / Visu Hex Grid Node
✔️	Windowing / Blackman FIlter Node

BluePrints Plugin :

Description :

Blue Print node system like in Unreal Engine for shaders

Status :

Published	Open Source	Free	status
❌	❌	❌

Nodes:

Published	Node	status

Code Generator Plugin :

Description :

This plugin not expose nodes, but a pane for easy node generation ready to compile. you can set inputs and outputs of one or many nodes. then with one operation, generate base cades for :

• node class
• module class
• pass class

Status :

Published	Open Source	Free	status
✔️	✔️	✔️

Landscape Plugin :

Description :

Landscape generation

Status :

Published	Open Source	Free	status
❌	✔️	✔️

Nodes:

Published	Node	status

Lighting Plugin :

Description :

Status :

Published	Open Source	Free	status
✔️	✔️	✔️

Nodes:

Published	Node	status
✔️	Breaks / Break Texture 2D Group Node
❌	Exporters / Export Texture Group to file Node
❌	Joins / Join Texture 2D Group Node
❌	Lighting / Fog Node
✔️	Lighting / Diffuse Node
✔️	Lighting / Light Group Node
✔️	Lighting / Refraction Node
✔️	Lighting / Reflection Node
✔️	Lighting / Model Shadow Node
❌	Lighting / RoughNess Node
✔️	Lighting / Shadow Mappings Node
✔️	Lighting / Specular Node
✔️	Lighting / Cell Shading Node
✔️	Preview / Cube Map Preview Node
✔️	Preview / LongLat Preview Node
✔️	Renderers / Deferred Renderer Node
✔️	Renderers / PBR Renderer Node
✔️	Renderers / Billboard Renderer Node
✔️	Utils / Depth Converter Node
✔️	Utils / Pos To Depth Node
❌	Utils / Cube Map to LongLat Node
❌	Utils / Cube Map To MatCap Node
❌	Utils / LongLat to Cube Map Node
❌	Utils / LongLat To MatCap Node
✔️	Utils / Flat Gradient Node

MeshGen Plugin :

Description :

Mesh generation

Status :

Published	Open Source	Free	status
✔️	✔️	✔️

Nodes:

Published	Node	status
✔️	Curve / Parametric Curve Node
✔️	Curve / Parametric Curve Differential Node
✔️	Mesh / Primitive Node
❌	Mesh Ops / Extrusion along path Node
✔️	Surface / Parametric UV Surface Node

MeshSim Plugin :

Description :

Simulation on mesh without texture or uv map

Status :

Published	Open Source	Free	status
❌	❌	✔️

Nodes:

Published	Node	status
❌	Lighting / Shadow Map Node
❌	Modifiers / Simulator Node
❌	Renderers / Renderer Node

MeshSSS Plugin :

Description :

My Mesh Sub Surface Scattering (SSS) Idea

Status :

Published	Open Source	Free	status
❌	❌	✔️

Nodes:

Published	Node	status

Misc Plugin :

Description :

Many misc nodes

Status :

Published	Open Source	Free	status
✔️	✔️	✔️

Nodes:

Published	Node	status
✔️	Misc / Layering Node
✔️	Misc / Sdf Texture Node
✔️	Modifiers / Smooth Normals Node
✔️	Tesselation / Alien Rock Node

MorphoGenesis Plugin :

Description :

Morphogenesis Nodes like on https://github.com/jasonwebb/morphogenesis-resources

Status :

Published	Open Source	Free	status
❌	❌	❌

Nodes:

Published	Node	status

Particles Plugin :

Description :

GPU particles nodes

Status :

Published	Open Source	Free	status
✔️	✔️	✔️

Nodes:

Published	Node	status
✔️	Emitters / Point Emitter Node
❌	Simulation / Simulation Node
❌	Constraints / Force Node

Planet System Plugin :

Description :

A generation of planet system, like in Universe Sandbox

Status :

Published	Open Source	Free	status
✔️	✔️	✔️

Nodes:

Published	Node	status
✔️	Planet Node

Post Processing Plugin :

Description :

Post Processing Effects

There is a summary nodes for all effects

Status :

Published	Open Source	Free	status
✔️	✔️	✔️

Nodes:

Published	Node	status
✔️	Postpro / Effects / Bloom Node
✔️	Postpro / Effects / Blur Node
✔️	Postpro / Effects / Chromatic Aberration Node
❌	Postpro / Effects / Color Corrector Node
❌	Postpro / Effects / Depth of Field Node
✔️	Postpro / Effects / Dilation Node
✔️	Postpro / Effects / Heat Map Node
❌	Postpro / Effects / Fog Node
❌	Postpro / Effects / Grain Node
❌	Postpro / Effects / LUT Node
❌	Postpro / Effects / Motion Blur Node
❌	Postpro / Effects / Outlining Node
❌	Postpro / Effects / Posteriztion Node
❌	Postpro / Effects / Pixelisation Node
✔️	Postpro / Effects / Sharpness Node
✔️	Postpro / Effects / Tone Mapping Node
✔️	Postpro / Effects / Vignette Node
✔️	Postpro / PostProcessing Node

Screen Space Plugin :

Description :

Many nodes of Simulation

Status :

Published	Open Source	Free	status
✔️	✔️	✔️

Nodes:

Published	Node	status
✔️	Postpro / Effects / Screen Space Ambient Occlusion Node (SSAO)
❌	Postpro / Effects / Screen Space Interior Node (SSI)
✔️	Postpro / Effects / Screen Space Reflection Node (SSRe)
❌	Postpro / Effects / Screen Space Refraction Node (SSRa)

Simulation Plugin :

Description :

Many nodes of Simulation

Status :

Published	Open Source	Free	status
✔️	✔️	✔️

Nodes:

Published	Node	status
✔️	Differential Operators / Curl Node
✔️	Differential Operators / Divergence Node
✔️	Differential Operators / Gradient Node
✔️	Differential Operators / Laplacian Node
✔️	Simulation / GrayScott Node
✔️	Simulation / Conway Node (Game of Life)

Smoke Plugin :

Description :

GPU Smoke nodes

Status :

Published	Open Source	Free	status
❌	✔️	✔️

Nodes:

Published	Node	status

RTX Plugin :

Description :

Ray Tracing Integration (RTX)

Status :

Published	Open Source	Free	status
✔️	✔️	✔️

Nodes:

Published	Node	status
✔️	Builders / Model to Accel Structure Node
✔️	Renderers / Model Shadow Node
✔️	Renderers / PBR Node
❌	Renderers / SSS Node

SdfEditor Plugin :

Description :

Sdf Editor like Magica CSG

Status :

Published	Open Source	Free	status
❌	❌	❌

Nodes:

Published	Node	status

SdfMesher Plugin :

Description :

Sdf to Mesh Generation

Status :

Published	Open Source	Free	status
❌	❌	❌

Nodes:

Published	Node	status

SoGLSL Plugin :

Description :

Scripting Over GLSL system for write shaders

Status :

Published	Open Source	Free	status
❌	❌	❌

Nodes:

Published	Node	status

UVDiffMap Plugin :

Description :

UV Mapper of high def Model based of Vertex Diffusion

Status :

Published	Open Source	Free	status
❌	❌	❌

Nodes:

Published	Node	status

VDBTools Plugin :

Description :

OpenVDB Nodes

Status :

Published	Open Source	Free	status
❌	✔️	✔️

Nodes:

Published	Node	status

Voxel Plugin :

Description :

Voxel Manipulation like Magicavoxel

Status :

Published	Open Source	Free	status
❌	✔️	✔️

Nodes:

Published	Node	status

VR Plugin :

Description :

Virtual Reality integration

Status :

Published	Open Source	Free	status
❌	✔️	✔️

Nodes:

Published	Node	status

ScreenShots

v0.3.802 (Vulkan 1.2) :

A bloom effect implemented whith nodes

v0.2.798 (Vulkan 1.0) :

My Shadow mapping (max 8 lights), diffuse, specular and SSAO

v0.2.32 (Vulkan 1.0) :

My MeshSim plugin, with a basic deferred renderrer, one light shadow + ssao

Libraries used by Lumo :

• Glslang (BSD-3)
• Glfw (Zlib)
• Tinyxml2 (Zlib)
• Efsw (MIT)
• Glm (GLM)
• Stb (MIT/Public)
• Dear ImGui (MIT)
• Freetype2 (Freetype)
• ImGuiColorTextEdit (MIT)
• LodePng (Zlib)
• VulkanHPP (Apache 2.0)
• ImGuiMarkDown (Zlib)
• AlphaNum (MIT) github mirror
• Cpp_Ipc (MIT)
• imgui_node_editor (MIT)
• ImGuizmo (MIT)
• assimp (ASSIMP)
• zlib (Zlib)
• taskflow (MIT)
• Tracy (BSD-3)
• glsl-tone-map (MIT)

And my libs :

• ctools (MIT)
• ImGuiFileDialog (MIT)
• BuildInc (MIT)