Doc build tools have a standard mechanism for inserting [Experimental], [Win10], and [NoCompositor] tags

This commit is contained in:
Shawn Hargreaves 2015-08-10 16:09:41 -07:00
Родитель fc3bc02bef
Коммит 4d5f27abac
61 изменённых файлов: 470 добавлений и 261 удалений

Просмотреть файл

@ -171,6 +171,7 @@
<AutomatedTests>desktop</AutomatedTests>
</AnyCPUProject>
<AnyCPUProject Include="tools\docs\DocDiff\DocDiff.csproj" />
<AnyCPUProject Include="tools\docs\DocPreprocess\DocPreprocess.csproj" />
<AnyCPUProject Include="tools\docs\ExtractAPISurface\ExtractAPISurface.csproj" />
<AnyCPUProject Include="tools\docs\MergeIntellisense\MergeIntellisense.csproj" />
<AnyCPUProject Include="tools\exportsample\exportsample.csproj" />

Просмотреть файл

@ -36,6 +36,7 @@
<!-- Tools used to generate the documentation -->
<ItemGroup>
<ToolProject Include="DocDiff\DocDiff.csproj" Condition="!$(IntellisenseOnly)" />
<ToolProject Include="DocPreprocess\DocPreprocess.csproj" />
<ToolProject Include="ExtractAPISurface\ExtractAPISurface.csproj" Condition="!$(IntellisenseOnly)" />
<ToolProject Include="MergeIntellisense\MergeIntellisense.csproj" />
</ItemGroup>
@ -43,7 +44,7 @@
<!-- Master target just chains to a bunch of workers -->
<Target Name="BuildDocs"
DependsOnTargets="BuildTools; ExtractAPISurface; CompileAPISurface; DiffDocs; RunSandcastle; MergeIntellisense" />
DependsOnTargets="BuildTools; ExtractAPISurface; CompileAPISurface; DiffDocs; PreprocessDocs; RunSandcastle; MergeIntellisense" />
<!-- Build our custom tools -->
@ -91,6 +92,22 @@
</Target>
<!-- Preprocess the docsrc XML files to insert things like [Win10] tags -->
<Target Name="PreprocessDocs">
<ItemGroup>
<DocSrc Remove="@(DocSrc)" />
<DocSrc Include="%(InputAssembly.DocSrc)" />
</ItemGroup>
<PropertyGroup>
<DocPreprocessTool>$(BinariesDirectory)\WindowsAnyCPU\$(Configuration)\DocPreprocess\DocPreprocess.exe</DocPreprocessTool>
</PropertyGroup>
<Exec Command="&quot;$(DocPreprocessTool)&quot; /OutputPath:&quot;$(IntermediateOutputPath)docsrc&quot; @(DocSrc, ' ')" />
</Target>
<ItemGroup>
<NuGetRestore Include="$(MSBuildThisFileDirectory)packages.config" />
</ItemGroup>
@ -115,7 +132,7 @@
<MergeIntellisenseTool>$(BinariesDirectory)\WindowsAnyCPU\$(Configuration)\MergeIntellisense\MergeIntellisense.exe</MergeIntellisenseTool>
</PropertyGroup>
<Exec Command="&quot;$(MergeIntellisenseTool)&quot; &quot;$(BinariesDirectory)\intellisense\%(InputAssembly.Filename).xml&quot; @(DocSrc, ' ')" />
<Exec Command="&quot;$(MergeIntellisenseTool)&quot; &quot;$(BinariesDirectory)\intellisense\%(InputAssembly.Filename).xml&quot; @(DocSrc->'&quot;$(IntermediateOutputPath)docsrc\%(Filename)%(Extension)&quot;', ' ')" />
</Target>
<Import Project="$(MsBuildThisFileDirectory)..\..\build\nuget-restore.targets" />

Просмотреть файл

@ -46,9 +46,7 @@
<DocumentationSource sourceFile="$(MSBuildThisFileDirectory)..\..\obj\docs\Microsoft.Graphics.Canvas.Numerics.dll" />
<!-- Reference documentation source XML -->
<DocumentationSource sourceFile="$(MSBuildThisFileDirectory)..\..\winrt\docsrc\*.xml" />
<DocumentationSource sourceFile="$(MSBuildThisFileDirectory)..\..\winrt\docsrc\effects\*.xml" />
<DocumentationSource sourceFile="$(MSBuildThisFileDirectory)..\..\numerics\DotNet\docsrc\*.xml" />
<DocumentationSource sourceFile="$(MSBuildThisFileDirectory)..\..\obj\docs\docsrc\*.xml" />
<!-- Generated placeholder documentation linking to types on MSDN -->
<DocumentationSource sourceFile="$(MSBuildThisFileDirectory)..\..\obj\docs\Microsoft.Graphics.Canvas.placeholders.xml" />

Просмотреть файл

@ -0,0 +1,6 @@
<?xml version="1.0" encoding="utf-8" ?>
<configuration>
<startup>
<supportedRuntime version="v4.0" sku=".NETFramework,Version=v4.5" />
</startup>
</configuration>

Просмотреть файл

@ -0,0 +1,17 @@
// Copyright (c) Microsoft Corporation. All rights reserved.
//
// Licensed under the MIT License. See LICENSE.txt in the project root for license information.
using Shared;
using System.Collections.Generic;
namespace DocPreprocess
{
public class CommandLineOptions
{
[CommandLineParser.Required]
public readonly List<string> DocSrc = new List<string>();
public string OutputPath;
}
}

Просмотреть файл

@ -0,0 +1,53 @@
<?xml version="1.0" encoding="utf-8"?>
<Project ToolsVersion="12.0" DefaultTargets="Build" xmlns="http://schemas.microsoft.com/developer/msbuild/2003">
<Import Project="$(MSBuildExtensionsPath)\$(MSBuildToolsVersion)\Microsoft.Common.props" Condition="Exists('$(MSBuildExtensionsPath)\$(MSBuildToolsVersion)\Microsoft.Common.props')" />
<PropertyGroup>
<Configuration Condition=" '$(Configuration)' == '' ">Debug</Configuration>
<Platform Condition=" '$(Platform)' == '' ">AnyCPU</Platform>
<ProjectGuid>{86D8A337-C763-4E92-A3DB-70041BC92A3D}</ProjectGuid>
<OutputType>Exe</OutputType>
<AppDesignerFolder>Properties</AppDesignerFolder>
<RootNamespace>DocPreprocess</RootNamespace>
<AssemblyName>DocPreprocess</AssemblyName>
<TargetPlatformIdentifier>Windows</TargetPlatformIdentifier>
<TargetFrameworkVersion>v4.5</TargetFrameworkVersion>
<FileAlignment>512</FileAlignment>
</PropertyGroup>
<Import Project="$(MSBuildThisFileDirectory)..\..\..\build\Win2D.cs.props" />
<PropertyGroup Condition=" '$(Configuration)|$(Platform)' == 'Debug|AnyCPU' ">
<PlatformTarget>AnyCPU</PlatformTarget>
<DebugSymbols>true</DebugSymbols>
<DebugType>full</DebugType>
<Optimize>false</Optimize>
<DefineConstants>DEBUG;TRACE</DefineConstants>
<ErrorReport>prompt</ErrorReport>
</PropertyGroup>
<PropertyGroup Condition=" '$(Configuration)|$(Platform)' == 'Release|AnyCPU' ">
<PlatformTarget>AnyCPU</PlatformTarget>
<DebugType>pdbonly</DebugType>
<Optimize>true</Optimize>
<DefineConstants>TRACE</DefineConstants>
<ErrorReport>prompt</ErrorReport>
</PropertyGroup>
<ItemGroup>
<Reference Include="System" />
<Reference Include="System.Core" />
<Reference Include="Microsoft.CSharp" />
<Reference Include="System.Xml" />
<Reference Include="System.Xml.Linq" />
</ItemGroup>
<ItemGroup>
<Compile Include="..\..\shared\CommandLineParser.cs">
<Link>CommandLineParser.cs</Link>
</Compile>
<Compile Include="CommandLineOptions.cs" />
<Compile Include="Program.cs" />
<Compile Include="Properties\AssemblyInfo.cs" />
<Compile Include="Tag.cs" />
</ItemGroup>
<ItemGroup>
<None Include="App.config" />
</ItemGroup>
<Import Project="$(MSBuildToolsPath)\Microsoft.CSharp.targets" />
<Import Project="$(MSBuildThisFileDirectory)..\..\..\build\Win2D.cs.targets" />
</Project>

