MBS Plugin Documentation

Search:

Statistics   -   FAQ   -   Plugin Parts (All, Dependencies)   -   Class hierarchie

New in Version 7.0 7.1 7.2 7.3 7.4 7.5 7.6 7.7 7.8 8.0 8.1 8.2 8.3 8.4 8.5 8.6 8.7 9.0

The list of the   themes,   classes,   controls,   modules,   global methods by category,   global methods by name,   screenshots,   licenses   and   examples.

Platforms to show: All Mac Windows Linux Cross-Platform

Previous items

IMImageMBS.RGBTransformImage(Colorspace as integer) as boolean
method, Image Magick, MBS ImageMagick Plugin (ImageMagick), class IMImageMBS, Console safe, Plugin version: 5.2, Mac OS X: Works, Windows: Works, Linux x86: Works, Feedback.

Function: Method RGBTransformImage converts the reference image from RGB to an alternate colorspace.
Notes:
The transformation matrices are not the standard ones: the weights are rescaled to normalized the range of the transformed values to be [0..MaxRGB].

colorspace: An integer value that indicates which colorspace to transform the image.

Returns false on any error and true on success.

constants:
UndefinedColorspace0
RGBColorspace1
GRAYColorspace2
TransparentColorspace3
OHTAColorspace4
LABColorspace5
XYZColorspace6
YCbCrColorspace7
YCCColorspace8
YIQColorspace9
YPbPrColorspace10
YUVColorspace11
CMYKColorspace12
sRGBColorspace13
HSBColorspace14
HSLColorspace15
HWBColorspace16
IMImageMBS.Roll(x as integer, y as integer) as IMImageMBS
method, Image Magick, MBS ImageMagick Plugin (ImageMagick), class IMImageMBS, Console safe, Plugin version: 6.1, Mac OS X: Works, Windows: Works, Linux x86: Works, Feedback.

Function: Roll offsets an image as defined by x and y.
Notes:
Returns nil on any error.
Sets the last exception property.
IMImageMBS.Rotate(degrees as double) as IMImageMBS
method, Image Magick, MBS ImageMagick Plugin (ImageMagick), class IMImageMBS, Console safe, Plugin version: 5.1, Mac OS X: Works, Windows: Works, Linux x86: Works, Feedback.

Function: Rotation of an image.
Notes:
Method RotateImage creates a new image that is a rotated copy of an existing one. Positive angles rotate counter-clockwise (right-hand rule), while negative angles rotate clockwise. Rotated images are usually larger than the originals and have 'empty' triangular corners. X axis. Empty triangles left over from shearing the image are filled with the color specified by the image background_color. RotateImage allocates the memory necessary for the new Image structure and returns a pointer to the new image.

Method RotateImage is based on the paper ``A Fast Algorithm for General Raster Rotatation'' by Alan W. Paeth. RotateImage is adapted from a similar method based on the Paeth paper written by Michael Halle of the Spatial Imaging Group, MIT Media Lab.

degrees: Specifies the number of degrees to rotate the image.

Sets the lastexception property.
Returns nil on low memory.
For more details please check the ImageMagick documentation.
IMImageMBS.Sample(width as integer, height as integer) as IMImageMBS
method, Image Magick, MBS ImageMagick Plugin (ImageMagick), class IMImageMBS, Console safe, Plugin version: 5.1, Mac OS X: Works, Windows: Works, Linux x86: Works, Feedback.

Function: Scales an image to the desired dimensions with pixel sampling.
Notes:
Unlike other scaling methods, this method does not introduce any additional color into the scaled image.
For more details please check the ImageMagick documentation.
Sets the last exception property.
IMImageMBS.Scale(width as integer, height as integer) as IMImageMBS
method, Image Magick, MBS ImageMagick Plugin (ImageMagick), class IMImageMBS, Console safe, Plugin version: 5.1, Mac OS X: Works, Windows: Works, Linux x86: Works, Feedback.

Function: Changes the size of an image to the given dimensions.
Example:
image=Image.Scale(100,80)

Notes:
This method was designed by Bob Friesenhahn as a low cost thumbnail generator.

columns: The number of columns in the scaled image.
rows: The number of rows in the scaled image.

