Monkeybread Software - MBS FileMaker Plugin: GMImage.SetCompressType

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

MBS( "GMImage.SetCompressType"; ImageRef; CompressionType ) More

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

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
Set Variable [ $Image ; Value: MBS("GMImage.NewFromContainer"; GraphicsMagick::image) ]

# make black and white with threshold
Set Variable [ $Result ; Value: MBS("GMImage.Threshold";$Image; 127) ]

# mark as monochrome image
Set Variable [ $Result ; Value: MBS("GMImage.SetMonochrome";$Image; 1) ]

# set type to 1 for black/white
Set Variable [ $Result ; Value: MBS("GMImage.SetType";$Image; 1) ]

# set to use TIFF for compression
Set Variable [ $Result ; Value: MBS("GMImage.SetMagick";$Image; "TIFF") ]

# set to use CCITT 4 Fax compression
Set Variable [ $Result ; Value: MBS("GMImage.SetCompressType";$Image; 4) ]

# and write to a file
Set Variable [ $Result ; Value: MBS("GMImage.WriteToFile"; $Image; "/tmp/test.tif") ]

# cleanup
Set Variable [ $Error ; Value: MBS("GMImage.Release";$Image) ]

<?xml version="1.0" encoding="UTF-8"?>
<fmxmlsnippet type="FMObjectList">
  <Step enable="True" id="89" name="# (comment)">
    <Text> Load from container</Text>
  </Step>
  <Step enable="True" id="141" name="Set Variable">
    <Value>
      <Calculation>MBS("GMImage.NewFromContainer"; GraphicsMagick::image) </Calculation>
    </Value>
    <Repetition>
      <Calculation>1</Calculation>
    </Repetition>
    <Name>$Image</Name>
  </Step>
  <Step enable="True" id="89" name="# (comment)">
    <Text> make black and white with threshold</Text>
  </Step>
  <Step enable="True" id="141" name="Set Variable">
    <Value>
      <Calculation>MBS("GMImage.Threshold";$Image; 127) </Calculation>
    </Value>
    <Repetition>
      <Calculation>1</Calculation>
    </Repetition>
    <Name>$Result</Name>
  </Step>
  <Step enable="True" id="89" name="# (comment)">
    <Text> mark as monochrome image</Text>
  </Step>
  <Step enable="True" id="141" name="Set Variable">
    <Value>
      <Calculation>MBS("GMImage.SetMonochrome";$Image; 1) </Calculation>
    </Value>
    <Repetition>
      <Calculation>1</Calculation>
    </Repetition>
    <Name>$Result</Name>
  </Step>
  <Step enable="True" id="89" name="# (comment)">
    <Text> set type to 1 for black/white</Text>
  </Step>
  <Step enable="True" id="141" name="Set Variable">
    <Value>
      <Calculation>MBS("GMImage.SetType";$Image; 1) </Calculation>
    </Value>
    <Repetition>
      <Calculation>1</Calculation>
    </Repetition>
    <Name>$Result</Name>
  </Step>
  <Step enable="True" id="89" name="# (comment)">
    <Text> set to use TIFF for compression</Text>
  </Step>
  <Step enable="True" id="141" name="Set Variable">
    <Value>
      <Calculation>MBS("GMImage.SetMagick";$Image; "TIFF") </Calculation>
    </Value>
    <Repetition>
      <Calculation>1</Calculation>
    </Repetition>
    <Name>$Result</Name>
  </Step>
  <Step enable="True" id="89" name="# (comment)">
    <Text> set to use CCITT 4 Fax compression</Text>
  </Step>
  <Step enable="True" id="141" name="Set Variable">
    <Value>
      <Calculation>MBS("GMImage.SetCompressType";$Image; 4) </Calculation>
    </Value>
    <Repetition>
      <Calculation>1</Calculation>
    </Repetition>
    <Name>$Result</Name>
  </Step>
  <Step enable="True" id="89" name="# (comment)">
    <Text> and write to a file</Text>
  </Step>
  <Step enable="True" id="141" name="Set Variable">
    <Value>
      <Calculation>MBS("GMImage.WriteToFile"; $Image; "/tmp/test.tif") </Calculation>
    </Value>
    <Repetition>
      <Calculation>1</Calculation>
    </Repetition>
    <Name>$Result</Name>
  </Step>
  <Step enable="True" id="89" name="# (comment)">
    <Text> cleanup</Text>
  </Step>
  <Step enable="True" id="141" name="Set Variable">
    <Value>
      <Calculation>MBS("GMImage.Release";$Image) </Calculation>
    </Value>
    <Repetition>
      <Calculation>1</Calculation>
    </Repetition>
    <Name>$Error</Name>
  </Step>
</fmxmlsnippet>

GMImage.SetCompressType

Parameters

Result

Description

Examples

See also