Platforms to show: All Mac Windows Linux Cross-Platform
Back to CGImageDestinationMBS class.
CGImageDestinationMBS.CreateWithData(type as string, count as Integer = 1) as CGImageDestinationMBS
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
shared method | CoreGraphics | MBS MacCG Plugin | 9.5 | ✅ Yes | ❌ No | ❌ No | ✅ Yes | All |
type: The uniform type identifier (UTI) of the resulting image file. See Uniform Type Identifiers Overview for a list of system-declared and third-party UTIs.
count: The number of images (not including thumbnail images) that the image file will contain.
On error the function returns nil.
Available in Mac OS X version 10.4 and later.
CGImageDestinationMBS.CreateWithFile(file as folderitem, type as string, count as Integer = 1) as CGImageDestinationMBS
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
shared method | CoreGraphics | MBS MacCG Plugin | 9.5 | ✅ Yes | ❌ No | ❌ No | ✅ Yes | All |
file: The file to write to. If the file already exists, the data at this location is overwritten.
type: The UTI (uniform type identifier) of the resulting image file. See Uniform Type Identifiers Overview for a list of system-declared and third-party UTIs.
count: The number of images (not including thumbnail images) that the image file will contain.
On failure the function returns nil.
Available in Mac OS X version 10.4 and later.
CGImageDestinationMBS.CreateWithURL(url as string, type as string, count as Integer = 1) as CGImageDestinationMBS
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
shared method | CoreGraphics | MBS MacCG Plugin | 9.5 | ✅ Yes | ❌ No | ❌ No | ✅ Yes | All |
url: The URL to write to. If the URL already exists, the data at this location is overwritten.
type: The UTI (uniform type identifier) of the resulting image file. See Uniform Type Identifiers Overview for a list of system-declared and third-party UTIs.
count: The number of images (not including thumbnail images) that the image file will contain.
On error nil is returned.
Available in Mac OS X version 10.4 and later.
CGImageDestinationMBS.kCGImageDestinationBackgroundColor as string
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
shared method | CoreGraphics | MBS MacCG Plugin | 9.5 | ✅ Yes | ❌ No | ❌ No | ✅ Yes | All |
The desired background color to composite against when writing an image that has an alpha component to a destination format that does not support alpha. If present, the value associated with this key must be a CGColorRef data type without an alpha component of its own. If not present, and if a background color is needed, a white color is used.
Available in Mac OS X v10.4 and later.
CGImageDestinationMBS.kCGImageDestinationDateTime as string
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
shared method | CoreGraphics | MBS MacCG Plugin | 13.1 | ✅ Yes | ❌ No | ❌ No | ✅ Yes | All |
Updates the DateTime parameters of the image metadata. Only values present in the original image will updated. If present, the value should be a String or a Date. If String, the value must be in Exif DateTime or ISO 8601 DateTime format. This option is mutually exclusive with kCGImageDestinationMetadata.
CGImageDestinationMBS.kCGImageDestinationLossyCompressionQuality as string
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
shared method | CoreGraphics | MBS MacCG Plugin | 9.5 | ✅ Yes | ❌ No | ❌ No | ✅ Yes | All |
The desired compression quality to use when writing to an image destination. If present, the value associated with this key must be a double in the range 0.0 to 1.0. A value of 1.0 specifies to use lossless compression if destination format supports it. A value of 0.0 implies to use maximum compression.
Available in Mac OS X v10.4 and later.
Some examples using this method:
CGImageDestinationMBS.kCGImageDestinationMergeMetadata as string
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
shared method | CoreGraphics | MBS MacCG Plugin | 13.1 | ✅ Yes | ❌ No | ❌ No | ✅ Yes | All |
If true, The metadata will be copied from the source and merged with the tags specified in kCGImageDestinationMetadata. If a tag does not exist in the source, it will be added. If the tag exists in the source, it will be updated. A metadata tag can be removed by setting the tag's value to nil. If present, the value of this key is a Boolean. The default is False.
CGImageDestinationMBS.kCGImageDestinationMetadata as string
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
shared method | CoreGraphics | MBS MacCG Plugin | 13.1 | ✅ Yes | ❌ No | ❌ No | ✅ Yes | All |
Set the metadata tags for the image destination. If present, the value of this key is a CGImageMetadata. By default, all EXIF, IPTC, and XMP tags will be replaced. Use kCGImageDestinationMergeMetadata to merge the tags with the existing tags in the image source.
CGImageDestinationMBS.kCGImageDestinationOrientation as string
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
shared method | CoreGraphics | MBS MacCG Plugin | 13.1 | ✅ Yes | ❌ No | ❌ No | ✅ Yes | All |
Updates the orientation in the image metadata. The image data itself will not be rotated. If present, the value should be a Integer from 1 to 8. This option is mutually exclusive with kCGImageDestinationMetadata.
CGImageDestinationMBS.kCGImageMetadataShouldExcludeXMP as string
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
shared method | CoreGraphics | MBS MacCG Plugin | 13.1 | ✅ Yes | ❌ No | ❌ No | ✅ Yes | All |
XMP data will not be written to the destination. If used in conjunction with kCGImageDestinationMetadata, EXIF and/or IPTC tags will be preserved, but an XMP packet will not be written to the file. If present, the value for this key is a Boolean. The default is False.
CGImageDestinationMBS.TypeIdentifiers as string()
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
shared method | CoreGraphics | MBS MacCG Plugin | 9.5 | ✅ Yes | ❌ No | ❌ No | ✅ Yes | All |
Returns an array of the UTIs that are supported for image destinations. See Uniform Type Identifiers Overview for a list of system-declared and third-party UTIs that can be returned.
Available in Mac OS X version 10.4 and later.
The items on this page are in the following plugins: MBS MacCG Plugin.
