Platforms to show: All Mac Windows Linux Cross-Platform

Back to GMImageMBS class.

Previous items Next items

GMImageMBS.iccColorProfile as GMBlobMBS

Type Topic Plugin Version macOS Windows Linux iOS Targets
property GraphicsMagick MBS GraphicsMagick Plugin 9.3 ✅ Yes ✅ Yes ✅ Yes ✅ Yes All
ICC color profile.
Example
dim f as FolderItem = SpecialFolder.Desktop.Child("IMG_0793.tif")
dim Image as new GMImageMBS(f)
dim ProfileBlob as GMBlobMBS = Image.iccColorProfile
dim ProfileData as string = ProfileBlob.CopyString
dim cm as LCMS2ProfileMBS = LCMS2ProfileMBS.OpenProfileFromString(ProfileData)
dim name as string = cm.Name

Break // check data in debugger

Supplied via a Blob since Magick++/ and GraphicsMagick do not currently support formating this data structure directly. Specifications are available from the International Color Consortium for the format of ICC color profiles.
(Read and Write property)

GMImageMBS.interlaceType as Integer

Type Topic Plugin Version macOS Windows Linux iOS Targets
property GraphicsMagick MBS GraphicsMagick Plugin 9.3 ✅ Yes ✅ Yes ✅ Yes ✅ Yes All
The type of interlacing scheme (default NoInterlace ).

This option is used to specify the type of interlacing scheme for raw image formats such as RGB or YUV. NoInterlace means do not interlace, LineInterlace uses scanline interlacing, and PlaneInterlace uses plane interlacing. PartitionInterlace is like PlaneInterlace except the different planes are saved to individual files (e.g. image.R, image.G, and image.B). Use LineInterlace or PlaneInterlace to create an interlaced GIF or progressive JPEG image.
(Read and Write property)

GMImageMBS.iptcProfile as GMBlobMBS

Type Topic Plugin Version macOS Windows Linux iOS Targets
property GraphicsMagick MBS GraphicsMagick Plugin 9.3 ✅ Yes ✅ Yes ✅ Yes ✅ Yes All
IPTC profile.

Supplied via a Blob since Magick++ and GraphicsMagick do not currently support formating this data structure directly. Specifications are available from the International Press Telecommunications Council for IPTC profiles.
(Read and Write property)

GMImageMBS.isValid as boolean

Type Topic Plugin Version macOS Windows Linux iOS Targets
property GraphicsMagick MBS GraphicsMagick Plugin 9.3 ✅ Yes ✅ Yes ✅ Yes ✅ Yes All
Does object contain valid image?

Set to false in order to invalidate the image. Images constructed via the default constructor are invalid images and isValid() will return false.
(Read and Write property)

GMImageMBS.label as string

Type Topic Plugin Version macOS Windows Linux iOS Targets
property GraphicsMagick MBS GraphicsMagick Plugin 9.3 ✅ Yes ✅ Yes ✅ Yes ✅ Yes All
Image label.

(Read only property)

See also:

GMImageMBS.lineWidth as Double

Type Topic Plugin Version macOS Windows Linux iOS Targets
property GraphicsMagick MBS GraphicsMagick Plugin 9.3 ✅ Yes ✅ Yes ✅ Yes ✅ Yes All
Stroke width for drawing vector objects (default one)

This method is now deprecated. Please use strokeWidth instead.
(Read and Write property)

GMImageMBS.magick as string

Type Topic Plugin Version macOS Windows Linux iOS Targets
property GraphicsMagick MBS GraphicsMagick Plugin 10.2 ✅ Yes ✅ Yes ✅ Yes ✅ Yes All
The name of the codec to use for compression.
Example
// this converts 32 bit PNG with alpha channel to BMP

dim f as FolderItem = SpecialFolder.Desktop.Child("test.png")
dim p as Picture = Picture.Open(f)

