Indirect Display Driver Sample

This is a sample driver that shows how to create a Windows Indirect Display Driver using the IddCx class extension driver.

Installation

Scoop (recommended)

If you have Scoop, you can easily install this driver in one go. In an elevated prompt, run:

scoop bucket add nonportable
scoop install iddsampledriver-ge9-np -g

The driver should be automatically installed and should be working out of the box.

Manually

Copy option.txt to C:\IddSampleDriver\option.txt before installing the driver (important!). See https://github.com/roshkins/IddSampleDriver/releases for the rest of the installation steps.

Configuration

Configure C:\IddSampleDriver\option.txt to set the number of monitors and resolutions. See option.txt

Background reading

Start at the Indirect Display Driver Model Overview on MSDN.

Customizing the sample

The sample driver code is very simplistic and does nothing more than enumerate a single monitor when its device enters the D0/started power state. Throughout the code, there are TODO blocks with important information on implementing functionality in a production driver.

Code structure

• Direct3DDevice class
  • Contains logic for enumerating the correct render GPU from DXGI and creating a D3D device.
  • Manages the lifetime of a DXGI factory and a D3D device created for the render GPU the system is using to render frames for your indirect display device's swap-chain.
• SwapChainProcessor class
  • Processes frames for a swap-chain assigned to the monitor object on a dedicated thread.
  • The sample code does nothing with the frames, but demonstrates a correct processing loop with error handling and notifying the OS of frame completion.
• IndirectDeviceContext class
  • Processes device callbacks from IddCx.
  • Manages the creation and arrival of the sample monitor.
  • Handles swap-chain arrival and departure by creating a Direct3DDevice and handing it off to a SwapChainProcessor.

First steps

Consider the capabilities of your device. If the device supports multiple monitors being hotplugged and removed at runtime, you may want to abstract the monitors further from the IndirectDeviceContext class.

The INF file included in the sample needs updating for production use. One field, DeviceGroupId, controls how the UMDF driver gets pooled with other UMDF drivers in the same process. Since indirect display drivers tend to be more complicated than other driver classes, it's highly recommended that you pick a unique string for this field which will cause instances of your device driver to pool in a dedicated process. This will improve system reliability in case your driver encounters a problem since other drivers will not be affected.

Ensure the device information reported to IddCxAdapterInitAsync is accurate. This information determines how the device is reported to the OS and what static features (like support for gamma tables) the device will have available. If some information cannot be known immediately in the EvtDeviceD0Entry callback, IddCx allows the driver to call IddCxAdapterInitAsync at any point after D0 entry, before D0 exit.

Careful attention should be paid to the frame processing loop. This will directly impact the performance of the user's system, so making use of the Multimedia Class Scheduler Service and DXGI's support for GPU prioritization should be considered. Any significant work should be performed outside the main processing loop, such as by queuing work in a thread pool. See SwapChainProcessor::RunCore for more information.

License

License MIT and CC0 or Public Domain (for changes I made, check with Microsoft for their license), whichever is least restrictive -- Use it

AS IS - NO IMPLICIT OR EXPLICIT warranty This may break your computer, it didn't break mine. It runs in User Mode which means it's less likely to cause system instability like the Blue Screen of Death.

Acknowledgements

See the original repo below: https://github.com/roshkins/IddSampleDriver

Thanks to https://github.com/akatrevorjay/edid-generator for the hi-res EDID.