PixelFormat Struct

Definition

Namespace:

System.Windows.Media

Assembly:

PresentationCore.dll

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

public value class PixelFormat : IEquatable<System::Windows::Media::PixelFormat>

[System.ComponentModel.TypeConverter(typeof(System.Windows.Media.PixelFormatConverter))]
public struct PixelFormat : IEquatable<System.Windows.Media.PixelFormat>

[<System.ComponentModel.TypeConverter(typeof(System.Windows.Media.PixelFormatConverter))>]
type PixelFormat = struct

Public Structure PixelFormat
Implements IEquatable(Of PixelFormat)

Inheritance

Object

ValueType

PixelFormat

Attributes

TypeConverterAttribute

Implements

IEquatable<PixelFormat>

Examples

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

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

Remarks

XAML Attribute Usage

<object property="pixelFormat"/>  

XAML Values

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

Properties

BitsPerPixel	Gets the number of bits-per-pixel (bpp) for this PixelFormat.
Masks	Gets a collection of bit masks associated with the PixelFormat.

Methods

Equals(Object)	Determines whether the specified object is equal to the current object.
Equals(PixelFormat)	Determines whether the pixel format equals the given PixelFormat.
Equals(PixelFormat, PixelFormat)	Determines whether the specified PixelFormat instances are considered equal.
GetHashCode()	Creates a hash code from this pixel format's Masks value.
ToString()	Creates a string representation of this PixelFormat.

Operators

Equality(PixelFormat, PixelFormat)	Compares two PixelFormat instances for equality.
Inequality(PixelFormat, PixelFormat)	Compares two PixelFormat instances for inequality.

See also

• PixelFormats