dim g as new GMImageMBS( new GMGeometryMBS(p.Width, p.Height), new GMColorGrayMBS(1.0))

g.type = g.TrueColorMatteType
g.matte = True
g.magick = "BMP"

g.SetPicture(p, 0, 0)
g.SetPictureMask(p.mask.invertMBS, 0, 0)

f = SpecialFolder.Desktop.Child("test.bmp")
g.write(f)

(Read and Write property)

GMImageMBS.matte as boolean

Type Topic Plugin Version macOS Windows Linux iOS Targets
property GraphicsMagick MBS GraphicsMagick Plugin 9.3 ✅ Yes ✅ Yes ✅ Yes ✅ Yes All
Image supports transparency (matte channel)

(Read and Write property)

GMImageMBS.matteColor as GMColorMBS

Type Topic Plugin Version macOS Windows Linux iOS Targets
property GraphicsMagick MBS GraphicsMagick Plugin 9.3 ✅ Yes ✅ Yes ✅ Yes ✅ Yes All
Image matte (frame) color.

(Read and Write property)

GMImageMBS.meanErrorPerPixel as Double

Type Topic Plugin Version macOS Windows Linux iOS Targets
property GraphicsMagick MBS GraphicsMagick Plugin 9.3 ✅ Yes ✅ Yes ✅ Yes ✅ Yes All
The mean error per pixel computed when an image is color reduced.

This parameter is only valid if verbose is set to true and the image has just been quantized.
(Read only property)

GMImageMBS.modulusDepth as UInt32

Type Topic Plugin Version macOS Windows Linux iOS Targets
property GraphicsMagick MBS GraphicsMagick Plugin 9.3 ✅ Yes ✅ Yes ✅ Yes ✅ Yes All
Image modulus depth (minimum number of bits required to support red/green/blue components without loss of accuracy).

The pixel modulus depth may be decreased by supplying a value which is less than the current value, updating the pixels (reducing accuracy) to the new depth. The pixel modulus depth can not be increased over the current value using this method.
(Read and Write property)

GMImageMBS.monochrome as boolean

Type Topic Plugin Version macOS Windows Linux iOS Targets
property GraphicsMagick MBS GraphicsMagick Plugin 9.3 ✅ Yes ✅ Yes ✅ Yes ✅ Yes All
Transform image to black and white while color reducing (quantizing).

(Read and Write property)

GMImageMBS.normalizedMaxError as Double

Type Topic Plugin Version macOS Windows Linux iOS Targets
property GraphicsMagick MBS GraphicsMagick Plugin 9.3 ✅ Yes ✅ Yes ✅ Yes ✅ Yes All
The normalized max error per pixel computed when an image is color reduced.

This parameter is only valid if verbose is set to true and the image has just been quantized.
(Read only property)

GMImageMBS.normalizedMeanError as Double

Type Topic Plugin Version macOS Windows Linux iOS Targets
property GraphicsMagick MBS GraphicsMagick Plugin 9.3 ✅ Yes ✅ Yes ✅ Yes ✅ Yes All
The normalized mean error per pixel computed when an image is color reduced.

This parameter is only valid if verbose is set to true and the image has just been quantized.
(Read only property)

GMImageMBS.orientation as Integer

Type Topic Plugin Version macOS Windows Linux iOS Targets
property GraphicsMagick MBS GraphicsMagick Plugin 9.3 ✅ Yes ✅ Yes ✅ Yes ✅ Yes All
Image orientation. Supported by some file formats such as DPX and TIFF. Useful for turning the right way up.

(Read and Write property)

GMImageMBS.page as GMGeometryMBS

Type Topic Plugin Version macOS Windows Linux iOS Targets
property GraphicsMagick MBS GraphicsMagick Plugin 9.3 ✅ Yes ✅ Yes ✅ Yes ✅ Yes All
Preferred size and location of an image canvas.

Use this option to specify the dimensions and position of the Postscript page in dots per inch or a TEXT page in pixels. This option is typically used in concert with density .

