Monkeybread Realbasic plugin

Platforms to show: All Mac Windows Linux Cross-Platform

class ImageMagickMBS
class, Image Magick, MBS REALbasic ImageMagick Plugin (ImageMagick), class ImageMagickMBS, Console safe, Plugin version: 5.1, Mac OS X: Works, Windows: Works, Linux x86: Works, Feedback.

Function: The class for global functions from the Image Magick library
Notes:
Before using this class you need to load the ImageMagick bundle or dll.

Not all functions from the library are available through the plugin. If you need something special, please ask.

For Mac OS X you need the ImageMagick.bundle (on the plugins download page) and for Windows the normal ImageMagick installation with the DLL. The bundle is just the normal self containing dylib file dropped in a default bundle folder.

For more details please check the ImageMagick documentation.

ConsoleImageMagickMBS is for all applications, best for console applications.
ImageMagickMBS (without console in name) is for GUI applications only and has some more usefull functions like picture converting.

ImageMagickMBS.Copyright as String
method, Image Magick, MBS REALbasic ImageMagick Plugin (ImageMagick), class ImageMagickMBS, Console safe, Plugin version: 5.1, Mac OS X: Works, Windows: Works, Linux x86: Works, Feedback.

Function: The copyright notice for this format.
Notes: For more details please check the ImageMagick documentation.

ImageMagickMBS.HomeURL as String
method, Image Magick, MBS REALbasic ImageMagick Plugin (ImageMagick), class ImageMagickMBS, Console safe, Plugin version: 5.1, Mac OS X: Works, Windows: Works, Linux x86: Works, Feedback.

Function: Returns the home url of the library.
Notes: For more details please check the ImageMagick documentation.

ImageMagickMBS.InitializeMagick(path as string)
method, Image Magick, MBS REALbasic ImageMagick Plugin (ImageMagick), class ImageMagickMBS, Console safe, Plugin version: 5.1, Mac OS X: Works, Windows: Works, Linux x86: Works, Feedback.

Function: Initializes the ImageMagick environment.
Example:

dim i as ImageMagickMBS
i=new ImageMagickMBS
i.InitializeMagick("")

Notes:
Path: The execution path of the current ImageMagick client.

For more details please check the ImageMagick documentation.

ImageMagickMBS.IsMagickInstantiated as boolean
method, Image Magick, MBS REALbasic ImageMagick Plugin (ImageMagick), class ImageMagickMBS, Console safe, Plugin version: 5.1, Mac OS X: Works, Windows: Works, Linux x86: Works, Feedback.

Function: Returns true if the ImageMagick environment is currently instantiated.
Notes:
In other words: True if InitializeMagick has been called before.

For more details please check the ImageMagick documentation.

ImageMagickMBS.LastError as Integer
property, Image Magick, MBS REALbasic ImageMagick Plugin (ImageMagick), class ImageMagickMBS, Console safe, Plugin version: 5.1, Mac OS X: Works, Windows: Works, Linux x86: Works, Feedback.

Function: The last error code reported.
Notes:
If an exception is raised and it is not a warning exception, this exception code is saved in this property.
(Read and Write property)

ImageMagickMBS.LastException as IMExceptionMBS
property, Image Magick, MBS REALbasic ImageMagick Plugin (ImageMagick), class ImageMagickMBS, Console safe, Plugin version: 5.1, Mac OS X: Works, Windows: Works, Linux x86: Works, Feedback.

Function: The last exception thrown by the Image Magick library.
Notes:
You should check this value after every call to the library, process the error and set the property to nil.

For more details please check the ImageMagick documentation.
(Read and Write property)

ImageMagickMBS.LoadErrorString as string
method, Image Magick, MBS REALbasic ImageMagick Plugin (ImageMagick), class ImageMagickMBS, Console safe, Plugin version: 9.2, Mac OS X: Works, Windows: Works, Linux x86: Works, Feedback.

Function: The last error message from loading the image magick library.

ImageMagickMBS.LoadLibrary(path as string) as boolean
shared method, Image Magick, MBS REALbasic ImageMagick Plugin (ImageMagick), class ImageMagickMBS, Console safe, Plugin version: 5.1, Mac OS X: Works, Windows: Works, Linux x86: Works, Feedback.

