Skip to content
GameWorks cross-platform graphics API samples
C C++ Objective-C Makefile HTML Shell Other
Branch: master
Clone or download

README.md

NVIDIA GameWorks Graphics Samples

The GameWorks Graphics Samples pack is a resource for cross-platform Vulkan, OpenGL 4 (GL4) and OpenGL ES 2 and 3 (ES2 and ES3) development, targeting Android and Windows (and soon, will again support Linux x86/x64 and Linux for Tegra). It is an expansion and continuation of the longstanding OpenGL Graphics and Compute Samples, adding full support for and samples of the Vulkan 3D API.

The samples run on all supported target platforms from a single source base.

Advanced OpenGL features such as Tessellation Shaders, Geometry Shaders, Compute Shaders, Direct State Access, Texture Arrays and Instancing are all demonstrated. In addition, support for NVIDIA's NSight Tegra Visual Studio plug-in means that developers can experiment with their effects on Windows OpenGL and immediately rebuild and retarget to run on Android Tegra systems, including Tegra K1.

The samples also include source for a simple cross-platform application framework which forms the basis of all of the samples. This framework supports VK/GL window and context management, platform-independent main event loop, handling of input devices including game controllers, asset/file reading, texture/model loading, and other VK/GL utilities.

Important GitHub Note:

Moving forward, the most frequent releases will be made to this GitHub repository. It will represent the latest, greatest public code.

What to Read Next:

Note: a table of contents for the linked documents is forthcoming...

  • Release Notes ** What's new in this release, along with any known issues.
  • Prerequisites ** Details the per-platform requirements for developing with the samples.
  • Setup Guide ** Details the per-platform steps needed to set up your PC for building and running the samples.
  • Overview of Vulkan Samples ** Describes each of the Vulkan samples in the pack, what they demonstrate, and in some cases further detailed analysis of how they work.
  • Overview of OpenGL Samples ** Describes each of the OpenGL samples in the pack, what they demonstrate, and in some cases further detailed analysis of how they work.
  • Overview of OpenGL ES Samples ** Describes each of the OpenGL ES samples in the pack, what they demonstrate, and in some cases further detailed analysis of how they work.
  • Overview of App Framework and Libraries ** Details the cross-platform application framework and other support libraries, along with links to class/structure documentation.

Providing Pull Requests:

NVIDIA is happy to review and consider pull requests for merging into the main tree of the samples for bug fixes and features. Before providing a pull request to NVIDIA, please note the following:

  • A pull request provided to this repo by a developer constitutes permission from the developer for NVIDIA to merge the provided changes or any NVIDIA modified version of these changes to the repo. NVIDIA may remove or change the code at any time and in any way deemed appropriate.
  • Not all pull requests can be or will be accepted. NVIDIA will close pull requests that it does not intend to merge.
  • The modified files and any new files must include the unmodified NVIDIA copyright header seen at the top of all shipping files.
You can’t perform that action at this time.