Sets the last exception property.
For more details please check the ImageMagick documentation.
IMImageMBS.Scene as Integer
property, Image Magick, MBS ImageMagick Plugin (ImageMagick), class IMImageMBS, Console safe, Plugin version: 5.2, Mac OS X: Works, Windows: Works, Linux x86: Works, Feedback.

Function: An undocumented property.
Notes: (Read and Write property)
IMImageMBS.SetImageAttribute(key as string, value as string) as boolean
method, Image Magick, MBS ImageMagick Plugin (ImageMagick), class IMImageMBS, Console safe, Plugin version: 6.1, Mac OS X: Works, Windows: Works, Linux x86: Works, Feedback.

Function: SetImageAttribute searches the list of image attributes and replaces the attribute value.
Notes: If it is not found in the list, the attribute name and value is added to the list. If the attribute exists in the list, the value is concatenated to the attribute. SetImageAttribute returns True if the attribute is successfully concatenated or added to the list, otherwise False. If the value is "", the matching key is deleted from the list.
IMImageMBS.SetImageColorspace(Colorspace as integer) as boolean
method, Image Magick, MBS ImageMagick Plugin (ImageMagick), class IMImageMBS, Console safe, Plugin version: 5.2, Mac OS X: Works, Windows: Works, Linux x86: Works, Feedback.

Function: Sets the colorspace member of the Image structure.
Notes: Returns false on any error and true on success.
IMImageMBS.SetImageProfile(name as string, ProfileData as string) as boolean
method, Image Magick, MBS ImageMagick Plugin (ImageMagick), class IMImageMBS, Console safe, Plugin version: 5.2, Mac OS X: Works, Windows: Works, Linux x86: Works, Feedback.

Function: Adds a named profile to the image.
Notes:
If a profile with the same name already exists, it is replaced. This method differs from the ProfileImage() method in that it does not apply CMS color profiles.

name: The profile name.
profiledata: The binary data of the profile.

Returns false on any error and true on success.
IMImageMBS.SetPicture(pic as picture, x as integer, y as integer)
method, Image Magick, MBS ImageMagick Plugin (ImageMagick), class IMImageMBS, Plugin version: 5.2, Mac OS X: Works, Windows: Works, Linux x86: Works, Feedback.

Function: Copies the pixels from a given Realbasic picture into the Image Magick Image at the given location.
Example:
dim p as picture

p=NewPicture(32,32,32)
p.Graphics.ForeColor=rgb(0,255,0)
p.Graphics.FillRect 0,0,32,32

image.SetPicture(p,30,30)

Notes:
Sets the last exception property.
The method will do nothing on bad bounds.
This method works only for bitmap images.
x and y are zero based.
IMImageMBS.SetPictureMask(maskpic as picture, x as integer, y as integer)
method, Image Magick, MBS ImageMagick Plugin (ImageMagick), class IMImageMBS, Plugin version: 5.2, Mac OS X: Works, Windows: Works, Linux x86: Works, Feedback.

Function: Copies the pixels from a given Realbasic picture into the mask of the Image Magick Image at the given location.
Example:
dim p as picture

p=NewPicture(32,32,32)
p.Graphics.ForeColor=rgb(0,255,0)
p.Graphics.FillRect 0,0,32,32

image.SetPictureMask(p,30,30)

Notes:
Sets the last exception property.
The method will do nothing on bad bounds.
This method works only for bitmap images.
x and y are zero based.
You may need to set matte=True after this.
IMImageMBS.SetPixel(x as integer, y as integer, newPixel as IMColorMBS)
method, Image Magick, MBS ImageMagick Plugin (ImageMagick), class IMImageMBS, Console safe, Plugin version: 5.2, Mac OS X: Works, Windows: Works, Linux x86: Works, Feedback.

Function: Sets a pixel value.
Example:
co=new IMColorMBS
co.blue=65535 // max value
image.SetPixel 50,50,co // Makes Pixel 50/50 blue

Notes:
The method will fail silently if the values are out of bounds or the image is not a bitmap image.
This method works only for bitmap images.
x and y are zero based.
IMImageMBS.Shade(gray as boolean, azimuth as double, elevation as double) as IMImageMBS
method, Image Magick, MBS ImageMagick Plugin (ImageMagick), class IMImageMBS, Console safe, Plugin version: 5.1, Mac OS X: Works, Windows: Works, Linux x86: Works, Feedback.

