DisplayPath Class

Definition

Namespace:

Windows.Devices.Display.Core

Represents a display pipeline path from a logical "source" to a DisplayTarget. A logical source provides a frame buffer, in a format described by the source properties. The display pipeline composes the source content and transforms it into the format described by the target properties.

DisplayPath objects also implement the COM interface IDisplayPathInterop.

public ref class DisplayPath sealed

/// [Windows.Foundation.Metadata.ContractVersion(Windows.Foundation.UniversalApiContract, 458752)]
/// [Windows.Foundation.Metadata.MarshalingBehavior(Windows.Foundation.Metadata.MarshalingType.Agile)]
class DisplayPath final

[Windows.Foundation.Metadata.ContractVersion(typeof(Windows.Foundation.UniversalApiContract), 458752)]
[Windows.Foundation.Metadata.MarshalingBehavior(Windows.Foundation.Metadata.MarshalingType.Agile)]
public sealed class DisplayPath

Public NotInheritable Class DisplayPath

Inheritance

Object Platform::Object IInspectable DisplayPath

Attributes

ContractVersionAttribute MarshalingBehaviorAttribute

Windows requirements

Device family	Windows 10, version 1809 (introduced in 10.0.17763.0)
API contract	Windows.Foundation.UniversalApiContract (introduced in v7.0)

Properties

IsInterlaced	Gets or sets an optional value for whether the target mode for this path is interlaced.
IsStereo	Gets or sets whether the target mode for this path is in 3D stereoscopic mode.
PhysicalPresentationRate	Gets or sets the actual physical rate at which the display is scanning out pixels (when refresh rates are being virtualized).
PresentationRate	Gets or sets an optional value for the refresh rate, also known as the vertical sync rate, of this path's target mode.
Properties	Reserved for future use.
Rotation	Gets or sets how the display pipeline rotates the source frame buffer before scanning out to the target.
Scaling	Gets or sets how the display pipeline scales the source frame buffer before scanning out to the target.
SourcePixelFormat	Gets or sets the pixel format of the surfaces that will be allowed to present to this DisplayPath.
SourceResolution	Gets or sets an optional value for the size of the pixel buffer used for scanout, before it is transformed to fit into the target resolution.
Status	Gets the last status of the path in the system, captured when the DisplayState was last created or applied.
Target	The DisplayTarget that this path connects to.
TargetResolution	Gets or sets an optional value for the size of the frame provided to the target's monitor. This can differ from the size of the "source" frame buffer, in which case the display pipeline transforms the content using the Rotation and Scaling properties.
View	Gets the logical view that this path is connected from. All paths residing in the same DisplayView are logically cloned together.
WireFormat	Gets or sets an optional value for the exact hardware representation used to scan out; such as the pixel encoding, bits per channel, color space, and HDR metadata format.

Methods

ApplyPropertiesFromMode(DisplayModeInfo)	Sets on this DisplayPath object all properties reflected in a supplied DisplayModeInfo. Note that the wire format is not set by this method, since a DisplayModeInfo object refers to a range of valid wire formats.
FindModes(DisplayModeQueryOptions)	Queries the driver to determine the valid mode combinations that can be applied to this DisplayPath. Any properties that have already been set on this path are used as constraints to limit the set of modes returned.