Microsoft Graphics Canvas

https://microsoft.github.io/Win2D/WinUI3/html/
Admin
This project provides documentation for the Microsoft.Graphics.Canvas API, offering details on its...
Tokens:834,833
Snippets:6,832
Trust Score:8.3
Update:1 month ago
Show doc for...
Tokens:
Raw
### CreateTransferTableFromFunction Example

Source: https://microsoft.github.io/Win2D/WinUI3/html/M_Microsoft_Graphics_Canvas_Effects_EffectTransferTable3D_CreateFromColors.htm

Example demonstrating how to create a 3D transfer table by evaluating a color transfer function for each color value. This function populates a list of colors and then uses EffectTransferTable3D.CreateFromColors to generate the table.

```csharp
EffectTransferTable3D CreateTransferTableFromFunction(ICanvasResourceCreator resourceCreator, int sizeB, int sizeG, int sizeR, Func<Vector3, Vector3> transferFunction)
{
    var tableColors = new List<Color>();

    var maxExtents = new Vector3(sizeR, sizeG, sizeB) - Vector3.One;

    for (int r = 0; r < sizeR; r++)
    {
        for (int g = 0; g < sizeG; g++)
        {
            for (int b = 0; b < sizeB; b++)
            {
                Vector3 sourceColor = new Vector3(r, g, b) / maxExtents;

                Vector3 outputColor = transferFunction(sourceColor);

                tableColors.Add(ToColor(outputColor));
            }
        }
    }

    return EffectTransferTable3D.CreateFromColors(resourceCreator, tableColors.ToArray(), sizeB, sizeG, sizeR);
}
```

--------------------------------

### ICanvasPathReceiver.BeginFigure Method Signature

Source: https://microsoft.github.io/Win2D/WinUI3/html/M_Microsoft_Graphics_Canvas_Geometry_ICanvasPathReceiver_BeginFigure.htm

This is the method signature for BeginFigure, which starts a new figure in a path. It requires a starting point and specifies how the figure should be filled.

```csharp
void BeginFigure(
	Vector2 startPoint,
	CanvasFigureFill figureFill
)
```

--------------------------------

### ConvolveMatrixEffect Examples

Source: https://microsoft.github.io/Win2D/WinUI3/html/T_Microsoft_Graphics_Canvas_Effects_ConvolveMatrixEffect.htm

Code examples demonstrating how to use the KernelMatrix property to achieve various image effects.

```APIDOC
## ConvolveMatrixEffect Examples

### Description
Examples of applying different filter kernels to achieve specific image processing effects.

### Edge Detect Filter
```csharp
effect.KernelMatrix = new float[]
{
    0,  1,  0,
    1, -4,  1,
    0,  1,  0,
};
```

### Emboss Filter
```csharp
effect.KernelMatrix = new float[]
{
    -2, -1,  0,
    -1,  1,  1,
     0,  1,  2,
};
```

### Sharpen Filter
```csharp
effect.KernelMatrix = new float[]
{
    -1, -2,  -1,
    -2,  13, -2,
    -1, -2,  -1,
};
```

### Box Blur Filter
```csharp
effect.KernelMatrix = new float[]
{
    1, 1, 1,
    1, 1, 1,
    1, 1, 1,
};
effect.Divisor = 9;
```
```

--------------------------------

### Simple Pixel Shader Example (HLSL)

Source: https://microsoft.github.io/Win2D/WinUI3/html/M_Microsoft_Graphics_Canvas_Effects_PixelShaderEffect__ctor.htm

A basic HLSL shader that samples from a single input texture and multiplies it by a tint color. This example uses D2D_INPUT_COUNT and D2D_INPUT0_SIMPLE.

```hlsl
#define D2D_INPUT_COUNT 1
#define D2D_INPUT0_SIMPLE

#include "d2d1effecthelpers.hlsli"

float4 tint;

D2D_PS_ENTRY(main)
{
    float4 color = D2DGetInput(0);

    return color * tint;
}
```

--------------------------------

### CanvasPathBuilder.BeginFigure Method Overloads

Source: https://microsoft.github.io/Win2D/WinUI3/html/Overload_Microsoft_Graphics_Canvas_Geometry_CanvasPathBuilder_BeginFigure.htm

The BeginFigure method starts a new figure at a specified point. It has overloads that allow specifying the starting point as a Vector2 or as separate X and Y coordinates, and optionally a CanvasFigureFill option.

```APIDOC
## CanvasPathBuilder.BeginFigure Method Overloads

### Description
Starts a new figure at the specified point. This method has multiple overloads to accommodate different ways of specifying the starting point and the figure fill option.

### Methods

#### BeginFigure(Vector2)
Starts a new figure at the specified point, with the default figure fill option of Default.

#### BeginFigure(Single, Single)
Starts a new figure at the specified point, with the default figure fill option of Default.

#### BeginFigure(Vector2, CanvasFigureFill)
Starts a new figure at the specified point, with the specified figure fill option.

#### BeginFigure(Single, Single, CanvasFigureFill)
Starts a new figure at the specified point, with the specified figure fill option.
```

--------------------------------

### Custom Text Renderer Example with CreateGlyphRun

Source: https://microsoft.github.io/Win2D/WinUI3/html/M_Microsoft_Graphics_Canvas_Geometry_CanvasGeometry_CreateGlyphRun.htm

This example demonstrates how to use CanvasGeometry.CreateGlyphRun within a custom ICanvasTextRenderer implementation to draw glyph runs with a dashed stroke. It shows converting text to geometry and then drawing that geometry.

```csharp
class MyTextRenderer : ICanvasTextRenderer
{
    ...

    public void DrawGlyphRun(
        Microsoft.Graphics.Canvas.Numerics.Vector2 position,
        CanvasFontFace fontFace,
        float fontSize,
        CanvasGlyph[] glyphs,
        bool isSideways,
        uint bidiLevel,
        object brush,
        CanvasTextMeasuringMode measuringMode,
        string locale,
        string textString,
        int[] custerMapIndices,
        uint textPosition,
        CanvasGlyphOrientation glyphOrientation)
        {
            CanvasGeometry geometry = CanvasGeometry.CreateGlyphRun(
                resourceCreator,
                position,
                fontFace,
                fontSize,
                glyphs,
                isSideways,
                bidiLevel,
                measuringMode,
                glyphOrientation);

            CanvasStrokeStyle dashedStroke = new CanvasStrokeStyle()
            {
                DashStyle = CanvasDashStyle.Dash
            };

            drawingSession.DrawGeometry(geometry, Colors.White, 2.0f, dashedStroke);
        }
}
```

--------------------------------

### GetRectangleAttribute

Source: https://microsoft.github.io/Win2D/WinUI3/html/Methods_T_Microsoft_Graphics_Canvas_Svg_CanvasSvgNamedElement.htm

Gets a rectangle attribute. Available starting from Windows 10, version 15063.

```APIDOC
## GetRectangleAttribute

### Description
Gets a rectangle attribute.

### Method
Not specified (likely an SDK method call)

### Endpoint
Not applicable (SDK method)

### Parameters
* **name** (string) - Required - The name of the attribute.
* **namespacePrefix** (string) - Optional - The namespace prefix of the attribute.
* **defaultValue** (Rect) - Optional - The default rectangle to return if the attribute is not found.
```

--------------------------------

### Initialize and Draw to CanvasSwapChainPanel

