This documentation is archived and is not being maintained.

PixelFormat.Masks Property

Gets a collection of bit masks associated with the PixelFormat.

Namespace:  System.Windows.Media
Assembly:  PresentationCore (in PresentationCore.dll)

public IList<PixelFormatChannelMask> Masks { get; }
You cannot set this property in XAML.

Property Value

Type: System.Collections.Generic.IList<PixelFormatChannelMask>
The collection of bit masks and shifts associated with the PixelFormat.

The following example shows how to use the Masks property to get the bit masks associated with the pixel format.

public PixelFormat createPixelFormat()
{
    // Create a PixelFormat object.
    PixelFormat myPixelFormat = new PixelFormat();

    // Make this PixelFormat a Gray32Float pixel format.
    myPixelFormat = PixelFormats.Gray32Float;

    // Get the number of bits-per-pixel for this format. Because 
    // the format is "Gray32Float", the float value returned will be 32.
    int bpp = myPixelFormat.BitsPerPixel;

    // Get the collection of masks associated with this format.
    IList<PixelFormatChannelMask> myChannelMaskCollection = myPixelFormat.Masks;

    // Capture the mask info in a string.
    String stringOfValues = " ";
    foreach (PixelFormatChannelMask myMask in myChannelMaskCollection)
    {
        IList<byte> myBytesCollection = myMask.Mask;
        foreach (byte myByte in myBytesCollection)
        {
            stringOfValues = stringOfValues + myByte.ToString();
        }
    }

    // Return the PixelFormat which, for example, could be  
    // used to set the pixel format of a bitmap by using it to set 
    // the DestinationFormat of a FormatConvertedBitmap. 
    return myPixelFormat;
}

Windows 7, Windows Vista, Windows XP SP2, Windows Server 2008 R2, Windows Server 2008, Windows Server 2003

The .NET Framework and .NET Compact Framework do not support all versions of every platform. For a list of the supported versions, see .NET Framework System Requirements.

.NET Framework

Supported in: 3.5, 3.0
Show: