Skip to content

Commit

Permalink
Merged PR 13484: update descriptions and some metadata
Browse files Browse the repository at this point in the history
  • Loading branch information
mimisasouvanh committed Dec 19, 2018
1 parent 771cca0 commit eb704a1
Show file tree
Hide file tree
Showing 7 changed files with 276 additions and 259 deletions.
202 changes: 101 additions & 101 deletions wdk-ddi-src/content/d3dkmthk/ne-d3dkmthk-d3dkmt_miracast_device_status.md
Original file line number Diff line number Diff line change
@@ -1,101 +1,101 @@
---
UID: NE:d3dkmthk.__unnamed_enum_2
title: D3DKMT_MIRACAST_DEVICE_STATUS
author: windows-driver-content
description: Miracast (wireless display) device status.
ms.assetid: bf6c74a4-ace8-4fbe-bc61-5066211e9e51
ms.date: 10/19/2018
ms.topic: enum
ms.keywords: D3DKMT_MIRACAST_DEVICE_STATUS, D3DKMT_MIRACAST_DEVICE_STATUS,
req.header: d3dkmthk.h
req.include-header:
req.target-type:
req.target-min-winverclnt:
req.target-min-winversvr:
req.kmdf-ver:
req.umdf-ver:
req.ddi-compliance:
req.max-support:
req.typenames: D3DKMT_MIRACAST_DEVICE_STATUS
topic_type:
- apiref
api_type:
- HeaderDef
api_location:
- d3dkmthk.h
api_name:
- D3DKMT_MIRACAST_DEVICE_STATUS
product:
- Windows
targetos: Windows
ms.custom: RS5
tech.root: display
---

# D3DKMT_MIRACAST_DEVICE_STATUS enumeration

## -description

Miracast (wireless display) device status.

## -enum-fields

### -field D3DKMT_MIRACAST_DEVICE_STATUS_SUCCESS

Success.

### -field D3DKMT_MIRACAST_DEVICE_STATUS_SUCCESS_NO_MONITOR

Success with no monitor.

### -field D3DKMT_MIRACAST_DEVICE_STATUS_PENDING

Pending.

### -field D3DKMT_MIRACAST_DEVICE_STATUS_UNKOWN_ERROR

Unknown error.

### -field D3DKMT_MIRACAST_DEVICE_STATUS_GPU_RESOURCE_IN_USE

GPU resource in use.

### -field D3DKMT_MIRACAST_DEVICE_STATUS_DEVICE_ERROR

Device error.

### -field D3DKMT_MIRACAST_DEVICE_STATUS_UNKOWN_PAIRING

Unknown pairing.

### -field D3DKMT_MIRACAST_DEVICE_STATUS_REMOTE_SESSION

Remote session.

### -field D3DKMT_MIRACAST_DEVICE_STATUS_DEVICE_NOT_FOUND

Device not found.

### -field D3DKMT_MIRACAST_DEVICE_STATUS_DEVICE_NOT_STARTED

Device not started.

### -field D3DKMT_MIRACAST_DEVICE_STATUS_INVALID_PARAMETER

Invalid parameter.

### -field D3DKMT_MIRACAST_DEVICE_STATUS_INSUFFICIENT_BANDWIDTH

Insufficient bandwidth.

### -field D3DKMT_MIRACAST_DEVICE_STATUS_INSUFFICIENT_MEMORY

Insufficient memory.

### -field D3DKMT_MIRACAST_DEVICE_STATUS_CANCELLED

Cancelled.

## -remarks

## -see-also
---
UID: NE:d3dkmthk.D3DKMT_MIRACAST_DEVICE_STATUS
title: D3DKMT_MIRACAST_DEVICE_STATUS
author: windows-driver-content
description: Miracast (wireless display) device status.
ms.assetid: bf6c74a4-ace8-4fbe-bc61-5066211e9e51
ms.date: 10/19/2018
ms.topic: enum
ms.keywords: D3DKMT_MIRACAST_DEVICE_STATUS, D3DKMT_MIRACAST_DEVICE_STATUS,
req.header: d3dkmthk.h
req.include-header:
req.target-type:
req.target-min-winverclnt:
req.target-min-winversvr:
req.kmdf-ver:
req.umdf-ver:
req.ddi-compliance:
req.max-support:
req.typenames: D3DKMT_MIRACAST_DEVICE_STATUS
topic_type:
- apiref
api_type:
- HeaderDef
api_location:
- d3dkmthk.h
api_name:
- D3DKMT_MIRACAST_DEVICE_STATUS
product:
- Windows
targetos: Windows
ms.custom: RS5
tech.root: display
---