Source: https://microsoft.github.io/Win2D/WinUI3/html/T_Microsoft_Graphics_Canvas_UI_Xaml_CanvasSwapChainPanel.htm

This snippet demonstrates how to create a CanvasSwapChain, assign it to the CanvasSwapChainPanel, draw a circle to the swap chain, and present the drawing. Ensure you handle potential memory leaks by following the guidelines in the documentation.

```csharp
CanvasSwapChain swapChain = new CanvasSwapChain(new CanvasDevice(), 800, 600);

canvasSwapChainPanel.SwapChain = swapChain;

using(CanvasDrawingSession ds = swapChain.CreateDrawingSession(Colors.White))
{
    ds.DrawCircle(400, 300, 100, Colors.Red, 20);
}

swapChain.Present();
```

--------------------------------

### GetAttribute

Source: https://microsoft.github.io/Win2D/WinUI3/html/Methods_T_Microsoft_Graphics_Canvas_Svg_CanvasSvgNamedElement.htm

Gets an object attribute. Available starting from Windows 10, version 15063.

```APIDOC
## GetAttribute

### Description
Gets an object attribute.

### Method
Not specified (likely an SDK method call)

### Endpoint
Not applicable (SDK method)

### Parameters
* **name** (string) - Required - The name of the attribute.
* **namespacePrefix** (string) - Optional - The namespace prefix of the attribute.
```

--------------------------------

### Compiling HLSL Shaders with fxc.exe

Source: https://microsoft.github.io/Win2D/WinUI3/html/M_Microsoft_Graphics_Canvas_Effects_PixelShaderEffect__ctor.htm

Command-line examples for compiling HLSL shaders using fxc.exe, generating .fxlib and .bin files.

```bash
set INCLUDEPATH "%WindowsSdkDir%\Include\%WindowsSDKVersion%\um"

fxc MyShader.hlsl /nologo /T lib_4_0_level_9_3_ps_only /D D2D_FUNCTION /D D2D_ENTRY=main /Fl MyShader.fxlib /I %INCLUDEPATH%
fxc MyShader.hlsl /nologo /T ps_4_0_level_9_3 /D D2D_FULL_SHADER /D D2D_ENTRY=main /E main /setprivate MyShader.fxlib /Fo:MyShader.bin /I %INCLUDEPATH%
```

--------------------------------

### Instantiating and Using CanvasImageSource

Source: https://microsoft.github.io/Win2D/WinUI3/html/T_Microsoft_Graphics_Canvas_UI_Xaml_CanvasImageSource.htm

This C# example demonstrates how to create a CanvasImageSource, assign it to an Image control, and use a drawing session to render content. Ensure you have a CanvasDevice and appropriate dimensions.

```csharp
var imageSource = new CanvasImageSource(canvasDevice, width, height, dpi);

imageControl.Source = imageSource;

using (var ds = imageSource.CreateDrawingSession(Colors.Black))
{
    // drawing code
}
```

--------------------------------

### GetLineJoinAttribute

Source: https://microsoft.github.io/Win2D/WinUI3/html/Methods_T_Microsoft_Graphics_Canvas_Svg_CanvasSvgNamedElement.htm

Gets a line join attribute. Available starting from Windows 10, version 15063.

```APIDOC
## GetLineJoinAttribute

### Description
Gets a line join attribute.

### Method
Not specified (likely an SDK method call)

### Endpoint
Not applicable (SDK method)

### Returns
* **CanvasSvgLineJoin** - The line join value.
```

--------------------------------

### Device Property

Source: https://microsoft.github.io/Win2D/WinUI3/html/Properties_T_Microsoft_Graphics_Canvas_Svg_ICanvasSvgAttribute.htm

Gets the device with which this attribute is associated. This property is available starting from Windows 10, version 15063.

```APIDOC
## Device Property

### Description
Gets the device with which this attribute is associated.

### Type
[CanvasDevice](https://docs.microsoft.com/en-us/uwp/api/microsoft.graphics.canvas.canvasdevice)

### Availability
[Win10_15063]
```

--------------------------------

### SaturationEffect Constructor and Usage

Source: https://microsoft.github.io/Win2D/WinUI3/html/T_Microsoft_Graphics_Canvas_Effects_SaturationEffect.htm

Demonstrates how to initialize and use the SaturationEffect to adjust image saturation.

```APIDOC
## SaturationEffect Constructor and Usage

### Description
Initializes a new instance of the SaturationEffect class and demonstrates its application with an image.

### Method
Constructor and Property Assignment

### Endpoint
N/A (Class Initialization)

### Parameters
#### Constructor Parameters
None explicitly listed for direct instantiation.

#### Properties
- **Saturation** (float) - Gets or sets the saturation intensity for the effect. Value should be between 0.0 (grayscale) and 1.0 (maximum saturation).
- **Source** (ICanvasImage) - Gets or sets the input source for the Saturation effect.

### Request Example
```csharp
SaturationEffect saturationEffect = new SaturationEffect()
{
    Saturation = 0.8,
    Source = catBitmap // Assuming 'catBitmap' is a CanvasBitmap
};
```

### Response
#### Success Response
N/A (Object instantiation and property setting)

#### Response Example
N/A
```

--------------------------------

### Text Property

Source: https://microsoft.github.io/Win2D/WinUI3/html/Properties_T_Microsoft_Graphics_Canvas_Svg_CanvasSvgTextElement.htm

Gets or sets the text for this element. This property is available starting from Windows 10, version 15063.

```APIDOC
## Text Property

### Description
Gets or sets the text for this element.

### Applies To
CanvasSvgTextElement

### Version
[Win10_15063]

### Remarks
This property allows direct manipulation of the text content within an SVG text element.
```

--------------------------------

### ColorManagementProfile.CreateCustom Method

Source: https://microsoft.github.io/Win2D/WinUI3/html/M_Microsoft_Graphics_Canvas_Effects_ColorManagementProfile_CreateCustom.htm

Initializes a new instance of the ColorManagementProfile class using the specified ICC color profile. The resulting color profile will have a type of Icc.

```APIDOC
## ColorManagementProfile.CreateCustom Method

### Description
Initializes a new instance of the ColorManagementProfile class using the specified ICC color profile.

### Method
static ColorManagementProfile

### Parameters
#### Path Parameters
* **iccProfile** (System.Byte[]) - Required - The byte array representing the ICC color profile.

### Return Value
Type: ColorManagementProfile - The resulting color profile will have a type of Icc.
```

--------------------------------

### GetCanvasDevice

Source: https://microsoft.github.io/Win2D/WinUI3/html/Methods_T_Microsoft_Graphics_Canvas_UI_Composition_CanvasComposition.htm

Gets the CanvasDevice associated with the given CompositionGraphicsDevice. This method is available starting from Windows 10 build 10586.

```APIDOC
## GetCanvasDevice

### Description
Gets the CanvasDevice associated with the given CompositionGraphicsDevice.

### Method
[Method Signature or relevant details if not HTTP]

### Endpoint
[Not applicable for SDK methods]

### Parameters
[Parameters would be listed here if documented]

### Request Example
[Not applicable for SDK methods]

### Response
[Response details would be listed here if documented]

### Remarks
Available starting from Windows 10 build 10586.
```

--------------------------------

### Initialize HighlightsAndShadowsEffect

Source: https://microsoft.github.io/Win2D/WinUI3/html/M_Microsoft_Graphics_Canvas_Effects_HighlightsAndShadowsEffect__ctor.htm

Initializes a new instance of the HighlightsAndShadowsEffect class. This is the default constructor.

