Bitmap.LockBits Method (Rectangle, ImageLockMode, PixelFormat)

 

Locks a Bitmap into system memory.

Namespace:   System.Drawing
Assembly:  System.Drawing (in System.Drawing.dll)

[<SecurityPermissionAttribute(SecurityAction.LinkDemand, Flags = SecurityPermissionFlag.UnmanagedCode)>]
member LockBits : 
        rect:Rectangle *
        flags:ImageLockMode *
        format:PixelFormat -> BitmapData

Parameters

rect
Type: System.Drawing.Rectangle

A Rectangle structure that specifies the portion of the Bitmap to lock.

flags
Type: System.Drawing.Imaging.ImageLockMode

An ImageLockMode enumeration that specifies the access level (read/write) for the Bitmap.

format
Type: System.Drawing.Imaging.PixelFormat

A PixelFormat enumeration that specifies the data format of this Bitmap.

Return Value

Type: System.Drawing.Imaging.BitmapData

A BitmapData that contains information about this lock operation.

Exception Condition
ArgumentException

The PixelFormat is not a specific bits-per-pixel value.

-or-

The incorrect PixelFormat is passed in for a bitmap.

Exception

The operation failed.

Use the LockBits method to lock an existing bitmap in system memory so that it can be changed programmatically. You can change the color of an image with the SetPixel method, although the LockBits method offers better performance for large-scale changes.

The BitmapData specifies the attributes of the Bitmap, such as size, pixel format, the starting address of the pixel data in memory, and length of each scan line (stride).

When calling this method, you should use a member of the System.Drawing.Imaging.PixelFormat enumeration that contains a specific bits-per-pixel (BPP) value. Using System.Drawing.Imaging.PixelFormat values such as Indexed and Gdi will throw an System.ArgumentException. Also, passing the incorrect pixel format for a bitmap will throw an System.ArgumentException.

The following code example demonstrates how to use the PixelFormat, Height, Width, and Scan0 properties; the LockBits and UnlockBits methods; and the ImageLockMode enumeration. This example is designed to be used with Windows Forms. This example is not designed to work correctly with all pixel formats, but to provide an example of how to use the LockBits method. To run this example, paste it into a form and handle the form's Paint event by calling the LockUnlockBitsExample method, passing e as PaintEventArgs.

No code example is currently available or this language may not be supported.

.NET Framework
Available since 1.1
Return to top
Show: