{"id":13441403,"url":"https://github.com/tcoppex/sparkle","last_synced_at":"2025-04-04T20:10:01.349Z","repository":{"id":65817503,"uuid":"102747772","full_name":"tcoppex/sparkle","owner":"tcoppex","description":":sparkler: A particle engine running on the GPU, using c++14 and OpenGL 4.4.","archived":false,"fork":false,"pushed_at":"2025-01-24T14:46:47.000Z","size":948,"stargazers_count":195,"open_issues_count":1,"forks_count":12,"subscribers_count":11,"default_branch":"master","last_synced_at":"2025-03-28T19:07:41.578Z","etag":null,"topics":["compute-shader","cpp14","glsl","gpu","opengl","particle-engine","simulation"],"latest_commit_sha":null,"homepage":"","language":"C++","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/tcoppex.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2017-09-07T14:34:25.000Z","updated_at":"2025-02-03T13:59:03.000Z","dependencies_parsed_at":"2025-03-28T19:05:49.511Z","dependency_job_id":"0fb5ef45-c986-443a-83e0-7526312e00c0","html_url":"https://github.com/tcoppex/sparkle","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/tcoppex%2Fsparkle","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/tcoppex%2Fsparkle/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/tcoppex%2Fsparkle/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/tcoppex%2Fsparkle/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/tcoppex","download_url":"https://codeload.github.com/tcoppex/sparkle/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":247242678,"owners_count":20907134,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["compute-shader","cpp14","glsl","gpu","opengl","particle-engine","simulation"],"created_at":"2024-07-31T03:01:33.533Z","updated_at":"2025-04-04T20:10:01.332Z","avatar_url":"https://github.com/tcoppex.png","language":"C++","funding_links":[],"categories":["C++","Graphics"],"sub_categories":[],"readme":"\n# Spärkle\n[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)\n[![Build Status](https://travis-ci.org/tcoppex/sparkle.svg?branch=master)](https://travis-ci.org/tcoppex/sparkle)\n\n![screenshot](https://i.imgur.com/TPVEcoe.png)\n\nSpärkle is a particle engine running entirely on the GPU, inspired by the work of SquareEnix Advance Technology Division on *Agni's Philosophy*.\n\nIt is written in **C++ 14** and **OpenGL 4.4**.\n\n## Features\n\n- Complete Compute Shader based GPU pipeline,\n- Bitonic Sorting for alpha-blending,\n- Curl Noise,\n- 3D Vector Field,\n- *Structure of Arrays* and *Array of Structures* data layout patterns.\n\nFor more images, check the [gallery](https://imgur.com/a/uMMGV).\n\n## Quickstart\n\nWe will be using the command-line on Unix and [Git Bash](https://git-for-windows.github.io/) on Windows.\n\n### Dependencies\n\nThe following dependencies are pulled in as submodules.\n\n- [GLFW 3.2.1](https://github.com/glfw/glfw) as window manager,\n- [GLM 9.8](https://github.com/g-truc/glm/releases/tag/0.9.8.1) as mathematics library.\n- [imgui 1.6](https://github.com/ocornut/imgui) as user interface.\n\nTo retrieve them, type the following command line in the project directory :\n```bash\ngit submodule init\ngit submodule update\n```\n\n### Build\n\nWe will first create a build directory then generate the CMake cache depending on your system.\n\n```bash\nmkdir BUILDs \u0026\u0026 cd BUILDs\n```\n\nOn **Unix**, using Makefile (*replace `$NUM_CPU` by the number of core you want to use*) :\n```bash\ncmake .. -G Makefile -DCMAKE_BUILD_TYPE=Release\nmake -j$NUM_CPU\n```\n\nOn **Windows**, using MSVC 15 for x64:\n```bash\ncmake .. -G \"Visual Studio 15 2017 Win64\"\ncmake --build . --target ALL_BUILD --config Release\n```\n\n*Notes:*\n\n 1. *Using CMake, the build configuration type (ie. Debug, Release) is set at Build Time with MSVC and at Cache Generation Time with Makefile.*\n\n 2. *OpenGL extensions are generated automatically by a custom [Python](https://www.python.org/downloads/) script.  Alternatively [GLEW](http://glew.sourceforge.net/) can be used by specifying the option `-DUSE_GLEW=ON` to CMake. __If something does not compile due to OpenGL functions, try to use GLEW.__*\n\n### Run\n\nThe binary can be found in the project `./bin/` directory:\n```bash\n../bin/sparkle_demo\n```\n\n*Dev Note:*\n\n - *The development being done on GNU/Linux, it is primarly optimized for it. The MS Windows version is at this moment quite slow.* \n\n\n[//]: # (## Directory structure)\n[//]: # (## Known bugs)\n\n---\n\n## References\n\n- *Practical Applications of Compute for Simulation in Agni's Philosophy*, Napaporn Metaaphanon, [GPU Compute for Graphics, ACM SIGGRAPH ASIA 2014 Courses](http://www.jp.square-enix.com/tech/library/pdf/SiggraphAsia2014_simulation.pdf),\n- *Curl noise for procedural fluid flow*, R. Bridson, J. Hourihan, and M. Nordenstam, [Proc. ACM SIGGRAPH 2007](https://www.cs.ubc.ca/~rbridson/docs/bridson-siggraph2007-curlnoise.pdf),\n- *Noise-Based Particles*, Philip Rideout, [The Little Grasshoper](http://prideout.net/blog/?p=63),\n- *Implementing Improved Perlin Noise*, Simon Green, [GPU Gems 2](https://developer.nvidia.com/gpugems/GPUGems2/gpugems2_chapter26.html)\n\n## License\n\n*Spärkle* is released under the *MIT* license.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ftcoppex%2Fsparkle","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Ftcoppex%2Fsparkle","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ftcoppex%2Fsparkle/lists"}