Visual.IsPixelSnappingEnabled Property

Definition

Namespace:

Windows.UI.Composition

Gets or sets a value that indicates whether the composition engine aligns the rendered visual with a pixel boundary.

public:
 property bool IsPixelSnappingEnabled { bool get(); void set(bool value); };

bool IsPixelSnappingEnabled();

void IsPixelSnappingEnabled(bool value);

public bool IsPixelSnappingEnabled { get; set; }

var boolean = visual.isPixelSnappingEnabled;
visual.isPixelSnappingEnabled = boolean;

Public Property IsPixelSnappingEnabled As Boolean

Property Value

Boolean

bool

true if the composition engine aligns the rendered visual with a pixel boundary; otherwise, false. The default is false.

Windows requirements

Device family	Windows 10, version 2104 (introduced in 10.0.20348.0)
API contract	Windows.Foundation.UniversalApiContract (introduced in v12.0)

Examples

public Visual CreateVisualTree(Compositor compositor)
{
    // Say we have two visuals, one containing an image and one containing text.
    // The image can be resampled and still look fine, but the text looks bad if
    // it doesn't land perfectly on pixel boundaries.
    var root = compositor.CreateContainerVisual();

    var imageVisual = compositor.CreateSpriteVisual();
    ImageLoadingHelper(imageVisual);

    var textVisual = compositor.CreateSpriteVisual();
    TextLoadingHelper(textVisual);

    textVisual.Offset = new Vector3(50, 0, 0);
    textVisual.IsPixelSnappingEnabled = true;

    root.Children.Add(imageVisual);
    root.Children.Add(textVisual);

    return root;
}