Page may also be used to position a GIF image (such as for a scene in an animation).
(Read and Write property)

GMImageMBS.penColor as GMColorMBS

Type Topic Plugin Version macOS Windows Linux iOS Targets
property GraphicsMagick MBS GraphicsMagick Plugin 9.3 ✅ Yes ✅ Yes ✅ Yes ✅ Yes All
The pen color.

(Read and Write property)

GMImageMBS.quality as UInt32

Type Topic Plugin Version macOS Windows Linux iOS Targets
property GraphicsMagick MBS GraphicsMagick Plugin 9.3 ✅ Yes ✅ Yes ✅ Yes ✅ Yes All
JPEG/MIFF/PNG compression level (default 75).

(Read and Write property)

GMImageMBS.quantizeColors as UInt32

Type Topic Plugin Version macOS Windows Linux iOS Targets
property GraphicsMagick MBS GraphicsMagick Plugin 9.3 ✅ Yes ✅ Yes ✅ Yes ✅ Yes All
Maximum number of colors to quantize to.
Example
dim p as Picture = LogoMBS(500)
dim image as new GMImageMBS(p)

image.quantizeColors = 10
image.quantize

image.type = image.TrueColorType
Backdrop=image.CopyPicture

(Read and Write property)

GMImageMBS.quantizeColorSpace as Integer

Type Topic Plugin Version macOS Windows Linux iOS Targets
property GraphicsMagick MBS GraphicsMagick Plugin 9.3 ✅ Yes ✅ Yes ✅ Yes ✅ Yes All
Colorspace to quantize in (default RGB).
Example
// load a picture
dim f as FolderItem = SpecialFolder.Desktop.Child("test.png")
dim pic as Picture = Picture.Open(f)

const GrayColorSpace = 2

Dim Converter As New GMImageMBS(Pic)

// quantize with dither
Converter.type = GMImageMBS.BilevelType
Converter.quantizeColorSpace = GrayColorSpace
Converter.quantizeColors = 2
Converter.quantizeDither = True
Converter.quantize

// convert back to Xojo
Converter.type = GMImageMBS.TrueColorType
Backdrop = Converter.CopyPicture

Empirical evidence suggests that distances in color spaces such as YUV or YIQ correspond to perceptual color differences more closely than do distances in RGB space. These color spaces may give better results when color reducing an image.
(Read and Write property)

GMImageMBS.quantizeDither as boolean

Type Topic Plugin Version macOS Windows Linux iOS Targets
property GraphicsMagick MBS GraphicsMagick Plugin 9.3 ✅ Yes ✅ Yes ✅ Yes ✅ Yes All
Apply Floyd/Steinberg error diffusion to the image.
Example
dim p as Picture = LogoMBS(500)
dim image as new GMImageMBS(p)

image.quantizeColors = 10
image.quantizeDither = true
image.quantize

image.type = image.TrueColorType
Backdrop=image.CopyPicture

The basic strategy of dithering is to trade intensity resolution for spatial resolution by averaging the intensities of several neighboring pixels. Images which suffer from severe contouring when reducing colors can be improved with this option. The quantizeColors or monochrome option must be set for this option to take effect.
(Read and Write property)

GMImageMBS.quantizeTreeDepth as UInt32

Type Topic Plugin Version macOS Windows Linux iOS Targets
property GraphicsMagick MBS GraphicsMagick Plugin 9.3 ✅ Yes ✅ Yes ✅ Yes ✅ Yes All
Depth of the quantization color classification tree.

Values of 0 or 1 allow selection of the optimal tree depth for the color reduction algorithm. Values between 2 and 8 may be used to manually adjust the tree depth.
(Read and Write property)

GMImageMBS.Quiet as Boolean

Type Topic Plugin Version macOS Windows Linux iOS Targets
property GraphicsMagick MBS GraphicsMagick Plugin 19.0 ✅ Yes ✅ Yes ✅ Yes ✅ Yes All
Suppress all warning messages.