# D3DKMT_MIRACAST_DEVICE_STATUS enumeration

## -description

Miracast (wireless display) device status.

## -enum-fields

### -field D3DKMT_MIRACAST_DEVICE_STATUS_SUCCESS

Success.

### -field D3DKMT_MIRACAST_DEVICE_STATUS_SUCCESS_NO_MONITOR

Success with no monitor.

### -field D3DKMT_MIRACAST_DEVICE_STATUS_PENDING

Pending.

### -field D3DKMT_MIRACAST_DEVICE_STATUS_UNKOWN_ERROR

Unknown error.

### -field D3DKMT_MIRACAST_DEVICE_STATUS_GPU_RESOURCE_IN_USE

GPU resource in use.

### -field D3DKMT_MIRACAST_DEVICE_STATUS_DEVICE_ERROR

Device error.

### -field D3DKMT_MIRACAST_DEVICE_STATUS_UNKOWN_PAIRING

Unknown pairing.

### -field D3DKMT_MIRACAST_DEVICE_STATUS_REMOTE_SESSION

Remote session.

### -field D3DKMT_MIRACAST_DEVICE_STATUS_DEVICE_NOT_FOUND

Device not found.

### -field D3DKMT_MIRACAST_DEVICE_STATUS_DEVICE_NOT_STARTED

Device not started.

### -field D3DKMT_MIRACAST_DEVICE_STATUS_INVALID_PARAMETER

Invalid parameter.

### -field D3DKMT_MIRACAST_DEVICE_STATUS_INSUFFICIENT_BANDWIDTH

Insufficient bandwidth.

### -field D3DKMT_MIRACAST_DEVICE_STATUS_INSUFFICIENT_MEMORY

Insufficient memory.

### -field D3DKMT_MIRACAST_DEVICE_STATUS_CANCELLED

Cancelled.

## -remarks

## -see-also
Original file line number Diff line number Diff line change
@@ -1,61 +1,61 @@
---
UID: NE:d3dkmthk.__unnamed_enum_1
title: D3DKMT_MIRACAST_DISPLAY_DEVICE_STATE
author: windows-driver-content
description: Miracast display device state.
ms.assetid: 266068fa-5ac9-4c83-8425-cb4efcfd6bce
ms.date: 10/19/2018
ms.topic: enum
ms.keywords: D3DKMT_MIRACAST_DISPLAY_DEVICE_STATE, D3DKMT_MIRACAST_DISPLAY_DEVICE_STATE,
req.header: d3dkmthk.h
req.include-header:
req.target-type:
req.target-min-winverclnt:
req.target-min-winversvr:
req.kmdf-ver:
req.umdf-ver:
req.ddi-compliance:
req.max-support:
req.typenames: D3DKMT_MIRACAST_DISPLAY_DEVICE_STATE
topic_type:
- apiref
api_type:
- HeaderDef
api_location:
- d3dkmthk.h
api_name:
- D3DKMT_MIRACAST_DISPLAY_DEVICE_STATE
product:
- Windows
targetos: Windows
ms.custom: RS5
tech.root: display
---

# D3DKMT_MIRACAST_DISPLAY_DEVICE_STATE enumeration

## -description

Miracast display device state.

## -enum-fields

### -field MiracastStopped

Stopped.

### -field MiracastStartPending

Start pending.

### -field MiracastStarted

Started.

### -field MiracastStopPending

Stop pending.

## -remarks

## -see-also
---
UID: NE:d3dkmthk.D3DKMT_MIRACAST_DISPLAY_DEVICE_STATE
title: D3DKMT_MIRACAST_DISPLAY_DEVICE_STATE
author: windows-driver-content
description: Miracast display device state.
ms.assetid: 266068fa-5ac9-4c83-8425-cb4efcfd6bce
ms.date: 10/19/2018
ms.topic: enum
ms.keywords: D3DKMT_MIRACAST_DISPLAY_DEVICE_STATE, D3DKMT_MIRACAST_DISPLAY_DEVICE_STATE,
req.header: d3dkmthk.h
req.include-header:
req.target-type:
req.target-min-winverclnt:
req.target-min-winversvr:
req.kmdf-ver:
req.umdf-ver:
req.ddi-compliance:
req.max-support:
req.typenames: D3DKMT_MIRACAST_DISPLAY_DEVICE_STATE
topic_type:
- apiref
api_type:
- HeaderDef
api_location:
- d3dkmthk.h
api_name:
- D3DKMT_MIRACAST_DISPLAY_DEVICE_STATE
product:
- Windows
targetos: Windows
ms.custom: RS5
tech.root: display
---

