All functions
Mac OS X
Windows
Crossplatform
Server
Components
Guides
Statistic
New in version:
2.0
2.1
2.2
2.3
2.4
2.5
2.6
2.7
2.8
2.9
3.0
3.1
3.2
Component: GraphicsMagick
Image functions to convert between image formats and apply effects.
| Name | Description | Mac/Win |
|---|---|---|
| GM.SetCacheThreshold | Sets the Pixel cache threshold in megabytes. | Both |
| GMImage.AdaptiveThreshold | Local adaptive threshold image. | Both |
| GMImage.AddNoise | Add noise to image with specified noise type. | Both |
| GMImage.AddNoiseChannel | Add noise to image with specified noise type. | Both |
| GMImage.Annotate | Annotate image (draw text on image). | Both |
| GMImage.AveragePixelValue | Calculates the average pixel value. | Both |
| GMImage.BaseColumns | Returns the base image width (before transformations). | Both |
| GMImage.BaseFilename | Returns the Base image filename (before transformations) | Both |
| GMImage.BaseRows | Returns the base image height (before transformations) | Both |
| GMImage.Blur | Blur image with specified blur factor. | Both |
| GMImage.BlurChannel | Blur image with specified blur factor. | Both |
| GMImage.Border | Border image (add border to image). | Both |
| GMImage.BoundingBox | Returns smallest bounding box enclosing non-border pixels. | Both |
| GMImage.Channel | Extract channel from image. | Both |
| GMImage.Charcoal | Charcoal effect image (looks like charcoal sketch). | Both |
| GMImage.Chop | Chop image (remove vertical or horizontal subregion of image). | Both |
| GMImage.ClipMask | Associate a clip mask with the image. | Both |
| GMImage.Colorize | Colorize image with pen color, using specified percent opacity. | Both |
| GMImage.ColorizeRGB | Colorize image with pen color, using specified percent opacity for red, green, and blue quantums. | Both |
| GMImage.Columns | Returns the Image width. | Both |
| GMImage.Compare | Compares current image with another image. | Both |
| GMImage.Composite | Compose an image onto another at specified offset and using specified algorithm. | Both |
| GMImage.CompositeXY | Compose an image onto another at specified offset and using specified algorithm. | Both |
| GMImage.Contrast | Contrast image (enhance intensity differences in image). | Both |
| GMImage.Copy | Creates a copy of the picture. | Both |
| GMImage.Crop | Crop image (subregion of original image). | Both |
| GMImage.CycleColormap | Cycle image colormap. | Both |
| GMImage.Despeckle | Despeckle image (reduce speckle noise). | Both |
| GMImage.Destroy | Releases the image from memory. | Both |
| GMImage.Directory | Returns the directory string. | Both |
| GMImage.DrawArc | Draws an arc. | Both |
| GMImage.DrawCircle | Draws a circle. | Both |
| GMImage.DrawEllipse | Draw an ellipse. | Both |
| GMImage.DrawLine | Draws a line. | Both |
| GMImage.DrawRectangle | Draws a rectangle. | Both |
| GMImage.DrawRoundRectangle | Draw a rounded rectangle. | Both |
| GMImage.Edge | Edge image (hilight edges in image) | Both |
| GMImage.Emboss | Emboss image (hilight edges with 3D effect). | Both |
| GMImage.Enhance | Enhance image (minimize noise) | Both |
| GMImage.Equalize | Equalize image (histogram equalization) | Both |
| GMImage.Erase | Erase image to current "background color" | Both |
| GMImage.FillPattern | Sets the pattern to use while filling drawn objects. | Both |
| GMImage.Flip | Flip image (reflect each scanline in the vertical direction) | Both |
| GMImage.FloodFillColor | Flood-fill color across pixels. | Both |
| GMImage.FloodFillColorXY | Flood-fill color across pixels starting at target-pixel and stopping at pixels matching specified border color. | Both |
| GMImage.FloodFillOpacity | Floodfill pixels matching color (within fuzz factor) of target pixel(x,y) with replacement opacity value using method. | Both |
| GMImage.FloodFillTexture | Flood-fill texture across pixels. | Both |
| GMImage.FloodFillTextureXY | Flood-fill texture across pixels. | Both |
| GMImage.Flop | Flop image (reflect each scanline in the horizontal direction) | Both |
| GMImage.Format | Long image format description. | Both |
| GMImage.Frame | Frame image. | Both |
| GMImage.Gamma | Gamma correct image. | Both |
| GMImage.GaussianBlur | Gaussian blur image. | Both |
| GMImage.GaussianBlurChannel | Gaussian blur image. | Both |
| GMImage.Geometry | Preferred size of the image when encoding. | Both |
| GMImage.GetAdjoin | Get adjoin value. Join images into a single multi-image file | Both |
| GMImage.GetAnimationDelay | Queries the animation delay. | Both |
| GMImage.GetAnimationIterations | Queries the Number of iterations to loop an animation (e.g. Netscape loop extension) for. | Both |
| GMImage.GetAntiAlias | Returns whether to Anti-alias Postscript and TrueType fonts (default true) | Both |
| GMImage.GetAttribute | Query a named attribute. | Both |
| GMImage.GetBackgroundColor | Queries the Image background color. | Both |
| GMImage.GetBackgroundTexture | Queries the Name of texture image to tile onto the image background. | Both |
| GMImage.GetBorderColor | Queries the Image border color. | Both |
| GMImage.GetBoxColor | Queries the Text bounding-box base color (default none). | Both |
| GMImage.GetchannelDepth | Obtain modulus channel depth | Both |
| GMImage.GetClassType | Queries the Image class (DirectClass or PseudoClass) | Both |
| GMImage.GetColorFuzz | Queries the color fuzz. Colors within this distance are considered equal | Both |
| GMImage.GetcolorMap | Queries an entry in the color map. | Both |
| GMImage.GetColorMapSize | Queries the Colormap size (number of colormap entries) | Both |
| GMImage.GetColorSpace | Queries the Image Color Space | Both |
| GMImage.GetComment | Queries the comment. | Both |
| GMImage.GetCompose | Queries the Composition operator to be used when composition is implicitly used (such as for image flattening). | Both |
| GMImage.GetCompressType | Queries the compression type. | Both |
| GMImage.GetDebug | Queries whether printing of debug messages from ImageMagick is enabled. | Both |
| GMImage.GetDefineSet | Queries a define value. | Both |
| GMImage.GetDefineValue | Queries a value. | Both |
| GMImage.GetDensity | Queries the Vertical and horizontal resolution in pixels of the image | Both |
| GMImage.GetDepth | Queries the Image depth (bits allocated to red/green/blue components) | Both |
| GMImage.GetEndian | Queries the Endianness (little like Intel or big like SPARC) for image formats which support endian-specific options. | Both |
| GMImage.GetFileName | Queries the Image file name. | Both |
| GMImage.GetFileSize | Returns the number of bytes of the image on disk | Both |
| GMImage.GetFillColor | Queries the Color to use when filling drawn objects. | Both |
| GMImage.GetFillRule | Queries the rule to use when filling drawn objects | Both |
| GMImage.GetFilterType | Queries the Filter to use when resizing image | Both |
| GMImage.GetFont | Queries the Text rendering font. | Both |
| GMImage.GetFontPointsize | Queries the Font point size. | Both |
| GMImage.GetGamma | Gamma level of the image | Both |
| GMImage.GetGifDisposeMethod | Queries the GIF disposal method. | Both |
| GMImage.GetHeight | Returns the image height. | Both |
| GMImage.GeticcColorProfile | Queries the ICC color profile. | Both |
| GMImage.GetInterlaceType | Queries the interlace type. | Both |
| GMImage.GetiptcProfile | Queries the IPTC profile. | Both |
| GMImage.GetIsValid | Does object contain valid image? | Both |
| GMImage.GetJPEGAsBase64 | Returns the picture in JPEG format as a base64 encoded string. | Both |
| GMImage.GetJPEGAsHex | Returns the picture in JPEG format as a hex encoded string. | Both |
| GMImage.GetLabel | Queries the image label. | Both |
| GMImage.GetLineWidth | Queries the Stroke width for drawing vector objects (default one) | Both |
| GMImage.GetMagick | Queries the File type magick identifier (.e.g "GIF") | Both |
| GMImage.GetMatte | Queries the image supports transparency (matte channel) | Both |
| GMImage.GetMatteColor | Queries the Transparent color. | Both |
| GMImage.GetModulusDepth | Queries the image modulus depth. | Both |
| GMImage.GetMonochrome | Queries the monochrome flag. Transform image to black and white | Both |
| GMImage.GetOrientation | Queries the image orientation. | Both |
| GMImage.GetPage | Queries the Preferred size and location of an image canvas. | Both |
| GMImage.GetpixelColor | get pixel color at location x & y. | Both |
| GMImage.GetPNGAsBase64 | Returns the picture in PNG format as a base64 encoded string. | Both |
| GMImage.GetPNGAsHex | Returns the picture in PNG format as a hex encoded string. | Both |
| GMImage.Getprofile | Retrieve a named profile from the image. | Both |
| GMImage.GetQuality | Queries the JPEG/MIFF/PNG compression level (default 75). | Both |
| GMImage.GetQuantizeColors | Queries the Maximum number of colors to quantize to. | Both |
| GMImage.GetQuantizeColorSpace | Gets the Colorspace to quantize in. | Both |
| GMImage.GetQuantizeDither | Queries whether to dither image during quantization (default true). | Both |
| GMImage.GetQuantizeTreeDepth | Queries the Quantization tree-depth. | Both |
| GMImage.GetRenderingIntent | Queries the type of rendering intent. | Both |
| GMImage.GetResolutionUnits | Queries which units are used for image resolution. | Both |
| GMImage.GetScene | Gets the image scene number | Both |
| GMImage.GetSize | Queries the Width and height of a raw image | Both |
| GMImage.GetStrokeAntiAlias | Whether stroke anti-aliasing is enabled. | Both |
| GMImage.GetStrokeColor | Queries the Color to use when drawing object outlines. | Both |
| GMImage.GetStrokeDashOffset | Gets the stroke dash offset. | Both |
| GMImage.GetStrokeLineCap | Specify the shape to be used at the end of open subpaths when they are stroked. | Both |
| GMImage.GetStrokeLineJoin | Specify the shape to be used at the corners of paths (or other vector shapes) when they are stroked. | Both |
| GMImage.GetStrokeMiterLimit | Gets the miter limit. | Both |
| GMImage.GetStrokeWidth | Gets the Stroke width for drawing vector objects (default one) | Both |
| GMImage.GetSubImage | Queries which image of an image sequence is currently used. | Both |
| GMImage.GetSubRange | Gets the Number of images relative to the base image | Both |
| GMImage.GetTextEncoding | Queries the text encoding. | Both |
| GMImage.GetTileName | Queries the Tile name. | Both |
| GMImage.GetType | Image representation type. | Both |
| GMImage.GetVerbose | Queries whether to print detailed information about the image | Both |
| GMImage.GetView | Queries the FlashPix viewing parameters. | Both |
| GMImage.GetWidth | Returns the Image width. | Both |
| GMImage.Implode | Implode image (special effect). | Both |
| GMImage.Level | Level image. | Both |
| GMImage.LevelChannel | Level image channel. | Both |
| GMImage.Magnify | Magnify image by integral size. | Both |
| GMImage.Map | Remap image colors with closest color from reference image. | Both |
| GMImage.MatteFloodfill | Floodfill designated area with replacement opacity value. | Both |
| GMImage.MeanErrorPerPixel | The mean error per pixel computed when an image is color reduced. | Both |
| GMImage.MedianFilter | Filter image by replacing each pixel component with the median color in a circular neighborhood. | Both |
| GMImage.Minify | Reduce image by integral size. | Both |
| GMImage.Modulate | Modulate percent hue, saturation, and brightness of an image. | Both |
| GMImage.MontageGeometry | Tile size and offset within an image montage. | Both |
| GMImage.MotionBlur | Motion blur image with specified blur factor. | Both |
| GMImage.Negate | Negate colors in image. | Both |
| GMImage.New | Construct a blank image canvas of specified size and color. | Both |
| GMImage.NewFromBase64 | Loads a picture from base64 encoded data. | Both |
| GMImage.NewFromContainer | Loads a picture from the given container. | Both |
| GMImage.NewFromFile | Loads a picture file. | Both |
| GMImage.NewFromHex | Loads a picture from hex encoded data. | Both |
| GMImage.Normalize | Normalize image (increase contrast by normalizing the pixel values to span the full range of color values) | Both |
| GMImage.NormalizedMaxError | The normalized max error per pixel computed when an image is color reduced. | Both |
| GMImage.NormalizedMeanError | The normalized mean error per pixel computed when an image is color reduced. | Both |
| GMImage.OilPaint | Oilpaint image (image looks like oil painting) | Both |
| GMImage.Opacity | Set or attenuate the opacity channel in the image. | Both |
| GMImage.Opaque | Change color of opaque pixel to specified pen color. | Both |
| GMImage.Quantize | Quantize image (reduce number of colors). | Both |
| GMImage.Raise | Raise image (lighten or darken the edges of an image to give a 3-D raised or lowered effect) | Both |
| GMImage.RandomThreshold | Random threshold image. | Both |
| GMImage.RandomThresholdChannel | Random threshold image. | Both |
| GMImage.ReduceNoise | Reduce noise in image using a noise peak elimination filter. | Both |
| GMImage.Roll | Roll image (rolls image vertically and horizontally) by specified number of columnms and rows) | Both |
| GMImage.Rollxy | Roll image (rolls image vertically and horizontally) by specified number of columnms and rows) | Both |
| GMImage.Rotate | Rotate image counter-clockwise by specified number of degrees. | Both |
| GMImage.Rows | Returns the image height. | Both |
| GMImage.Sample | Resize image by using pixel sampling algorithm. | Both |
| GMImage.Scale | Resize image by using simple ratio algorithm. | Both |
| GMImage.Segment | Segments the image. | Both |
| GMImage.SetAdjoin | Set adjoin value. Join images into a single multi-image file | Both |
| GMImage.SetAnimationDelay | Sets the animation delay. | Both |
| GMImage.SetAnimationIterations | Sets the Number of iterations to loop an animation (e.g. Netscape loop extension) for. | Both |
| GMImage.SetAntiAlias | Sets whether to Anti-alias Postscript and TrueType fonts (default true) | Both |
| GMImage.SetAttribute | Set a named attribute. | Both |
| GMImage.SetBackgroundColor | Sets the Image background color. | Both |
| GMImage.SetBackgroundTexture | Sets the Name of texture image to tile onto the image background | Both |
| GMImage.SetBorderColor | Sets the Image border color. | Both |
| GMImage.SetBoxColor | Text bounding-box base color (default none). | Both |
| GMImage.SetchannelDepth | Set modulus channel depth | Both |
| GMImage.SetClassType | Sets the Image class (DirectClass=1 or PseudoClass=2) | Both |
| GMImage.SetColorFuzz | Sets the color fuzz. Colors within this distance are considered equal | Both |
| GMImage.SetcolorMap | Sets an entry in the color map. | Both |
| GMImage.SetColorMapSize | Sets the Colormap size (number of colormap entries) | Both |
| GMImage.SetColorSpace | Sets the Image Color Space. | Both |
| GMImage.SetComment | Sets the image comment. | Both |
| GMImage.SetCompose | Sets the Composition operator to be used when composition is implicitly used (such as for image flattening). | Both |
| GMImage.SetCompressType | Sets the compression type. | Both |
| GMImage.SetDebug | Enables printing of debug messages from ImageMagick | Both |
| GMImage.SetDefineSet | Sets a define value. | Both |
| GMImage.SetDefineValue | Sets a value. | Both |
| GMImage.SetDensity | Sets the Vertical and horizontal resolution in pixels of the image | Both |
| GMImage.SetDepth | Sets the Image depth (bits allocated to red/green/blue components) | Both |
| GMImage.SetEndian | Sets the Endianness (little like Intel or big like SPARC) for image formats which support endian-specific options. | Both |
| GMImage.SetFileName | Sets the Image file name. | Both |
| GMImage.SetFillColor | Sets the Color to use when filling drawn objects. | Both |
| GMImage.SetFillRule | Sets the rule to use when filling drawn objects | Both |
| GMImage.SetFilterType | Sets the Filter to use when resizing image | Both |
| GMImage.SetFont | Sets the Text rendering font. | Both |
| GMImage.SetFontPointsize | Sets the font point size. | Both |
| GMImage.SetGifDisposeMethod | Sets the GIF disposal method. | Both |
| GMImage.SeticcColorProfile | Sets the ICC color profile. | Both |
| GMImage.SetInterlaceType | Sets the interlace type. | Both |
| GMImage.SetiptcProfile | Sets the IPTC profile. | Both |
| GMImage.SetIsValid | Sets whether the object contain a valid image. | Both |
| GMImage.SetLabel | Sets the image label. | Both |
| GMImage.SetLineWidth | Sets the Stroke width for drawing vector objects (default one) | Both |
| GMImage.SetMagick | Sets the File type magick identifier (.e.g "GIF") | Both |
| GMImage.SetMatte | Sets whether image supports transparency (matte channel) | Both |
| GMImage.SetMatteColor | Sets the Transparent color. | Both |
| GMImage.SetModulusDepth | Sets the Image modulus depth. | Both |
| GMImage.SetMonochrome | If set, transform image to black and white. | Both |
| GMImage.SetOrientation | Sets the image orientation. | Both |
| GMImage.SetPage | Sets the Preferred size and location of an image canvas. | Both |
| GMImage.SetpixelColor | set pixel color at location x & y. | Both |
| GMImage.Setprofile | Add or remove a named profile to/from the image. | Both |
| GMImage.SetQuality | Sets the JPEG/MIFF/PNG compression level (default 75). | Both |
| GMImage.SetQuantizeColors | Sets the Maximum number of colors to quantize to | Both |
| GMImage.SetQuantizeColorSpace | Sets the Colorspace to quantize in. | Both |
| GMImage.SetQuantizeDither | Sets whether to dither image during quantization (default true). | Both |
| GMImage.SetQuantizeTreeDepth | Sets the Quantization tree-depth. | Both |
| GMImage.SetRenderingIntent | Sets the type of rendering intent | Both |
| GMImage.SetResolutionUnits | Sets which units are used for image resolution. | Both |
| GMImage.SetScene | Sets the image scene number | Both |
| GMImage.SetSize | Sets the Width and height of a raw image | Both |
| GMImage.SetStrokeAntiAlias | Enables/disables stroke anti-aliasing. | Both |
| GMImage.SetStrokeColor | Sets the Color to use when drawing object outlines. | Both |
| GMImage.SetStrokeDashOffset | Sets the stroke dash offset. | Both |
| GMImage.SetStrokeLineCap | Specify the shape to be used at the end of open subpaths when they are stroked. | Both |
| GMImage.SetStrokeLineJoin | Specify the shape to be used at the corners of paths (or other vector shapes) when they are stroked. | Both |
| GMImage.SetStrokeMiterLimit | Sets the miter limit. | Both |
| GMImage.SetStrokeWidth | Sets the Stroke width for drawing vector objects (default one) | Both |
| GMImage.SetSubImage | Selects which image of an image sequence is currently used. | Both |
| GMImage.SetSubRange | Sets the Number of images relative to the base image | Both |
| GMImage.SetTextEncoding | Sets the Annotation text encoding (e.g. "UTF-16") | Both |
| GMImage.SetTileName | Sets the Tile name. | Both |
| GMImage.SetType | Sets the Image representation type. | Both |
| GMImage.SetVerbose | Sets whether to print detailed information about the image. | Both |
| GMImage.SetView | Sets the FlashPix viewing parameters. | Both |
| GMImage.Shade | Shade image using distant light source. | Both |
| GMImage.Sharpen | Sharpen pixels in image. | Both |
| GMImage.SharpenChannel | Sharpen pixels in image | Both |
| GMImage.Shave | Shave pixels from image edges. | Both |
| GMImage.Shear | Shear image (create parallelogram by sliding image by X or Y axis). | Both |
| GMImage.Signature | Image signature. Set force to 1 in order to re-calculate the signature regardless of whether the image data has been modified. | Both |
| GMImage.Solarize | Solarize image (similar to effect seen when exposing a photographic film to light during the development process). | Both |
| GMImage.Spread | Spread pixels randomly within image by specified ammount. | Both |
| GMImage.Stegano | Add a digital watermark to the image (based on second image) | Both |
| GMImage.Stereo | Create an image which appears in stereo when viewed with red-blue glasses (Red image on left, blue on right) | Both |
| GMImage.StrokePattern | Sets the pattern image to use while stroking object outlines. | Both |
| GMImage.Swirl | Swirl image (image pixels are rotated by degrees). | Both |
| GMImage.Texture | Channel a texture on image background. | Both |
| GMImage.Threshold | Threshold image channels (below threshold becomes black, above threshold becomes white). | Both |
| GMImage.TotalColors | Number of colors in the image | Both |
| GMImage.Transform | Transform image based on image and crop geometries. | Both |
| GMImage.TransformOrigin | Origin of coordinate system to use when annotating with text or drawing. | Both |
| GMImage.TransformReset | Reset transformation parameters to default. | Both |
| GMImage.TransformRotation | Rotation to use when annotating with text or drawing. | Both |
| GMImage.TransformScale | Scale to use when annotating with text or drawing. | Both |
| GMImage.TransformSkewX | Skew to use in X axis when annotating with text or drawing. | Both |
| GMImage.TransformSkewY | Skew to use in Y axis when annotating with text or drawing. | Both |
| GMImage.Transparent | Add matte image to image, setting pixels matching color to transparent | Both |
| GMImage.Trim | Trim edges that are the background color from the image. Please use GMImage.SetBackgroundColor to set the background color. | Both |
| GMImage.Unsharpmask | Replace image with a sharpened version of the original image using the unsharp mask algorithm. | Both |
| GMImage.UnsharpmaskChannel | Replace image with a sharpened version of the original image using the unsharp mask algorithm. | Both |
| GMImage.Wave | Map image pixels to a sine wave: | Both |
| GMImage.WriteToBMPContainer | Writes the picture in BMP format to a container object which you can store in a container field. | Both |
| GMImage.WriteToFile | Write single image frame to a file. | Both |
| GMImage.WriteToGIFContainer | Writes the picture in GIF format to a container object which you can store in a container field. | Both |
| GMImage.WriteToJPEGContainer | Writes the picture in JPEG format to a container object which you can store in a container field. | Both |
| GMImage.WriteToPNGContainer | Writes the picture in PNG format to a container object which you can store in a container field. | Both |
| GMImage.XResolution | Returns the x resolution of the image. | Both |
| GMImage.YResolution | Returns the y resolution of the image. | Both |
| GMImage.Zoom | Zoom image to specified size. | Both |
Feedback: Report problem or ask question.