Function: Shines a distant light on an image to create a three-dimensional effect.
Notes:
You control the positioning of the light with azimuth and elevation; azimuth is measured in degrees off the x axis and elevation is measured in pixels above the Z axis.
Sets the last exception property.

For more details please check the ImageMagick documentation.
IMImageMBS.SharpenChannel(channel as integer, radius as double, sigma as double) as IMImageMBS
method, Image Magick, MBS ImageMagick Plugin (ImageMagick), class IMImageMBS, Console safe, Plugin version: 5.1, Mac OS X: Works, Windows: Works, Linux x86: Works, Feedback.

Function: Sharpens one or more image channels.
Notes:
We convolve the image with a Gaussian operator of the given radius and standard deviation (sigma) . For reasonable results, radius should be larger than sigma. Use a radius of 0 and Sharpen selects a suitable radius for you.

channel: The channel type.
radius: The radius of the Gaussian, in pixels, not counting the center pixel.
sigma: The standard deviation of the Laplacian, in pixels.

Constants for channel:
const UndefinedChannel= 0
const RedChannel= &h0001
const GrayChannel= &h0001
const CyanChannel= &h0001
const GreenChannel= &h0002
const MagentaChannel= &h0002
const BlueChannel= &h0004
const YellowChannel= &h0004
const AlphaChannel= &h0008
const OpacityChannel= &h0008
const BlackChannel= &h0020
const IndexChannel= &h0020
const AllChannels= &h7fffffff

Sets the last exception property.
For more details please check the ImageMagick documentation.
IMImageMBS.Shave(x as integer, y as integer, width as integer, height as integer) as IMImageMBS
method, Image Magick, MBS ImageMagick Plugin (ImageMagick), class IMImageMBS, Console safe, Plugin version: 6.1, Mac OS X: Works, Windows: Works, Linux x86: Works, Feedback.

Function: Shave shaves pixels from the image edges.
Notes:
It allocates the memory necessary for the new Image structure and returns a pointer to the new image.
Returns nil on any error.
Sets the last exception property.
IMImageMBS.Shear(Xshear as double, Yshear as double) as IMImageMBS
method, Image Magick, MBS ImageMagick Plugin (ImageMagick), class IMImageMBS, Console safe, Plugin version: 5.1, Mac OS X: Works, Windows: Works, Linux x86: Works, Feedback.

Function: Method ShearImage creates a new image that is a shear_image copy of an existing one.
Notes:
Shearing slides one edge of an image along the X or Y axis, creating a parallelogram. An X direction shear slides an edge along the X axis, while a Y direction shear slides an edge along the Y axis. The amount of the shear is controlled by a shear angle. For X direction shears, x_shear is measured relative to the Y axis, and similarly, for Y direction shears y_shear is measured relative to the X axis. Empty triangles left over from shearing the image are filled with the color defined by the pixel at location (0,0). ShearImage allocates the memory necessary for the new Image structure and returns a pointer to the new image.

Xshear and YYshear specify the number of degrees to shear the image.

Sets the last exception property.
For more details please check the ImageMagick documentation.
IMImageMBS.Solarize(factor as double) as boolean
method, Image Magick, MBS ImageMagick Plugin (ImageMagick), class IMImageMBS, Console safe, Plugin version: 5.4, Mac OS X: Works, Windows: Works, Linux x86: Works, Feedback.

Function: Method SolarizeImage produces a 'solarization' effect seen when exposing a photographic film to light during the development process.
Notes:
factor: An double value that defines the extent of the solarization.
Returns nil on any error.
Sets the last exception property.
IMImageMBS.Splice(x as integer, y as integer, width as integer, height as integer) as IMImageMBS
method, Image Magick, MBS ImageMagick Plugin (ImageMagick), class IMImageMBS, Console safe, Plugin version: 6.1, Mac OS X: Works, Windows: Works, Linux x86: Works, Feedback.

