Platforms to show: All Mac Windows Linux Cross-Platform
Back to GMImageMBS class.
GMImageMBS.ping(Path as string)
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
method | GraphicsMagick | MBS GraphicsMagick Plugin | 9.3 | ✅ Yes | ✅ Yes | ✅ Yes | ✅ Yes | All |
Ping is similar to read except only enough of the image is read to determine the image columns, rows, and filesize. Access the columns, rows, and fileSize attributes after invoking ping. The image pixels are not valid after calling ping.
See also:
GMImageMBS.pixelColor(x as UInt32, y as UInt32) as GMColorMBS
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
property | GraphicsMagick | MBS GraphicsMagick Plugin | 9.3 | ✅ Yes | ✅ Yes | ✅ Yes | ✅ Yes | All |
(Read and Write computed property)
GMImageMBS.profile(name as string) as GMBlobMBS
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
property | GraphicsMagick | MBS GraphicsMagick Plugin | 9.3 | ✅ Yes | ✅ Yes | ✅ Yes | ✅ Yes | All |
Add or remove a named profile to/from the image. Remove the profile by passing an empty Blob (e.g. Blob()). Valid names are "*", "8BIM", "ICM", "IPTC", or a user/format-defined profile name.
Retrieve a named profile from the image. Valid names are: "8BIM", "8BIMTEXT", "APP1", "APP1JPEG", "ICC", "ICM", & "IPTC" or an existing user/format-defined profile name
(Read and Write computed property)
GMImageMBS.quantize(measureError as boolean=false)
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
method | GraphicsMagick | MBS GraphicsMagick Plugin | 9.3 | ✅ Yes | ✅ Yes | ✅ Yes | ✅ Yes | All |
Set measureError to true in order to calculate error attributes.
GMImageMBS.quantumOperator(channel as Integer, Operator as Integer, rvalue as Double)
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
method | GraphicsMagick | MBS GraphicsMagick Plugin | 16.4 | ✅ Yes | ✅ Yes | ✅ Yes | ✅ Yes | All |
See also:
GMImageMBS.quantumOperator(x as Integer, y as Integer, columns as Integer, rows as Integer, channel as Integer, Operator as Integer, rvalue as Double)
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
method | GraphicsMagick | MBS GraphicsMagick Plugin | 16.4 | ✅ Yes | ✅ Yes | ✅ Yes | ✅ Yes | All |
See also:
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
method | GraphicsMagick | MBS GraphicsMagick Plugin | 9.3 | ✅ Yes | ✅ Yes | ✅ Yes | ✅ Yes | All |
See also:
GMImageMBS.raiseImage(geometry as GMGeometryMBS, raisedFlag as boolean=false)
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
method | GraphicsMagick | MBS GraphicsMagick Plugin | 9.3 | ✅ Yes | ✅ Yes | ✅ Yes | ✅ Yes | All |
See also:
GMImageMBS.randomThreshold(thresholds as GMGeometryMBS)
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
method | GraphicsMagick | MBS GraphicsMagick Plugin | 9.3 | ✅ Yes | ✅ Yes | ✅ Yes | ✅ Yes | All |
Changes the value of individual pixels based on the intensity of each pixel compared to a random threshold. The result is a low-contrast, two color image. The thresholds argument is a geometry containing LOWxHIGH thresholds. If the string contains 2x2, 3x3, or 4x4, then an ordered dither of order 2, 3, or 4 will be performed instead. If a channel argument is specified then only the specified channel is altered. This is a very fast alternative to 'quantize' based dithering.
GMImageMBS.randomThresholdChannel(thresholds as GMGeometryMBS, channel as Integer)
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
method | GraphicsMagick | MBS GraphicsMagick Plugin | 9.3 | ✅ Yes | ✅ Yes | ✅ Yes | ✅ Yes | All |
Changes the value of individual pixels based on the intensity of each pixel compared to a random threshold. The result is a low-contrast, two color image. The thresholds argument is a geometry containing LOWxHIGH thresholds. If the string contains 2x2, 3x3, or 4x4, then an ordered dither of order 2, 3, or 4 will be performed instead. If a channel argument is specified then only the specified channel is altered. This is a very fast alternative to 'quantize' based dithering.
GMImageMBS.read(blob as GMBlobMBS)
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
method | GraphicsMagick | MBS GraphicsMagick Plugin | 9.3 | ✅ Yes | ✅ Yes | ✅ Yes | ✅ Yes | All |
See also:
- read(blob as GMBlobMBS, size as GMGeometryMBS)
- read(blob as GMBlobMBS, size as GMGeometryMBS, depth as Integer)
- read(blob as GMBlobMBS, size as GMGeometryMBS, depth as Integer, magick as string)
- read(blob as GMBlobMBS, size as GMGeometryMBS, magick as string)
- read(file as folderitem)
- read(path as string)
- read(size as GMGeometryMBS, file as folderitem)
- read(size as GMGeometryMBS, Path as string)
- read(width as UInt32, height as UInt32, map as string, StorageType as Integer, data as ptr)
GMImageMBS.read(blob as GMBlobMBS, size as GMGeometryMBS)
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
method | GraphicsMagick | MBS GraphicsMagick Plugin | 9.3 | ✅ Yes | ✅ Yes | ✅ Yes | ✅ Yes | All |
See also:
- read(blob as GMBlobMBS)
- read(blob as GMBlobMBS, size as GMGeometryMBS, depth as Integer)
- read(blob as GMBlobMBS, size as GMGeometryMBS, depth as Integer, magick as string)
- read(blob as GMBlobMBS, size as GMGeometryMBS, magick as string)
- read(file as folderitem)
- read(path as string)
- read(size as GMGeometryMBS, file as folderitem)
- read(size as GMGeometryMBS, Path as string)
- read(width as UInt32, height as UInt32, map as string, StorageType as Integer, data as ptr)
GMImageMBS.read(blob as GMBlobMBS, size as GMGeometryMBS, depth as Integer)
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
method | GraphicsMagick | MBS GraphicsMagick Plugin | 9.3 | ✅ Yes | ✅ Yes | ✅ Yes | ✅ Yes | All |
See also:
- read(blob as GMBlobMBS)
- read(blob as GMBlobMBS, size as GMGeometryMBS)
- read(blob as GMBlobMBS, size as GMGeometryMBS, depth as Integer, magick as string)
- read(blob as GMBlobMBS, size as GMGeometryMBS, magick as string)
- read(file as folderitem)
- read(path as string)
- read(size as GMGeometryMBS, file as folderitem)
- read(size as GMGeometryMBS, Path as string)
- read(width as UInt32, height as UInt32, map as string, StorageType as Integer, data as ptr)
GMImageMBS.read(blob as GMBlobMBS, size as GMGeometryMBS, depth as Integer, magick as string)
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
method | GraphicsMagick | MBS GraphicsMagick Plugin | 9.3 | ✅ Yes | ✅ Yes | ✅ Yes | ✅ Yes | All |
See also:
- read(blob as GMBlobMBS)
- read(blob as GMBlobMBS, size as GMGeometryMBS)
- read(blob as GMBlobMBS, size as GMGeometryMBS, depth as Integer)
- read(blob as GMBlobMBS, size as GMGeometryMBS, magick as string)
- read(file as folderitem)
- read(path as string)
- read(size as GMGeometryMBS, file as folderitem)
- read(size as GMGeometryMBS, Path as string)
- read(width as UInt32, height as UInt32, map as string, StorageType as Integer, data as ptr)
GMImageMBS.read(blob as GMBlobMBS, size as GMGeometryMBS, magick as string)
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
method | GraphicsMagick | MBS GraphicsMagick Plugin | 9.3 | ✅ Yes | ✅ Yes | ✅ Yes | ✅ Yes | All |
See also:
- read(blob as GMBlobMBS)
- read(blob as GMBlobMBS, size as GMGeometryMBS)
- read(blob as GMBlobMBS, size as GMGeometryMBS, depth as Integer)
- read(blob as GMBlobMBS, size as GMGeometryMBS, depth as Integer, magick as string)
- read(file as folderitem)
- read(path as string)
- read(size as GMGeometryMBS, file as folderitem)
- read(size as GMGeometryMBS, Path as string)
- read(width as UInt32, height as UInt32, map as string, StorageType as Integer, data as ptr)
GMImageMBS.read(file as folderitem)
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
method | GraphicsMagick | MBS GraphicsMagick Plugin | 9.3 | ✅ Yes | ✅ Yes | ✅ Yes | ✅ Yes | All |
See also:
- read(blob as GMBlobMBS)
- read(blob as GMBlobMBS, size as GMGeometryMBS)
- read(blob as GMBlobMBS, size as GMGeometryMBS, depth as Integer)
- read(blob as GMBlobMBS, size as GMGeometryMBS, depth as Integer, magick as string)
- read(blob as GMBlobMBS, size as GMGeometryMBS, magick as string)
- read(path as string)
- read(size as GMGeometryMBS, file as folderitem)
- read(size as GMGeometryMBS, Path as string)
- read(width as UInt32, height as UInt32, map as string, StorageType as Integer, data as ptr)
GMImageMBS.read(path as string)
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
method | GraphicsMagick | MBS GraphicsMagick Plugin | 9.3 | ✅ Yes | ✅ Yes | ✅ Yes | ✅ Yes | All |
See also:
- read(blob as GMBlobMBS)
- read(blob as GMBlobMBS, size as GMGeometryMBS)
- read(blob as GMBlobMBS, size as GMGeometryMBS, depth as Integer)
- read(blob as GMBlobMBS, size as GMGeometryMBS, depth as Integer, magick as string)
- read(blob as GMBlobMBS, size as GMGeometryMBS, magick as string)
- read(file as folderitem)
- read(size as GMGeometryMBS, file as folderitem)
- read(size as GMGeometryMBS, Path as string)
- read(width as UInt32, height as UInt32, map as string, StorageType as Integer, data as ptr)
GMImageMBS.read(size as GMGeometryMBS, file as folderitem)
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
method | GraphicsMagick | MBS GraphicsMagick Plugin | 9.3 | ✅ Yes | ✅ Yes | ✅ Yes | ✅ Yes | All |
See also:
- read(blob as GMBlobMBS)
- read(blob as GMBlobMBS, size as GMGeometryMBS)
- read(blob as GMBlobMBS, size as GMGeometryMBS, depth as Integer)
- read(blob as GMBlobMBS, size as GMGeometryMBS, depth as Integer, magick as string)
- read(blob as GMBlobMBS, size as GMGeometryMBS, magick as string)
- read(file as folderitem)
- read(path as string)
- read(size as GMGeometryMBS, Path as string)
- read(width as UInt32, height as UInt32, map as string, StorageType as Integer, data as ptr)
GMImageMBS.read(size as GMGeometryMBS, Path as string)
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
method | GraphicsMagick | MBS GraphicsMagick Plugin | 9.3 | ✅ Yes | ✅ Yes | ✅ Yes | ✅ Yes | All |
See also:
- read(blob as GMBlobMBS)
- read(blob as GMBlobMBS, size as GMGeometryMBS)
- read(blob as GMBlobMBS, size as GMGeometryMBS, depth as Integer)
- read(blob as GMBlobMBS, size as GMGeometryMBS, depth as Integer, magick as string)
- read(blob as GMBlobMBS, size as GMGeometryMBS, magick as string)
- read(file as folderitem)
- read(path as string)
- read(size as GMGeometryMBS, file as folderitem)
- read(width as UInt32, height as UInt32, map as string, StorageType as Integer, data as ptr)
GMImageMBS.read(width as UInt32, height as UInt32, map as string, StorageType as Integer, data as ptr)
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
method | GraphicsMagick | MBS GraphicsMagick Plugin | 14.1 | ✅ Yes | ✅ Yes | ✅ Yes | ✅ Yes | All |
Returns an Image corresponding to an image stored in a raw memory array format. The pixel data must be in scanline order top-to-bottom. The data can be unsigned char, unsigned short int, unsigned int, unsigned long, float, or double. Float and double require the pixels to be normalized to the range [0..1], otherwise the range is [0..MaxVal] where MaxVal is the maximum possible value for that type.
Note that for most 32-bit architectures the size of an unsigned long is the same as unsigned int, but for 64-bit architectures observing the LP64 standard, an unsigned long is 64 bits, while an unsigned int remains 32 bits. This should be considered when deciding if the data should be described as "Integer" or "Long".
For example, to create a 640x480 image from unsigned red-green-blue character data, use
image = new GMImageMBS(640, 480, "RGB", GMImageMBS.StorageTypeCharPixel, pixels);
width: width in pixels of the image.
height: height in pixels of the image.
map: This string reflects the expected ordering of the pixel array. It can be any combination or order of R = red, G = green, B = blue, A = alpha (same as Transparency), O = Opacity, T = Transparency, C = cyan, Y = yellow, M = magenta, K = black, or I = intensity (for grayscale). Specify "P" = pad, to skip over a quantum which is intentionally ignored. Creation of an alpha channel for CMYK images is currently not supported.
type: Define the data type of the pixels. Float and double types are expected to be normalized [0..1] otherwise [0..MaxRGB]. Choose from these types: StorageTypeCharPixel, StorageTypeShortPixel, StorageTypeIntegerPixel, StorageTypeLongPixel, StorageTypeFloatPixel, or StorageTypeDoublePixel.
pixels: This array of values contain the pixel components as defined by map and type. You must preallocate this array where the expected length varies depending on the values of width, height, map, and type.
See also:
- read(blob as GMBlobMBS)
- read(blob as GMBlobMBS, size as GMGeometryMBS)
- read(blob as GMBlobMBS, size as GMGeometryMBS, depth as Integer)
- read(blob as GMBlobMBS, size as GMGeometryMBS, depth as Integer, magick as string)
- read(blob as GMBlobMBS, size as GMGeometryMBS, magick as string)
- read(file as folderitem)
- read(path as string)
- read(size as GMGeometryMBS, file as folderitem)
- read(size as GMGeometryMBS, Path as string)
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
method | GraphicsMagick | MBS GraphicsMagick Plugin | 9.3 | ✅ Yes | ✅ Yes | ✅ Yes | ✅ Yes | All |
See also:
GMImageMBS.reduceNoise(order as Double)
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
method | GraphicsMagick | MBS GraphicsMagick Plugin | 9.3 | ✅ Yes | ✅ Yes | ✅ Yes | ✅ Yes | All |
See also:
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
method | GraphicsMagick | MBS GraphicsMagick Plugin | 19.0 | ✅ Yes | ✅ Yes | ✅ Yes | ✅ Yes | All |
GMImageMBS.resize(geo as GMGeometryMBS)
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
method | GraphicsMagick | MBS GraphicsMagick Plugin | 19.0 | ✅ Yes | ✅ Yes | ✅ Yes | ✅ Yes | All |
Same result as 'zoom' method.
See also:
GMImageMBS.resize(geo as GMGeometryMBS, filterType as Integer)
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
method | GraphicsMagick | MBS GraphicsMagick Plugin | 19.0 | ✅ Yes | ✅ Yes | ✅ Yes | ✅ Yes | All |
See also:
GMImageMBS.resize(geo as GMGeometryMBS, filterType as Integer, blur as double)
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
method | GraphicsMagick | MBS GraphicsMagick Plugin | 19.0 | ✅ Yes | ✅ Yes | ✅ Yes | ✅ Yes | All |
See also:
GMImageMBS.roll(columns as UInt32, rows as UInt32)
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
method | GraphicsMagick | MBS GraphicsMagick Plugin | 9.3 | ✅ Yes | ✅ Yes | ✅ Yes | ✅ Yes | All |
See also:
GMImageMBS.roll(roll as GMGeometryMBS)
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
method | GraphicsMagick | MBS GraphicsMagick Plugin | 9.3 | ✅ Yes | ✅ Yes | ✅ Yes | ✅ Yes | All |
See also:
GMImageMBS.rotate(degree as Double)
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
method | GraphicsMagick | MBS GraphicsMagick Plugin | 9.3 | ✅ Yes | ✅ Yes | ✅ Yes | ✅ Yes | All |
GMImageMBS.sample(geometry as GMGeometryMBS)
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
method | GraphicsMagick | MBS GraphicsMagick Plugin | 9.3 | ✅ Yes | ✅ Yes | ✅ Yes | ✅ Yes | All |
GMImageMBS.scale(geometry as GMGeometryMBS)
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
method | GraphicsMagick | MBS GraphicsMagick Plugin | 9.3 | ✅ Yes | ✅ Yes | ✅ Yes | ✅ Yes | All |
GMImageMBS.segment(clusterThreshold as Double=1.0, smoothingThreshold as Double=1.5)
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
method | GraphicsMagick | MBS GraphicsMagick Plugin | 9.3 | ✅ Yes | ✅ Yes | ✅ Yes | ✅ Yes | All |
A histogram is built for the image. This histogram is filtered to reduce noise and a second derivative of the histogram plot is built and used to identify potential cluster colors (peaks in the histogram). The cluster colors are then validated by scanning through all of the pixels to see how many pixels fall within each cluster. Some candidate cluster colors may not match any of the image pixels at all and should be discarded. Specify clusterThreshold, as the number of pixels matching a cluster color in order for the cluster to be considered valid. SmoothingThreshold eliminates noise in the second derivative of the histogram. As the value is increased, you can expect a smoother second derivative. The default is 1.5.
GMImageMBS.setChromaBluePrimary(x as Double, y as Double)
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
method | GraphicsMagick | MBS GraphicsMagick Plugin | 9.3 | ✅ Yes | ✅ Yes | ✅ Yes | ✅ Yes | All |
e.g. x=0.15, y=0.06
GMImageMBS.setchromaGreenPrimary(x as Double, y as Double)
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
method | GraphicsMagick | MBS GraphicsMagick Plugin | 9.3 | ✅ Yes | ✅ Yes | ✅ Yes | ✅ Yes | All |
e.g. x=0.3, y=0.6
GMImageMBS.setchromaRedPrimary(x as Double, y as Double)
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
method | GraphicsMagick | MBS GraphicsMagick Plugin | 9.3 | ✅ Yes | ✅ Yes | ✅ Yes | ✅ Yes | All |
e.g. x=0.64, y=0.33
GMImageMBS.setchromaWhitePoint(x as Double, y as Double)
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
method | GraphicsMagick | MBS GraphicsMagick Plugin | 9.3 | ✅ Yes | ✅ Yes | ✅ Yes | ✅ Yes | All |
e.g. x=0.3127, y=0.329
GMImageMBS.SetEXIFOrientation(orientation as integer) as boolean
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
method | GraphicsMagick | MBS GraphicsMagick Plugin | 18.4 | ✅ Yes | ✅ Yes | ✅ Yes | ✅ Yes | All |
Changing orientation may need to set orientation via SetOrientation and SetEXIFOrientation. With a JPEG you have orientation both in JPEG header and in EXIF metadata.
Returns true for success and false for failure.
For new development, please use ExifTagsMBS class instead.
GMImageMBS.SetPicture(pic as picture, x as Integer, y as Integer)
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
method | GraphicsMagick | MBS GraphicsMagick Plugin | 9.3 | ✅ Yes | ✅ Yes | ✅ Yes | ✅ Yes | All |
GMImageMBS.SetPictureMask(maskpic as picture, x as Integer, y as Integer)
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
method | GraphicsMagick | MBS GraphicsMagick Plugin | 9.3 | ✅ Yes | ✅ Yes | ✅ Yes | ✅ Yes | All |
GMImageMBS.setPixels(x as Integer, y as Integer, columns as Integer, rows as Integer) as Ptr
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
method | GraphicsMagick | MBS GraphicsMagick Plugin | 16.4 | ✅ Yes | ✅ Yes | ✅ Yes | ✅ Yes | All |
This area is subsequently transferred from the pixel cache to the image via syncPixels.
The items on this page are in the following plugins: MBS GraphicsMagick Plugin.