Просмотреть файл

@ -0,0 +1,176 @@
// Copyright (c) Microsoft Corporation. All rights reserved.
//
// Licensed under the MIT License. See LICENSE.txt in the project root for license information.
using Shared;
using System;
using System.Linq;
using System.Xml.Linq;
using System.IO;
using System.Xml;
using System.Collections.Generic;
namespace DocPreprocess
{
class Program
{
[STAThread]
static int Main(string[] args)
{
// Parse commandline options.
var options = new CommandLineOptions();
var parser = new CommandLineParser(options);
if (!parser.ParseCommandLine(args))
{
return 1;
}
// Run the program logic.
try
{
Run(options);
}
catch (Exception e)
{
Console.Error.WriteLine("Error: {0}\n\n{1}:\n{2}", e.Message, e.GetType(), e.StackTrace);
return 1;
}
return 0;
}
static void Run(CommandLineOptions options)
{
Console.WriteLine("Preprocessing documentation sources");
Directory.CreateDirectory(options.OutputPath);
foreach (var filename in options.DocSrc)
{
var doc = XDocument.Load(filename);
Preprocess(doc, filename);
string output = Path.Combine(options.OutputPath, Path.GetFileName(filename));
doc.Save(output);
}
}
static void Preprocess(XDocument doc, string filename)
{
var members = doc.Element("doc").Element("members").Elements();
foreach (var tag in Tag.Tags.Reverse())
{
ValidateNoExplicitTags(doc, filename, tag);
if (tag.PropagateTypeTagsToMembers)
{
PropagateTypeTagsToMembers(members, tag);
}
InsertTagText(members, tag);
}
}
static void ValidateNoExplicitTags(XDocument doc, string filename, Tag tag)
{
if (doc.Descendants().Any(e => e.Value.Contains(tag.Summary)))
{
Console.WriteLine("{0}: warning: docsrc contains explicit {1} tag.", filename, tag.Summary);
}
}
static void PropagateTypeTagsToMembers(IEnumerable<XElement> members, Tag tag)
{
// Find all the types (classes, structs) that have this tag.
var taggedTypes = (from member in members
where IsMemberType(member, 'T') && HasTag(member, tag)
select MemberName(member) + '.').ToList();
// Find members (methods, fields) of these types that should also be tagged.
var membersToTag = from member in members
where taggedTypes.Any(type => MemberName(member).StartsWith(type))
select member;
foreach (var member in membersToTag)
{
member.SetAttributeValue(tag.Attribute, true);
}
}
static void InsertTagText(IEnumerable<XElement> members, Tag tag)
{
foreach (var member in members.Where(e => HasTag(e, tag)))
{
// Clear the no-longer-needed attribute.
member.SetAttributeValue(tag.Attribute, null);
var summary = GetOrCreateElement(member, "summary");
var remarks = GetOrCreateElement(member, "remarks");
// If this doc entry has a plain text summary, we insert before that, but if
// it already contains <p> formatting we want to go inside the paragraph block.
var firstSummaryElement = summary.Elements().FirstOrDefault();
if (firstSummaryElement != null && firstSummaryElement.Name == "p")
{
summary = firstSummaryElement;
}
summary.AddFirst(new XElement("b", tag.Summary + " "));
remarks.AddFirst(new XElement("p", new XElement("i", tag.Description)));
}
}
static bool IsMemberType(XElement member, char memberType)
{
// Checks eg. the 'T' part of "T:Microsoft.Graphics.Canvas.Foo"
return member.Attribute("name").Value.StartsWith(memberType + ":");
}
static string MemberName(XElement member)
{
var name = member.Attribute("name").Value;
// Skip eg. the "T:" part of "T:Microsoft.Graphics.Canvas.Foo"
if (name.Length > 2 && name[1] == ':')
{
name = name.Substring(2);
}
return name;
}
static bool HasTag(XElement member, Tag tag)
{
var attribute = member.Attribute(tag.Attribute);
return attribute != null && XmlConvert.ToBoolean(attribute.Value);
}
static XElement GetOrCreateElement(XElement parent, string elementName)
{
var element = parent.Element(elementName);
if (element == null)
{
element = new XElement(elementName);
parent.Add(element);
}
return element;
}
}
}

Просмотреть файл

@ -0,0 +1,13 @@
// Copyright (c) Microsoft Corporation. All rights reserved.
//
// Licensed under the MIT License. See LICENSE.txt in the project root for license information.
using System.Reflection;
using System.Runtime.InteropServices;
[assembly: AssemblyTitle("DocPreprocess")]
[assembly: AssemblyProduct("Win2D")]
[assembly: AssemblyCompany("Microsoft Corporation")]
[assembly: AssemblyCopyright("Copyright (c) Microsoft Corporation")]
[assembly: ComVisible(false)]

Просмотреть файл

@ -0,0 +1,35 @@
// Copyright (c) Microsoft Corporation. All rights reserved.
//
// Licensed under the MIT License. See LICENSE.txt in the project root for license information.
namespace DocPreprocess
{
class Tag
{
public static readonly Tag[] Tags =
{
new Tag("Experimental", "This API is marked as [Experimental], meaning it may be subject to change in future Win2D releases.") { PropagateTypeTagsToMembers = true },
new Tag("Win10", "This API is available on Windows 10 (Universal Windows Platform) only. It is not supported on Windows 8.1 or Phone 8.1."),
new Tag("NoComposition", "Supported by Win2D but not Windows.UI.Composition."),
};
public string Attribute { get; private set; }
public string Description { get; private set; }
public bool PropagateTypeTagsToMembers { get; private set; }
public string Summary
{
get { return '[' + Attribute + ']'; }
}
Tag(string attribute, string description)
{
this.Attribute = attribute;
this.Description = description;
}
}
}

Просмотреть файл

@ -104,6 +104,7 @@ namespace MergeIntellisense
string[] tagsToStrip =
{
"a",
"b",
"img",
};

Просмотреть файл

