DisplayPath DisplayPath DisplayPath DisplayPath DisplayPath Class

Definition

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.

public : sealed class DisplayPath
struct winrt::Windows::Devices::Display::Core::DisplayPath
public sealed class DisplayPath
Public NotInheritable Class DisplayPath
// This class does not provide a public constructor.
Attributes

Windows 10 requirements

Device family
Windows 10, version 1809 (introduced v10.0.17763.0)
API contract
Windows.Foundation.UniversalApiContract (introduced v7)

Properties

IsInterlaced IsInterlaced IsInterlaced IsInterlaced IsInterlaced

Gets or sets an optional value for whether the target mode for this path is interlaced.

IsStereo IsStereo IsStereo IsStereo IsStereo

Gets or sets whether the target mode for this path is in 3D stereoscopic mode.

PresentationRate PresentationRate PresentationRate PresentationRate 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 Properties Properties Properties Properties

Reserved for future use.

Rotation Rotation Rotation Rotation Rotation

Gets or sets how the display pipeline rotates the source frame buffer before scanning out to the target.

Scaling Scaling Scaling Scaling Scaling

Gets or sets how the display pipeline scales the source frame buffer before scanning out to the target.

SourcePixelFormat SourcePixelFormat SourcePixelFormat SourcePixelFormat SourcePixelFormat

Gets or sets the pixel format of the surfaces that will be allowed to present to this DisplayPath.

SourceResolution SourceResolution SourceResolution SourceResolution 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 Status Status Status Status

Gets the last status of the path in the system, captured when the DisplayState was last created or applied.

Target Target Target Target Target

The DisplayTarget that this path connects to.

TargetResolution TargetResolution TargetResolution TargetResolution 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 View View View View

Gets the logical view that this path is connected from. All paths residing in the same DisplayView are logically cloned together.

WireFormat WireFormat WireFormat WireFormat 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) ApplyPropertiesFromMode(DisplayModeInfo) ApplyPropertiesFromMode(DisplayModeInfo) ApplyPropertiesFromMode(DisplayModeInfo) 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) FindModes(DisplayModeQueryOptions) FindModes(DisplayModeQueryOptions) FindModes(DisplayModeQueryOptions) 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.