{"id":20367809,"url":"https://github.com/flaxengine/dlss","last_synced_at":"2025-04-12T05:36:30.509Z","repository":{"id":105039874,"uuid":"577720420","full_name":"FlaxEngine/DLSS","owner":"FlaxEngine","description":"NVIDIA DLSS plugin for Flax Engine","archived":false,"fork":false,"pushed_at":"2024-10-17T17:27:04.000Z","size":35,"stargazers_count":12,"open_issues_count":0,"forks_count":4,"subscribers_count":2,"default_branch":"master","last_synced_at":"2025-03-26T01:02:43.899Z","etag":null,"topics":["dlss","flax","flax-engine","gamedev","graphics","nvidia"],"latest_commit_sha":null,"homepage":"","language":"C++","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/FlaxEngine.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":"2022-12-13T11:24:42.000Z","updated_at":"2025-02-26T14:24:53.000Z","dependencies_parsed_at":null,"dependency_job_id":"36301497-f563-4c60-b184-4312390cfe72","html_url":"https://github.com/FlaxEngine/DLSS","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/FlaxEngine%2FDLSS","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/FlaxEngine%2FDLSS/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/FlaxEngine%2FDLSS/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/FlaxEngine%2FDLSS/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/FlaxEngine","download_url":"https://codeload.github.com/FlaxEngine/DLSS/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248524849,"owners_count":21118615,"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":["dlss","flax","flax-engine","gamedev","graphics","nvidia"],"created_at":"2024-11-15T00:34:49.315Z","updated_at":"2025-04-12T05:36:30.477Z","avatar_url":"https://github.com/FlaxEngine.png","language":"C++","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Deep Learning Super Sampling (DLSS) for Flax Engine\n\n[DLSS](https://www.nvidia.com/en-us/geforce/technologies/dlss/) is a revolutionary breakthrough in AI-powered graphics upscaling technology that massively boosts performance. This repository contains a plugin project for [Flax Engine](https://flaxengine.com/) games with DLSS.\n\nMinimum supported Flax version: `1.5`.\n\n## Installation\n\n0. Ensure to have proper system setup for C++ Scripting - see [Flax Docs](https://docs.flaxengine.com/manual/scripting/cpp/index.html)\n\n1. Clone repo into `\u003cgame-project\u003e\\Plugins\\DLSS`\n\n2. Add reference to DLSS project in your game by modyfying your game `\u003cgame-project\u003e.flaxproj` as follows:\n\n\n```\n...\n\"References\": [\n    {\n        \"Name\": \"$(EnginePath)/Flax.flaxproj\"\n    },\n    {\n        \"Name\": \"$(ProjectPath)/Plugins/DLSS/DLSS.flaxproj\"\n    }\n]\n```\n\n3. Setup plugin\n\nNow, open Flax Editor and add new `DLSS` settings (via *Content* window **New -\u003e Settings**, select Type to `DLSSSettings`). The you can provide *AppId* or *ProjectId* for NVIDIA DLSS. Also, you might want to get [official DLSS SDK](https://developer.nvidia.com/rtx/dlss/get-started) and update DLL files in this repo.\n\n4. Test it out!\n\nFinally you can use DLSS for image upscaling. DLSS extension will be visible in Plugins window (under Rendering category). It implements `CustomUpscale` postFx to increase visual quality when using low-res rendering. To test it simply start the game and adjust the **Rendering Percentage** property in *Graphics Quality Window*. Use plugin API to adjust DLSS quality and setup proper `RenderingPercentage` of the game rendering based on optimal settings from NVIDIA.\n\n## Supported Platforms\n\nPlatforms:\n* Windows x64\n* Linux x64 (untested)\n\nGraphics APIs:\n* DirectX 11\n* DirectX 12\n* Vulkan (untested)\n\n## API\n\nIn order to access DLSS API in C++/C# scripting import it in your code module (modify `Game.Build.cs` file):\n\n```cs\npublic override void Setup(BuildOptions options)\n{\n    base.Setup(options);\n    \n    // Adds DLSS module to PrivateDependencies if supported on current platform (eg. Windows/Linux x64)\n    DLSS.ConditionalImport(options, options.PrivateDependencies);\n}\n```\n\nDLSS is implemented as a `GamePlugin` and can be accessed as follows to configure effect:\n\n```cs\n// Get DLSS plugin\nvar dlss = PluginManager.GetPlugin\u003cDLSS\u003e();\n\n// Check if DLSS is not supported\nif (dlss.Support != DLSSSupport.Supported)\n    return;\n\n// Adjust quality and sharpness\ndlss.Quality = DLSSQuality.UltraQuality;\ndlss.Sharpness = 0.1f;\n\n// Use automatic settings based on output resolution and quality\n// Sets main render task RenderingPercentage and DLSS Sharpness\ndlss.ApplyRecommendedSettings(DLSSQuality.UltraPerformance);\n\n// Enable/disable effect\ndlss.PostFx.Enabled = true;\n```\n\n## License\n\nSee official [NVIDIA DLSS License](https://github.com/NVIDIA/DLSS/blob/main/LICENSE.txt).\n\n## Trademarks\n\nNVIDIA and the NVIDIA logo are trademarks and/or registered trademarks of NVIDIA Corporation in the\nU.S. and other countries. Other company and product names may be trademarks of the respective\ncompanies with which they are associated.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fflaxengine%2Fdlss","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fflaxengine%2Fdlss","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fflaxengine%2Fdlss/lists"}