@ -1,6 +1,6 @@
Microsoft Visual Studio Solution File, Format Version 12.00
# Visual Studio 2013
VisualStudioVersion = 12.0.31101.0
VisualStudioVersion = 12.0.40629.0
MinimumVisualStudioVersion = 10.0.40219.1
Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "codegen.exe", "codegen\exe\codegen.exe.csproj", "{984ABFAE-12D5-4929-AF2B-A733341BCCCF}"
EndProject
@ -26,6 +26,8 @@ Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "mock.test", "mock\test\mock
EndProject
Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "exportsample", "exportsample\exportsample.csproj", "{7465574A-8830-4F80-8687-E1EA17BE5918}"
EndProject
Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "DocPreprocess", "docs\DocPreprocess\DocPreprocess.csproj", "{86D8A337-C763-4E92-A3DB-70041BC92A3D}"
EndProject
Global
GlobalSection(SolutionConfigurationPlatforms) = preSolution
Debug|Any CPU = Debug|Any CPU
@ -68,6 +70,10 @@ Global
{7465574A-8830-4F80-8687-E1EA17BE5918}.Debug|Any CPU.Build.0 = Debug|Any CPU
{7465574A-8830-4F80-8687-E1EA17BE5918}.Release|Any CPU.ActiveCfg = Release|Any CPU
{7465574A-8830-4F80-8687-E1EA17BE5918}.Release|Any CPU.Build.0 = Release|Any CPU
{86D8A337-C763-4E92-A3DB-70041BC92A3D}.Debug|Any CPU.ActiveCfg = Debug|Any CPU
{86D8A337-C763-4E92-A3DB-70041BC92A3D}.Debug|Any CPU.Build.0 = Debug|Any CPU
{86D8A337-C763-4E92-A3DB-70041BC92A3D}.Release|Any CPU.ActiveCfg = Release|Any CPU
{86D8A337-C763-4E92-A3DB-70041BC92A3D}.Release|Any CPU.Build.0 = Release|Any CPU
EndGlobalSection
GlobalSection(SolutionProperties) = preSolution
HideSolutionNode = FALSE
@ -80,5 +86,6 @@ Global
{8FFF9905-A38A-477C-9097-FA5E6D9631D4} = {EA3B56C6-8B15-4191-ACC4-44A78A99A84B}
{4864078E-BB10-4A7C-86F1-30D6FD4C1832} = {A1494431-90FA-43B4-B7AA-F98166B17912}
{6FDE4A4E-DF4F-4823-B4C6-DCBD8D762D50} = {A1494431-90FA-43B4-B7AA-F98166B17912}
{86D8A337-C763-4E92-A3DB-70041BC92A3D} = {EA3B56C6-8B15-4191-ACC4-44A78A99A84B}
EndGlobalSection
EndGlobal

Просмотреть файл

@ -148,12 +148,9 @@ Licensed under the MIT License. See LICENSE.txt in the project root for license
<summary>Creates a CanvasBitmap from an array of colors, using the specified pixel width/height, DPI and alpha behavior.</summary>
</member>
<member name="M:Microsoft.Graphics.Canvas.CanvasBitmap.CreateFromSoftwareBitmap(Microsoft.Graphics.Canvas.ICanvasResourceCreator,Windows.Graphics.Imaging.SoftwareBitmap)">
<summary>[Experimental][Win10] Creates a CanvasBitmap from a SoftwareBitmap.</summary>
<member name="M:Microsoft.Graphics.Canvas.CanvasBitmap.CreateFromSoftwareBitmap(Microsoft.Graphics.Canvas.ICanvasResourceCreator,Windows.Graphics.Imaging.SoftwareBitmap)" Experimental="true" Win10="true">
<summary>Creates a CanvasBitmap from a SoftwareBitmap.</summary>
<remarks>
<p>
This API is available on Windows 10 only. It's marked as [Experimental], meaning it may be subject to change in upcoming Win2D releases.
</p>
<p>
The CanvasBitmap's Format is determined from the SoftwareBitmap's
BitmapPixelFormat property. Not all BitmapPixelFormats are supported

Просмотреть файл

@ -1018,14 +1018,11 @@ Licensed under the MIT License. See LICENSE.txt in the project root for license
<seealso cref="T:Microsoft.Graphics.Canvas.CanvasActiveLayer"/>
</member>
<member name="M:Microsoft.Graphics.Canvas.CanvasDrawingSession.DrawInk(System.Collections.Generic.IEnumerable{Windows.UI.Input.Inking.InkStroke})">
<member name="M:Microsoft.Graphics.Canvas.CanvasDrawingSession.DrawInk(System.Collections.Generic.IEnumerable{Windows.UI.Input.Inking.InkStroke})" Experimental="true" Win10="true">
<summary>
[Experimental][Win10] Draws a collection of ink strokes.
Draws a collection of ink strokes.
</summary>
<remarks>
<p>
This API is available on Windows 10 only. It's marked as [Experimental], meaning it may be subject to change in upcoming Win2D releases.
</p>
<p>
This overload reads the high-contrast accessiblity option from the
system environment.
@ -1056,14 +1053,11 @@ Licensed under the MIT License. See LICENSE.txt in the project root for license
</p>
</remarks>
</member>
<member name="M:Microsoft.Graphics.Canvas.CanvasDrawingSession.DrawInk(System.Collections.Generic.IEnumerable{Windows.UI.Input.Inking.InkStroke},System.Boolean)">
<member name="M:Microsoft.Graphics.Canvas.CanvasDrawingSession.DrawInk(System.Collections.Generic.IEnumerable{Windows.UI.Input.Inking.InkStroke},System.Boolean)" Experimental="true" Win10="true">
<summary>
[Experimental][Win10] Draws a collection of ink strokes.
Draws a collection of ink strokes.
</summary>
<remarks>
<p>
This API is available on Windows 10 only. It's marked as [Experimental], meaning it may be subject to change in upcoming Win2D releases.
</p>
<p>
This overload allows an app to use an arbitrary high-contrast
accessibility option, which may be different from the one

Просмотреть файл

@ -11,10 +11,9 @@ Licensed under the MIT License. See LICENSE.txt in the project root for license
</assembly>
<members>
<member name="T:Microsoft.Graphics.Canvas.Effects.AtlasEffect">
<member name="T:Microsoft.Graphics.Canvas.Effects.AtlasEffect" NoComposition="true">
<summary>
<p>Outputs a specified region from an atlas bitmap.</p>
<p><i>Supported by Win2D but not Windows.UI.Composition.</i></p>
Outputs a specified region from an atlas bitmap.
</summary>
<remarks>
<p>

Просмотреть файл