Error messages are still reported.
(Read and Write property)

GMImageMBS.renderingIntent as Integer

Type Topic Plugin Version macOS Windows Linux iOS Targets
property GraphicsMagick MBS GraphicsMagick Plugin 9.3 ✅ Yes ✅ Yes ✅ Yes ✅ Yes All
The type of rendering intent (used when applying an ICC color profile).

(Read and Write property)

GMImageMBS.resolutionUnits as Integer

Type Topic Plugin Version macOS Windows Linux iOS Targets
property GraphicsMagick MBS GraphicsMagick Plugin 9.3 ✅ Yes ✅ Yes ✅ Yes ✅ Yes All
Units of image resolution.
Example

Dim item As FolderItem = SpecialFolder.Desktop.Child("test.jpeg")
Dim p As New GMImageMBS(item)

// scale image
p.quality = 95
p.scale New GMGeometryMBS(1000,1000)

// change resolution
p.density = New GMGeometryMBS(300, 300)
p.resolutionUnits = p.PixelsPerInchResolution

// remove metadata
Dim empty As New GMBlobMBS
p.profile("EXIF") = empty
p.profile("IPTC") = empty
p.profile("XMP") = empty

Dim out As FolderItem = SpecialFolder.Desktop.Child("output.jpeg")
p.write out

(Read and Write property)

GMImageMBS.rows as UInt32

Type Topic Plugin Version macOS Windows Linux iOS Targets
property GraphicsMagick MBS GraphicsMagick Plugin 9.3 ✅ Yes ✅ Yes ✅ Yes ✅ Yes All
The number of pixel rows in the image.
Example
dim p as Picture = LogoMBS(500)
dim image as new GMImageMBS(p)

Title = str(image.columns)+" x "+str(image.rows)
Backdrop=image.CopyPicture

(Read only property)

GMImageMBS.scene as UInt32

Type Topic Plugin Version macOS Windows Linux iOS Targets
property GraphicsMagick MBS GraphicsMagick Plugin 9.3 ✅ Yes ✅ Yes ✅ Yes ✅ Yes All
Image scene number.

(Read and Write property)

GMImageMBS.size as GMGeometryMBS

Type Topic Plugin Version macOS Windows Linux iOS Targets
property GraphicsMagick MBS GraphicsMagick Plugin 9.3 ✅ Yes ✅ Yes ✅ Yes ✅ Yes All
Width and height of a raw image (an image which does not support width and height information).
Example
dim p as Picture = LogoMBS(500)
dim image as new GMImageMBS(p)

MsgBox image.size.StringValue

image.size = new GMGeometryMBS(200,200)

Backdrop=image.CopyPicture

