├── genprj.bat ├── Screenshots └── Showcase.png ├── .gitmodules ├── LICENSE ├── premake5.lua ├── README.md └── .gitignore /genprj.bat: -------------------------------------------------------------------------------- 1 | "ThirdParty/bin/premake5.exe" vs2019 2 | pause -------------------------------------------------------------------------------- /Screenshots/Showcase.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/ZeXo-Softwares/zxShaderViz/HEAD/Screenshots/Showcase.png -------------------------------------------------------------------------------- /.gitmodules: -------------------------------------------------------------------------------- 1 | [submodule "build/ThirdParty/glm"] 2 | path = build/ThirdParty/glm 3 | url = https://www.github.com/g-truc/glm 4 | [submodule "build/ThirdParty/ImGui"] 5 | path = build/ThirdParty/ImGui 6 | url = https://github.com/Ciridev/imgui 7 | [submodule "build/ThirdParty/YAML"] 8 | path = build/ThirdParty/YAML 9 | url = https://github.com/Ciridev/Yaml-cpp 10 | [submodule "build/ThirdParty/GLFW"] 11 | path = build/ThirdParty/GLFW 12 | url = https://github.com/Ciridev/GLFW 13 | -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 1 | MIT License 2 | 3 | Copyright (c) 2021 ZeXo Entertainment 4 | 5 | Permission is hereby granted, free of charge, to any person obtaining a copy 6 | of this software and associated documentation files (the "Software"), to deal 7 | in the Software without restriction, including without limitation the rights 8 | to use, copy, modify, merge, publish, distribute, sublicense, and/or sell 9 | copies of the Software, and to permit persons to whom the Software is 10 | furnished to do so, subject to the following conditions: 11 | 12 | The above copyright notice and this permission notice shall be included in all 13 | copies or substantial portions of the Software. 14 | 15 | THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR 16 | IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, 17 | FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE 18 | AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER 19 | LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, 20 | OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE 21 | SOFTWARE. 22 | -------------------------------------------------------------------------------- /premake5.lua: -------------------------------------------------------------------------------- 1 | workspace "zxShaderViz" 2 | architecture "x64" 3 | configurations { "Debug", "Release" } 4 | startproject "zxShaderViz" 5 | 6 | outputdir = "%{cfg.buildcfg}-%{cfg.system}-%{cfg.architecture}" 7 | 8 | ExtLibs = {} 9 | ExtLibs["Glad"] = "build/ThirdParty/Glad/include" 10 | ExtLibs["GLFW"] = "build/ThirdParty/GLFW/include" 11 | ExtLibs["Yaml"] = "build/ThirdParty/YAML/include" 12 | ExtLibs["ImGui"] = "build/ThirdParty/ImGui" 13 | 14 | IncludeDirectories = {} 15 | IncludeDirectories["glm"] = "build/ThirdParty/glm" 16 | 17 | include "build/ThirdParty/Glad" 18 | include "build/ThirdParty/GLFW" 19 | include "build/ThirdParty/ImGui" 20 | include "build/ThirdParty/YAML" 21 | 22 | project "zxShaderViz" 23 | location "build" 24 | language "C++" 25 | cppdialect "C++17" 26 | 27 | targetdir ( "bin/".. outputdir .. "/%{prj.name}" ) 28 | objdir ( "bin/intermediates/" .. outputdir .. "/%{prj.name}" ) 29 | 30 | files 31 | { 32 | "build/src/**.cpp", 33 | "build/include/**.h", 34 | "%{IncludeDirectories.glm}/glm/**.hpp", 35 | } 36 | 37 | includedirs 38 | { 39 | "build/src", 40 | "build/include", 41 | "%{IncludeDirectories.glm}", 42 | "%{ExtLibs.Glad}", 43 | "%{ExtLibs.GLFW}", 44 | "%{ExtLibs.ImGui}", 45 | "%{ExtLibs.Yaml}" 46 | } 47 | 48 | links { "Glad", "GLFW", "ImGui", "Yaml-cpp", "opengl32.lib" } 49 | 50 | pchheader "zxpch.h" 51 | pchsource "build/src/zxpch.cpp" 52 | 53 | filter "system:windows" 54 | staticruntime "On" 55 | systemversion "latest" 56 | system "windows" 57 | 58 | defines { "ZX_WIN" } 59 | 60 | filter { "configurations:Debug" } 61 | defines { "DEBUG" } 62 | symbols "On" 63 | kind "ConsoleApp" 64 | 65 | filter { "configurations:Release" } 66 | defines { "ZX_RELEASE", "NDEBUG" } 67 | optimize "On" 68 | kind "WindowedApp" 69 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # zxShaderViz 2 | 3 | ![zxShaderViz Showcase](https://github.com/Ciridev/ShaderPlayground/blob/master/Screenshots/Showcase.png) 4 | 5 | ## About 6 | zxShaderViz is a useful tool made by our team, which aims to help learning about shader development. Currently zxShaderViz is still under development. However, we have released an Alpha Version to let you test the product and give us your precious feedback. Many features are yet to come, but the essential is in there. We will keep updating the software to implement all the ideas we have in mind. 7 | 8 | > I recently started learning OpenGL and Shader Development so I decided to code up a simple visualizer to help me learning. Then I created this software to help others as well, but also to prove myself and see how far I can go. 9 | 10 | @Ciridev 11 | 12 | ## Developers 13 | ### Active 14 | 15 | Developer | GitHub | Platform | Version 16 | ------------ | ------------ | ------------ | ------------ 17 | | Lorenzo Cirillo | [@Ciridev](https://www.github.com/Ciridev) | Windows | Alpha Release v1.0.0 | 18 | ### Coming Soon 19 | Developer| GitHub| Platform 20 | ------------ | ---------- | ------------ 21 | Giancamillo Alessandroni | [@NotManyIdeasDev](https://www.github.com/NotManyIdeasDev) | Windows 22 | ###### We are looking for developers! [Join us!](https://github.com/ZeXo-Entertainment/Join-Us) 23 | 24 | 25 | 26 | ## Getting Started 27 | ### Download the latest release... 28 | 29 | Platform | Release 30 | ------------ | ------------ 31 | Windows | [Download v1.0.1 Alpha](https://github.com/ZeXo-Entertainment/zxShaderViz/releases/tag/v1.0.1a) 32 | Windows | [Download v1.0.0 Alpha](https://github.com/ZeXo-Entertainment/zxShaderViz/releases/tag/v1.0.0a) 33 | Windows | [Source Code](https://github.com/ZeXo-Entertainment/zxShaderViz/releases/tag/v1.0.0a) 34 | 35 | 36 | ### ...or compile yourself the project! 37 | Using Visual Studio 2019 is recommended, you will need [Premake](https://premake.github.io/) to generate the solution files needed. 38 | 1. Start by cloning the repository with the following command: 39 | `git clone --recurive https://github.com/ZeXo-Entertainment/zxShaderViz`. 40 | Or if you cloned the repository non-recusively, you can use this command: 41 | `git submodule update --init` to add all the dependencies. 42 | 43 | 1. Since we are not storing Premake binaries inside our project, you will need to add them manually (This could change in the future). 44 | * Start by creating a directory called `"ThirdParty"` and another directory called `"bin"` and put the last created directory inside the first one. 45 | * Then copy the Premake binaries inside the `"bin"` folder. 46 | * Run the `"genprj.bat"` file. 47 | 48 | 3. Compile the project! 49 | 50 | **NOTE:** If you want to store the binaries in a different folder, make sure to **edit** the `"genprj.bat"` and match the `"premake5.exe"` file with the chosen path! 51 | 52 | **NOTE:** The Source Code release already contains every submodule and the Premake binaries, so you will simply have to execute the batch script to generate all the files you need. 53 | 54 | ### Dependencies 55 | Dependency | Website | GitHub | 56 | ------------ | ------------ | ------------ 57 | GLFW | [glfw.org](https://www.glfw.org) | [glfw/glfw](https://www.github.com/glfw/glfw) 58 | Glad | [glad.dav1d.de](https://glad.dav1d.de/) | [Dav1dde/glad](https://github.com/Dav1dde/glad) 59 | Dear ImGui | ------------ | [ocornut/imgui](https://www.github.com/ocornut/imgui) 60 | glm |[glm.g-truc.net](https://glm.g-truc.net/0.9.9/index.html) | [g-truc/glm](https://github.com/g-truc/glm) 61 | YAML|[yaml.org](https://yaml.org/)|[Yaml-cpp](https://github.com/jbeder/yaml-cpp/) 62 | 63 | ## Building and Platforms 64 | The project uses **[Premake](https://premake.github.io/)** to generate **Visual Studio Solution Files**. 65 | Currently **zxShaderViz** only supports **Windows** and does not run on different systems because several core functionalities have no Cross-Platform implementation. 66 | We have planned to **extend** this project to **Linux**, thus we will use CMake as our build system, but currently we have no date set. 67 | Unfortunately, **we will not** provide support for **MacOS** in the short term because we have no way of testing functionalities. If you are a **MacOS developer** and you want to help us with this project, **consider reaching up**. 68 | 69 | ## License 70 | Our software is distributed using the MIT License. 71 | 72 | ## Contributing 73 | Your help is precious! 74 | Currently zxShaderViz is in Alpha so it may contain bugs, code may be unefficient and more. So we highly recommend you to open an Issue or even open a Pull Request if you have a fix for a bug. If you want to share some ideas or discuss about anything related, feel free to open an Issue. 75 | 76 | **NOTE:** If you open a Pull Request, please respect our coding conventions, otherwise the code will result inconsistent and may be harder and messy to read. 77 | -------------------------------------------------------------------------------- /.gitignore: -------------------------------------------------------------------------------- 1 | ## Ignore Visual Studio temporary files, build results, and 2 | ## files generated by popular Visual Studio add-ons. 3 | ## 4 | ## Get latest from https://github.com/github/gitignore/blob/master/VisualStudio.gitignore 5 | 6 | # User-specific files 7 | *.rsuser 8 | *.suo 9 | *.user 10 | *.userosscache 11 | *.sln.docstates 12 | 13 | # User-specific files (MonoDevelop/Xamarin Studio) 14 | *.userprefs 15 | 16 | # Mono auto generated files 17 | mono_crash.* 18 | 19 | # Build results 20 | [Dd]ebug/ 21 | [Dd]ebugPublic/ 22 | [Rr]elease/ 23 | [Rr]eleases/ 24 | x64/ 25 | x86/ 26 | [Ww][Ii][Nn]32/ 27 | [Aa][Rr][Mm]/ 28 | [Aa][Rr][Mm]64/ 29 | bld/ 30 | [Bb]in/ 31 | [Oo]bj/ 32 | [Ll]og/ 33 | [Ll]ogs/ 34 | 35 | # Visual Studio 2015/2017 cache/options directory 36 | .vs/ 37 | # Uncomment if you have tasks that create the project's static files in wwwroot 38 | #wwwroot/ 39 | 40 | # Visual Studio 2017 auto generated files 41 | Generated\ Files/ 42 | 43 | # MSTest test Results 44 | [Tt]est[Rr]esult*/ 45 | [Bb]uild[Ll]og.* 46 | 47 | # NUnit 48 | *.VisualState.xml 49 | TestResult.xml 50 | nunit-*.xml 51 | 52 | # Build Results of an ATL Project 53 | [Dd]ebugPS/ 54 | [Rr]eleasePS/ 55 | dlldata.c 56 | 57 | # Benchmark Results 58 | BenchmarkDotNet.Artifacts/ 59 | 60 | # .NET Core 61 | project.lock.json 62 | project.fragment.lock.json 63 | artifacts/ 64 | 65 | # ASP.NET Scaffolding 66 | ScaffoldingReadMe.txt 67 | 68 | # StyleCop 69 | StyleCopReport.xml 70 | 71 | # Files built by Visual Studio 72 | *_i.c 73 | *_p.c 74 | *_h.h 75 | *.ilk 76 | *.meta 77 | *.obj 78 | *.iobj 79 | *.pch 80 | *.pdb 81 | *.ipdb 82 | *.pgc 83 | *.pgd 84 | *.rsp 85 | *.sbr 86 | *.tlb 87 | *.tli 88 | *.tlh 89 | *.tmp 90 | *.tmp_proj 91 | *_wpftmp.csproj 92 | *.log 93 | *.tlog 94 | *.vspscc 95 | *.vssscc 96 | .builds 97 | *.pidb 98 | *.svclog 99 | *.scc 100 | 101 | # Chutzpah Test files 102 | _Chutzpah* 103 | 104 | # Visual C++ cache files 105 | ipch/ 106 | *.aps 107 | *.ncb 108 | *.opendb 109 | *.opensdf 110 | *.sdf 111 | *.cachefile 112 | *.VC.db 113 | *.VC.VC.opendb 114 | 115 | # Visual Studio profiler 116 | *.psess 117 | *.vsp 118 | *.vspx 119 | *.sap 120 | 121 | # Visual Studio Trace Files 122 | *.e2e 123 | 124 | # TFS 2012 Local Workspace 125 | $tf/ 126 | 127 | # Guidance Automation Toolkit 128 | *.gpState 129 | 130 | # ReSharper is a .NET coding add-in 131 | _ReSharper*/ 132 | *.[Rr]e[Ss]harper 133 | *.DotSettings.user 134 | 135 | # TeamCity is a build add-in 136 | _TeamCity* 137 | 138 | # DotCover is a Code Coverage Tool 139 | *.dotCover 140 | 141 | # AxoCover is a Code Coverage Tool 142 | .axoCover/* 143 | !.axoCover/settings.json 144 | 145 | # Coverlet is a free, cross platform Code Coverage Tool 146 | coverage*.json 147 | coverage*.xml 148 | coverage*.info 149 | 150 | # Visual Studio code coverage results 151 | *.coverage 152 | *.coveragexml 153 | 154 | # NCrunch 155 | _NCrunch_* 156 | .*crunch*.local.xml 157 | nCrunchTemp_* 158 | 159 | # MightyMoose 160 | *.mm.* 161 | AutoTest.Net/ 162 | 163 | # Web workbench (sass) 164 | .sass-cache/ 165 | 166 | # Installshield output folder 167 | [Ee]xpress/ 168 | 169 | # DocProject is a documentation generator add-in 170 | DocProject/buildhelp/ 171 | DocProject/Help/*.HxT 172 | DocProject/Help/*.HxC 173 | DocProject/Help/*.hhc 174 | DocProject/Help/*.hhk 175 | DocProject/Help/*.hhp 176 | DocProject/Help/Html2 177 | DocProject/Help/html 178 | 179 | # Click-Once directory 180 | publish/ 181 | 182 | # Publish Web Output 183 | *.[Pp]ublish.xml 184 | *.azurePubxml 185 | # Note: Comment the next line if you want to checkin your web deploy settings, 186 | # but database connection strings (with potential passwords) will be unencrypted 187 | *.pubxml 188 | *.publishproj 189 | 190 | # Microsoft Azure Web App publish settings. Comment the next line if you want to 191 | # checkin your Azure Web App publish settings, but sensitive information contained 192 | # in these scripts will be unencrypted 193 | PublishScripts/ 194 | 195 | # NuGet Packages 196 | *.nupkg 197 | # NuGet Symbol Packages 198 | *.snupkg 199 | # The packages folder can be ignored because of Package Restore 200 | **/[Pp]ackages/* 201 | # except build/, which is used as an MSBuild target. 202 | !**/[Pp]ackages/build/ 203 | # Uncomment if necessary however generally it will be regenerated when needed 204 | #!**/[Pp]ackages/repositories.config 205 | # NuGet v3's project.json files produces more ignorable files 206 | *.nuget.props 207 | *.nuget.targets 208 | 209 | # Nuget personal access tokens and Credentials 210 | nuget.config 211 | 212 | # Microsoft Azure Build Output 213 | csx/ 214 | *.build.csdef 215 | 216 | # Microsoft Azure Emulator 217 | ecf/ 218 | rcf/ 219 | 220 | # Windows Store app package directories and files 221 | AppPackages/ 222 | BundleArtifacts/ 223 | Package.StoreAssociation.xml 224 | _pkginfo.txt 225 | *.appx 226 | *.appxbundle 227 | *.appxupload 228 | 229 | # Visual Studio cache files 230 | # files ending in .cache can be ignored 231 | *.[Cc]ache 232 | # but keep track of directories ending in .cache 233 | !?*.[Cc]ache/ 234 | 235 | # Others 236 | ClientBin/ 237 | ~$* 238 | *~ 239 | *.dbmdl 240 | *.dbproj.schemaview 241 | *.jfm 242 | *.pfx 243 | *.publishsettings 244 | orleans.codegen.cs 245 | 246 | # Including strong name files can present a security risk 247 | # (https://github.com/github/gitignore/pull/2483#issue-259490424) 248 | #*.snk 249 | 250 | # Since there are multiple workflows, uncomment next line to ignore bower_components 251 | # (https://github.com/github/gitignore/pull/1529#issuecomment-104372622) 252 | #bower_components/ 253 | 254 | # RIA/Silverlight projects 255 | Generated_Code/ 256 | 257 | # Backup & report files from converting an old project file 258 | # to a newer Visual Studio version. Backup files are not needed, 259 | # because we have git ;-) 260 | _UpgradeReport_Files/ 261 | Backup*/ 262 | UpgradeLog*.XML 263 | UpgradeLog*.htm 264 | ServiceFabricBackup/ 265 | *.rptproj.bak 266 | 267 | # SQL Server files 268 | *.mdf 269 | *.ldf 270 | *.ndf 271 | 272 | # Business Intelligence projects 273 | *.rdl.data 274 | *.bim.layout 275 | *.bim_*.settings 276 | *.rptproj.rsuser 277 | *- [Bb]ackup.rdl 278 | *- [Bb]ackup ([0-9]).rdl 279 | *- [Bb]ackup ([0-9][0-9]).rdl 280 | 281 | # Microsoft Fakes 282 | FakesAssemblies/ 283 | 284 | # GhostDoc plugin setting file 285 | *.GhostDoc.xml 286 | 287 | # Node.js Tools for Visual Studio 288 | .ntvs_analysis.dat 289 | node_modules/ 290 | 291 | # Visual Studio 6 build log 292 | *.plg 293 | 294 | # Visual Studio 6 workspace options file 295 | *.opt 296 | 297 | # Visual Studio 6 auto-generated workspace file (contains which files were open etc.) 298 | *.vbw 299 | 300 | # Visual Studio LightSwitch build output 301 | **/*.HTMLClient/GeneratedArtifacts 302 | **/*.DesktopClient/GeneratedArtifacts 303 | **/*.DesktopClient/ModelManifest.xml 304 | **/*.Server/GeneratedArtifacts 305 | **/*.Server/ModelManifest.xml 306 | _Pvt_Extensions 307 | 308 | # Paket dependency manager 309 | .paket/paket.exe 310 | paket-files/ 311 | 312 | # FAKE - F# Make 313 | .fake/ 314 | 315 | # CodeRush personal settings 316 | .cr/personal 317 | 318 | # Python Tools for Visual Studio (PTVS) 319 | __pycache__/ 320 | *.pyc 321 | 322 | # Cake - Uncomment if you are using it 323 | # tools/** 324 | # !tools/packages.config 325 | 326 | # Tabs Studio 327 | *.tss 328 | 329 | # Telerik's JustMock configuration file 330 | *.jmconfig 331 | 332 | # BizTalk build output 333 | *.btp.cs 334 | *.btm.cs 335 | *.odx.cs 336 | *.xsd.cs 337 | 338 | # OpenCover UI analysis results 339 | OpenCover/ 340 | 341 | # Azure Stream Analytics local run output 342 | ASALocalRun/ 343 | 344 | # MSBuild Binary and Structured Log 345 | *.binlog 346 | 347 | # NVidia Nsight GPU debugger configuration file 348 | *.nvuser 349 | 350 | # MFractors (Xamarin productivity tool) working folder 351 | .mfractor/ 352 | 353 | # Local History for Visual Studio 354 | .localhistory/ 355 | 356 | # BeatPulse healthcheck temp database 357 | healthchecksdb 358 | 359 | # Backup folder for Package Reference Convert tool in Visual Studio 2017 360 | MigrationBackup/ 361 | 362 | # Ionide (cross platform F# VS Code tools) working folder 363 | .ionide/ 364 | 365 | # Fody - auto-generated XML schema 366 | FodyWeavers.xsd 367 | 368 | # VS Code files for those working on multiple tools 369 | .vscode/* 370 | !.vscode/settings.json 371 | !.vscode/tasks.json 372 | !.vscode/launch.json 373 | !.vscode/extensions.json 374 | *.code-workspace 375 | 376 | # Local History for Visual Studio Code 377 | .history/ 378 | 379 | # Windows Installer files from build outputs 380 | *.cab 381 | *.msi 382 | *.msix 383 | *.msm 384 | *.msp 385 | 386 | # JetBrains Rider 387 | .idea/ 388 | *.sln.iml 389 | 390 | # other 391 | [Tt][Oo][Dd][Oo]/ 392 | build/assets/shader/ 393 | *.one 394 | *.frag 395 | *.glsl 396 | *.zxshad 397 | *.frag#version 398 | *.sln 399 | *.vcxproj 400 | *.vcxproj.filters 401 | *.vcxproj.user --------------------------------------------------------------------------------