DisplayDevice.CreateSimpleScanout Method

Definition

Namespace:

Windows.Devices.Display.Core

Creates a DisplayScanout object that can be used to present a full-screen surface directly to the screen.

public:
 virtual DisplayScanout ^ CreateSimpleScanout(DisplaySource ^ pSource, DisplaySurface ^ pSurface, unsigned int SubResourceIndex, unsigned int SyncInterval) = CreateSimpleScanout;

DisplayScanout CreateSimpleScanout(DisplaySource const& pSource, DisplaySurface const& pSurface, uint32_t const& SubResourceIndex, uint32_t const& SyncInterval);

public DisplayScanout CreateSimpleScanout(DisplaySource pSource, DisplaySurface pSurface, uint SubResourceIndex, uint SyncInterval);

function createSimpleScanout(pSource, pSurface, SubResourceIndex, SyncInterval)

Public Function CreateSimpleScanout (pSource As DisplaySource, pSurface As DisplaySurface, SubResourceIndex As UInteger, SyncInterval As UInteger) As DisplayScanout

Parameters

pSource

DisplaySource

A DisplaySource to present full-screen content to.

pSurface

DisplaySurface

A full-screen primary surface.

SubResourceIndex

UInt32

unsigned int

uint32_t

Related to Direct3D's concept of subresources. Using this index, you can specify which subresource within the DisplaySurface should be used for scanout, in the event that there are multiple subresources.

The only way to have a DisplaySurface that has multiple subresources is either to create the DisplaySurface with the isStereo flag (see CreateWithProperties), or to open an ID3D11Texture2D using APIs in IDisplayDeviceInterop.

The most common value for subresourceindex will be 0, which indicates that no subresource is needed or available.

SyncInterval

UInt32

unsigned int

uint32_t

An integer that specifies how to synchronize presentation of a frame with the vertical blank of the display.

SyncInterval == 0. Presentation happens on the next vertical blank from the display. If there are other presents in the queue with value = 0, then those presents are discarded. SyncInterval == 0, with DisplayScanoutOptions::AllowTearing. The presentation occurs immediately; there is no synchronization with the previous frame. This can cause visible tearing. SyncInterval == 1 through 4. Synchronize presentation for at least n vertical blanks of the display.

Returns

DisplayScanout

A DisplayScanout value.