# D3DKMT_MIRACAST_DISPLAY_DEVICE_STATE enumeration

## -description

Miracast display device state.

## -enum-fields

### -field MiracastStopped

Stopped.

### -field MiracastStartPending

Start pending.

### -field MiracastStarted

Started.

### -field MiracastStopPending

Stop pending.

## -remarks

## -see-also
Original file line number Diff line number Diff line change
Expand Up @@ -10,8 +10,8 @@ ms.keywords: D3DKMT_MULTIPLANE_OVERLAY_VIDEO_FRAME_FORMAT, D3DKMT_MULTIPLANE_OVE
req.header: d3dkmthk.h
req.include-header:
req.target-type:
req.target-min-winverclnt:
req.target-min-winversvr:
req.target-min-winverclnt: Windows 8
req.target-min-winversvr: Windows Server 2012
req.kmdf-ver:
req.umdf-ver:
req.ddi-compliance:
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -8,10 +8,10 @@ ms.date: 10/19/2018
ms.topic: struct
ms.keywords: D3DDDI_CHECK_MULTIPLANE_OVERLAY_SUPPORT_PLANE_INFO, D3DDDI_CHECK_MULTIPLANE_OVERLAY_SUPPORT_PLANE_INFO,
req.header: d3dumddi.h
req.include-header:
req.include-header: D3d10umddi.h
req.target-type:
req.target-min-winverclnt:
req.target-min-winversvr:
req.target-min-winverclnt: Windows 8.1
req.target-min-winversvr: Windows Server 2012 R2
req.kmdf-ver:
req.umdf-ver:
req.lib:
Expand Down Expand Up @@ -45,15 +45,15 @@ Used to check multiplane overlay support plane info.

### -field hResource

A handle to the resource.
A handle to the resource. The display miniport driver must set this member to a value that it can use to refer to its private tracking structure for the resource.

### -field SubResourceIndex

The subresource index.
The zero-based index into the resource, which is specified by the handle in the **hResource** member. This index indicates the subresource, or surface, on which an overlay plane is to be displayed.

### -field PlaneAttributes

Plane attributes.
A [D3DDDI_MULTIPLANE_OVERLAY_ATTRIBUTES](ns-d3dumddi-_d3dddi_multiplane_overlay_attributes.md) structure that specifies overlay plane attributes.

## -remarks

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -42,7 +42,8 @@ ms.custom: RS5

## -description

Reports the colorimetry values selected by the OS for a target.
Reports the colorimetry values selected by the OS for a target. The OS will call this routine whenever any of the values in the [DXGK_COLORIMETRY](../d3dkmddi/ns-d3dkmddi-_dxgk_colorimetry.md) changes or the **SdrWhiteLevel** in [DXGK_MULTIPLANE_OVERLAY_ATTRIBUTES3 structure](https://docs.microsoft.com/en-us/windows-hardware/drivers/ddi/content/d3dkmddi/ns-d3dkmddi-_dxgk_multiplane_overlay_attributes3) changes for a target.


## -prototype

Expand Down Expand Up @@ -76,8 +77,10 @@ Pointer to a [DXGKARG_SETTARGETADJUSTEDCOLORIMETRY2](ns-dispmprt-_dxgkarg_settar
The driver returns STATUS_SUCCESS if it has updates its colorimetry values based on the supplied data.
## -remarks
If the driver fails, the OS will revert to standard SDR values for all parameters (i.e. 709 primaries, 2.2 gamma and 8-bit per color component RGB wire format), but it will not call the driver as this should never fail.
## -remarks
This callback function replaces [DXGKDDI_SETTARGETADJUSTEDCOLORIMETRY](nc-dispmprt-dxgkddi_settargetadjustedcolorimetry.md) and is more extensible in the future, as it contains a pointer to the DXGKARG_SETTARGETADJUSTEDCOLORIMETRY2 that can change over new releases.
## -see-also
Loading

0 comments on commit eb704a1

Please sign in to comment.