Components | All | New | MacOS | Windows | Linux | iOS | ||||
Examples | Mac & Win | Server | Client | Guides | Statistic | FMM | Blog | Deprecated | Old |
GMImage.SetCompressType
Sets the compression type.
Component | Version | macOS | Windows | Linux | Server | iOS SDK |
GraphicsMagick | 2.0 | ✅ Yes | ✅ Yes | ✅ Yes | ✅ Yes | ✅ Yes |
Parameters
Parameter | Description | Example |
---|---|---|
ImageRef | The image reference number. | 1 |
CompressionType | UndefinedCompression = 0, NoCompression = 1, BZipCompression = 2, FaxCompression = 3, Group4Compression = 4, JPEGCompression = 5, LosslessJPEGCompression = 6, LZWCompression = 7, RLECompression = 8, ZipCompression = 9 | 1 |
Result
Returns "OK" on success.
Description
Sets the compression type.CompressionType is used to express the desired compression type when encoding an image. Be aware that most image types only support a sub-set of the available compression types. If the compression type specified is incompatible with the image, GraphicsMagick selects a compression type compatible with the image type.
GIF is always LZW compressed, PNG is always zip compressed.
Examples
Convert image to 1 bit TIFF:
# Load from container
$Image = MBS("GMImage.NewFromContainer"; GraphicsMagick::image);
# make black and white with threshold
$Result = MBS("GMImage.Threshold";$Image; 127);
# mark as monochrome image
$Result = MBS("GMImage.SetMonochrome";$Image; 1);
# set type to 1 for black/white
$Result = MBS("GMImage.SetType";$Image; 1);
# set to use TIFF for compression
$Result = MBS("GMImage.SetMagick";$Image; "TIFF");
# set to use CCITT 4 Fax compression
$Result = MBS("GMImage.SetCompressType";$Image; 4);
# and write to a file
$Result = MBS("GMImage.WriteToFile"; $Image; "/tmp/test.tif");
# cleanup
$Error = MBS("GMImage.Release";$Image)
See also
- GMImage.GetCompressType
- GMImage.NewFromContainer
- GMImage.Release
- GMImage.SetClassType
- GMImage.SetMagick
- GMImage.SetMonochrome
- GMImage.SetType
- GMImage.Threshold
- GMImage.WriteToFile
- GMImage.WriteToTiffContainer
This function checks for a license.
Created 18th August 2014, last changed 6th December 2022