{"id":46253441,"url":"https://github.com/microsoft/directstorage","last_synced_at":"2026-03-03T23:04:15.368Z","repository":{"id":39849719,"uuid":"454494211","full_name":"microsoft/DirectStorage","owner":"microsoft","description":"DirectStorage for Windows is an API that allows game developers to unlock the full potential of high speed NVMe drives for loading game assets.","archived":false,"fork":false,"pushed_at":"2026-03-03T16:25:54.000Z","size":543615,"stargazers_count":825,"open_issues_count":13,"forks_count":95,"subscribers_count":24,"default_branch":"main","last_synced_at":"2026-03-03T20:43:54.812Z","etag":null,"topics":["direct3d12","directx","microsoft","storage"],"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/microsoft.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":"CODE_OF_CONDUCT.md","threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":"SECURITY.md","support":"SUPPORT.md","governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null,"notice":null,"maintainers":null,"copyright":null,"agents":null,"dco":null,"cla":null}},"created_at":"2022-02-01T17:59:52.000Z","updated_at":"2026-02-25T18:27:27.000Z","dependencies_parsed_at":"2025-10-28T02:27:36.176Z","dependency_job_id":null,"html_url":"https://github.com/microsoft/DirectStorage","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/microsoft/DirectStorage","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/microsoft%2FDirectStorage","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/microsoft%2FDirectStorage/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/microsoft%2FDirectStorage/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/microsoft%2FDirectStorage/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/microsoft","download_url":"https://codeload.github.com/microsoft/DirectStorage/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/microsoft%2FDirectStorage/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":30064798,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-03-03T18:21:05.932Z","status":"ssl_error","status_checked_at":"2026-03-03T18:20:59.341Z","response_time":61,"last_error":"SSL_connect returned=1 errno=0 peeraddr=140.82.121.5:443 state=error: unexpected eof while reading","robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":false,"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":["direct3d12","directx","microsoft","storage"],"created_at":"2026-03-03T23:04:14.730Z","updated_at":"2026-03-03T23:04:15.364Z","avatar_url":"https://github.com/microsoft.png","language":"C++","funding_links":[],"categories":[],"sub_categories":[],"readme":"# DirectStorage on Windows Samples\nDirectStorage is a feature intended to allow games to make full use of high-speed storage (such as NVMe SSDs) that can can deliver multiple gigabytes a second of small (eg 64kb) data reads with minimal CPU overhead.  Although it is possible to saturate a drive using traditional ReadFile-based IO the CPU overhead increases non-linearly as the size of individual reads decreases.  Additionally, most games choose to store their assets compressed on disk in order to reduce the install footprint, with these assets being decompressed on the fly as load time.  The CPU overhead of this becomes increasingly expensive as bandwidth increases.\n\nVideo game consoles such as the XBox Series X|S address these issues by offloading aspects of this to hardware - making use of the NVMe hardware queue to manage IO and hardware accelerated decompression.  As we expect to see more titles designed to take advantage of the possibilities offered by this architecture it becomes important that Windows has similar capabilities.\n\nThe DirectStorage API already exists on Xbox and in order to ease porting of titles between Xbox and Windows, the two APIs are as similar as possible.\n\nDirectStorage only supports read operations.\n\nYou can find some good starting information in [Developer Guidance](Docs/DeveloperGuidance.md)\n\nWe invite you to join us at our [discord server](http://discord.gg/directx). See the [related links](##-Related-links) section for our full list of Direct3D 12 and DirectStorage-related links.\n\n## API Samples\nThe Samples directory contains sample code that demonstrates how to use the DirectStorage APIs.\n\n1. [HelloDirectStorage](Samples/HelloDirectStorage/README.md): This rudimentary sample serves to provide a quick and easy way to get acquainted with the DirectStorage runtime by reading the contents of a file and writing them out to a buffer on the GPU using DirectStorage.\n    \n    \u003cimg src=\"Samples/HelloDirectStorage/HelloDirectStorageRender.png\" alt=\"HelloDirectStorage screenshot\" height=\"200\"\u003e\n\n2. [BulkLoadDemo](Samples/BulkLoadDemo/README.md): This demonstrates using DirectStorage, GPU decompression and custom CPU decompression.\n    \n    \u003cimg src=\"Samples/BulkLoadDemo/BulkLoadDemo-screenshot.png\" alt=\"BulkLoadDemo screenshot\" height=\"200\"\u003e\n\n3. [GpuDecompressionBenchmark](Samples/GpuDecompressionBenchmark/README.md): This sample provides a quick way to see the DirectStorage runtime decompression performance by reading the contents of a file, compressing it and then decompressing multiple ways while measuring the bandwidth and CPU usage.  Decompression is performed using the GPU as well as the CPU for comparison.\n    \n    \u003cimg src=\"Samples/GpuDecompressionBenchmark/GpuDecompressionBenchmarkRender.png\" alt=\"GpuDecompressionBenchmark screenshot\" height=\"200\"\u003e\n\n4. [EnqueueRequestsDemo](Samples/EnqueueRequestsDemo/README.md): This sample demonstrates the use of `EnqueueRequests()` and the destination type\n`DSTORAGE_REQUEST_DESTINATION_MULTIPLE_SUBRESOURCES_RANGE`.\n    \n    \u003cimg src=\"Samples/EnqueueRequestsDemo/EnqueueRequestsDemo.png\" alt=\"EnqueueRequestsDemo screenshot\" height=\"200\"\u003e\n\n## GDeflate Reference Implementation\nThis directory contains codec source and sample code that demonstrates how to use [GDeflate](GDeflate/README.md).\n\nThe repo uses submodules, so be sure to pass `--recurse-submodules` to the `git clone` command.\n\nIf you forget to do this then you can run `git submodule update --init`\n\n## Contributing\n\nThis project welcomes contributions and suggestions.  Most contributions require you to agree to a Contributor License Agreement (CLA) declaring that you have the right to, and actually do, grant us the rights to use your contribution. For details, visit https://cla.opensource.microsoft.com.\n\nWhen you submit a pull request, a CLA bot will automatically determine whether you need to provide a CLA and decorate the PR appropriately (e.g., status check, comment). Simply follow the instructions provided by the bot. You will only need to do this once across all repos using our CLA.\n\nThis project has adopted the [Microsoft Open Source Code of Conduct](https://opensource.microsoft.com/codeofconduct/). For more information see the [Code of Conduct FAQ](https://opensource.microsoft.com/codeofconduct/faq/) or contact [opencode@microsoft.com](mailto:opencode@microsoft.com) with any additional questions or comments.\n\n## Trademarks\n\nThis project may contain trademarks or logos for projects, products, or services. Authorized use of Microsoft trademarks or logos is subject to and must follow \n[Microsoft's Trademark \u0026 Brand Guidelines](https://www.microsoft.com/en-us/legal/intellectualproperty/trademarks/usage/general). Use of Microsoft trademarks or logos in modified versions of this project must not cause confusion or imply Microsoft sponsorship. Any use of third-party trademarks or logos are subject to those third-party's policies.\n\n# Build\nInstall [Visual Studio](http://www.visualstudio.com/downloads) 2019 or higher.\n\nOpen the following Visual Studio solutions and build\n```\nSamples\\HelloDirectStorage\\HelloDirectStorage.sln\nSamples\\BulkLoadDemo\\BulkLoadDemo.sln\nSamples\\GpuDecompressionBenchmark\\GpuDecompressionBenchmark.sln\nSamples\\EnqueueRequestsDemo\\EnqueueRequestsDemo.sln\n```\n\n## Related links\n* https://aka.ms/directstorage\n* [DirectX Landing Page](https://devblogs.microsoft.com/directx/landing-page/)\n* [Discord server](http://discord.gg/directx)\n* [Developer Guidance](Docs/DeveloperGuidance.md)\n* [PIX on Windows](https://devblogs.microsoft.com/pix/documentation/)\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmicrosoft%2Fdirectstorage","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fmicrosoft%2Fdirectstorage","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmicrosoft%2Fdirectstorage/lists"}