Function: Splice splices a solid color into the image as defined by the geometry.
Notes:
Returns nil on any error.
Sets the last exception property.
IMImageMBS.Spread(radius as double) as IMImageMBS
method, Image Magick, MBS ImageMagick Plugin (ImageMagick), class IMImageMBS, Console safe, Plugin version: 5.1, Mac OS X: Works, Windows: Works, Linux x86: Works, Feedback.

Function: This is a special effects method that randomly displaces each pixel in a block defined by the radius parameter.
Notes:
radius: Choose a random pixel in a neighborhood of this extent.
Sets the last exception property.

For more details please check the ImageMagick documentation.
IMImageMBS.Stegano(watermarkImage as IMImageMBS) as IMImageMBS
method, Image Magick, MBS ImageMagick Plugin (ImageMagick), class IMImageMBS, Console safe, Plugin version: 5.4, Mac OS X: Works, Windows: Works, Linux x86: Works, Feedback.

Function: Method SteganoImage hides a digital watermark within the image.
Notes:
Returns nil on any error.
Sets the last exception property.
IMImageMBS.Stereo(otherImage as IMImageMBS) as IMImageMBS
method, Image Magick, MBS ImageMagick Plugin (ImageMagick), class IMImageMBS, Console safe, Plugin version: 5.4, Mac OS X: Works, Windows: Works, Linux x86: Works, Feedback.

Function: Method StereoImage combines two images and produces a single image that is the composite of a left and right image of a stereo pair.
Notes:
The left image is converted to gray scale and written to the red channel of the stereo image. The right image is converted to gray scale and written to the blue channel of the stereo image. View the composite image with red-blue glasses to create a stereo effect.

left image = self
right image = otherImage parameter

Returns nil on any error.
Sets the last exception property.
IMImageMBS.StorageClass as Integer
property, Image Magick, MBS ImageMagick Plugin (ImageMagick), class IMImageMBS, Console safe, Plugin version: 5.2, Mac OS X: Works, Windows: Works, Linux x86: Works, Feedback.

Function: Image storage class.
Notes:
If DirectClass then the image packets contain valid RGB or CMYK colors. If PseudoClass then the image has a colormap referenced by pixel's index member.

constants:
UndefinedClass0Unset value.
DirectClass1Image is composed of pixels which represent literal color values.
PseudoClass2Image is composed of pixels which specify an index in a color palette.
(Read and Write property)
IMImageMBS.Swirl(degrees as double) as IMImageMBS
method, Image Magick, MBS ImageMagick Plugin (ImageMagick), class IMImageMBS, Console safe, Plugin version: 5.4, Mac OS X: Works, Windows: Works, Linux x86: Works, Feedback.

Function: Method SwirlImage creates a new image that is a copy of an existing one with the image pixels "swirl" at a specified angle.
Notes:
degrees: An double value that defines the tightness of the swirling.

Returns nil on any error.
Sets the last exception property.
IMImageMBS.Taint as Boolean
property, Image Magick, MBS ImageMagick Plugin (ImageMagick), class IMImageMBS, Console safe, Plugin version: 5.2, Mac OS X: Works, Windows: Works, Linux x86: Works, Feedback.

Function: Set to True if the image pixels have been modified.
Notes: (Read and Write property)
IMImageMBS.Thumbnail(width as integer, height as integer) as IMImageMBS
method, Image Magick, MBS ImageMagick Plugin (ImageMagick), class IMImageMBS, Console safe, Plugin version: 5.1, Mac OS X: Works, Windows: Works, Linux x86: Works, Feedback.

Function: Changes the size of an image to the given dimensions.
Notes:
Sets the last exception property.
This method was designed by Bob Friesenhahn as a low cost thumbnail generator.
For more details please check the ImageMagick documentation.
IMImageMBS.TransformRGBImage(Colorspace as integer) as boolean
method, Image Magick, MBS ImageMagick Plugin (ImageMagick), class IMImageMBS, Console safe, Plugin version: 5.2, Mac OS X: Works, Windows: Works, Linux x86: Works, Feedback.

Function: Method TransformRGBImage converts the reference image from an alternate colorspace.
Notes:
The transformation matrices are not the standard ones: the weights are rescaled to normalized the range of the transformed values to be [0..MaxRGB].

colorspace: An integer value that indicates the colorspace the image is currently in. On return the image is in the RGB color space.

Returns false on any error and true on success.