@ -77,11 +77,8 @@ Licensed under the MIT License. See LICENSE.txt in the project root for license
<member name="F:Microsoft.Graphics.Canvas.Effects.BlendEffectMode.Lighten">
<summary>Lighten blend mode. <img src="../media/BlendEffectMode_Lighten.png"/></summary>
</member>
<member name="F:Microsoft.Graphics.Canvas.Effects.BlendEffectMode.Dissolve">
<summary>
<p>Dissolve blend mode. <img src="../media/BlendEffectMode_Dissolve.png"/></p>
<p><i>Supported by Win2D but not Windows.UI.Composition.</i></p>
</summary>
<member name="F:Microsoft.Graphics.Canvas.Effects.BlendEffectMode.Dissolve" NoComposition="true">
<summary>Dissolve blend mode. <img src="../media/BlendEffectMode_Dissolve.png"/></summary>
</member>
<member name="F:Microsoft.Graphics.Canvas.Effects.BlendEffectMode.ColorBurn">
<summary>Color burn blend mode. <img src="../media/BlendEffectMode_ColorBurn.png"/></summary>
@ -128,29 +125,17 @@ 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">
<summary>
<p>Hue blend mode. <img src="../media/BlendEffectMode_Hue.png"/></p>
<p><i>Supported by Win2D but not Windows.UI.Composition.</i></p>
</summary>
<member name="F:Microsoft.Graphics.Canvas.Effects.BlendEffectMode.Hue" NoComposition="true">
<summary>Hue blend mode. <img src="../media/BlendEffectMode_Hue.png"/></summary>
</member>
<member name="F:Microsoft.Graphics.Canvas.Effects.BlendEffectMode.Saturation">
<summary>
<p>Saturation blend mode. <img src="../media/BlendEffectMode_Saturation.png"/></p>
<p><i>Supported by Win2D but not Windows.UI.Composition.</i></p>
</summary>
<member name="F:Microsoft.Graphics.Canvas.Effects.BlendEffectMode.Saturation" NoComposition="true">
<summary>Saturation blend mode. <img src="../media/BlendEffectMode_Saturation.png"/></summary>
</member>
<member name="F:Microsoft.Graphics.Canvas.Effects.BlendEffectMode.Color">
<summary>
<p>Color blend mode. <img src="../media/BlendEffectMode_Color.png"/></p>
<p><i>Supported by Win2D but not Windows.UI.Composition.</i></p>
</summary>
<member name="F:Microsoft.Graphics.Canvas.Effects.BlendEffectMode.Color" NoComposition="true">
<summary>Color blend mode. <img src="../media/BlendEffectMode_Color.png"/></summary>
</member>
<member name="F:Microsoft.Graphics.Canvas.Effects.BlendEffectMode.Luminosity">
<summary>
<p>Luminosity blend mode. <img src="../media/BlendEffectMode_Luminosity.png"/></p>
<p><i>Supported by Win2D but not Windows.UI.Composition.</i></p>
</summary>
<member name="F:Microsoft.Graphics.Canvas.Effects.BlendEffectMode.Luminosity" NoComposition="true">
<summary>Luminosity blend mode. <img src="../media/BlendEffectMode_Luminosity.png"/></summary>
</member>
<member name="F:Microsoft.Graphics.Canvas.Effects.BlendEffectMode.Subtract">
<summary>Subtract blend mode. <img src="../media/BlendEffectMode_Subtract.png"/></summary>

Просмотреть файл

@ -11,14 +11,11 @@ Licensed under the MIT License. See LICENSE.txt in the project root for license
</assembly>
<members>
<member name="T:Microsoft.Graphics.Canvas.Effects.BorderEffect">
<member name="T:Microsoft.Graphics.Canvas.Effects.BorderEffect" NoComposition="true">
<summary>
<p>
Extends an image to infinite size, specifying whether areas beyond its original
extents are filled by repeating pixels from the edges of the image,
wrapping pixels from the opposite edge of the image, or mirroring the image.
</p>
<p><i>Supported by Win2D but not Windows.UI.Composition.</i></p>
Extends an image to infinite size, specifying whether areas beyond its original
extents are filled by repeating pixels from the edges of the image,
wrapping pixels from the opposite edge of the image, or mirroring the image.
</summary>
<remarks>
<p>This Windows Runtime type corresponds to the

Просмотреть файл

@ -11,10 +11,9 @@ Licensed under the MIT License. See LICENSE.txt in the project root for license
</assembly>
<members>
<member name="T:Microsoft.Graphics.Canvas.Effects.BrightnessEffect">
<member name="T:Microsoft.Graphics.Canvas.Effects.BrightnessEffect" NoComposition="true">
<summary>
<p>Alters the brightness of an image.</p>
<p><i>Supported by Win2D but not Windows.UI.Composition.</i></p>
Alters the brightness of an image.
</summary>
<remarks>
<p>This Windows Runtime type corresponds to the

Просмотреть файл

@ -12,11 +12,9 @@ Licensed under the MIT License. See LICENSE.txt in the project root for license
<members>
<member name="T:Microsoft.Graphics.Canvas.Effects.ChromaKeyEffect">
<member name="T:Microsoft.Graphics.Canvas.Effects.ChromaKeyEffect" Win10="true" NoComposition="true">
<summary>
<p>Replaces a specified color with transparency.</p>
<p><i>This effect is new in the Universal Windows Platform. It is not supported on Windows 8.1 or Phone 8.1.</i></p>
<p><i>Supported by Win2D but not Windows.UI.Composition.</i></p>
Replaces a specified color with transparency.
</summary>
<remarks>
<p>Chroma keying is a more general purpose version of the green screen technique

Просмотреть файл

@ -11,10 +11,9 @@ Licensed under the MIT License. See LICENSE.txt in the project root for license
</assembly>
<members>
<member name="T:Microsoft.Graphics.Canvas.Effects.ColorMatrixEffect">
<member name="T:Microsoft.Graphics.Canvas.Effects.ColorMatrixEffect" NoComposition="true">
<summary>
<p>Alters the colors of an image by applying a 5x4 transform matrix.</p>
<p><i>Supported by Win2D but not Windows.UI.Composition.</i></p>
Alters the colors of an image by applying a 5x4 transform matrix.
</summary>
<remarks>
<p>

Просмотреть файл

@ -12,11 +12,9 @@ Licensed under the MIT License. See LICENSE.txt in the project root for license
<members>
<member name="T:Microsoft.Graphics.Canvas.Effects.ContrastEffect">
<member name="T:Microsoft.Graphics.Canvas.Effects.ContrastEffect" Win10="true" NoComposition="true">
<summary>
<p>Increases or decreases the contrast of an image.</p>
<p><i>This effect is new in the Universal Windows Platform. It is not supported on Windows 8.1 or Phone 8.1.</i></p>
<p><i>Supported by Win2D but not Windows.UI.Composition.</i></p>
Increases or decreases the contrast of an image.
</summary>
<remarks>
<p>The contrast function modifies each color channel value using two piecewise

Просмотреть файл

@ -11,13 +11,10 @@ Licensed under the MIT License. See LICENSE.txt in the project root for license
</assembly>
<members>
<member name="T:Microsoft.Graphics.Canvas.Effects.ConvolveMatrixEffect">
<member name="T:Microsoft.Graphics.Canvas.Effects.ConvolveMatrixEffect" NoComposition="true">
<summary>
<p>
Applies an arbitrary 2D filter kernel to an image.
This can perform operations such as edge detect, emboss, sharpen, or blur.
</p>
<p><i>Supported by Win2D but not Windows.UI.Composition.</i></p>
Applies an arbitrary 2D filter kernel to an image.
This can perform operations such as edge detect, emboss, sharpen, or blur.
</summary>
<remarks>
<p>

Просмотреть файл

@ -11,10 +11,9 @@ Licensed under the MIT License. See LICENSE.txt in the project root for license
</assembly>
<members>
<member name="T:Microsoft.Graphics.Canvas.Effects.CropEffect">
<member name="T:Microsoft.Graphics.Canvas.Effects.CropEffect" NoComposition="true">
<summary>
<p>Crops an image, outputting only a specified region.</p>
<p><i>Supported by Win2D but not Windows.UI.Composition.</i></p>
Crops an image, outputting only a specified region.
</summary>
<remarks>
<p>

Просмотреть файл

