Platforms to show: All Mac Windows Linux Cross-Platform
Back to TwainImageInfoMBS class.
TwainImageInfoMBS.BitsPerPixel as Integer
Function:
The number of bits in each image pixel (or bit depth).
Notes:
This value is invariant across the image. 24-bit R-G-B has BitsPerPixel = 24. 40-bit C-M-Y-K has BitsPerPixel=40. 8-bit Grayscale has BitsPerPixel = 8. Black and White has BitsPerPixel = 1.
(Read and Write property)
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
property | Twain | MBS Picture Plugin | 12.2 | ✅ Yes | ✅ Yes | ❌ No | ✅ Yes | All |
Notes:
This value is invariant across the image. 24-bit R-G-B has BitsPerPixel = 24. 40-bit C-M-Y-K has BitsPerPixel=40. 8-bit Grayscale has BitsPerPixel = 8. Black and White has BitsPerPixel = 1.
(Read and Write property)
TwainImageInfoMBS.Compression as Integer
Function:
The compression method used to process the data being transferred.
Notes:
Default is no compression.
(plugin currently only supports no compression)
(Read and Write property)
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
property | Twain | MBS Picture Plugin | 12.2 | ✅ Yes | ✅ Yes | ❌ No | ✅ Yes | All |
Notes:
Default is no compression.
(plugin currently only supports no compression)
(Read and Write property)
TwainImageInfoMBS.ImageLength as Integer
Function:
How tall/long, in pixels, the image to be transferred is.
Notes:
If the Source doesn't know, set this field to -1 (hand scanners may do this).
-1 can only be used if the application has set ICAP_UNDEFINEDIMAGESIZE to TRUE.
(the plugin doesn't support undefined image size)
(Read and Write property)
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
property | Twain | MBS Picture Plugin | 12.2 | ✅ Yes | ✅ Yes | ❌ No | ✅ Yes | All |
Notes:
If the Source doesn't know, set this field to -1 (hand scanners may do this).
-1 can only be used if the application has set ICAP_UNDEFINEDIMAGESIZE to TRUE.
(the plugin doesn't support undefined image size)
(Read and Write property)
Some examples using this property:
TwainImageInfoMBS.ImageWidth as Integer
Function:
How wide, in pixels, the entire image to be transferred is.
Notes:
If the Source doesn't know, set this field to -1 (hand scanners may do this).
-1 can only be used if the application has set ICAP_UNDEFINEDIMAGESIZE to TRUE.
(the plugin doesn't support undefined image size)
(Read and Write property)
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
property | Twain | MBS Picture Plugin | 12.2 | ✅ Yes | ✅ Yes | ❌ No | ✅ Yes | All |
Notes:
If the Source doesn't know, set this field to -1 (hand scanners may do this).
-1 can only be used if the application has set ICAP_UNDEFINEDIMAGESIZE to TRUE.
(the plugin doesn't support undefined image size)
(Read and Write property)
TwainImageInfoMBS.PixelType as Integer
Function:
This is the highest categorization for how the data being transferred should be interpreted by the application.
Notes:
This is how the application can tell if the data is Black and White, Grayscale, or Color. Currently, the only color type defined is "tri-stimulus", or color described by three characteristics. Most popular color description methods use tri- stimulus descriptors. For simplicity, the constant used to identify tri-stimulus color is called TWPT_RBG, for R-G-B color. There is no default for this value. Fill this field with the appropriate TWPT_xxxx constant.
The plugin does currently only support RGB, GRAY, BW and PALETTE.
(Read and Write property)
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
property | Twain | MBS Picture Plugin | 12.2 | ✅ Yes | ✅ Yes | ❌ No | ✅ Yes | All |
Notes:
This is how the application can tell if the data is Black and White, Grayscale, or Color. Currently, the only color type defined is "tri-stimulus", or color described by three characteristics. Most popular color description methods use tri- stimulus descriptors. For simplicity, the constant used to identify tri-stimulus color is called TWPT_RBG, for R-G-B color. There is no default for this value. Fill this field with the appropriate TWPT_xxxx constant.
The plugin does currently only support RGB, GRAY, BW and PALETTE.
(Read and Write property)
TwainImageInfoMBS.Planar as Boolean
Function:
Whether image is planar.
Notes:
If SamplesPerPixel > 1, indicates whether the samples follow one another on a pixel-by-pixel basis (R-G-B-R-G-B-R-G-B...) as is common with a one-pass scanner or all the pixels for each sample are grouped together (complete group of R, complete group of G, complete group of B) as is common with a three-pass scanner. If the pixel-by-pixel method (also known as "chunky") is used, the Source should set Planar = false. If the grouped method (also called "planar") is used, the Source should set Planar = true.
(Read and Write property)
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
property | Twain | MBS Picture Plugin | 12.2 | ✅ Yes | ✅ Yes | ❌ No | ✅ Yes | All |
Notes:
If SamplesPerPixel > 1, indicates whether the samples follow one another on a pixel-by-pixel basis (R-G-B-R-G-B-R-G-B...) as is common with a one-pass scanner or all the pixels for each sample are grouped together (complete group of R, complete group of G, complete group of B) as is common with a three-pass scanner. If the pixel-by-pixel method (also known as "chunky") is used, the Source should set Planar = false. If the grouped method (also called "planar") is used, the Source should set Planar = true.
(Read and Write property)
TwainImageInfoMBS.RowBytes as Integer
Function:
The number of bytes in a row.
Notes:
This is not exactly the value as you may expect as Twain needs some rounding.
(Read and Write property)
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
property | Twain | MBS Picture Plugin | 12.5 | ✅ Yes | ✅ Yes | ❌ No | ✅ Yes | All |
Notes:
This is not exactly the value as you may expect as Twain needs some rounding.
(Read and Write property)
TwainImageInfoMBS.SamplesPerPixel as Integer
Function:
The number of samples being returned.
Notes:
For R-G-B, this field would be set to 3. For C-M-Y-K, 4. For Grayscale or Black and White, 1.
(Read and Write property)
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
property | Twain | MBS Picture Plugin | 12.2 | ✅ Yes | ✅ Yes | ❌ No | ✅ Yes | All |
Notes:
For R-G-B, this field would be set to 3. For C-M-Y-K, 4. For Grayscale or Black and White, 1.
(Read and Write property)
TwainImageInfoMBS.XResolution as Double
Function:
Horizontal resolution.
Notes:
In pixels per inch.
(Read and Write property)
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
property | Twain | MBS Picture Plugin | 12.2 | ✅ Yes | ✅ Yes | ❌ No | ✅ Yes | All |
Notes:
In pixels per inch.
(Read and Write property)
TwainImageInfoMBS.YResolution as Double
Function:
Vertical resolution.
Notes:
In pixels per inch.
(Read and Write property)
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
property | Twain | MBS Picture Plugin | 12.2 | ✅ Yes | ✅ Yes | ❌ No | ✅ Yes | All |
Notes:
In pixels per inch.
(Read and Write property)
The items on this page are in the following plugins: MBS Picture Plugin.