```csharp
public HighlightsAndShadowsEffect()
```

--------------------------------

### GetPoints Method

Source: https://microsoft.github.io/Win2D/WinUI3/html/Methods_T_Microsoft_Graphics_Canvas_Svg_CanvasSvgPointsAttribute.htm

Gets points from the points array. This method is available starting from Windows 10, version 15063.

```APIDOC
## GetPoints Method

### Description
Gets points from the points array.

### Method
(Not specified, likely a standard object method)

### Endpoint
(Not applicable for SDK methods)

### Parameters
(Parameters for specifying which points to retrieve are not explicitly documented in the source.)

### Request Example
(Not applicable for SDK methods)

### Response
#### Success Response
- **Array of Points**: The retrieved points from the array.

#### Response Example
(Not applicable for SDK methods)
```

--------------------------------

### GetCommands Method

Source: https://microsoft.github.io/Win2D/WinUI3/html/Methods_T_Microsoft_Graphics_Canvas_Svg_CanvasSvgPathAttribute.htm

Gets commands from the commands array. This method is available starting from Windows 10, version 15063.

```APIDOC
## GetCommands Method

### Description
Gets commands from the commands array.

### Method
(Not specified, likely a C# method call)

### Endpoint
(Not applicable for SDK methods)

### Parameters
(None explicitly listed)

### Request Example
(Not applicable for SDK methods)

### Response
(Not specified, likely returns a collection of commands)

### Success Response (200)
(Not applicable for SDK methods)
```

--------------------------------

### ColorManagementProfile Constructors

Source: https://microsoft.github.io/Win2D/WinUI3/html/T_Microsoft_Graphics_Canvas_Effects_ColorManagementProfile.htm

Initializes a new instance of the ColorManagementProfile class.

```APIDOC
## ColorManagementProfile Constructor

### Description
Initializes a new instance of the ColorManagementProfile class using the specified color space.

### Method
Constructor

### Parameters
* **colorSpace** (ColorSpace) - Description of the color space.
```

```APIDOC
## CreateCustom Constructor

### Description
Initializes a new instance of the ColorManagementProfile class using the specified ICC color profile.

### Method
Static Constructor

### Parameters
* **iccProfile** (byte[]) - The ICC color profile data.
```

```APIDOC
## CreateExtended Constructor

### Description
Initializes a new instance of the ColorManagementProfile class using the specified ExtendedColorSpace.

### Method
Static Constructor

### Parameters
* **extendedColorSpace** (ExtendedColorSpace) - The extended color space description.
```

```APIDOC
## CreateSimple Constructor

### Description
Initializes a new instance of the ColorManagementProfile class using the specified ColorManagementSimpleProfile.

### Method
Static Constructor

### Parameters
* **simpleProfile** (ColorManagementSimpleProfile) - The simple color profile description.
```

--------------------------------

### HighlightsAndShadowsEffect Constructor

Source: https://microsoft.github.io/Win2D/WinUI3/html/M_Microsoft_Graphics_Canvas_Effects_HighlightsAndShadowsEffect__ctor.htm

Initializes a new instance of the HighlightsAndShadowsEffect class.

```APIDOC
## HighlightsAndShadowsEffect Constructor

### Description
Initializes a new instance of the HighlightsAndShadowsEffect class.

### Method
Constructor

### Endpoint
N/A

### Parameters
None

### Request Example
None

### Response
None
```

--------------------------------

### GetSegmentData Method

Source: https://microsoft.github.io/Win2D/WinUI3/html/Methods_T_Microsoft_Graphics_Canvas_Svg_CanvasSvgPathAttribute.htm

Gets data from the segment data array. This method is available starting from Windows 10, version 15063.

```APIDOC
## GetSegmentData Method

### Description
Gets data from the segment data array.

### Method
(Not specified, likely a C# method call)

### Endpoint
(Not applicable for SDK methods)

### Parameters
(None explicitly listed)

### Request Example
(Not applicable for SDK methods)

### Response
(Not specified, likely returns segment data)

### Success Response (200)
(Not applicable for SDK methods)
```

--------------------------------

### GetSystemFontFamilies Method (Overload 1)

Source: https://microsoft.github.io/Win2D/WinUI3/html/Methods_T_Microsoft_Graphics_Canvas_Text_CanvasTextFormat.htm

Gets a list of all font families available on the system. This method provides a comprehensive list of installed fonts.

```APIDOC
## GetSystemFontFamilies()

### Description
Gets a list of font families available on the system.

### Method
GetSystemFontFamilies

### Parameters
None

### Response
- **IReadOnlyList<String>** - A list of available font family names.
```

--------------------------------

### Create CanvasSolidColorBrush with CanvasDevice

Source: https://microsoft.github.io/Win2D/WinUI3/html/T_Microsoft_Graphics_Canvas_ICanvasResourceCreator.htm

Example of creating a CanvasSolidColorBrush using a CanvasDevice. This requires explicit access to the device.

```csharp
var brush = new CanvasSolidColorBrush(canvasControl.Device, Colors.OliveDrab);
```

--------------------------------

### ColorManagementProfile.CreateSimple Method

Source: https://microsoft.github.io/Win2D/WinUI3/html/M_Microsoft_Graphics_Canvas_Effects_ColorManagementProfile_CreateSimple.htm

Initializes a new instance of the ColorManagementProfile class using the specified ColorManagementSimpleProfile. This API is only available when running on Windows 10 build 15063 (Creators Update) or greater.

```APIDOC
## ColorManagementProfile.CreateSimple Method

### Description
Initializes a new instance of the ColorManagementProfile class using the specified ColorManagementSimpleProfile.

### Method Signature
```csharp
public static ColorManagementProfile CreateSimple(ColorManagementSimpleProfile simpleProfile)
```

### Parameters
#### Parameters
- **simpleProfile** (ColorManagementSimpleProfile) - Description: The simple profile to use for creating the color management profile.

### Return Value
Type: ColorManagementProfile

### Remarks
This API is only available when running on Windows 10 build 15063 (Creators Update) or greater. Use IsSupported(ColorManagementProfileType, CanvasDevice) to check whether simple color profiles are supported on the current version of Windows. The resulting color profile will have a type of Simple. To use ColorManagementEffect with a simple color profile, Quality must be set to Best.
```

--------------------------------

### CanvasStrokeStyle.DashOffset Property

Source: https://microsoft.github.io/Win2D/WinUI3/html/P_Microsoft_Graphics_Canvas_Geometry_CanvasStrokeStyle_DashOffset.htm

Gets or sets how far into the dash sequence the stroke will start. This property allows you to control the offset within the defined dash pattern.

```APIDOC
## CanvasStrokeStyle.DashOffset Property

### Description
Gets or sets how far into the dash sequence the stroke will start.

### Property Value
Type: Single

### C# Example
```csharp
CanvasStrokeStyle strokeStyle = new CanvasStrokeStyle();
strokeStyle.DashOffset = 5.0f; // Sets the offset to 5 units into the dash pattern
float offset = strokeStyle.DashOffset; // Retrieves the current offset
```
```

--------------------------------

### CanvasVirtualImageSource Constructor

Source: https://microsoft.github.io/Win2D/WinUI3/html/M_Microsoft_Graphics_Canvas_UI_Xaml_CanvasVirtualImageSource__ctor_1.htm

