Monkeybread Xojo plugin - CGImageDestinationMBS class

Platforms to show: All Mac Windows Linux Cross-Platform

CGImageDestinationMBS class

Type	Topic	Plugin	Version	macOS	Windows	Linux	iOS	Targets
class	CoreGraphics	MBS MacCG Plugin	9.5	✅ Yes	❌ No	❌ No	✅ Yes	All

A class to write CGImages.

Example

Var logo as Picture = LogoMBS(500)
Var image as CGImageMBS = CGCreateImageMBS(logo)

Var dic as new Dictionary

// 10%
'dic.Value(CGImageDestinationMBS.kCGImageDestinationLossyCompressionQuality)=0.1

// 100%
dic.Value(CGImageDestinationMBS.kCGImageDestinationLossyCompressionQuality)=1.0

Var file as FolderItem = SpecialFolder.Desktop.Child("logo.jpg")
Var d as new CGImageDestinationMBS(file, "public.jpeg", 1)

d.AddImage(image, dic)

if d.Finalize then
  MsgBox "Saved"
else
  MsgBox "Failed to save."
end if

CGImageDestination objects, available in Mac OS X v10.4 or later, abstract the data-writing task. An image destination can represent a single image or multiple images. It can contain thumbnail images as well as properties for each image.

The functions described in this reference can write data to three kinds of destinations: a file, an URL and a string. After creating a CGImageDestination object for the appropriate destination, you can add image data and set image properties. When you are finished adding data, call the function Finalize to write the image data and properties.

property Handle as Integer
12 methods
- method AddImage(image as CGImageMBS, properties as dictionary=nil)
- method AddImageCF(image as CGImageMBS, properties as Variant = nil)
- method AddImageFromSource(source as CGImageSourceMBS, index as Integer, options as dictionary = nil)
- method AddImageFromSourceCF(source as CGImageSourceMBS, index as Integer, options as Variant = nil)
- method Constructor(file as folderitem, type as string, count as Integer = 1)
- method Constructor(type as string, count as Integer = 1)
- method Constructor(url as string, type as string, count as Integer = 1)
- method Data as string
- method Finalize as boolean
- method FinalizeMT as boolean
- method SetProperties(options as dictionary = nil)
- method SetPropertiesCF(options as Variant)
4 shared methods
- shared method CreateWithData(type as string, count as Integer = 1) as CGImageDestinationMBS
- shared method CreateWithFile(file as folderitem, type as string, count as Integer = 1) as CGImageDestinationMBS
- shared method CreateWithURL(url as string, type as string, count as Integer = 1) as CGImageDestinationMBS
- shared method TypeIdentifiers as string()
34 constants as shared methods
- shared method kCGImageDestinationBackgroundColor as string
- shared method kCGImageDestinationDateTime as string
- shared method kCGImageDestinationEmbedThumbnail as string New in 25.5
- shared method kCGImageDestinationEncodeAlternateColorSpace as string New in 25.5
- shared method kCGImageDestinationEncodeBaseColorSpace as string New in 25.5
- shared method kCGImageDestinationEncodeBaseIsSDR as string New in 25.5
- shared method kCGImageDestinationEncodeBasePixelFormatRequest as string New in 25.5
- shared method kCGImageDestinationEncodeGainMapPixelFormatRequest as string New in 25.5
- shared method kCGImageDestinationEncodeGainMapSubsampleFactor as string New in 25.5
- shared method kCGImageDestinationEncodeGenerateGainMapWithBaseImage as string New in 25.5
- shared method kCGImageDestinationEncodeIsBaseImage as string New in 25.5
- shared method kCGImageDestinationEncodeRequest as string New in 25.5
- shared method kCGImageDestinationEncodeRequestOptions as string New in 25.5
- shared method kCGImageDestinationEncodeToISOGainmap as string New in 25.5
- shared method kCGImageDestinationEncodeToISOHDR as string New in 25.5
- shared method kCGImageDestinationEncodeTonemapMode as string New in 25.5
- shared method kCGImageDestinationEncodeToSDR as string New in 25.5
- shared method kCGImageDestinationImageMaxPixelSize as string New in 25.5
- shared method kCGImageDestinationLossyCompressionQuality as string
- shared method kCGImageDestinationMergeMetadata as string
- shared method kCGImageDestinationMetadata as string
- shared method kCGImageDestinationOptimizeColorForSharing as string New in 25.5
- shared method kCGImageDestinationOrientation as string
- shared method kCGImageDestinationPreserveGainMap as string New in 25.5
- shared method kCGImageMetadataShouldExcludeGPS as string New in 25.5
- shared method kCGImageMetadataShouldExcludeXMP as string
- shared method kCGImagePropertyASTCBlockSize as string New in 25.5
- shared method kCGImagePropertyASTCBlockSize4x4 as string New in 25.5
- shared method kCGImagePropertyASTCBlockSize8x8 as string New in 25.5
- shared method kCGImagePropertyASTCEncoder as string New in 25.5
- shared method kCGImagePropertyBCEncoder as string New in 25.5
- shared method kCGImagePropertyBCFormat as string New in 25.5
- shared method kCGImagePropertyEncoder as string New in 25.5
- shared method kCGImagePropertyPVREncoder as string New in 25.5

This class has no sub classes.

Blog Entries

Release notes

Version 25.5
- Rewrote CGImageSourceMBS and CGImageDestinationMBS classes. More methods and properties and raising exceptions in case of errors.

Some examples using this class:

Some related classes:

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

CGGradientMBS - CGImageMBS

💬 Ask a question or report a problem