@ -11,14 +11,11 @@ Licensed under the MIT License. See LICENSE.txt in the project root for license
</assembly>
<members>
<member name="T:Microsoft.Graphics.Canvas.Effects.DirectionalBlurEffect">
<member name="T:Microsoft.Graphics.Canvas.Effects.DirectionalBlurEffect" NoComposition="true">
<summary>
<p>
Blurs an image in a particular direction.
You can use this effect to make an image look as if
it is in motion or to emphasize an animated image.
</p>
<p><i>Supported by Win2D but not Windows.UI.Composition.</i></p>
Blurs an image in a particular direction.
You can use this effect to make an image look as if
it is in motion or to emphasize an animated image.
</summary>
<remarks>
<p>This Windows Runtime type corresponds to the

Просмотреть файл

@ -11,10 +11,9 @@ Licensed under the MIT License. See LICENSE.txt in the project root for license
</assembly>
<members>
<member name="T:Microsoft.Graphics.Canvas.Effects.DiscreteTransferEffect">
<member name="T:Microsoft.Graphics.Canvas.Effects.DiscreteTransferEffect" NoComposition="true">
<summary>
<p>Alters the colors of an image using a quantized transfer function defined by an arbitrary lookup table.</p>
<p><i>Supported by Win2D but not Windows.UI.Composition.</i></p>
Alters the colors of an image using a quantized transfer function defined by an arbitrary lookup table.
</summary>
<remarks>
<p>

Просмотреть файл

@ -11,10 +11,9 @@ Licensed under the MIT License. See LICENSE.txt in the project root for license
</assembly>
<members>
<member name="T:Microsoft.Graphics.Canvas.Effects.DisplacementMapEffect">
<member name="T:Microsoft.Graphics.Canvas.Effects.DisplacementMapEffect" NoComposition="true">
<summary>
<p>Displaces the pixels of an input image by the intensity values of a second image.</p>
<p><i>Supported by Win2D but not Windows.UI.Composition.</i></p>
Displaces the pixels of an input image by the intensity values of a second image.
</summary>
<remarks>
<p>The locations of the pixels in the output are determined using this formula:</p>

Просмотреть файл

@ -11,14 +11,11 @@ Licensed under the MIT License. See LICENSE.txt in the project root for license
</assembly>
<members>
<member name="T:Microsoft.Graphics.Canvas.Effects.DistantDiffuseEffect">
<member name="T:Microsoft.Graphics.Canvas.Effects.DistantDiffuseEffect" NoComposition="true">
<summary>
<p>
Lighting effect creates an image that appears to be an illuminated non-reflective
surface. This effect uses the alpha channel as a height map, and lights it with
an infinitely distant light source (such as the sun).
</p>
<p><i>Supported by Win2D but not Windows.UI.Composition.</i></p>
Lighting effect creates an image that appears to be an illuminated non-reflective
surface. This effect uses the alpha channel as a height map, and lights it with
an infinitely distant light source (such as the sun).
</summary>
<remarks>
<p>This Windows Runtime type corresponds to the

Просмотреть файл

@ -11,15 +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.DistantSpecularEffect">
<member name="T:Microsoft.Graphics.Canvas.Effects.DistantSpecularEffect" NoComposition="true">
<summary>
<p>
Lighting effect creates an image that appears to be a reflective surface. This
effect uses the alpha channel as a height map, and lights it with an infinitely
distant light source (such as the sun) applying the specular portion of the Phong
lighting model.
</p>
<p><i>Supported by Win2D but not Windows.UI.Composition.</i></p>
Lighting effect creates an image that appears to be a reflective surface. This
effect uses the alpha channel as a height map, and lights it with an infinitely
distant light source (such as the sun) applying the specular portion of the Phong
lighting model.
</summary>
<remarks>
<p>This Windows Runtime type corresponds to the

Просмотреть файл

@ -11,13 +11,10 @@ Licensed under the MIT License. See LICENSE.txt in the project root for license
</assembly>
<members>
<member name="T:Microsoft.Graphics.Canvas.Effects.DpiCompensationEffect">
<member name="T:Microsoft.Graphics.Canvas.Effects.DpiCompensationEffect" NoComposition="true">
<summary>
<p>
Scales an input bitmap to match a different DPI. This is useful for situations
where a bitmap is created or loaded at a different DPI than the screen.
</p>
<p><i>Supported by Win2D but not Windows.UI.Composition.</i></p>
Scales an input bitmap to match a different DPI. This is useful for situations
where a bitmap is created or loaded at a different DPI than the screen.
</summary>
<remarks>
<p>This Windows Runtime type corresponds to the

Просмотреть файл

@ -12,11 +12,9 @@ Licensed under the MIT License. See LICENSE.txt in the project root for license
<members>
<member name="T:Microsoft.Graphics.Canvas.Effects.EdgeDetectionEffect">
<member name="T:Microsoft.Graphics.Canvas.Effects.EdgeDetectionEffect" Win10="true" NoComposition="true">
<summary>
<p>Filters out the content of an image leaving lines at the edges of contrasting sections.</p>
<p><i>This effect is new in the Universal Windows Platform. It is not supported on Windows 8.1 or Phone 8.1.</i></p>
<p><i>Supported by Win2D but not Windows.UI.Composition.</i></p>
Filters out the content of an image leaving lines at the edges of contrasting sections.
</summary>
<remarks>
<p>This Windows Runtime type corresponds to the
@ -84,10 +82,9 @@ Licensed under the MIT License. See LICENSE.txt in the project root for license
</remarks>
</member>
<member name="T:Microsoft.Graphics.Canvas.Effects.EdgeDetectionEffectMode">
<member name="T:Microsoft.Graphics.Canvas.Effects.EdgeDetectionEffectMode" Win10="true">
<summary>
<p>Specifies what type of filter kernel to use for edge detection.</p>
<p><i>This enum is new in the Universal Windows Platform. It is not supported on Windows 8.1 or Phone 8.1.</i></p>
</summary>
</member>
<member name="F:Microsoft.Graphics.Canvas.Effects.EdgeDetectionEffectMode.Sobel">

Просмотреть файл

@ -12,11 +12,9 @@ Licensed under the MIT License. See LICENSE.txt in the project root for license
<members>
<member name="T:Microsoft.Graphics.Canvas.Effects.EmbossEffect">
<member name="T:Microsoft.Graphics.Canvas.Effects.EmbossEffect" Win10="true" NoComposition="true">
<summary>
<p>Creates a grayscale version of an image that appears as though it has been stamped into paper.</p>
<p><i>This effect is new in the Universal Windows Platform. It is not supported on Windows 8.1 or Phone 8.1.</i></p>
<p><i>Supported by Win2D but not Windows.UI.Composition.</i></p>
Creates a grayscale version of an image that appears as though it has been stamped into paper.
</summary>
<remarks>
<p>This Windows Runtime type corresponds to the

Просмотреть файл

@ -12,11 +12,9 @@ Licensed under the MIT License. See LICENSE.txt in the project root for license
<members>
<member name="T:Microsoft.Graphics.Canvas.Effects.ExposureEffect">
<member name="T:Microsoft.Graphics.Canvas.Effects.ExposureEffect" Win10="true" NoComposition="true">
<summary>
<p>Increases or decreases the exposure of an image.</p>
<p><i>This effect is new in the Universal Windows Platform. It is not supported on Windows 8.1 or Phone 8.1.</i></p>
<p><i>Supported by Win2D but not Windows.UI.Composition.</i></p>
Increases or decreases the exposure of an image.
</summary>
<remarks>
<p>This Windows Runtime type corresponds to the

Просмотреть файл