Initializes a CanvasVirtualImageSource with a resource creator, dimensions, DPI, and alpha mode. Use CanvasAlphaMode.Ignore for opaque backgrounds (more efficient) or CanvasAlphaMode.Premultiplied for transparent backgrounds. Do not use CanvasAlphaMode.Straight.

```csharp
public CanvasVirtualImageSource(
	ICanvasResourceCreator resourceCreator,
	float width,
	float height,
	float dpi,
	CanvasAlphaMode alphaMode
)
```

--------------------------------

### CanvasTextFormat.TrimmingGranularity Property

Source: https://microsoft.github.io/Win2D/WinUI3/html/P_Microsoft_Graphics_Canvas_Text_CanvasTextFormat_TrimmingGranularity.htm

Gets or sets the granularity used to trim text that overflows the layout box. This property determines how finely the text is trimmed, for example, by character or by word.

```APIDOC
## CanvasTextFormat.TrimmingGranularity Property

### Description
Specifies the granularity used to trim text overflowing the layout box.

### Property Value
Type: CanvasTextTrimmingGranularity

### Remarks
This property determines the level of detail when trimming text that exceeds the bounds of its layout container. For instance, it can be set to trim by individual characters or by entire words.
```

--------------------------------

### CanvasVirtualControl.CustomDevice Property

Source: https://microsoft.github.io/Win2D/WinUI3/html/P_Microsoft_Graphics_Canvas_UI_Xaml_CanvasVirtualControl_CustomDevice.htm

Gets or sets an application-chosen device for this control. This allows controls to use a CanvasDevice from arbitrary sources, for example, from Direct3D interop. The default value is null, meaning the control will obtain its devices from GetSharedDevice(Boolean) if UseSharedDevice is set, or create its own new device. Setting this property overrides default device creation behavior, ignoring UseSharedDevice and ForceSoftwareRenderer.

```APIDOC
## CanvasVirtualControl.CustomDevice Property

### Description
Gets or sets an application-chosen device for this control.

### Property Value
Type: CanvasDevice

Setting this property allows controls to use a CanvasDevice from arbitrary sources- for example, from Direct3D interop. The default value for this property is null. This means that the control will obtain its devices from GetSharedDevice(Boolean) if UseSharedDevice is set. Otherwise, it will create its own new device each time. Setting this property overrides the control's default device creation behavior, so the UseSharedDevice and ForceSoftwareRenderer properties are ignored. One way to handle device lost while using a custom device, is to subscribe to the custom device's DeviceLost event. Then in the event handler, create a new device and assign it to CustomDevice.
```

--------------------------------

### Usage Example

Source: https://microsoft.github.io/Win2D/WinUI3/html/T_Microsoft_Graphics_Canvas_UI_Xaml_CanvasVirtualImageSource.htm

Demonstrates how to create a CanvasVirtualImageSource, assign its source to an image control, and handle the RegionsInvalidated event to redraw specific regions.

```APIDOC
## Usage Example

### Description
This example shows how to use CanvasVirtualImageSource to display a virtualized image and handle redraw requests for specific regions.

### Code
```csharp
var imageSource = new CanvasVirtualImageSource(canvasDevice, width, height, dpi);
imageControl.Source = imageSource.Source;
imageSource.RegionsInvalidated += ImageSource_RegionsInvalidated;

private void ImageSource_RegionsInvalidated(CanvasVirtualImageSource sender, CanvasRegionsInvalidatedEventArgs args)
{
    foreach (var region in args.InvalidatedRegions)
    {
        using (var ds = sender.CreateDrawingSession(clearColor, region))
        {
            // drawing commands
        }
    }
}
```
```

--------------------------------

### GetBounds

Source: https://microsoft.github.io/Win2D/WinUI3/html/Methods_T_Microsoft_Graphics_Canvas_Geometry_CanvasGradientMesh.htm

Gets the bounds of this CanvasGradientMesh. Overloads are provided to get bounds with or without a transformation matrix.

```APIDOC
## GetBounds(ICanvasResourceCreator)

### Description
Gets the bounds of this CanvasGradientMesh.

### Method
(Not specified, likely an instance method)

### Endpoint
(Not applicable for SDK methods)

### Parameters
#### Path Parameters
- **resourceCreator** (ICanvasResourceCreator) - Required - The resource creator to use for bounds calculation.

### Request Example
(Not applicable for SDK methods)

### Response
#### Success Response
- **Rect** - The bounds of the gradient mesh.

#### Response Example
(Not applicable for SDK methods)
```

```APIDOC
## GetBounds(ICanvasResourceCreator, Matrix3x2)

### Description
Gets the bounds of this CanvasGradientMesh, applying a transformation matrix.

### Method
(Not specified, likely an instance method)

### Endpoint
(Not applicable for SDK methods)

### Parameters
#### Path Parameters
- **resourceCreator** (ICanvasResourceCreator) - Required - The resource creator to use for bounds calculation.
- **transform** (Matrix3x2) - Required - The transformation matrix to apply.

### Request Example
(Not applicable for SDK methods)

### Response
#### Success Response
- **Rect** - The transformed bounds of the gradient mesh.

#### Response Example
(Not applicable for SDK methods)
```

--------------------------------

### Present()

Source: https://microsoft.github.io/Win2D/WinUI3/html/Overload_Microsoft_Graphics_Canvas_CanvasSwapChain_Present.htm

Presents a rendered image. This overload uses the default sync interval.

```APIDOC
## Present()

### Description
Presents a rendered image. This overload uses the default sync interval.

### Method
Not applicable (SDK method)

### Endpoint
Not applicable (SDK method)

### Parameters
This method does not take any parameters.

### Response
This method does not return a value.
```

--------------------------------

### Initialize SpotDiffuseEffect

Source: https://microsoft.github.io/Win2D/WinUI3/html/M_Microsoft_Graphics_Canvas_Effects_SpotDiffuseEffect__ctor.htm

Initializes a new instance of the SpotDiffuseEffect class. This is the default constructor.

```csharp
public SpotDiffuseEffect()
```

--------------------------------

### CanvasFontFace.GetGlyphMetrics Method

Source: https://microsoft.github.io/Win2D/WinUI3/html/M_Microsoft_Graphics_Canvas_Text_CanvasFontFace_GetGlyphMetrics.htm

Gets the metrics and bounds of the glyphs that would get drawn in em units.

```APIDOC
## GetGlyphMetrics Method

### Description
Gets the metrics and bounds of the glyphs that would get drawn in em units.

### Method Signature
```
public CanvasGlyphMetrics[] GetGlyphMetrics(
	int[] inputElements,
	bool isSideways
)
```

### Parameters
#### inputElements
- **inputElements** (System.Int32[]) - Description not available.

#### isSideways
- **isSideways** (System.Boolean) - Description not available.

### Return Value
- **CanvasGlyphMetrics[]** - Type: CanvasGlyphMetrics[]
```

--------------------------------

### BeginFigure Method (Vector2) Signature

Source: https://microsoft.github.io/Win2D/WinUI3/html/M_Microsoft_Graphics_Canvas_Geometry_CanvasPathBuilder_BeginFigure.htm

This is the signature for the BeginFigure method that takes a Vector2 as the starting point. It is used to initiate a new figure in a canvas path.

```csharp
public void BeginFigure(
	Vector2 startPoint
)
```

--------------------------------

### CanvasImageSource Usage Example

Source: https://microsoft.github.io/Win2D/WinUI3/html/T_Microsoft_Graphics_Canvas_UI_Xaml_CanvasImageSource.htm