constants:
UndefinedColorspace0
RGBColorspace1
GRAYColorspace2
TransparentColorspace3
OHTAColorspace4
LABColorspace5
XYZColorspace6
YCbCrColorspace7
YCCColorspace8
YIQColorspace9
YPbPrColorspace10
YUVColorspace11
CMYKColorspace12
sRGBColorspace13
HSBColorspace14
HSLColorspace15
HWBColorspace16
IMImageMBS.Trim as IMImageMBS
method, Image Magick, MBS ImageMagick Plugin (ImageMagick), class IMImageMBS, Console safe, Plugin version: 6.1, Mac OS X: Works, Windows: Works, Linux x86: Works, Feedback.

Function: Trim trims pixels from the image edges.
Notes:
It allocates the memory necessary for the new Image structure and returns a pointer to the new image.

Returns nil on any error.
Sets the last exception property.
IMImageMBS.UnsharpMaskChannel(channel as integer, radius as double, sigma as double, amount as double, threshold as double) as IMImageMBS
method, Image Magick, MBS ImageMagick Plugin (ImageMagick), class IMImageMBS, Console safe, Plugin version: 5.1, Mac OS X: Works, Windows: Works, Linux x86: Works, Feedback.

Function: Sharpens one or more image channels.
Notes:
We convolve the image with a Gaussian operator of the given radius and standard deviation (sigma). For reasonable results, radius should be larger than sigma. Use a radius of 0 and UnsharpMask selects a suitable radius for you.

Constants for channel:
const UndefinedChannel= 0
const RedChannel= &h0001
const GrayChannel= &h0001
const CyanChannel= &h0001
const GreenChannel= &h0002
const MagentaChannel= &h0002
const BlueChannel= &h0004
const YellowChannel= &h0004
const AlphaChannel= &h0008
const OpacityChannel= &h0008
const BlackChannel= &h0020
const IndexChannel= &h0020
const AllChannels= &h7fffffff

Sets the last exception property.
For more details please check the ImageMagick documentation.
IMImageMBS.Wave(amplitude as double, wavelength as double) as IMImageMBS
method, Image Magick, MBS ImageMagick Plugin (ImageMagick), class IMImageMBS, Console safe, Plugin version: 5.4, Mac OS X: Works, Windows: Works, Linux x86: Works, Feedback.

Function: Method Wave creates a new image that is a copy of an existing one with the image pixels altered along a sine wave.
Notes:
Parameters are double values that indicates the amplitude and wavelength of the sine wave.
Returns nil on any error.
Sets the last exception property.
IMImageMBS.WhiteThreshold(threshold as string) as boolean
method, Image Magick, MBS ImageMagick Plugin (ImageMagick), class IMImageMBS, Console safe, Plugin version: 5.1, Mac OS X: Works, Windows: Works, Linux x86: Works, Feedback.

Function: WhiteThreshold is like Threshold but forces all pixels above the threshold into white while leaving all pixels below the threshold unchanged.
Notes:
No exceptions are generated.
threshold: Define the threshold value. (ASCII string)
For more details please check the ImageMagick documentation.
IMImageMBS.Width as integer
property, Image Magick, MBS ImageMagick Plugin (ImageMagick), class IMImageMBS, Console safe, Plugin version: 5.1, Mac OS X: Works, Windows: Works, Linux x86: Works, Feedback.

Function: The width of the image in pixels.
Notes:
For more details please check the ImageMagick documentation.
(Read and Write property)
IMImageMBS.WriteImage(info as IMImageInfoMBS) as boolean
method, Image Magick, MBS ImageMagick Plugin (ImageMagick), class IMImageMBS, Console safe, Plugin version: 5.2, Mac OS X: Works, Windows: Works, Linux x86: Works, Feedback.

Function: Method WriteImage writes an image to a file as defined by image.filename.
Notes:
You can specify a particular image format by prefixing the file with the image type and a colon (i.e. ps:image) or specify the image type as the filename suffix (i.e. image.ps). The image may be modified to adapt it to the requirements of the image format. For example, DirectClass images must be color-reduced to PseudoClass if the format is GIF.

WriteImage returns True if the image is written. False is returned if there is a memory shortage or if the image file fails to write.

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