@ -11,10 +11,9 @@ Licensed under the MIT License. See LICENSE.txt in the project root for license
</assembly>
<members>
<member name="T:Microsoft.Graphics.Canvas.Effects.GammaTransferEffect">
<member name="T:Microsoft.Graphics.Canvas.Effects.GammaTransferEffect" NoComposition="true">
<summary>
<p>Alters the colors of an image by applying a per-channel gamma transfer function.</p>
<p><i>Supported by Win2D but not Windows.UI.Composition.</i></p>
Alters the colors of an image by applying a per-channel gamma transfer function.
</summary>
<remarks>
<p>The gamma transfer function is evaluated separately for each color channel:</p>

Просмотреть файл

@ -11,10 +11,9 @@ Licensed under the MIT License. See LICENSE.txt in the project root for license
</assembly>
<members>
<member name="T:Microsoft.Graphics.Canvas.Effects.GaussianBlurEffect">
<member name="T:Microsoft.Graphics.Canvas.Effects.GaussianBlurEffect" NoComposition="true">
<summary>
<p>Creates a blur effect based on the Gaussian function over the entire input image.</p>
<p><i>Supported by Win2D but not Windows.UI.Composition.</i></p>
Creates a blur effect based on the Gaussian function over the entire input image.
</summary>
<remarks>
<example>

Просмотреть файл

@ -12,11 +12,9 @@ Licensed under the MIT License. See LICENSE.txt in the project root for license
<members>
<member name="T:Microsoft.Graphics.Canvas.Effects.GrayscaleEffect">
<member name="T:Microsoft.Graphics.Canvas.Effects.GrayscaleEffect" Win10="true" NoComposition="true">
<summary>
<p>Converts an image to monochromatic gray.</p>
<p><i>This effect is new in the Universal Windows Platform. It is not supported on Windows 8.1 or Phone 8.1.</i></p>
<p><i>Supported by Win2D but not Windows.UI.Composition.</i></p>
Converts an image to monochromatic gray.
</summary>
<remarks>
<p>

Просмотреть файл

@ -12,11 +12,9 @@ Licensed under the MIT License. See LICENSE.txt in the project root for license
<members>
<member name="T:Microsoft.Graphics.Canvas.Effects.HighlightsAndShadowsEffect">
<member name="T:Microsoft.Graphics.Canvas.Effects.HighlightsAndShadowsEffect" Win10="true" NoComposition="true">
<summary>
<p>Adjusts the highlights and shadows of an image.</p>
<p><i>This effect is new in the Universal Windows Platform. It is not supported on Windows 8.1 or Phone 8.1.</i></p>
<p><i>Supported by Win2D but not Windows.UI.Composition.</i></p>
Adjusts the highlights and shadows of an image.
</summary>
<remarks>
<p>This Windows Runtime type corresponds to the

Просмотреть файл

@ -11,10 +11,9 @@ Licensed under the MIT License. See LICENSE.txt in the project root for license
</assembly>
<members>
<member name="T:Microsoft.Graphics.Canvas.Effects.HueRotationEffect">
<member name="T:Microsoft.Graphics.Canvas.Effects.HueRotationEffect" NoComposition="true">
<summary>
<p>Alters the color of an image by rotating its hue values.</p>
<p><i>Supported by Win2D but not Windows.UI.Composition.</i></p>
Alters the color of an image by rotating its hue values.
</summary>
<remarks>
<p>

Просмотреть файл

@ -12,11 +12,9 @@ Licensed under the MIT License. See LICENSE.txt in the project root for license
<members>
<member name="T:Microsoft.Graphics.Canvas.Effects.HueToRgbEffect">
<member name="T:Microsoft.Graphics.Canvas.Effects.HueToRgbEffect" Win10="true" NoComposition="true">
<summary>
<p>Converts an HSV (hue, saturation, value) or HSL (hue, saturation, lightness) image to RGB color space.</p>
<p><i>This effect is new in the Universal Windows Platform. It is not supported on Windows 8.1 or Phone 8.1.</i></p>
<p><i>Supported by Win2D but not Windows.UI.Composition.</i></p>
Converts an HSV (hue, saturation, value) or HSL (hue, saturation, lightness) image to RGB color space.
</summary>
<remarks>
<p>
@ -68,12 +66,11 @@ Licensed under the MIT License. See LICENSE.txt in the project root for license
Default value <see cref="F:Microsoft.Graphics.Canvas.Effects.EffectHueColorSpace.Hsv"/>.</summary>
</member>
<member name="T:Microsoft.Graphics.Canvas.Effects.EffectHueColorSpace">
<member name="T:Microsoft.Graphics.Canvas.Effects.EffectHueColorSpace" Win10="true">
<summary>
<p>Specifies the color space used by
<see cref="T:Microsoft.Graphics.Canvas.Effects.HueToRgbEffect"/> and
<see cref="T:Microsoft.Graphics.Canvas.Effects.RgbToHueEffect"/>.</p>
<p><i>This enum is new in the Universal Windows Platform. It is not supported on Windows 8.1 or Phone 8.1.</i></p>
</summary>
</member>
<member name="F:Microsoft.Graphics.Canvas.Effects.EffectHueColorSpace.Hsv">

Просмотреть файл

@ -12,11 +12,9 @@ Licensed under the MIT License. See LICENSE.txt in the project root for license
<members>
<member name="T:Microsoft.Graphics.Canvas.Effects.InvertEffect">
<member name="T:Microsoft.Graphics.Canvas.Effects.InvertEffect" Win10="true" NoComposition="true">
<summary>
<p>Inverts the colors of an image.</p>
<p><i>This effect is new in the Universal Windows Platform. It is not supported on Windows 8.1 or Phone 8.1.</i></p>
<p><i>Supported by Win2D but not Windows.UI.Composition.</i></p>
Inverts the colors of an image.
</summary>
<remarks>
<p>

Просмотреть файл

@ -11,10 +11,9 @@ Licensed under the MIT License. See LICENSE.txt in the project root for license
</assembly>
<members>
<member name="T:Microsoft.Graphics.Canvas.Effects.LinearTransferEffect">
<member name="T:Microsoft.Graphics.Canvas.Effects.LinearTransferEffect" NoComposition="true">
<summary>
<p>Alters the colors of an image by applying a per-channel linear transfer function.</p>
<p><i>Supported by Win2D but not Windows.UI.Composition.</i></p>
Alters the colors of an image by applying a per-channel linear transfer function.
</summary>
<remarks>
<p>The linear transfer function is evaluated separately for each color channel:</p>

Просмотреть файл

@ -11,14 +11,11 @@ Licensed under the MIT License. See LICENSE.txt in the project root for license
</assembly>
<members>
<member name="T:Microsoft.Graphics.Canvas.Effects.LuminanceToAlphaEffect">
<member name="T:Microsoft.Graphics.Canvas.Effects.LuminanceToAlphaEffect" NoComposition="true">
<summary>
<p>
Generates an image with alpha channel set to the luminance of the source image, and
color channels set to 0. Use it to make a semitransparent overlay based on the
brightness of the source image.
</p>
<p><i>Supported by Win2D but not Windows.UI.Composition.</i></p>
Generates an image with alpha channel set to the luminance of the source image, and
color channels set to 0. Use it to make a semitransparent overlay based on the
brightness of the source image.
</summary>
<remarks>
<p>

Просмотреть файл

