Hide Table of Contents
GetPixels Method (IBitmapImageSource)

Gets the raw pixel buffer of the bitmap image.

.NET Syntax

Visual Basic (Declaration) 
Function GetPixels() As System.Byte()
Visual Basic (Usage) 
Dim instance As IBitmapImageSource
Dim value() As System.Byte
 
value = instance.GetPixels()
C# 
System.byte[] GetPixels()
C++/CLI 
System.array<byte>^ GetPixels();

Return Value

A byte array representing the pixel data of the image (see Remarks)

Remarks

This method returns the raw pixel buffer of the bitmap image in Bgr32 format. Bgr32 is a 32-bit sRGB pixel format in which each pixel is composed of 8 bits each for blue, green and red channels. There is an additional 8 unused bits, typically for alignment.

The byte array length is Width X Height X 4 bytes. Pixels are laid out in row-major order, left to right, top to bottom.

 

See Also

Availability

SOLIDWORKS Visualize Add-in API 2026 FCS


Provide feedback on this topic

SOLIDWORKS welcomes your feedback concerning the presentation, accuracy, and thoroughness of the documentation. Use the form below to send your comments and suggestions about this topic directly to our documentation team. The documentation team cannot answer technical support questions. Click here for information about technical support.

* Required

 
*Email:  
Subject:   Feedback on Help Topics
Page:   GetPixels Method (IBitmapImageSource)
*Comment:  
*   I acknowledge I have read and I hereby accept the privacy policy under which my Personal Data will be used by Dassault Systèmes

Print Topic

Select the scope of content to print:

x

We have detected you are using a browser version older than Internet Explorer 7. For optimized display, we suggest upgrading your browser to Internet Explorer 7 or newer.

 Never show this message again
x

Web Help Content Version: API Help (English only) 2026 PR1

To disable Web help from within SOLIDWORKS and use local help instead, click Help > Use SOLIDWORKS Web Help.

To report problems encountered with the Web help interface and search, contact your local support representative. To provide feedback on individual help topics, use the “Feedback on this topic” link on the individual topic page.

10.20.6