Skip to content
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

Jump to bottom

Fix outdated remarks/attributes about Composition support for effects #932

Open
wants to merge 2 commits into
base: uwp/main
Choose a base branch
from
Open

Fix outdated remarks/attributes about Composition support for effects #932

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
ee42d75
Fix outdated remarks/attributes about Composition support for effects
ahmed605 Sep 9, 2023
ac2dda2
Use list for CanvasComposite elements remark
ahmed605 Sep 9, 2023
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
16 changes: 9 additions & 7 deletions winrt/docsrc/CanvasDrawingSession.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -754,12 +754,14 @@ Licensed under the MIT License. See LICENSE.txt in the project root for license
<member name="T:Microsoft.Graphics.Canvas.CanvasComposite">
<summary>The composite mode used for the effect.</summary>
<remarks>
<p>The equations listed in enum descriptions use these elements:
O = Output
S = Source
SA = Source Alpha
D = Destination
DA = Destination Alpha</p>
<p>The equations listed in enum descriptions use these elements:</p>
<ul>
<li>O = Output</li>
<li>S = Source</li>
<li>SA = Source Alpha</li>
<li>D = Destination</li>
<li>DA = Destination Alpha</li>
</ul>
</remarks>
</member>
<member name="F:Microsoft.Graphics.Canvas.CanvasComposite.SourceOver">
Expand Down Expand Up @@ -796,7 +798,7 @@ Licensed under the MIT License. See LICENSE.txt in the project root for license
<member name="F:Microsoft.Graphics.Canvas.CanvasComposite.Copy">
<summary>Region of the source bitmap. Equation: O = S.</summary>
</member>
<member name="F:Microsoft.Graphics.Canvas.CanvasComposite.BoundedCopy">
<member name="F:Microsoft.Graphics.Canvas.CanvasComposite.BoundedCopy" NoComposition="true">
<summary>Union of source and destination bitmaps with no destination override.
Equation: O = S (only where source exists).</summary>
</member>
Expand Down
28 changes: 20 additions & 8 deletions winrt/docsrc/effects/BlendEffect.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -127,17 +127,29 @@ Licensed under the MIT License. See LICENSE.txt in the project root for license
<member name="F:Microsoft.Graphics.Canvas.Effects.BlendEffectMode.Exclusion">
<summary>Exclusion blend mode. <img src="../media/BlendEffectMode_Exclusion.png"/></summary>
</member>
<member name="F:Microsoft.Graphics.Canvas.Effects.BlendEffectMode.Hue" NoComposition="true">
<summary>Hue blend mode. <img src="../media/BlendEffectMode_Hue.png"/></summary>
<member name="F:Microsoft.Graphics.Canvas.Effects.BlendEffectMode.Hue">
<summary>
<p>Hue blend mode. <img src="../media/BlendEffectMode_Hue.png"/></p>
<p>This blend mode is supported by Windows.UI.Composition since Windows 10 build 18362 (May 2019 Update).</p>
</summary>
</member>
<member name="F:Microsoft.Graphics.Canvas.Effects.BlendEffectMode.Saturation" NoComposition="true">
<summary>Saturation blend mode. <img src="../media/BlendEffectMode_Saturation.png"/></summary>
<member name="F:Microsoft.Graphics.Canvas.Effects.BlendEffectMode.Saturation">
<summary>
<p>Saturation blend mode. <img src="../media/BlendEffectMode_Saturation.png"/></p>
<p>This blend mode is supported by Windows.UI.Composition since Windows 10 build 18362 (May 2019 Update).</p>
</summary>
</member>
<member name="F:Microsoft.Graphics.Canvas.Effects.BlendEffectMode.Color" NoComposition="true">
<summary>Color blend mode. <img src="../media/BlendEffectMode_Color.png"/></summary>
<member name="F:Microsoft.Graphics.Canvas.Effects.BlendEffectMode.Color">
<summary>
<p>Color blend mode. <img src="../media/BlendEffectMode_Color.png"/></p>
<p>This blend mode is supported by Windows.UI.Composition since Windows 10 build 18362 (May 2019 Update).</p>
</summary>
</member>
<member name="F:Microsoft.Graphics.Canvas.Effects.BlendEffectMode.Luminosity" NoComposition="true">
<summary>Luminosity blend mode. <img src="../media/BlendEffectMode_Luminosity.png"/></summary>
<member name="F:Microsoft.Graphics.Canvas.Effects.BlendEffectMode.Luminosity">
<summary>
<p>Luminosity blend mode. <img src="../media/BlendEffectMode_Luminosity.png"/></p>
<p>This blend mode is supported by Windows.UI.Composition since Windows 10 build 18362 (May 2019 Update).</p>
</summary>
</member>
<member name="F:Microsoft.Graphics.Canvas.Effects.BlendEffectMode.Subtract">
<summary>Subtract blend mode. <img src="../media/BlendEffectMode_Subtract.png"/></summary>
Expand Down
3 changes: 2 additions & 1 deletion winrt/docsrc/effects/LinearTransferEffect.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,11 +11,12 @@ Licensed under the MIT License. See LICENSE.txt in the project root for license
</assembly>
<members>

<member name="T:Microsoft.Graphics.Canvas.Effects.LinearTransferEffect" NoComposition="true">
<member name="T:Microsoft.Graphics.Canvas.Effects.LinearTransferEffect">
<summary>
Alters the colors of an image by applying a per-channel linear transfer function.
</summary>
<remarks>
<p>This effect is supported by Windows.UI.Composition since Windows 10 build 14393 (Anniversary Update).</p>
<p>The linear transfer function is evaluated separately for each color channel:</p>
<p>result = (input * slope) + offset</p>
<p>
Expand Down