Size may also be used to affect the image size read from a multi-resolution format (e.g. Photo CD, JBIG, or JPEG.
(Read and Write property)

GMImageMBS.strokeAntiAlias as boolean

Type Topic Plugin Version macOS Windows Linux iOS Targets
property GraphicsMagick MBS GraphicsMagick Plugin 9.3 ✅ Yes ✅ Yes ✅ Yes ✅ Yes All
Enable/disable stroke anti-aliasing.

(Read and Write property)

GMImageMBS.strokeColor as GMColorMBS

Type Topic Plugin Version macOS Windows Linux iOS Targets
property GraphicsMagick MBS GraphicsMagick Plugin 9.3 ✅ Yes ✅ Yes ✅ Yes ✅ Yes All
Color to use when drawing object outlines.
Example
dim g as new GMGeometryMBS(500,500)
dim c as new GMColorRGBMBS("white") // white
dim image as new GMImageMBS(g, c)

image.strokeColor = new GMColorRGBMBS("red") // Outline color
image.fillColor = new GMColorRGBMBS("green") // Fill color
image.strokeWidth = 5

dim draw as GMGraphicsMBS = image.Graphics

// Draw a circle
draw.Circle(250, 250, 120, 150)

Backdrop=image.CopyPicture

(Read and Write property)

GMImageMBS.strokeDashOffset as Double

Type Topic Plugin Version macOS Windows Linux iOS Targets
property GraphicsMagick MBS GraphicsMagick Plugin 9.3 ✅ Yes ✅ Yes ✅ Yes ✅ Yes All
While drawing using a dash pattern, specify distance into the dash pattern to start the dash (default 0).

(Read and Write property)

GMImageMBS.strokeLineCap as Integer

Type Topic Plugin Version macOS Windows Linux iOS Targets
property GraphicsMagick MBS GraphicsMagick Plugin 9.3 ✅ Yes ✅ Yes ✅ Yes ✅ Yes All
Specify the shape to be used at the end of open subpaths when they are stroked. #

Values of LineCap are UndefinedCap, ButtCap, RoundCap, and SquareCap.
(Read and Write property)

GMImageMBS.strokeLineJoin as Integer

Type Topic Plugin Version macOS Windows Linux iOS Targets
property GraphicsMagick MBS GraphicsMagick Plugin 9.3 ✅ Yes ✅ Yes ✅ Yes ✅ Yes All
Specify the shape to be used at the corners of paths (or other vector shapes) when they are stroked. Values of LineJoin are UndefinedJoin, MiterJoin, RoundJoin, and BevelJoin.

(Read and Write property)

GMImageMBS.strokeMiterLimit as UInt32

Type Topic Plugin Version macOS Windows Linux iOS Targets
property GraphicsMagick MBS GraphicsMagick Plugin 9.3 ✅ Yes ✅ Yes ✅ Yes ✅ Yes All
Specify miter limit.

When two line segments meet at a sharp angle and miter joins have been specified for 'lineJoin', it is possible for the miter to extend far beyond the thickness of the line stroking the path. The miterLimit' imposes a limit on the ratio of the miter length to the 'lineWidth'. The default value of this parameter is 4.
(Read and Write property)

GMImageMBS.strokePattern as GMImageMBS

Type Topic Plugin Version macOS Windows Linux iOS Targets
property GraphicsMagick MBS GraphicsMagick Plugin 9.3 ✅ Yes ✅ Yes ✅ Yes ✅ Yes All
Pattern image to use while stroking object outlines.

(Read and Write property)

GMImageMBS.strokeWidth as Double

Type Topic Plugin Version macOS Windows Linux iOS Targets
property GraphicsMagick MBS GraphicsMagick Plugin 9.3 ✅ Yes ✅ Yes ✅ Yes ✅ Yes All
Stroke width for drawing vector objects (default one).
Example
dim g as new GMGeometryMBS(500,500)
dim c as new GMColorRGBMBS("white") // white
dim image as new GMImageMBS(g, c)

image.strokeColor = new GMColorRGBMBS("red") // Outline color
image.fillColor = new GMColorRGBMBS("green") // Fill color
image.strokeWidth = 5

dim draw as GMGraphicsMBS = image.Graphics

// Draw a circle
draw.Circle(250, 250, 120, 150)

Backdrop=image.CopyPicture

(Read and Write property)

GMImageMBS.subImage as UInt32

Type Topic Plugin Version macOS Windows Linux iOS Targets
property GraphicsMagick MBS GraphicsMagick Plugin 9.3 ✅ Yes ✅ Yes ✅ Yes ✅ Yes All
Subimage of an image sequence.

(Read and Write property)

GMImageMBS.subRange as UInt32

Type Topic Plugin Version macOS Windows Linux iOS Targets
property GraphicsMagick MBS GraphicsMagick Plugin 9.3 ✅ Yes ✅ Yes ✅ Yes ✅ Yes All
Number of images relative to the base image.

(Read and Write property)

GMImageMBS.textEncoding as string

Type Topic Plugin Version macOS Windows Linux iOS Targets
property GraphicsMagick MBS GraphicsMagick Plugin 9.3 ✅ Yes ✅ Yes ✅ Yes ✅ Yes All
Annotation text encoding (e.g. "UTF-16").

(Read and Write property)

GMImageMBS.tileName as string

Type Topic Plugin Version macOS Windows Linux iOS Targets
property GraphicsMagick MBS GraphicsMagick Plugin 9.3 ✅ Yes ✅ Yes ✅ Yes ✅ Yes All
Tile name.

(Read and Write property)

GMImageMBS.totalColors as UInt32

Type Topic Plugin Version macOS Windows Linux iOS Targets
property GraphicsMagick MBS GraphicsMagick Plugin 9.3 ✅ Yes ✅ Yes ✅ Yes ✅ Yes All
Number of colors in the image.
Example
dim p as Picture = LogoMBS(500)
dim image as new GMImageMBS(p)

Title = str(image.totalColors) // shows 5284
Backdrop=image.CombinePictureWithMask

(Read only property)

GMImageMBS.type as Integer

Type Topic Plugin Version macOS Windows Linux iOS Targets
property GraphicsMagick MBS GraphicsMagick Plugin 9.3 ✅ Yes ✅ Yes ✅ Yes ✅ Yes All
The type of this image.
Example
dim p as Picture = LogoMBS(500)
dim image as new GMImageMBS(p)

image.type = image.GrayscaleType

Backdrop=image.CopyPicture

You can set this value to convert the image to the type.

Convert the image representation to the specified type or retrieve the current image type. If the image is reduced to an inferior type, then image information may be lost (e.g. color changed to grayscale).

Available enumerations for the type parameter:

BilevelType1black/white
GrayscaleType2grayscale
GrayscaleMatteType3grayscale with alpha (opacity) channel
PaletteType4colormapped
PaletteMatteType5colormapped with transparency
TrueColorType6true (full) color
TrueColorMatteType7true (full) color with alpha (opacity) channel
ColorSeparationType8Cyan, magenta, yellow, and black
ColorSeparationMatteType9Cyan, magenta, yellow, and black with alpha (opacity) channel
OptimizeType10Optimize the image type to best represent the existing pixels
(Read and Write property)

GMImageMBS.verbose as boolean

Type Topic Plugin Version macOS Windows Linux iOS Targets
property GraphicsMagick MBS GraphicsMagick Plugin 9.3 ✅ Yes ✅ Yes ✅ Yes ✅ Yes All
Print detailed information about the image.

(Read and Write property)

GMImageMBS.view as string

Type Topic Plugin Version macOS Windows Linux iOS Targets
property GraphicsMagick MBS GraphicsMagick Plugin 9.3 ✅ Yes ✅ Yes ✅ Yes ✅ Yes All
FlashPix viewing parameters.

(Read and Write property)

GMImageMBS.width as Integer

Type Topic Plugin Version macOS Windows Linux iOS Targets
property GraphicsMagick MBS GraphicsMagick Plugin 10.1 ✅ Yes ✅ Yes ✅ Yes ✅ Yes All
The width of the image.
Example
dim c as new GMColorRGBMBS(1.0,0.0,0.0)
dim size as new GMGeometryMBS(100,100)
dim g as new GMImageMBS(size, c)

MsgBox str(g.width)+" "+str(g.height)

This is a convenience function for you which calls size.width.
(Read only property)

GMImageMBS.x11Display as string

Type Topic Plugin Version macOS Windows Linux iOS Targets
property GraphicsMagick MBS GraphicsMagick Plugin 9.3 ✅ Yes ✅ Yes ✅ Yes ✅ Yes All
X11 display to display to, obtain fonts from, or to capture image from.

(Read and Write property)

Previous items Next items

The items on this page are in the following plugins: MBS GraphicsMagick Plugin.


The biggest plugin in space...