Function: Loads the dll/bundle on the give path.
Example:

dim i as new ImageMagickMBS

if TargetLinux then
  if i.LoadLibrary("libMagick.so.6") then
    //MsgBox "library loaded."
  else
    MsgBox "library failed."
  end if
elseif TargetWin32 then
  if i.LoadLibrary("CORE_RL_magick_.dll") then
    //MsgBox "library loaded."
  else
    MsgBox "library failed."
  end if
else
  // Mac OS X
  if i.LoadLibraryFile(GetFolderItem("ImageMagick.bundle")) then
    //MsgBox "library loaded."
  else
    MsgBox "The library failed to load."
  end if
end if

Notes:
In case the loading fails the library may be linked to some other libraries (e.g. X11) and you need to install them to get it working.

On Windows you can just pass the name of the library and the system will search it on the pathes in the environment variable "PATH" (or the Windows folder).

On Linux, pass the path or name of the library and the system will search for it.

For more details please check the ImageMagick documentation.

With plugin version 6.1 the Mac OS X part accepts a path to a dylib file, too.
Changed to a shared method in plugin version 10.4.

ImageMagickMBS.LoadLibraryFile(path as folderitem) as boolean
shared method, Image Magick, MBS REALbasic ImageMagick Plugin (ImageMagick), class ImageMagickMBS, Console safe, Plugin version: 5.1, Mac OS X: Works, Windows: Works, Linux x86: Works, Feedback.

Function: Loads the dll/bundle on the give path.
Example:

dim i as new ImageMagickMBS

if TargetLinux then
  if i.LoadLibrary("libMagick.so.6") then
    //MsgBox "library loaded."
  else
    MsgBox "library failed."
  end if
elseif TargetWin32 then
  if i.LoadLibrary("CORE_RL_magick_.dll") then
    //MsgBox "library loaded."
  else
    MsgBox "library failed."
  end if
else
  // Mac OS X
  if i.LoadLibraryFile(GetFolderItem("ImageMagick.bundle")) then
    //MsgBox "library loaded."
  else
    MsgBox "The library failed to load."
  end if
end if

Notes:
In case the loading fails the library may be linked to some other libraries (e.g. X11) and you need to install them to get it working.

This is the preferred way for Mac OS X as pathes may not be unique.

For more details please check the ImageMagick documentation.

With plugin version 6.1 the Mac OS X part accepts a folderitem for a dylib file, too.
Changed to a shared method in plugin version 10.4.

ImageMagickMBS.MagickInfoList as IMMagickInfoListMBS
method, Image Magick, MBS REALbasic ImageMagick Plugin (ImageMagick), class ImageMagickMBS, Console safe, Plugin version: 5.1, Mac OS X: Works, Windows: Works, Linux x86: Works, Feedback.

Function: Returns the list of known image formats.
Notes:
Sets the last exception property.
For more details please check the ImageMagick documentation.

ImageMagickMBS.MagickToMime(name as string) as string
method, Image Magick, MBS REALbasic ImageMagick Plugin (ImageMagick), class ImageMagickMBS, Console safe, Plugin version: 5.1, Mac OS X: Works, Windows: Works, Linux x86: Works, Feedback.

Function: Returns the officially registered (or de facto) MIME media-type corresponding to a magick string.
Notes:
If there is no registered media-type, then the string "image/x-magick" (all lower case) is returned.

For more details please check the ImageMagick documentation.

ImageMagickMBS.NewImageInfo as IMImageInfoMBS
method, Image Magick, MBS REALbasic ImageMagick Plugin (ImageMagick), class ImageMagickMBS, Console safe, Plugin version: 5.1, Mac OS X: Works, Windows: Works, Linux x86: Works, Feedback.

Function: Creates a new ImageInfo object.
Notes:
Returns nil on low memory.
For more details please check the ImageMagick documentation.

ImageMagickMBS.NewImageList as IMImageMBS
method, Image Magick, MBS REALbasic ImageMagick Plugin (ImageMagick), class ImageMagickMBS, Console safe, Plugin version: 5.1, Mac OS X: Works, Windows: Works, Linux x86: Works, Feedback.