Demonstrates how to create a CanvasImageSource, assign it to an image control, and use a drawing session to draw content.

```APIDOC
## CanvasImageSource Usage Example

### Description
This example shows the basic setup and usage of CanvasImageSource, including instantiation, assignment to a UI element, and performing drawing operations.

### Code Example
```csharp
var imageSource = new CanvasImageSource(canvasDevice, width, height, dpi);

imageControl.Source = imageSource;

using (var ds = imageSource.CreateDrawingSession(Colors.Black))
{
    // drawing code
}
```
```

--------------------------------

### ICanvasTextInlineObject.DrawBounds Property

Source: https://microsoft.github.io/Win2D/WinUI3/html/P_Microsoft_Graphics_Canvas_Text_ICanvasTextInlineObject_DrawBounds.htm

Gets the bounds of the parts of the text that would get drawn. These bounds are measured the same way as DrawBounds. Win2D doesn't do anything to validate whether this callback is honest about the bounds of what gets drawn. It's up to the app to report the correct bounds here.

```APIDOC
## ICanvasTextInlineObject.DrawBounds Property

### Description
Gets the bounds of the parts of the text that would get drawn.

### Property Value
Type: Rect
These bounds are measured the same way as DrawBounds
Win2D doesn't do anything to validate whether this callback is honest about the bounds of what gets drawn. It's up to the app to report the correct bounds here.

### C# Signature
```csharp
Rect DrawBounds { get; }
```
```

--------------------------------

### Get or Set CanvasStrokeStyle EndCap

Source: https://microsoft.github.io/Win2D/WinUI3/html/P_Microsoft_Graphics_Canvas_Geometry_CanvasStrokeStyle_EndCap.htm

This C# snippet shows how to get or set the EndCap property for a CanvasStrokeStyle. The default value is Flat.

```csharp
public CanvasCapStyle EndCap { get; set; }
```

--------------------------------

### C# Example: Create and use CanvasRenderTarget

Source: https://microsoft.github.io/Win2D/WinUI3/html/M_Microsoft_Graphics_Canvas_CanvasRenderTarget_CreateDrawingSession.htm

Demonstrates how to create a CanvasRenderTarget and use a 'using' statement to ensure the drawing session is properly closed after rendering.

```csharp
CanvasRenderTarget renderTarget = new CanvasRenderTarget(canvasControl, 100, 150);

using (CanvasDrawingSession drawingSession = renderTarget.CreateDrawingSession())
{
    drawingSession.Clear(Colors.Blue);
}
```

--------------------------------

### Initialize OpacityMetadataEffect

Source: https://microsoft.github.io/Win2D/WinUI3/html/M_Microsoft_Graphics_Canvas_Effects_OpacityMetadataEffect__ctor.htm

Initializes a new instance of the OpacityMetadataEffect class. This is the default constructor.

```csharp
public OpacityMetadataEffect()
```

--------------------------------

### CanvasFontFace.GetGdiCompatibleGlyphMetrics Method

Source: https://microsoft.github.io/Win2D/WinUI3/html/M_Microsoft_Graphics_Canvas_Text_CanvasFontFace_GetGdiCompatibleGlyphMetrics.htm

Gets the metrics and bounds of the glyphs that would get drawn, compatible with what GDI would produce, in em units.

```APIDOC
## CanvasFontFace.GetGdiCompatibleGlyphMetrics Method

### Description
Gets the metrics and bounds of the glyphs that would get drawn, compatible with what GDI would produce, in em units.

### Method
`CanvasFontFace.GetGdiCompatibleGlyphMetrics`

### Parameters
#### Path Parameters
- **fontSize** (System.Single) - Description: The font size in em units.
- **dpi** (System.Single) - Description: The dots per inch.
- **transform** (System.Numerics.Matrix3x2) - Description: The transformation matrix to apply.
- **useGdiNatural** (System.Boolean) - Description: A boolean indicating whether to use GDI natural metrics.
- **inputElements** (System.Int32[]) - Description: An array of input elements (glyph indices).
- **isSideways** (System.Boolean) - Description: A boolean indicating if the glyphs are sideways.

### Return Value
Type: CanvasGlyphMetrics[] - Description: An array of CanvasGlyphMetrics representing the metrics and bounds of the glyphs.
```

--------------------------------

### Loading and Drawing SVG Example

Source: https://microsoft.github.io/Win2D/WinUI3/html/T_Microsoft_Graphics_Canvas_Svg_CanvasSvgDocument.htm

This example demonstrates how to load an SVG document from an XML string and draw it to a CanvasControl using Win2D.

```C#
using Microsoft.Graphics.Canvas.Svg;

CanvasSvgDocument svgDocument;

void canvasControl_CreateResources(CanvasControl sender, Microsoft.Graphics.Canvas.UI.CanvasCreateResourcesEventArgs args)
{
    // Load SVG from an XML string
    svgDocument = CanvasSvgDocument.LoadFromXml(sender, "<svg><circle fill=\"#660000\" r=\"500"/></svg>");
}

void canvasControl_Draw(CanvasControl sender, CanvasDrawEventArgs args)
{
    // Draw the SVG document to the drawing session
    args.DrawingSession.DrawSvg(svgDocument, sender.Size);
}
```

--------------------------------

### CanvasDevice() Constructor

Source: https://microsoft.github.io/Win2D/WinUI3/html/Overload_Microsoft_Graphics_Canvas_CanvasDevice__ctor.htm

Initializes a new instance of the CanvasDevice class with default settings.

```APIDOC
## CanvasDevice()

### Description
Initializes a new instance of the CanvasDevice class.

### Method
Constructor

### Parameters
None

### Response
Initializes a CanvasDevice object.
```

--------------------------------

### ICanvasPathReceiver.BeginFigure Method

Source: https://microsoft.github.io/Win2D/WinUI3/html/M_Microsoft_Graphics_Canvas_Geometry_ICanvasPathReceiver_BeginFigure.htm

Signals the beginning of a figure to the app.

```APIDOC
## BeginFigure

### Description
Signals the beginning of a figure to the app.

### Method Signature
`void BeginFigure(Vector2 startPoint, CanvasFigureFill figureFill)`

### Parameters
#### startPoint
- **Type**: `System.Numerics.Vector2`
- **Description**: The starting point of the figure.

#### figureFill
- **Type**: `Microsoft.Graphics.Canvas.Geometry.CanvasFigureFill`
- **Description**: Specifies how the figure should be filled.
```

--------------------------------

### Get and Set LimitingConeAngle

Source: https://microsoft.github.io/Win2D/WinUI3/html/P_Microsoft_Graphics_Canvas_Effects_SpotDiffuseEffect_LimitingConeAngle.htm

This C# snippet shows how to get and set the LimitingConeAngle property for a SpotDiffuseEffect. The angle is specified in radians and defaults to pi/2.

```csharp
public float LimitingConeAngle { get; set; }
```

--------------------------------

### Present(Int32)

Source: https://microsoft.github.io/Win2D/WinUI3/html/Overload_Microsoft_Graphics_Canvas_CanvasSwapChain_Present.htm

Presents a rendered image, using the specified sync interval.

```APIDOC
## Present(Int32 syncInterval)

### Description
Presents a rendered image, using the specified sync interval.

### Method
Not applicable (SDK method)

### Endpoint
Not applicable (SDK method)

### Parameters
#### Path Parameters
- **syncInterval** (Int32) - Required - The sync interval to use for presenting the image. A value of 0 means present as soon as possible. A value of 1 means present on the next vertical sync. A value of 2 means present on the next two vertical syncs, and so on.
```

