{"id":19556715,"url":"https://github.com/webmobi59/videngine","last_synced_at":"2026-06-10T02:31:37.503Z","repository":{"id":130342529,"uuid":"193971828","full_name":"WebMobi59/VidEngine","owner":"WebMobi59","description":"AR Metal iOS graphics engine - Swift","archived":false,"fork":false,"pushed_at":"2019-09-23T09:28:30.000Z","size":1465,"stargazers_count":1,"open_issues_count":0,"forks_count":0,"subscribers_count":0,"default_branch":"master","last_synced_at":"2025-11-20T02:31:02.477Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"","language":"Swift","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/WebMobi59.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"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":"2019-06-26T20:17:24.000Z","updated_at":"2020-06-07T10:00:41.000Z","dependencies_parsed_at":"2023-03-24T05:03:23.596Z","dependency_job_id":null,"html_url":"https://github.com/WebMobi59/VidEngine","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/WebMobi59/VidEngine","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/WebMobi59%2FVidEngine","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/WebMobi59%2FVidEngine/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/WebMobi59%2FVidEngine/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/WebMobi59%2FVidEngine/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/WebMobi59","download_url":"https://codeload.github.com/WebMobi59/VidEngine/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/WebMobi59%2FVidEngine/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":34134633,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-05-26T15:22:16.424Z","status":"online","status_checked_at":"2026-06-10T02:00:07.152Z","response_time":89,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"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":[],"created_at":"2024-11-11T04:38:58.030Z","updated_at":"2026-06-10T02:31:37.483Z","avatar_url":"https://github.com/WebMobi59.png","language":"Swift","funding_links":[],"categories":[],"sub_categories":[],"readme":"Vid Engine\n=========\nGraphics engine written in Metal \u0026 Swift.\n\nIt's an endless work-in-progress that I use in my spare to test things. It should be usable to do basic stuff, but note that there are no plans for OpenGL ES support, and thus, both older devices and the simulators are not supported. You will need a Metal-compatible iOS device to build and run it.\n\nInstallation\n=========\nSimply add this repository as a submodule in your repository,\n\n    git submodule add git@github.com:webmobi59/VidEngine.git VidEngine\n\nThen,\n\n* Create a Workspace in Xcode\n* Add your project to the workspace\n    - An easy way to start is to create a Single View App from the iOS templates (File → New → Project).\n    - Under Target → Build Phases, add **MetalKit.framework** to `Link binary with libraries` section.\n    - Open `Main.storyboard`, select the `View`, and select `MTKView` class in the Identity inspector.\n* Add **VidFramework** project to the workspace: Add Files → select `xcodeproj` file.\n    - If you want to check the shaders, also add **VidMetalLib** to your workspace. But note that at the moment, you need to build the shader libraries from the console (see *Build* section).\n    - I would also add a sample app to your workspace. For instance, if you want to create an AR app, add **SampleAR** to your workspace.\n* Select your project in Xcode, and in Target → General → Embedded Binaries, select VidFramework (it should appear if it's in your workspace). This should also add it to Linked Framework \u0026 Libraries. But if it doesn't, add it there as well. Also make sure it did add an entry in Build Phases → Embed Frameworks.\n\nBuild\n====\nUse the provided `build.sh`, because I can't figure out how to get the shaders in **VidMetalLib** to get linked to the correct location from Xcode... 😅\n\nApp Configuration\n==============\n\n### Info.plist\n\nThis engine is Metal-only, so that needs to be specified as a requirement in your Info.plist. If you are going to use AR, you will also need to include `arkit` to the list. Your `Info.plist` should have this section,\n\n```\n\u003ckey\u003eUIRequiredDeviceCapabilities\u003c/key\u003e\n\u003carray\u003e\n\u003cstring\u003earmv7\u003c/string\u003e\n\u003cstring\u003emetal\u003c/string\u003e\n\u003cstring\u003earkit\u003c/string\u003e\n\u003c/array\u003e\n```\n\nOverview\n=======\n\n### 3D rendering\n\nVid Engine uses a right-handed coordinate system, with `Y` being the vertical direction. The camera looks to `-Z` by default. That means that `+Z` points towards the screen, and `+X` towards the right side of the screen. Units are given in meters by default. Therefore, both coordinate system and units match ARKit, so working with AR scene should be straightforward.\n\nSamples\n=======\nOpen the VidWorkspace and you should see several samples.\n\n## SampleAR\n\nARKit sample app using the VidEngine.\n\n[![SampleAR app](http://img.youtube.com/vi/-6M8qgVsx54/0.jpg)](https://www.youtube.com/watch?v=-6M8qgVsx54 \"SampleAR app\")\n\nDetails in these posts:\n* [Spherical Harmonics Lighting from ARKit Environment Probes](http://endavid.com/index.php?entry=85)\n* [How to combine Render Command Encoders that use a different shader in Metal](https://stackoverflow.com/q/55442494/1765629)\n\n\n## SampleColorPalette\n\nExample of using display-P3 color space, and Self-Organizing Maps (a type of neural network).\n\nRead these blog posts:\n* [Display P3 vs sRGB in Color Palettes](http://endavid.com/index.php?entry=80)\n* [Exploring the display-P3 color space](http://endavid.com/index.php?entry=79)\n\nAlso, this sample has been expanded into a full app: [Palettist](http://palettist.endavid.com)\n\n## SampleCornellBox\n\nThis is just the typical cornell box scene (WIP)\n\n## SampleRain\n\nVery simple procedural 2D rain. All the updates happen in the GPU with a compute shader.\nYou can read about it in this blog post: [Metal: a Swift Introduction](http://tech.metail.com/metal-swift-introduction/)\n\n[![Procedural 2D rain](http://img.youtube.com/vi/7qWMA4ow2jc/0.jpg)](https://www.youtube.com/watch?v=7qWMA4ow2jc \"Procedural 2D rain\")\n\nIf you need a more minimalistic example, find the `rain-demo` tag in git history.\n\n## SampleText\n\nThis demonstrates the support of font rendering in the 3D world using Signed-Distance Fields. \n\n\n## GPU Quaternions performance tests\n\nYou need to find these tags in the commit history:\n\n    instanced-spheres-quaternions\n    instanced-sphere-matrices\n    instanced-cubes-quaternions\n    instanced-cubes-matrices\n    cubes-demo-quaternions\n    cubes-demo-matrices\n\nJust examples of instancing and GPU quaternions. Read about it in detail in this blog post: \n[Performance of quaternions in the GPU](http://tech.metail.com/performance-quaternions-gpu/)\n\n[![Instanced cubes](http://img.youtube.com/vi/Q7GQbFIXMJg/0.jpg)](https://www.youtube.com/watch?v=Q7GQbFIXMJg \"Instanced cubes\")\n\n[![Instanced spheres](http://img.youtube.com/vi/P9fTjDLkOtI/0.jpg)](https://www.youtube.com/watch?v=P9fTjDLkOtI \"Instanced cubes\")\n\n\nLicense\n======\nMIT License.\nPlease let me know if you use this in any of your projects.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fwebmobi59%2Fvidengine","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fwebmobi59%2Fvidengine","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fwebmobi59%2Fvidengine/lists"}