Platforms to show: All Mac Windows Linux Cross-Platform
Back to PictureMBS class.
PictureMBS.AlphaOffset as Integer
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
property | Large Picture | MBS Images Plugin | 8.7 | ✅ Yes | ✅ Yes | ✅ Yes | ✅ Yes | All |
(Read and Write property)
PictureMBS.BitsPerComponent as Integer
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
property | Large Picture | MBS Images Plugin | 14.0 | ✅ Yes | ✅ Yes | ✅ Yes | ✅ Yes | All |
Value is 8 for most pictures except those with format ImageFormatGray16 which use 16.
(Read only property)
PictureMBS.BlackOffset as Integer
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
property | Large Picture | MBS Images Plugin | 11.0 | ✅ Yes | ✅ Yes | ✅ Yes | ✅ Yes | All |
(Read only property)
PictureMBS.BlueOffset as Integer
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
property | Large Picture | MBS Images Plugin | 8.7 | ✅ Yes | ✅ Yes | ✅ Yes | ✅ Yes | All |
(Read and Write property)
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
property | Large Picture | MBS Images Plugin | 18.1 | ✅ Yes | ✅ Yes | ✅ Yes | ✅ Yes | All |
For pictures which represent a channel of a bigger picture.
(Read only property)
See also:
PictureMBS.ChannelCount as Integer
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
property | Large Picture | MBS Images Plugin | 11.0 | ✅ Yes | ✅ Yes | ✅ Yes | ✅ Yes | All |
1 for gray, 2 for gray+alpha, 3 for RGB, 4 for RGB+alpha or CMYK and 5 for CMYK+alpha.
(Read only property)
PictureMBS.CyanOffset as Integer
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
property | Large Picture | MBS Images Plugin | 11.0 | ✅ Yes | ✅ Yes | ✅ Yes | ✅ Yes | All |
(Read only property)
PictureMBS.DebugPicture as Picture
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
property | Large Picture | MBS Images Plugin | 9.1 | ✅ Yes | ✅ Yes | ✅ Yes | ✅ Yes | All |
If DebugPictureEnabled is set to true iny our code you can use the DebugPicture property to watch the picture content in the debugger. For speed reasons the size of the debug picture is limited to 512 by 512 pixels. (that could be increased)
(Read only property)
PictureMBS.DebugPictureEnabled as Boolean
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
property | Large Picture | MBS Images Plugin | 9.1 | ✅ Yes | ✅ Yes | ✅ Yes | ✅ Yes | All |
If DebugPictureEnabled is set to true iny our code you can use the DebugPicture property to watch the picture content in the debugger. For speed reasons the size of the debug picture is limited to 512 by 512 pixels. (that could be increased)
(Read and Write property)
Some examples using this property:
PictureMBS.Factory as PictureFactoryMBS
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
property | Large Picture | MBS Images Plugin | 9.0 | ✅ Yes | ✅ Yes | ✅ Yes | ✅ Yes | All |
If one of the functions in this PictureMBS instance needs a new PictureMBS object, this factory is asked first.
(Read and Write property)
Some examples using this property:
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
property | Large Picture | MBS Images Plugin | 19.1 | ✅ Yes | ✅ Yes | ✅ Yes | ✅ Yes | All |
Only set when we have one, e.g. using mapped memory.
(Read only property)
PictureMBS.GrayOffset as Integer
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
property | Large Picture | MBS Images Plugin | 8.7 | ✅ Yes | ✅ Yes | ✅ Yes | ✅ Yes | All |
(Read and Write property)
PictureMBS.GreenOffset as Integer
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
property | Large Picture | MBS Images Plugin | 8.7 | ✅ Yes | ✅ Yes | ✅ Yes | ✅ Yes | All |
(Read and Write property)
PictureMBS.HasAlpha as Boolean
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
property | Large Picture | MBS Images Plugin | 8.7 | ✅ Yes | ✅ Yes | ✅ Yes | ✅ Yes | All |
(Read only property)
PictureMBS.HasBlack as Boolean
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
property | Large Picture | MBS Images Plugin | 11.0 | ✅ Yes | ✅ Yes | ✅ Yes | ✅ Yes | All |
(Read only property)
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
property | Large Picture | MBS Images Plugin | 8.7 | ✅ Yes | ✅ Yes | ✅ Yes | ✅ Yes | All |
(Read only property)
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
property | Large Picture | MBS Images Plugin | 11.0 | ✅ Yes | ✅ Yes | ✅ Yes | ✅ Yes | All |
(Read only property)
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
property | Large Picture | MBS Images Plugin | 8.7 | ✅ Yes | ✅ Yes | ✅ Yes | ✅ Yes | All |
(Read only property)
Some examples using this property:
PictureMBS.HasGreen as Boolean
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
property | Large Picture | MBS Images Plugin | 8.7 | ✅ Yes | ✅ Yes | ✅ Yes | ✅ Yes | All |
(Read only property)
PictureMBS.HasMagenta as Boolean
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
property | Large Picture | MBS Images Plugin | 11.0 | ✅ Yes | ✅ Yes | ✅ Yes | ✅ Yes | All |
(Read only property)
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
property | Large Picture | MBS Images Plugin | 8.7 | ✅ Yes | ✅ Yes | ✅ Yes | ✅ Yes | All |
(Read only property)
PictureMBS.HasYellow as Boolean
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
property | Large Picture | MBS Images Plugin | 11.0 | ✅ Yes | ✅ Yes | ✅ Yes | ✅ Yes | All |
(Read only property)
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
property | Large Picture | MBS Images Plugin | 8.7 | ✅ Yes | ✅ Yes | ✅ Yes | ✅ Yes | All |
(Read only property)
PictureMBS.ImageFormat as Integer
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
property | Large Picture | MBS Images Plugin | 8.7 | ✅ Yes | ✅ Yes | ✅ Yes | ✅ Yes | All |
See the ImageFormat* constants.
(Read only property)
PictureMBS.ImageFormatString as String
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
property | Large Picture | MBS Images Plugin | 8.7 | ✅ Yes | ✅ Yes | ✅ Yes | ✅ Yes | All |
Returns for example "RGB" for ImageFormatRGB.
(Read only property)
Some examples using this property:
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
property | Large Picture | MBS Images Plugin | 11.0 | ✅ Yes | ✅ Yes | ✅ Yes | ✅ Yes | All |
HasCyan, HasMagenta, HasYellow and HasBlack are true if IsRGB is true.
(Read only property)
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
property | Large Picture | MBS Images Plugin | 8.7 | ✅ Yes | ✅ Yes | ✅ Yes | ✅ Yes | All |
HasGray is true if IsGray is true.
(Read only property)
PictureMBS.IsMapping as Boolean
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
property | Large Picture | MBS Images Plugin | 8.7 | ✅ Yes | ✅ Yes | ✅ Yes | ✅ Yes | All |
If IsMapping is true you should not use the Memory property or the Clone function.
(Read only property)
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
property | Large Picture | MBS Images Plugin | 8.7 | ✅ Yes | ✅ Yes | ✅ Yes | ✅ Yes | All |
HasRed, HasBlue and HasGreen are true if IsRGB is true.
(Read only property)
PictureMBS.MagentaOffset as Integer
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
property | Large Picture | MBS Images Plugin | 11.0 | ✅ Yes | ✅ Yes | ✅ Yes | ✅ Yes | All |
(Read only property)
PictureMBS.MappingBlockSize as Int64
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
property | Large Picture | MBS Images Plugin | 8.7 | ✅ Yes | ✅ Yes | ✅ Yes | ✅ Yes | All |
(Read and Write property)
Some examples using this property:
PictureMBS.MappingFirstRow as Integer
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
property | Large Picture | MBS Images Plugin | 17.2 | ✅ Yes | ✅ Yes | ✅ Yes | ✅ Yes | All |
Only for mapped images.
Value is -1 if no data is mapped in.
(Read only property)
PictureMBS.MappingLastRow as Integer
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
property | Large Picture | MBS Images Plugin | 17.2 | ✅ Yes | ✅ Yes | ✅ Yes | ✅ Yes | All |
Only for mapped images.
Value is -1 if no data is mapped in.
(Read only property)
PictureMBS.MappingRows as Integer
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
property | Large Picture | MBS Images Plugin | 17.2 | ✅ Yes | ✅ Yes | ✅ Yes | ✅ Yes | All |
For a mapped image how many rows fit in the mapping buffer.
(Read only property)
PictureMBS.Memory as Memoryblock
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
property | Large Picture | MBS Images Plugin | 8.7 | ✅ Yes | ✅ Yes | ✅ Yes | ✅ Yes | All |
Use only if IsMapping is false.
If size is -1, it's a memoryblock referencing the pixel data.
If size is >0, you got the original memoryblock used to allocate the memory.
(Read only property)
PictureMBS.MemoryTarget as Memoryblock
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
property | Large Picture | MBS Images Plugin | 9.0 | ✅ Yes | ✅ Yes | ✅ Yes | ✅ Yes | All |
(Read only property)
Some examples using this property:
PictureMBS.Parent as PictureMBS
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
property | Large Picture | MBS Images Plugin | 8.7 | ✅ Yes | ✅ Yes | ✅ Yes | ✅ Yes | All |
One PictureMBS can reference the pixels of another PictureMBS. The parent is referenced in this property so it is not released.
(Read only property)
PictureMBS.PixelSize as Integer
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
property | Large Picture | MBS Images Plugin | 8.7 | ✅ Yes | ✅ Yes | ✅ Yes | ✅ Yes | All |
For example:
1 for Gray
2 for Gray with Alpha
3 for RGB
4 for RGB with Alpha
(Read only property)
Some examples using this property:
PictureMBS.RedOffset as Integer
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
property | Large Picture | MBS Images Plugin | 8.7 | ✅ Yes | ✅ Yes | ✅ Yes | ✅ Yes | All |
(Read and Write property)
PictureMBS.RowOffset as Integer
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
property | Large Picture | MBS Images Plugin | 8.7 | ✅ Yes | ✅ Yes | ✅ Yes | ✅ Yes | All |
Only used with clipping images.
(Read only property)
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
property | Large Picture | MBS Images Plugin | 8.7 | ✅ Yes | ✅ Yes | ✅ Yes | ✅ Yes | All |
Additional bytes may be needed per row for better alignment of the data.
Also using virtual memory functions requires alignment.
(Read only property)
Some examples using this property:
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
property | Large Picture | MBS Images Plugin | 8.7 | ✅ Yes | ✅ Yes | ✅ Yes | ✅ Yes | All |
if this PictureMBS references the pixels of a Xojo picture, this property keeps a reference to this target picture.
(Read only property)
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
property | Large Picture | MBS Images Plugin | 8.7 | ✅ Yes | ✅ Yes | ✅ Yes | ✅ Yes | All |
The result is Height*RowSize.
(Read only property)
Some examples using this property:
PictureMBS.UnclippedHeight as Integer
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
property | Large Picture | MBS Images Plugin | 14.3 | ✅ Yes | ✅ Yes | ✅ Yes | ✅ Yes | All |
Without clipping, the full height of the image.
(Read only property)
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
property | Large Picture | MBS Images Plugin | 8.7 | ✅ Yes | ✅ Yes | ✅ Yes | ✅ Yes | All |
Valid is false if the constructor failed to create a picture.
(Read only property)
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
property | Large Picture | MBS Images Plugin | 8.7 | ✅ Yes | ✅ Yes | ✅ Yes | ✅ Yes | All |
(Read only property)
PictureMBS.YellowOffset as Integer
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
property | Large Picture | MBS Images Plugin | 11.0 | ✅ Yes | ✅ Yes | ✅ Yes | ✅ Yes | All |
(Read only property)
PictureMBS.YieldTicks as Integer
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
property | Large Picture | MBS Images Plugin | 8.7 | ✅ Yes | ✅ Yes | ✅ Yes | ✅ Yes | All |
If value is greater than zero, the application will yield to another RB thread after the given number of ticks have passed. 60 ticks are one second. Using a small value can slow down processing a lot while a big value keeps your application not responding to mouse clicks.
If you use this property with e.g. 6 as the value, you may also want to use this method in a thread so you can handle mouse events or let Xojo redraw a progressbar.
(Read and Write property)
The items on this page are in the following plugins: MBS Images Plugin.