PixelFormat.Masks PixelFormat.Masks PixelFormat.Masks PixelFormat.Masks Property

Definition

Gets a collection of bit masks associated with the PixelFormat.

public:
 property System::Collections::Generic::IList<System::Windows::Media::PixelFormatChannelMask> ^ Masks { System::Collections::Generic::IList<System::Windows::Media::PixelFormatChannelMask> ^ get(); };
[get: System.Security.SecurityCritical]
public System.Collections.Generic.IList<System.Windows.Media.PixelFormatChannelMask> Masks { get; }
member this.Masks : System.Collections.Generic.IList<System.Windows.Media.PixelFormatChannelMask>
Public ReadOnly Property Masks As IList(Of PixelFormatChannelMask)

Property Value

The collection of bit masks and shifts associated with the PixelFormat.

Examples

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;
}
        Public Function createPixelFormat() As PixelFormat
            ' Create a PixelFormat object.
            Dim myPixelFormat As 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.
            Dim bpp As Integer = myPixelFormat.BitsPerPixel

            ' Get the collection of masks associated with this format.
            Dim myChannelMaskCollection As IList(Of PixelFormatChannelMask) = (myPixelFormat.Masks)

            ' Capture the mask info in a string.
            Dim stringOfValues As String = " "
            Dim myMask As PixelFormatChannelMask
            For Each myMask In myChannelMaskCollection
                Dim myBytesCollection As IList(Of Byte) = myMask.Mask
                Dim myByte As Byte
                For Each myByte In myBytesCollection
                    stringOfValues = stringOfValues + myByte.ToString()
                Next myByte
            Next myMask

            ' 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

        End Function 'createPixelFormat
    End Class
End Namespace 'ImagingSnippetGallery

Applies to