Function: Creates a new empty image list.
Notes: For more details please check the ImageMagick documentation.

ImageMagickMBS.PackageName as String
method, Image Magick, MBS REALbasic ImageMagick Plugin (ImageMagick), class ImageMagickMBS, Console safe, Plugin version: 5.1, Mac OS X: Works, Windows: Works, Linux x86: Works, Feedback.

Function: The package name of the library.
Notes: For more details please check the ImageMagick documentation.

ImageMagickMBS.QuantumDepth as String
method, Image Magick, MBS REALbasic ImageMagick Plugin (ImageMagick), class ImageMagickMBS, Console safe, Plugin version: 5.1, Mac OS X: Works, Windows: Works, Linux x86: Works, Feedback.

Function: The Quantum Depth of the library.
Notes: For more details please check the ImageMagick documentation.

ImageMagickMBS.QuantumDepthLibrary as Integer
method, Image Magick, MBS REALbasic ImageMagick Plugin (ImageMagick), class ImageMagickMBS, Console safe, Plugin version: 5.2, Mac OS X: Works, Windows: Works, Linux x86: Works, Feedback.

Function: The quantum depth used to compile the library.
Notes: QuantumDepthLibrary and QuantumDepthPlugin must be equal for the plugin to work correctly. Currently it is compiled for 16bit support.

ImageMagickMBS.QuantumDepthPlugin as Integer
method, Image Magick, MBS REALbasic ImageMagick Plugin (ImageMagick), class ImageMagickMBS, Console safe, Plugin version: 5.2, Mac OS X: Works, Windows: Works, Linux x86: Works, Feedback.

Function: The quantum depth used to compile the plugin.
Notes: QuantumDepthLibrary and QuantumDepthPlugin must be equal for the plugin to work correctly. Currently it is compiled for 16bit support.

ImageMagickMBS.ReadImage(info as IMImageInfoMBS) as IMImageMBS
method, Image Magick, MBS REALbasic ImageMagick Plugin (ImageMagick), class ImageMagickMBS, Console safe, Plugin version: 5.2, Mac OS X: Works, Windows: Works, Linux x86: Works, Feedback.

Function: Reads an image from a file.
Notes:
Sets the last exception property.
Returns nil on any error.
You need to pass in an info object to describe the image.

For more details please check the ImageMagick documentation.

ImageMagickMBS.ReadImageFromString(info as IMImageInfoMBS, data as string) as IMImageMBS
method, Image Magick, MBS REALbasic ImageMagick Plugin (ImageMagick), class ImageMagickMBS, Console safe, Plugin version: 5.1, Mac OS X: Works, Windows: Works, Linux x86: Works, Feedback.

Function: Reads an image from a string.
Notes:
Sets the last exception property.
Returns nil on any error.
You need to pass in an info object to describe the image.

For more details please check the ImageMagick documentation.

ImageMagickMBS.ReadImageHeaderFromString(info as IMImageInfoMBS, data as string) as IMImageMBS
method, Image Magick, MBS REALbasic ImageMagick Plugin (ImageMagick), class ImageMagickMBS, Console safe, Plugin version: 5.1, Mac OS X: Works, Windows: Works, Linux x86: Works, Feedback.

Function: Reads the image header.
Notes:
Same as ReadImageFromString except the pixel data is not read.
Sets the last exception property.
For more details please check the ImageMagick documentation.

ImageMagickMBS.ReleaseDate as String
method, Image Magick, MBS REALbasic ImageMagick Plugin (ImageMagick), class ImageMagickMBS, Console safe, Plugin version: 5.1, Mac OS X: Works, Windows: Works, Linux x86: Works, Feedback.

Function: The release date of the library.
Notes: For more details please check the ImageMagick documentation.

ImageMagickMBS.Version as String
method, Image Magick, MBS REALbasic ImageMagick Plugin (ImageMagick), class ImageMagickMBS, Console safe, Plugin version: 5.1, Mac OS X: Works, Windows: Works, Linux x86: Works, Feedback.

Function: The version of the library.
Notes: For more details please check the ImageMagick documentation.

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

Links
MBS REAL studio Plugins - Pfarrgemeinde Ministranten Nickenich