@ -11,15 +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.MorphologyEffect">
<member name="T:Microsoft.Graphics.Canvas.Effects.MorphologyEffect" NoComposition="true">
<summary>
<p>
Thins or thickens edge boundaries in an image. This effect uses a filter kernel
that is 2 times the size you specify. The kernel is centered on the pixel being
calculated, and returns the maximum value in the kernel (if dilating) or minimum
value (if eroding).
</p>
<p><i>Supported by Win2D but not Windows.UI.Composition.</i></p>
Thins or thickens edge boundaries in an image. This effect uses a filter kernel
that is 2 times the size you specify. The kernel is centered on the pixel being
calculated, and returns the maximum value in the kernel (if dilating) or minimum
value (if eroding).
</summary>
<remarks>
<p>This Windows Runtime type corresponds to the

Просмотреть файл

@ -11,10 +11,9 @@ Licensed under the MIT License. See LICENSE.txt in the project root for license
</assembly>
<members>
<member name="T:Microsoft.Graphics.Canvas.Effects.OpacityMetadataEffect">
<member name="T:Microsoft.Graphics.Canvas.Effects.OpacityMetadataEffect" NoComposition="true">
<summary>
<p>Marks an area of an input image as opaque, which can enable internal rendering optimizations.</p>
<p><i>Supported by Win2D but not Windows.UI.Composition.</i></p>
Marks an area of an input image as opaque, which can enable internal rendering optimizations.
</summary>
<remarks>
<p>Note: this effect doesn't modify the image itself to be opaque.

Просмотреть файл

@ -11,14 +11,11 @@ Licensed under the MIT License. See LICENSE.txt in the project root for license
</assembly>
<members>
<member name="T:Microsoft.Graphics.Canvas.Effects.PointDiffuseEffect">
<member name="T:Microsoft.Graphics.Canvas.Effects.PointDiffuseEffect" NoComposition="true">
<summary>
<p>
Lighting effect creates an image that appears to be an illuminated non-reflective
surface. This effect uses the alpha channel as a height map, and lights it with a
point light source.
</p>
<p><i>Supported by Win2D but not Windows.UI.Composition.</i></p>
Lighting effect creates an image that appears to be an illuminated non-reflective
surface. This effect uses the alpha channel as a height map, and lights it with a
point light source.
</summary>
<remarks>
<p>This Windows Runtime type corresponds to the

Просмотреть файл

@ -11,14 +11,11 @@ Licensed under the MIT License. See LICENSE.txt in the project root for license
</assembly>
<members>
<member name="T:Microsoft.Graphics.Canvas.Effects.PointSpecularEffect">
<member name="T:Microsoft.Graphics.Canvas.Effects.PointSpecularEffect" NoComposition="true">
<summary>
<p>
Lighting effect creates an image that appears to be a reflective surface. This
effect uses the alpha channel as a height map, and lights it with a point light
source applying the specular portion of the Phong lighting model.
</p>
<p><i>Supported by Win2D but not Windows.UI.Composition.</i></p>
Lighting effect creates an image that appears to be a reflective surface. This
effect uses the alpha channel as a height map, and lights it with a point light
source applying the specular portion of the Phong lighting model.
</summary>
<remarks>
<p>This Windows Runtime type corresponds to the

Просмотреть файл

@ -12,11 +12,9 @@ Licensed under the MIT License. See LICENSE.txt in the project root for license
<members>
<member name="T:Microsoft.Graphics.Canvas.Effects.PosterizeEffect">
<member name="T:Microsoft.Graphics.Canvas.Effects.PosterizeEffect" Win10="true" NoComposition="true">
<summary>
<p>Reduces the number of unique colors in an image.</p>
<p><i>This effect is new in the Universal Windows Platform. It is not supported on Windows 8.1 or Phone 8.1.</i></p>
<p><i>Supported by Win2D but not Windows.UI.Composition.</i></p>
Reduces the number of unique colors in an image.
</summary>
<remarks>
<p>This Windows Runtime type corresponds to the

Просмотреть файл

@ -11,10 +11,9 @@ Licensed under the MIT License. See LICENSE.txt in the project root for license
</assembly>
<members>
<member name="T:Microsoft.Graphics.Canvas.Effects.PremultiplyEffect">
<member name="T:Microsoft.Graphics.Canvas.Effects.PremultiplyEffect" NoComposition="true">
<summary>
<p>Converts an image from unpremultiplied to premultiplied alpha format.</p>
<p><i>Supported by Win2D but not Windows.UI.Composition.</i></p>
Converts an image from unpremultiplied to premultiplied alpha format.
</summary>
<remarks>
<p>This Windows Runtime type corresponds to the

Просмотреть файл

@ -12,11 +12,9 @@ Licensed under the MIT License. See LICENSE.txt in the project root for license
<members>
<member name="T:Microsoft.Graphics.Canvas.Effects.RgbToHueEffect">
<member name="T:Microsoft.Graphics.Canvas.Effects.RgbToHueEffect" Win10="true" NoComposition="true">
<summary>
<p>Converts an RGB image to HSV (hue, saturation, value) or HSL (hue, saturation, lightness) color space.</p>
<p><i>This effect is new in the Universal Windows Platform. It is not supported on Windows 8.1 or Phone 8.1.</i></p>
<p><i>Supported by Win2D but not Windows.UI.Composition.</i></p>
Converts an RGB image to HSV (hue, saturation, value) or HSL (hue, saturation, lightness) color space.
</summary>
<remarks>
<p>

Просмотреть файл

@ -11,10 +11,9 @@ Licensed under the MIT License. See LICENSE.txt in the project root for license
</assembly>
<members>
<member name="T:Microsoft.Graphics.Canvas.Effects.ScaleEffect">
<member name="T:Microsoft.Graphics.Canvas.Effects.ScaleEffect" NoComposition="true">
<summary>
<p>Resizes an image.</p>
<p><i>Supported by Win2D but not Windows.UI.Composition.</i></p>
Resizes an image.
</summary>
<remarks>
<p>This Windows Runtime type corresponds to the

Просмотреть файл

@ -12,11 +12,9 @@ Licensed under the MIT License. See LICENSE.txt in the project root for license
<members>
<member name="T:Microsoft.Graphics.Canvas.Effects.SepiaEffect">
<member name="T:Microsoft.Graphics.Canvas.Effects.SepiaEffect" Win10="true" NoComposition="true">
<summary>
<p>Converts an image to sepia tones.</p>
<p><i>This effect is new in the Universal Windows Platform. It is not supported on Windows 8.1 or Phone 8.1.</i></p>
<p><i>Supported by Win2D but not Windows.UI.Composition.</i></p>
Converts an image to sepia tones.
</summary>
<remarks>
<p>This Windows Runtime type corresponds to the

Просмотреть файл

@ -11,14 +11,11 @@ Licensed under the MIT License. See LICENSE.txt in the project root for license
</assembly>
<members>
<member name="T:Microsoft.Graphics.Canvas.Effects.ShadowEffect">
<member name="T:Microsoft.Graphics.Canvas.Effects.ShadowEffect" NoComposition="true">
<summary>
<p>
Generates a shadow from the alpha channel of an image. The shadow is more
opaque for higher alpha values and more transparent for lower alpha
values. You can set the amount of blur and the color of the shadow.
</p>
<p><i>Supported by Win2D but not Windows.UI.Composition.</i></p>
Generates a shadow from the alpha channel of an image. The shadow is more
opaque for higher alpha values and more transparent for lower alpha
values. You can set the amount of blur and the color of the shadow.
</summary>
<remarks>
<p>

Просмотреть файл