--------------------------------

### GetGlyphMetrics

Source: https://microsoft.github.io/Win2D/WinUI3/html/Methods_T_Microsoft_Graphics_Canvas_Text_CanvasFontFace.htm

Gets the metrics and bounds of the glyphs that would get drawn in em units. This provides detailed information about the size and spacing of glyphs.

```APIDOC
## GetGlyphMetrics

### Description
Gets the metrics and bounds of the glyphs that would get drawn in em units.

### Method
GetGlyphMetrics
```

--------------------------------

### Initialize CanvasTypography and Add Font Feature

Source: https://microsoft.github.io/Win2D/WinUI3/html/T_Microsoft_Graphics_Canvas_Text_CanvasTypography.htm

This example demonstrates how to create a CanvasTypography object, add a specific OpenType font feature (ContextualSwash), and apply it to a CanvasTextLayout. Ensure you have a resource creator, text, format, and dimensions available.

```csharp
var typography = new CanvasTypography();
typography.AddFeature(CanvasTypographyFeatureName.ContextualSwash, 1);

var format = new CanvasTextFormat();
var textLayout = new CanvasTextLayout(resourceCreator, "Abc", format, 100, 100);
textLayout.SetTypography(1, 1, typography);
```

--------------------------------

### Initialize CanvasDevice

Source: https://microsoft.github.io/Win2D/WinUI3/html/M_Microsoft_Graphics_Canvas_CanvasDevice__ctor.htm

Initializes a new instance of the CanvasDevice class. This is the default constructor.

```csharp
public CanvasDevice()
```

--------------------------------

### Get or Set CanvasDebugLevel

Source: https://microsoft.github.io/Win2D/WinUI3/html/P_Microsoft_Graphics_Canvas_CanvasDevice_DebugLevel.htm

Use this property to get or set the debug level for CanvasDevice instances. Changes to this property do not affect already created devices.

```csharp
public static CanvasDebugLevel DebugLevel { get; set; }
```

--------------------------------

### Initialize TableTransfer3DEffect

Source: https://microsoft.github.io/Win2D/WinUI3/html/M_Microsoft_Graphics_Canvas_Effects_TableTransfer3DEffect__ctor.htm

Initializes a new instance of the TableTransfer3DEffect class. This is the default constructor.

```csharp
public TableTransfer3DEffect()
```

--------------------------------

### Using SVG as an Image Source Example

Source: https://microsoft.github.io/Win2D/WinUI3/html/T_Microsoft_Graphics_Canvas_Svg_CanvasSvgDocument.htm

This example shows how to use a loaded SVG document as an image source for effects, such as an OpacityEffect, by drawing it into a CanvasCommandList.

```C#
using Microsoft.Graphics.Canvas.Svg;
using Microsoft.Graphics.Canvas.Effects;

void canvasControl_Draw(CanvasControl sender, CanvasDrawEventArgs args)
{
    // Create a command list to hold the SVG drawing
    CanvasCommandList commandList = new CanvasCommandList(sender);

    using (var ds = commandList.CreateDrawingSession())
    {
        ds.DrawSvg(svgDocument, sender.Size);
    }

    // Apply an OpacityEffect to the command list
    OpacityEffect opacityEffect = new OpacityEffect();
    opacityEffect.Opacity = 0.5f;
    opacityEffect.Source = commandList;

    // Draw the effect to the main drawing session
    args.DrawingSession.DrawImage(opacityEffect);
}
```

--------------------------------

### Get and Set CanvasSwapChain Rotation

Source: https://microsoft.github.io/Win2D/WinUI3/html/P_Microsoft_Graphics_Canvas_CanvasSwapChain_Rotation.htm

This snippet shows the C# syntax for getting and setting the Rotation property of a CanvasSwapChain. The property determines the rotation of the swap chain.

```csharp
public CanvasSwapChainRotation Rotation { get; set; }
```

--------------------------------

### BeginFigure

Source: https://microsoft.github.io/Win2D/WinUI3/html/Methods_T_Microsoft_Graphics_Canvas_Geometry_CanvasPathBuilder.htm

Starts a new figure at the specified point. This method can also specify the fill option for the new figure.

```APIDOC
## BeginFigure

### Description
Starts a new figure at the specified point. This method can also specify the fill option for the new figure.

### Method
* BeginFigure(Vector2 startPoint)
* BeginFigure(Single x, Single y)
* BeginFigure(Vector2 startPoint, CanvasFigureFill fill)
* BeginFigure(Single x, Single y, CanvasFigureFill fill)

### Parameters
* **startPoint** (Vector2) - The starting point of the new figure.
* **x** (Single) - The x-coordinate of the starting point.
* **y** (Single) - The y-coordinate of the starting point.
* **fill** (CanvasFigureFill) - The fill option for the new figure (Default or InwardContour).
```

--------------------------------

### CanvasSwapChain Constructor

Source: https://microsoft.github.io/Win2D/WinUI3/html/M_Microsoft_Graphics_Canvas_CanvasSwapChain__ctor_3.htm

Initializes a new instance of the CanvasSwapChain class with the specified size. The swap chain's pixel format defaults to DirectXPixelFormat.B8G8R8A8UIntNormalized, buffer count to 2, and alpha mode to CanvasAlphaMode.Premultiplied. Size is in device-independent pixels (DIPs), and DPI is taken from the specified resource creator interface.

```csharp
public CanvasSwapChain(
	ICanvasResourceCreatorWithDpi resourceCreator,
	Size size
)
```

--------------------------------

### CanvasPathBuilder.BeginFigure Method Signature

Source: https://microsoft.github.io/Win2D/WinUI3/html/M_Microsoft_Graphics_Canvas_Geometry_CanvasPathBuilder_BeginFigure_3.htm

This is the method signature for starting a new figure with a specified fill option. It requires the starting X and Y coordinates and the figure fill type.

```csharp
public void BeginFigure(
	float startX,
	float startY,
	CanvasFigureFill figureFill
)
```

--------------------------------

### Create and Configure CompositeEffect

Source: https://microsoft.github.io/Win2D/WinUI3/html/T_Microsoft_Graphics_Canvas_Effects_CompositeEffect.htm

Demonstrates how to create a CompositeEffect, set its compositing mode to Add, and add input images (cat and flower) to its Sources collection.

```csharp
CompositeEffect compositeEffect = new CompositeEffect();
compositeEffect.Mode = CompositeEffectMode.Add;
compositeEffect.Sources.Add(cat);
compositeEffect.Sources.Add(flower);
```

--------------------------------

### CanvasClusterMetrics.Width Field

Source: https://microsoft.github.io/Win2D/WinUI3/html/F_Microsoft_Graphics_Canvas_Text_CanvasClusterMetrics_Width.htm

The advance width of all glyphs in the cluster. This is the distance, in DIPs, from the start of this glyph cluster to the start of the next glyph cluster when this text layout is drawn.

```APIDOC
## CanvasClusterMetrics.Width Field

### Description
The advance width of all glyphs in the cluster. This is the distance, in DIPs, from the start of this glyph cluster to the start of the next glyph cluster when this text layout is drawn.

### Field Value
Type: Single
```

--------------------------------

### BeginFigure Method

Source: https://microsoft.github.io/Win2D/WinUI3/html/Methods_T_Microsoft_Graphics_Canvas_Geometry_ICanvasPathReceiver.htm

