BitmapSource.CopyPixels Method
Important
Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.
Copies the bitmap pixel data.
| CopyPixels(Array, Int32, Int32) |
Copies the bitmap pixel data into an array of pixels with the specified stride, starting at the specified offset. |
| CopyPixels(Int32Rect, Array, Int32, Int32) |
Copies the bitmap pixel data within the specified rectangle into an array of pixels that has the specified stride starting at the specified offset. |
| CopyPixels(Int32Rect, IntPtr, Int32, Int32) |
Copies the bitmap pixel data within the specified rectangle. |
Copies the bitmap pixel data into an array of pixels with the specified stride, starting at the specified offset.
public:
virtual void CopyPixels(Array ^ pixels, int stride, int offset);[System.Security.SecurityCritical]
public virtual void CopyPixels(Array pixels, int stride, int offset);public virtual void CopyPixels(Array pixels, int stride, int offset);[<System.Security.SecurityCritical>]
abstract member CopyPixels : Array * int * int -> unit
override this.CopyPixels : Array * int * int -> unitabstract member CopyPixels : Array * int * int -> unit
override this.CopyPixels : Array * int * int -> unitPublic Overridable Sub CopyPixels (pixels As Array, stride As Integer, offset As Integer)Parameters
- pixels
- Array
The destination array.
- stride
- Int32
The stride of the bitmap.
- offset
- Int32
The pixel location where copying starts.
- Attributes
Applies to
.NET Framework 4.8.1 and other versions
| Product | Versions |
|---|---|
| .NET Framework | 3.0, 3.5, 4.0, 4.5, 4.5.1, 4.5.2, 4.6, 4.6.1, 4.6.2, 4.7, 4.7.1, 4.7.2, 4.8, 4.8.1 |
| Windows Desktop | 3.0, 3.1, 5, 6, 7, 8, 9, 10 |
Copies the bitmap pixel data within the specified rectangle into an array of pixels that has the specified stride starting at the specified offset.
public:
virtual void CopyPixels(System::Windows::Int32Rect sourceRect, Array ^ pixels, int stride, int offset);[System.Security.SecurityCritical]
public virtual void CopyPixels(System.Windows.Int32Rect sourceRect, Array pixels, int stride, int offset);public virtual void CopyPixels(System.Windows.Int32Rect sourceRect, Array pixels, int stride, int offset);[<System.Security.SecurityCritical>]
abstract member CopyPixels : System.Windows.Int32Rect * Array * int * int -> unit
override this.CopyPixels : System.Windows.Int32Rect * Array * int * int -> unitabstract member CopyPixels : System.Windows.Int32Rect * Array * int * int -> unit
override this.CopyPixels : System.Windows.Int32Rect * Array * int * int -> unitPublic Overridable Sub CopyPixels (sourceRect As Int32Rect, pixels As Array, stride As Integer, offset As Integer)Parameters
- pixels
- Array
The destination array.
- stride
- Int32
The stride of the bitmap.
- offset
- Int32
The pixel location where copying begins.
- Attributes
Remarks
An empty sourceRect value (specified as all zeros) copies the entire bitmap.
Applies to
.NET Framework 4.8.1 and other versions
| Product | Versions |
|---|---|
| .NET Framework | 3.0, 3.5, 4.0, 4.5, 4.5.1, 4.5.2, 4.6, 4.6.1, 4.6.2, 4.7, 4.7.1, 4.7.2, 4.8, 4.8.1 |
| Windows Desktop | 3.0, 3.1, 5, 6, 7, 8, 9, 10 |
Copies the bitmap pixel data within the specified rectangle.
public:
virtual void CopyPixels(System::Windows::Int32Rect sourceRect, IntPtr buffer, int bufferSize, int stride);[System.Security.SecurityCritical]
public virtual void CopyPixels(System.Windows.Int32Rect sourceRect, IntPtr buffer, int bufferSize, int stride);public virtual void CopyPixels(System.Windows.Int32Rect sourceRect, IntPtr buffer, int bufferSize, int stride);[<System.Security.SecurityCritical>]
abstract member CopyPixels : System.Windows.Int32Rect * nativeint * int * int -> unit
override this.CopyPixels : System.Windows.Int32Rect * nativeint * int * int -> unitabstract member CopyPixels : System.Windows.Int32Rect * nativeint * int * int -> unit
override this.CopyPixels : System.Windows.Int32Rect * nativeint * int * int -> unitPublic Overridable Sub CopyPixels (sourceRect As Int32Rect, buffer As IntPtr, bufferSize As Integer, stride As Integer)Parameters
- buffer
-
IntPtr
nativeint
A pointer to the buffer.
- bufferSize
- Int32
The size of the buffer.
- stride
- Int32
The stride of the bitmap.
- Attributes
Remarks
An empty sourceRect value (specified as all zeros) copies the entire bitmap.
Applies to
.NET Framework 4.8.1 and other versions
| Product | Versions |
|---|---|
| .NET Framework | 3.0, 3.5, 4.0, 4.5, 4.5.1, 4.5.2, 4.6, 4.6.1, 4.6.2, 4.7, 4.7.1, 4.7.2, 4.8, 4.8.1 |
| Windows Desktop | 3.0, 3.1, 5, 6, 7, 8, 9, 10 |
.NET feedback
.NET is an open source project. Select a link to provide feedback: