This documentation is archived and is not being maintained.

PixelFormat Structure

Defines a pixel format for images and pixel-based surfaces.

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

<SerializableAttribute> _
<TypeConverterAttribute(GetType(PixelFormatConverter))> _
Public Structure PixelFormat _
	Implements IEquatable(Of PixelFormat)
Dim instance As PixelFormat
<object property="pixelFormat"/>

XAML Values


One of the predefined pixel formats defined by the PixelFormats class.

The following example shows how to create a PixelFormat and find the value of its properties.

        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 'PixelFormatsExample 
End Namespace 'ImagingSnippetGallery

More Code

How to: Convert an Image to Greyscale This example shows how to convert an image to grayscale using FormatConvertedBitmap.

Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.

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