This topic has not yet been rated - Rate this topic

PixelFormat Structure

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

Namespace:  System.Windows.Media
Assembly:  PresentationCore (in PresentationCore.dll)
XMLNS for XAML: http://schemas.microsoft.com/winfx/2006/xaml/presentation, http://schemas.microsoft.com/netfx/2007/xaml/presentation
[SerializableAttribute]
[TypeConverterAttribute(typeof(PixelFormatConverter))]
public struct PixelFormat : IEquatable<PixelFormat>
<object property="pixelFormat"/>

XAML Values

pixelFormat

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

The PixelFormat type exposes the following members.

  Name Description
Public property BitsPerPixel Gets the number of bits-per-pixel (bpp) for this PixelFormat.
Public property Masks Gets a collection of bit masks associated with the PixelFormat.
Top
  Name Description
Public method Equals(Object) Determines whether the specified object is equal to the current object. (Overrides ValueType.Equals(Object).)
Public method Equals(PixelFormat) Determines whether the pixel format equals the given PixelFormat.
Public method Static member Equals(PixelFormat, PixelFormat) Determines whether the specified PixelFormat instances are considered equal.
Protected method Finalize Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.)
Public method GetHashCode Creates a hash code from this pixel format's Masks value. (Overrides ValueType.GetHashCode().)
Public method GetType Gets the Type of the current instance. (Inherited from Object.)
Protected method MemberwiseClone Creates a shallow copy of the current Object. (Inherited from Object.)
Public method ToString Creates a string representation of this PixelFormat. (Overrides ValueType.ToString().)
Top
  Name Description
Public operator Static member Equality Compares two PixelFormat instances for equality.
Public operator Static member Inequality Compares two PixelFormat instances for inequality.
Top

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;
}


More Code

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

.NET Framework

Supported in: 4, 3.5, 3.0

.NET Framework Client Profile

Supported in: 4, 3.5 SP1

Windows 7, Windows Vista SP1 or later, Windows XP SP3, Windows Server 2008 (Server Core not supported), Windows Server 2008 R2 (Server Core supported with SP1 or later), Windows Server 2003 SP2

The .NET Framework does not support all versions of every platform. For a list of the supported versions, see .NET Framework System Requirements.
Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.
Did you find this helpful?
(1500 characters remaining)
Community Content Add
Annotations FAQ