Skip to content

Latest commit

 

History

History
120 lines (90 loc) · 6.61 KB

README.md

File metadata and controls

120 lines (90 loc) · 6.61 KB
Raw

NvAPIWrapper NvAPIWrapper (for NVAPI R410)

NvAPIWrapper is a .Net wrapper for NVIDIA public API, capable of managing all aspects of a display setup using NVIDIA GPUs.

This project is licensed under LGPL and therefore can be used in closed source or commercial projects. However, any commit or change to the main code must be public and there should be a read me file along with the DLL clarifying the license and its terms as part of your project as well as a hyperlink to this repository. Read more about LGPL.

How to get

This library is available for download and use through NuGet Gallery.

Help me fund my own Death Star

--OR--

You can always donate your time by contributing to the project or by introducing it to others.

What's Supported

NvAPIWrapper is not a complete wrapper of NVAPI; at least, not yet. Following is the list of NVAPI features and their status:

  • General: Full Support

    • Chipset Information
    • Driver Information and Driver Restart
    • Lid and Dock Information

  • Surround: Full Support

    • Topology Configuration (Mosaic Phase 2)
    • Grid Configuration (Mosaic Phase 1)
    • Warping Control
    • Color Intensity Control

  • Display: Full Support

    • Display Information and Capabilities
    • Path Configuration
    • Custom Resolutions
    • Refresh Rate Override
    • HDMI Support Information and Capabilities
    • DisplayPort Color Capabilities
    • HDR Capabalities

  • Display Control: Full Support

    • Color Control
    • Saturation Control (Vibrance)
    • HUE Control
    • HDMI InfoFrame Control
    • HDR and HDR Color Control
    • ScanOut Information and Configuration
    • View Control
    • EDID Retrival and Modification

  • GPU: Full Support

    • GPU Informaion
    • GPU Atchitecture Information
    • GPU Output Information
    • ECC Memory Reporting and Managment
    • PCI-E Information
    • Performance Capabilities and Monitoring
    • Cooler Information (Fan/Liquid/Passive) and Managment (Including RTX+)
    • GPU Illumination Managment
    • Usage Monitoring
    • Power Limit Status and Managment (Modification only via the low level API)
    • Thermal Limit Status and Managment (Modification only via the low level API)
    • Performance State Managment (Modification only via the low level API)
    • Clock Boost and Clock Boost Curve Confiurations (via low level API)
    • Voltage Boost and Voltage Boost Table Configurations (via low level API)
    • Clock Lock Configurations (via low level API)

  • DRS: Full Support

    • Session, Profile and Application Managment
    • Documented Setting and Managed Setting Values

  • Stereo (3D): Full Support

    • Stereo Control
    • Stereo Configurations

  • D3D: No Support

  • GSync: No Support

  • OpenGL: No Support

  • Vidio: No Support

If a feature you need is missing, feel free to open an issue.

How to use

NvAPIWrappr allows you to use the NVAPI functions directly (a.k.a. the low-level API) using the NvAPIWrapper.Native namespace. However, there is also a .Net friendly implementation of the NVAPI features (a.k.a. the high-level API) that can be used to minimize the complexity of your code and makes it more compatible with later releases of the library, therefore, I strongly recommend using these classes instead of using the native functions directly.

Currently, you can access different parts of the high level API as follow:

  • Namespace NvAPIWrapper.Display: Display and Display Control API
  • Namespace NvAPIWrapper.GPU: GPU specific API
  • Namespace NvAPIWrapper.Mosaic: Mosaic API - Surround
  • Namespace NvAPIWrapper.DRS: NVIDIA Driver settings and application profiles
  • Namespace NvAPIWrapper.Stereo: Stereo specific settings and configurations
  • Class NvAPIWrapper.NVIDIA: General Information And Methods

Please also take a look at the NvAPISample project for a number of simple examples.

This library is fully documented and this makes your journey through it as easy as it is possible with NVAPI.

Related Projects

  • WindowsDisplayAPI: WindowsDisplayAPI is a .Net wrapper for Windows Display and Windows CCD APIs

  • EDIDParser: EDIDParser is a library allowing all .Net developers to parse and to extract information from raw EDID binary data. (Extended Display Identification Data)

  • HeliosDisplayManagement: An open source display profile management program for Windows with support for NVIDIA Surround

License

Copyright (C) 2017-2020 Soroush Falahati

This project is licensed under the GNU Lesser General Public License ("LGPL") and therefore can be used in closed source or commercial projects. However, any commit or change to the main code must be public and there should be a read me file along with the DLL clarifying the license and its terms as part of your project as well as a hyperlink to this repository. Read more about LGPL.