Skip to content

Fix effect alpha mode docs #978

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 1 commit into
base: uwp/main
Choose a base branch
from
Open

Fix effect alpha mode docs #978

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 5 additions & 7 deletions winrt/docsrc/effects/ColorManagementEffect.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -52,18 +52,16 @@ Licensed under the MIT License. See LICENSE.txt in the project root for license
</remarks>
</member>
<member name="P:Microsoft.Graphics.Canvas.Effects.ColorManagementEffect.AlphaMode">
<summary>Specifies the treatment of alpha. Default value Premultiplied.</summary>
<summary>Specifies the alpha mode of the input. Default value Premultiplied.</summary>
<remarks>
<p>
Effect inputs and outputs are assumed to be in
<a href="PremultipliedAlpha.htm">premultiplied alpha</a> 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.
</p>
<p>
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).
</p>
</remarks>
</member>
Expand Down
8 changes: 3 additions & 5 deletions winrt/docsrc/effects/ColorMatrixEffect.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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.</summary>
</member>
<member name="P:Microsoft.Graphics.Canvas.Effects.ColorMatrixEffect.AlphaMode">
<summary>Specifies the treatment of alpha. Default value Premultiplied.</summary>
<summary>Specifies the alpha mode of the input. Default value Premultiplied.</summary>
<remarks>
<p>
Effect inputs and outputs are assumed to be in
<a href="PremultipliedAlpha.htm">premultiplied alpha</a> 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.
</p>
<p>
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.
</p>
Expand Down
8 changes: 3 additions & 5 deletions winrt/docsrc/effects/EdgeDetectionEffect.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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.</remarks>
</member>
<member name="P:Microsoft.Graphics.Canvas.Effects.EdgeDetectionEffect.AlphaMode">
<summary>Specifies the treatment of alpha. Default value Premultiplied.</summary>
<summary>Specifies the alpha mode of the input. Default value Premultiplied.</summary>
<remarks>
<p>
Effect inputs and outputs are assumed to be in
<a href="PremultipliedAlpha.htm">premultiplied alpha</a> 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.
</p>
<p>
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.
</p>
Expand Down
8 changes: 3 additions & 5 deletions winrt/docsrc/effects/SepiaEffect.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -34,16 +34,14 @@ Licensed under the MIT License. See LICENSE.txt in the project root for license
<summary>Intensity of the sepia effect. Default value 0.5, range 0 to 1.</summary>
</member>
<member name="P:Microsoft.Graphics.Canvas.Effects.SepiaEffect.AlphaMode">
<summary>Specifies the treatment of alpha. Default value Premultiplied.</summary>
<summary>Specifies the alpha mode of the input. Default value Premultiplied.</summary>
<remarks>
<p>
Effect inputs and outputs are assumed to be in
<a href="PremultipliedAlpha.htm">premultiplied alpha</a> 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.
</p>
<p>
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.
</p>
Expand Down
8 changes: 3 additions & 5 deletions winrt/docsrc/effects/TableTransfer3DEffect.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -40,16 +40,14 @@ Licensed under the MIT License. See LICENSE.txt in the project root for license
<summary>Gets or sets the 3D lookup table used to transform color values.</summary>
</member>
<member name="P:Microsoft.Graphics.Canvas.Effects.TableTransfer3DEffect.AlphaMode">
<summary>Specifies the treatment of alpha. Default value Premultiplied.</summary>
<summary>Specifies the alpha mode of the input. Default value Premultiplied.</summary>
<remarks>
<p>
Effect inputs and outputs are assumed to be in
<a href="PremultipliedAlpha.htm">premultiplied alpha</a> 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.
</p>
<p>
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.
</p>
Expand Down