@ -12,11 +12,9 @@ Licensed under the MIT License. See LICENSE.txt in the project root for license
<members>
<member name="T:Microsoft.Graphics.Canvas.Effects.SharpenEffect">
<member name="T:Microsoft.Graphics.Canvas.Effects.SharpenEffect" Win10="true" NoComposition="true">
<summary>
<p>Sharpens the image.</p>
<p><i>This effect is new in the Universal Windows Platform. It is not supported on Windows 8.1 or Phone 8.1.</i></p>
<p><i>Supported by Win2D but not Windows.UI.Composition.</i></p>
Sharpens the image.
</summary>
<remarks>
<p>This Windows Runtime type corresponds to the

Просмотреть файл

@ -11,15 +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.SpotDiffuseEffect">
<member name="T:Microsoft.Graphics.Canvas.Effects.SpotDiffuseEffect" NoComposition="true">
<summary>
<p>
Lighting effect creates an image that appears to be an illuminated non-reflective
surface where the light source is limited to a directed cone of light. This
effect uses the alpha channel as a height map, and lights it with a point light
source.
</p>
<p><i>Supported by Win2D but not Windows.UI.Composition.</i></p>
Lighting effect creates an image that appears to be an illuminated non-reflective
surface where the light source is limited to a directed cone of light. This
effect uses the alpha channel as a height map, and lights it with a point light
source.
</summary>
<remarks>
<p>This Windows Runtime type corresponds to the

Просмотреть файл

@ -11,15 +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.SpotSpecularEffect">
<member name="T:Microsoft.Graphics.Canvas.Effects.SpotSpecularEffect" NoComposition="true">
<summary>
<p>
Lighting effect creates an image that appears to be a reflective surface where
the light source is limited to a directed cone of light. This effect uses the
alpha channel as a height map, and lights it with a point light source applying
the specular portion of the Phong lighting model.
</p>
<p><i>Supported by Win2D but not Windows.UI.Composition.</i></p>
Lighting effect creates an image that appears to be a reflective surface where
the light source is limited to a directed cone of light. This effect uses the
alpha channel as a height map, and lights it with a point light source applying
the specular portion of the Phong lighting model.
</summary>
<remarks>
<p>This Windows Runtime type corresponds to the

Просмотреть файл

@ -12,11 +12,9 @@ Licensed under the MIT License. See LICENSE.txt in the project root for license
<members>
<member name="T:Microsoft.Graphics.Canvas.Effects.StraightenEffect">
<member name="T:Microsoft.Graphics.Canvas.Effects.StraightenEffect" Win10="true" NoComposition="true">
<summary>
<p>Rotates and optionally scales an image.</p>
<p><i>This effect is new in the Universal Windows Platform. It is not supported on Windows 8.1 or Phone 8.1.</i></p>
<p><i>Supported by Win2D but not Windows.UI.Composition.</i></p>
Rotates and optionally scales an image.
</summary>
<remarks>
<p>This effect is useful for correcting photos that were taken at an angle so their horizon is not quite horizontal.</p>

Просмотреть файл

@ -11,10 +11,9 @@ Licensed under the MIT License. See LICENSE.txt in the project root for license
</assembly>
<members>
<member name="T:Microsoft.Graphics.Canvas.Effects.TableTransferEffect">
<member name="T:Microsoft.Graphics.Canvas.Effects.TableTransferEffect" NoComposition="true">
<summary>
<p>Alters the colors of an image using a transfer function defined by an arbitrary lookup table.</p>
<p><i>Supported by Win2D but not Windows.UI.Composition.</i></p>
Alters the colors of an image using a transfer function defined by an arbitrary lookup table.
</summary>
<remarks>
<p>

Просмотреть файл

@ -12,11 +12,9 @@ Licensed under the MIT License. See LICENSE.txt in the project root for license
<members>
<member name="T:Microsoft.Graphics.Canvas.Effects.TemperatureAndTintEffect">
<member name="T:Microsoft.Graphics.Canvas.Effects.TemperatureAndTintEffect" Win10="true" NoComposition="true">
<summary>
<p>Adjusts the temperature and/or tint of an image.</p>
<p><i>This effect is new in the Universal Windows Platform. It is not supported on Windows 8.1 or Phone 8.1.</i></p>
<p><i>Supported by Win2D but not Windows.UI.Composition.</i></p>
Adjusts the temperature and/or tint of an image.
</summary>
<remarks>
<p>This Windows Runtime type corresponds to the

Просмотреть файл

@ -11,10 +11,9 @@ Licensed under the MIT License. See LICENSE.txt in the project root for license
</assembly>
<members>
<member name="T:Microsoft.Graphics.Canvas.Effects.TileEffect">
<member name="T:Microsoft.Graphics.Canvas.Effects.TileEffect" NoComposition="true">
<summary>
<p>Repeats the specified region of an image.</p>
<p><i>Supported by Win2D but not Windows.UI.Composition.</i></p>
Repeats the specified region of an image.
</summary>
<remarks>
<p>

Просмотреть файл

@ -11,10 +11,9 @@ Licensed under the MIT License. See LICENSE.txt in the project root for license
</assembly>
<members>
<member name="T:Microsoft.Graphics.Canvas.Effects.Transform3DEffect">
<member name="T:Microsoft.Graphics.Canvas.Effects.Transform3DEffect" NoComposition="true">
<summary>
<p>Applies an arbitrary 4x4 transform matrix to an image.</p>
<p><i>Supported by Win2D but not Windows.UI.Composition.</i></p>
Applies an arbitrary 4x4 transform matrix to an image.
</summary>
<remarks>
<example>

Просмотреть файл

@ -11,10 +11,9 @@ Licensed under the MIT License. See LICENSE.txt in the project root for license
</assembly>
<members>
<member name="T:Microsoft.Graphics.Canvas.Effects.TurbulenceEffect">
<member name="T:Microsoft.Graphics.Canvas.Effects.TurbulenceEffect" NoComposition="true">
<summary>
<p>Generates an image using the Perlin noise function.</p>
<p><i>Supported by Win2D but not Windows.UI.Composition.</i></p>
Generates an image using the Perlin noise function.
</summary>
<remarks>
<p>

Просмотреть файл

@ -11,10 +11,9 @@ Licensed under the MIT License. See LICENSE.txt in the project root for license
</assembly>
<members>
<member name="T:Microsoft.Graphics.Canvas.Effects.UnPremultiplyEffect">
<member name="T:Microsoft.Graphics.Canvas.Effects.UnPremultiplyEffect" NoComposition="true">
<summary>
<p>Converts an image from premultiplied to unpremultiplied alpha format.</p>
<p><i>Supported by Win2D but not Windows.UI.Composition.</i></p>
Converts an image from premultiplied to unpremultiplied alpha format.
</summary>
<remarks>
<p>This Windows Runtime type corresponds to the

Просмотреть файл

@ -12,11 +12,9 @@ Licensed under the MIT License. See LICENSE.txt in the project root for license
<members>
<member name="T:Microsoft.Graphics.Canvas.Effects.VignetteEffect">
<member name="T:Microsoft.Graphics.Canvas.Effects.VignetteEffect" Win10="true" NoComposition="true">
<summary>
<p>Fades out the edges of an image.</p>
<p><i>This effect is new in the Universal Windows Platform. It is not supported on Windows 8.1 or Phone 8.1.</i></p>
<p><i>Supported by Win2D but not Windows.UI.Composition.</i></p>
Fades out the edges of an image.
</summary>
<remarks>
<p>This Windows Runtime type corresponds to the