Signals the beginning of a new figure to the app. This method is part of the ICanvasPathReceiver interface for defining path geometry.

```APIDOC
## BeginFigure

### Description
Signals the beginning of a new figure to the app. This method is part of the ICanvasPathReceiver interface for defining path geometry.

### Method
(Not specified in source, assumed to be part of an SDK interface)

### Parameters
(Parameters not specified in source)

### Request Example
(Not applicable for this interface method)

### Response
(Not applicable for this interface method)
```

--------------------------------

### CanvasTextLayout.DrawBounds Property

Source: https://microsoft.github.io/Win2D/WinUI3/html/P_Microsoft_Graphics_Canvas_Text_CanvasTextLayout_DrawBounds.htm

Gets the bounds of the parts of the text that would get drawn. Draw bounds are useful as a clip rect, defining the area covered when the text is rendered.

```APIDOC
## CanvasTextLayout.DrawBounds Property

### Description
Gets the bounds of the parts of the text that would get drawn. Draw bounds are different from layout bounds and are useful as a clip rect.

### Property Value
Type: Rect

Draw bounds are the area that is covered when you draw the text. They may not align with edges and can overlap, unlike layout bounds which align with edges and do not overlap.
```

--------------------------------

### Get and Set KernelOffset Property

Source: https://microsoft.github.io/Win2D/WinUI3/html/P_Microsoft_Graphics_Canvas_Effects_ConvolveMatrixEffect_KernelOffset.htm

Demonstrates how to get and set the KernelOffset property for a ConvolveMatrixEffect. This property shifts the filter kernel from its default position centered on the output pixel.

```csharp
public Vector2 KernelOffset { get; set; }
```

--------------------------------

### Initialize SpotSpecularEffect

Source: https://microsoft.github.io/Win2D/WinUI3/html/M_Microsoft_Graphics_Canvas_Effects_SpotSpecularEffect__ctor.htm

Initializes a new instance of the SpotSpecularEffect class. This is the default constructor.

```csharp
public SpotSpecularEffect()
```

--------------------------------

### Transform3DEffect Constructor and Usage

Source: https://microsoft.github.io/Win2D/WinUI3/html/T_Microsoft_Graphics_Canvas_Effects_Transform3DEffect.htm

Demonstrates how to initialize a Transform3DEffect with a source image and a transformation matrix, and how to use it for drawing.

```APIDOC
## Transform3DEffect Constructor and Usage

### Description
Initializes a new instance of the Transform3DEffect class and applies a 3D transformation to a source image. This example shows how to set the source and transformation matrix, and then use the effect in a Draw event.

### Class
Microsoft.Graphics.Canvas.Effects.Transform3DEffect

### Members
#### Constructor
- **Transform3DEffect()**: Initializes a new instance of the Transform3DEffect class.

#### Properties
- **Source** (ICanvasImage): Gets or sets the input source for Transform3DEffect effect.
- **TransformMatrix** (Matrix4x4): Gets or sets the 4x4 transform matrix applied to the projection plane.

### Example
```csharp
// Assume 'cat' is a CanvasBitmap
Transform3DEffect transformEffect = new Transform3DEffect()
{
    Source = cat,
    TransformMatrix = Matrix4x4.CreateRotationZ(0.5f, new Vector3(0, 0, 0))
};

// In a Draw event handler:
void myWidget_Draw(CanvasControl sender, CanvasDrawEventArgs args)
{
    args.DrawingSession.DrawImage(transformEffect, 42, 42);
}
```
```

--------------------------------

### Get and Set Font Size

Source: https://microsoft.github.io/Win2D/WinUI3/html/P_Microsoft_Graphics_Canvas_Text_CanvasTextFormat_FontSize.htm

This snippet shows the C# signature for getting and setting the FontSize property of a CanvasTextFormat object. This property determines the size of the font in logical units.

```csharp
public float FontSize { get; set; }
```

--------------------------------

### CreateForCoreWindow

Source: https://microsoft.github.io/Win2D/WinUI3/html/Methods_T_Microsoft_Graphics_Canvas_CanvasSwapChain.htm

Initializes a new instance of a CanvasSwapChain, suitable for use with CoreWindow.

```APIDOC
## CreateForCoreWindow

### Description
Initializes a new instance of a CanvasSwapChain, suitable for use with CoreWindow.

### Method
Not specified (likely a static method)

### Parameters
- **resourceCreator** (ICanvasResourceCreator) - Description not specified
- **window** (CoreWindow) - Description not specified
- **dpi** (Single) - Description not specified
- **width** (Single) - Description not specified
- **height** (Single) - Description not specified
- **pixelFormat** (DirectXPixelFormat) - Description not specified
- **alphaMode** (Int32) - Description not specified

### Response
- **canvasSwapChain** (CanvasSwapChain) - Description not specified
```

--------------------------------

### CanvasSwapChain Constructor (ICanvasResourceCreatorWithDpi, Size)

Source: https://microsoft.github.io/Win2D/WinUI3/html/M_Microsoft_Graphics_Canvas_CanvasSwapChain__ctor_3.htm

Initializes a new instance of the CanvasSwapChain class, with the specified size. The swap chain's pixel format will default to DirectXPixelFormat.B8G8R8A8UIntNormalized, its buffer count will be 2, and its alpha mode will be CanvasAlphaMode.Premultiplied. Size is in device independent pixels (DIPs), and DPI is taken from the specified resource creator interface.

```APIDOC
## CanvasSwapChain Constructor (ICanvasResourceCreatorWithDpi, Size)

### Description
Initializes a new instance of the CanvasSwapChain class, with the specified size.

### Parameters
#### Path Parameters
* None

#### Query Parameters
* None

#### Request Body
* None

### Parameters
#### resourceCreator
* Type: Microsoft.Graphics.Canvas.ICanvasResourceCreatorWithDpi
* Description: The resource creator.

#### size
* Type: Windows.Foundation.Size
* Description: The swap chain's pixel format will default to DirectXPixelFormat.B8G8R8A8UIntNormalized, its buffer count will be 2, and its alpha mode will be CanvasAlphaMode.Premultiplied. Size is in device independent pixels (DIPs), and DPI is taken from the specified resource creator interface.

### Request Example
* None

### Response
#### Success Response (200)
* None

#### Response Example
* None
```

--------------------------------

### Get and Set GammaTransferEffect GreenExponent

Source: https://microsoft.github.io/Win2D/WinUI3/html/P_Microsoft_Graphics_Canvas_Effects_GammaTransferEffect_GreenExponent.htm

Demonstrates how to get and set the GreenExponent property for the GammaTransferEffect. This property controls the exponent applied to the green color channel. Default value is 1.

```C#
public float GreenExponent { get; set; }
```

--------------------------------

### Drawing Sprites with Tint

Source: https://microsoft.github.io/Win2D/WinUI3/html/M_Microsoft_Graphics_Canvas_CanvasSpriteBatch_DrawFromSpriteSheet_8.htm

Example of how to draw sprites using a sprite batch and applying a tint color. The tint is specified as a Vector4, and the example shows how to convert a Windows.UI.Color to this format.

```csharp
void DrawSomeSprites(CanvasDrawingSession ds)
{
    using (var spriteBatch = ds.CreateSpriteBatch())
    {
        spriteBatch.Draw(image, destRect, new Vector4(Color.R, Color.G, Color.B, Color.A) / 255.0f);
    }
}
```

--------------------------------

