From fe107eb745c4a1da70eec9b24663a89f71e2d7d6 Mon Sep 17 00:00:00 2001 From: benstevens48 Date: Thu, 9 Jan 2025 09:40:15 +0000 Subject: [PATCH] fix effect alpha mode docs --- winrt/docsrc/effects/ColorManagementEffect.xml | 12 +++++------- winrt/docsrc/effects/ColorMatrixEffect.xml | 8 +++----- winrt/docsrc/effects/EdgeDetectionEffect.xml | 8 +++----- winrt/docsrc/effects/SepiaEffect.xml | 8 +++----- winrt/docsrc/effects/TableTransfer3DEffect.xml | 8 +++----- 5 files changed, 17 insertions(+), 27 deletions(-) diff --git a/winrt/docsrc/effects/ColorManagementEffect.xml b/winrt/docsrc/effects/ColorManagementEffect.xml index 529ef8bff..e30520002 100644 --- a/winrt/docsrc/effects/ColorManagementEffect.xml +++ b/winrt/docsrc/effects/ColorManagementEffect.xml @@ -52,18 +52,16 @@ Licensed under the MIT License. See LICENSE.txt in the project root for license - Specifies the treatment of alpha. Default value Premultiplied. + Specifies the alpha mode of the input. Default value Premultiplied.

- Effect inputs and outputs are assumed to be in - premultiplied alpha format, so when this - property is set to Premultiplied, color management is applied directly to the + When this property is set to Straight, color management is applied directly to the input values with no extra conversions.

- If AlphaMode set to Straight, input values will be unpremultiplied, then the - color management applied, and finally the result converted back to premultiplied - format. + If AlphaMode set to Premultiplied (the default), input values will be unpremultiplied, then the + color management applied, and finally the result converted back to premultiplied format + (except in the case of 4-channel color spaces where there is no alpha data).

diff --git a/winrt/docsrc/effects/ColorMatrixEffect.xml b/winrt/docsrc/effects/ColorMatrixEffect.xml index 07f704d56..777673659 100644 --- a/winrt/docsrc/effects/ColorMatrixEffect.xml +++ b/winrt/docsrc/effects/ColorMatrixEffect.xml @@ -130,16 +130,14 @@ Licensed under the MIT License. See LICENSE.txt in the project root for license they are not of high enough precision. Default value false. - Specifies the treatment of alpha. Default value Premultiplied. + Specifies the alpha mode of the input. Default value Premultiplied.

- Effect inputs and outputs are assumed to be in - premultiplied alpha format, so when this - property is set to Premultiplied, the color matrix is applied directly to the + When this property is set to Straight, the color matrix is applied directly to the input values with no extra conversions.

- If AlphaMode set to Straight, input values will be unpremultiplied, then the + If AlphaMode set to Premultiplied (the default), input values will be unpremultiplied, then the color matrix applied, and finally the result converted back to premultiplied format.

diff --git a/winrt/docsrc/effects/EdgeDetectionEffect.xml b/winrt/docsrc/effects/EdgeDetectionEffect.xml index a1e430d43..a1b3ec3b5 100644 --- a/winrt/docsrc/effects/EdgeDetectionEffect.xml +++ b/winrt/docsrc/effects/EdgeDetectionEffect.xml @@ -51,16 +51,14 @@ Licensed under the MIT License. See LICENSE.txt in the project root for license the alpha channel is ignored for purposes of detecting edges. - Specifies the treatment of alpha. Default value Premultiplied. + Specifies the alpha mode of the input. Default value Premultiplied.

- Effect inputs and outputs are assumed to be in - premultiplied alpha format, so when this - property is set to Premultiplied, edge detection is applied directly to the + When this property is set to Straight, edge detection is applied directly to the input values with no extra conversions.

- If AlphaMode set to Straight, input values will be unpremultiplied, then + If AlphaMode set to Premultiplied (the default), input values will be unpremultiplied, then edge detection applied, and finally the result converted back to premultiplied format.

diff --git a/winrt/docsrc/effects/SepiaEffect.xml b/winrt/docsrc/effects/SepiaEffect.xml index da02a73dd..ad64f4d9c 100644 --- a/winrt/docsrc/effects/SepiaEffect.xml +++ b/winrt/docsrc/effects/SepiaEffect.xml @@ -34,16 +34,14 @@ Licensed under the MIT License. See LICENSE.txt in the project root for license Intensity of the sepia effect. Default value 0.5, range 0 to 1. - Specifies the treatment of alpha. Default value Premultiplied. + Specifies the alpha mode of the input. Default value Premultiplied.

- Effect inputs and outputs are assumed to be in - premultiplied alpha format, so when this - property is set to Premultiplied, the sepia effect is applied directly to the + When this property is set to Straight, the sepia effect is applied directly to the input values with no extra conversions.

- If AlphaMode set to Straight, input values will be unpremultiplied, then the + If AlphaMode set to Premultiplied (the default), input values will be unpremultiplied, then the sepia effect applied, and finally the result converted back to premultiplied format.

diff --git a/winrt/docsrc/effects/TableTransfer3DEffect.xml b/winrt/docsrc/effects/TableTransfer3DEffect.xml index bc6f6f9af..efcc966cd 100644 --- a/winrt/docsrc/effects/TableTransfer3DEffect.xml +++ b/winrt/docsrc/effects/TableTransfer3DEffect.xml @@ -40,16 +40,14 @@ Licensed under the MIT License. See LICENSE.txt in the project root for license Gets or sets the 3D lookup table used to transform color values. - Specifies the treatment of alpha. Default value Premultiplied. + Specifies the alpha mode of the input. Default value Premultiplied.

- Effect inputs and outputs are assumed to be in - premultiplied alpha format, so when this - property is set to Premultiplied, the transfer table is applied directly to the + When this property is set to Straight, the transfer table is applied directly to the input values with no extra conversions.

- If AlphaMode set to Straight, input values will be unpremultiplied, then the + If AlphaMode set to Premultiplied (the default), input values will be unpremultiplied, then the transfer table applied, and finally the result converted back to premultiplied format.