### CanvasSwapChain Constructor (ICanvasResourceCreator, Single, Single, Single)

Source: https://microsoft.github.io/Win2D/WinUI3/html/M_Microsoft_Graphics_Canvas_CanvasSwapChain__ctor.htm

Initializes a new instance of the CanvasSwapChain class with the specified width, height, and dpi. The swap chain's pixel format will default to DirectXPixelFormat.B8G8R8A8UIntNormalized, its buffer count will be 2, and its alpha mode will be CanvasAlphaMode.Premultiplied. Size is in device independent pixels (DIPs).

```APIDOC
## CanvasSwapChain Constructor (ICanvasResourceCreator, Single, Single, Single)

### Description
Initializes a new instance of the CanvasSwapChain class with the specified width, height, and dpi.

### Parameters
#### Path Parameters
- **resourceCreator** (ICanvasResourceCreator) - Required - The resource creator.
- **width** (Single) - Required - The width of the swap chain in device independent pixels (DIPs).
- **height** (Single) - Required - The height of the swap chain in device independent pixels (DIPs).
- **dpi** (Single) - Required - The DPI of the swap chain.

### Remarks
The swap chain's pixel format will default to DirectXPixelFormat.B8G8R8A8UIntNormalized, its buffer count will be 2, and its alpha mode will be CanvasAlphaMode.Premultiplied.
```

--------------------------------

### Initialize RgbToHueEffect

Source: https://microsoft.github.io/Win2D/WinUI3/html/M_Microsoft_Graphics_Canvas_Effects_RgbToHueEffect__ctor.htm

Initializes a new instance of the RgbToHueEffect class. This is the default constructor.

```csharp
public RgbToHueEffect()
```

--------------------------------

### Get and Set ClearColor Property

Source: https://microsoft.github.io/Win2D/WinUI3/html/P_Microsoft_Graphics_Canvas_UI_Xaml_ICanvasAnimatedControl_ClearColor.htm

This C# code defines the signature for the ClearColor property, which allows you to get or set the color used to clear the canvas before drawing. The control will redraw when this property is modified.

```csharp
Color ClearColor { get; set; }
```

--------------------------------

### GetGdiCompatibleGlyphMetrics

Source: https://microsoft.github.io/Win2D/WinUI3/html/Methods_T_Microsoft_Graphics_Canvas_Text_CanvasFontFace.htm

Gets the metrics and bounds of the glyphs that would get drawn, compatible with what GDI would produce, in em units. This method is useful for ensuring visual consistency with older GDI rendering.

```APIDOC
## GetGdiCompatibleGlyphMetrics

### Description
Gets the metrics and bounds of the glyphs that would get drawn, compatible with what GDI would produce, in em units.

### Method
GetGdiCompatibleGlyphMetrics
```

--------------------------------

### Using GetSystemFontFamilies with Application Languages

Source: https://microsoft.github.io/Win2D/WinUI3/html/M_Microsoft_Graphics_Canvas_Text_CanvasTextFormat_GetSystemFontFamilies_1.htm

This example demonstrates how to call GetSystemFontFamilies using the current application's preferred languages. Ensure you have the Windows.Globalization namespace imported.

```csharp
using Windows.Globalization;

...

string[] fontFamilyNames = CanvasTextFormat.GetSystemFontFamilies(ApplicationLanguages.Languages);
```

--------------------------------

### Initialize CanvasAnimatedControl

Source: https://microsoft.github.io/Win2D/WinUI3/html/M_Microsoft_Graphics_Canvas_UI_Xaml_CanvasAnimatedControl__ctor.htm

Use this constructor to create a new instance of the CanvasAnimatedControl. No specific setup or parameters are required for basic initialization.

```csharp
public CanvasAnimatedControl()

```

--------------------------------

### CanvasSwapChainPanel Constructor

Source: https://microsoft.github.io/Win2D/WinUI3/html/M_Microsoft_Graphics_Canvas_UI_Xaml_CanvasSwapChainPanel__ctor.htm

Initializes a new instance of the CanvasSwapChainPanel class.

```APIDOC
## CanvasSwapChainPanel()

### Description
Initializes a new instance of the CanvasSwapChainPanel class.

### Method
Constructor

### Parameters
This constructor does not take any parameters.

### Reference
CanvasSwapChainPanel Class
Microsoft.Graphics.Canvas.UI.Xaml Namespace
```

--------------------------------

### CanvasDevice Constructor with Boolean Parameter

Source: https://microsoft.github.io/Win2D/WinUI3/html/M_Microsoft_Graphics_Canvas_CanvasDevice__ctor_1.htm

Use this constructor to create a new CanvasDevice instance. Set 'forceSoftwareRenderer' to true to ensure rendering occurs on the CPU, which can be useful for debugging or specific hardware limitations.

```csharp
public CanvasDevice(
	bool forceSoftwareRenderer
)
```

--------------------------------

### Get or Set Brush Transform Matrix

Source: https://microsoft.github.io/Win2D/WinUI3/html/P_Microsoft_Graphics_Canvas_Brushes_ICanvasBrush_Transform.htm

Use the Transform property to get or set the brush's transformation matrix. This allows you to translate, rotate, or scale the brush's coordinate space independently of the render target.

```csharp
Matrix3x2 Transform { get; set; }
```

--------------------------------

### CanvasPathBuilder.BeginFigure Method (Single, Single)

Source: https://microsoft.github.io/Win2D/WinUI3/html/M_Microsoft_Graphics_Canvas_Geometry_CanvasPathBuilder_BeginFigure_2.htm

Starts a new figure at the specified point, with the default figure fill option of Default.

```APIDOC
## BeginFigure (Single, Single)

### Description
Starts a new figure at the specified point, with the default figure fill option of Default.

### Method
Not applicable (SDK method)

### Endpoint
Not applicable (SDK method)

### Parameters
#### Path Parameters
- **startX** (System.Single) - Required - The x-coordinate of the starting point.
- **startY** (System.Single) - Required - The y-coordinate of the starting point.

### Request Example
```csharp
// Example usage:
CanvasPathBuilder pathBuilder = new CanvasPathBuilder();
pathBuilder.BeginFigure(10.5f, 20.0f);
```

### Response
#### Success Response
This method does not return a value.
```

--------------------------------

### Initialize CanvasVirtualControl

Source: https://microsoft.github.io/Win2D/WinUI3/html/M_Microsoft_Graphics_Canvas_UI_Xaml_CanvasVirtualControl__ctor.htm

Initializes a new instance of the CanvasVirtualControl class. This is the default constructor.

```csharp
public CanvasVirtualControl()
```

--------------------------------

### ICanvasTextRenderer.Dpi Property

Source: https://microsoft.github.io/Win2D/WinUI3/html/P_Microsoft_Graphics_Canvas_Text_ICanvasTextRenderer_Dpi.htm

Gets the current DPI.

```APIDOC
## ICanvasTextRenderer.Dpi Property

### Description
Gets the current DPI.

### Property Value
Type: Single
```

--------------------------------

### CanvasPrintDocument.Device

Source: https://microsoft.github.io/Win2D/WinUI3/html/Properties_T_Microsoft_Graphics_Canvas_Printing_CanvasPrintDocument.htm

Gets the CanvasDevice that this CanvasPrintDocument uses for drawing.

```APIDOC
## CanvasPrintDocument.Device

### Description
Gets the CanvasDevice that this CanvasPrintDocument uses for drawing.

### Property Type
CanvasDevice
```
Tokens:
Raw