Platforms to show: All Mac Windows Linux Cross-Platform
Back to CIFilterMBS class.
CIFilterMBS.filterArrayFromSerializedXMP(xmpData as MemoryBlock, extent as CGRectMBS, byref NSError as Variant) as CIFilterMBS()
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
shared method | CoreImage | MBS MacCI Plugin | 14.1 | ✅ Yes | ❌ No | ❌ No | ✅ Yes | All |
xmpData: The XMP data created previously by calling serializedXMPFromFilters.
extent: The extent of the image from which the XMP data was extracted.
e: The address of an variant for receiving errors, otherwise nil. This is a NSErrorMBS.
Available in OS X v10.9 and later.
CIFilterMBS.FilterNamesInCategories(categories() as String) as string()
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
shared method | CoreImage | MBS MacCI Plugin | 7.3 | ✅ Yes | ❌ No | ❌ No | ✅ Yes | All |
categories: string array with the constants kCICategory*.
Returns nil on any error.
CIFilterMBS.FilterNamesInCategory(category as String) as string()
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
shared method | CoreImage | MBS MacCI Plugin | 7.3 | ✅ Yes | ❌ No | ❌ No | ✅ Yes | All |
nil on any error.
Some examples using this method:
CIFilterMBS.FilterWithHandle(handle as Integer) as CIFilterMBS
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
shared method | CoreImage | MBS MacCI Plugin | 10.4 | ✅ Yes | ❌ No | ❌ No | ✅ Yes | All |
The object is retained.
Returns nil on error.
CIFilterMBS.filterWithImageData(Data as MemoryBlock, options as Dictionary) as CIFilterMBS
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
shared method | CoreImage | MBS MacCI Plugin | 17.4 | ✅ Yes | ❌ No | ❌ No | ✅ Yes | All |
Note that when using this initializer, you should pass in a source type identifier hint (kCGImageSourceTypeIdentifierHint) key/value pair in order to help the decoder determine the file type, as otherwise confusion and incorrect results are possible.
CIFilterMBS.filterWithImageFile(File as FolderItem, options as Dictionary) as CIFilterMBS
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
shared method | CoreImage | MBS MacCI Plugin | 17.4 | ✅ Yes | ❌ No | ❌ No | ✅ Yes | All |
Some examples using this method:
CIFilterMBS.filterWithImageURL(URL as String, options as Dictionary) as CIFilterMBS
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
shared method | CoreImage | MBS MacCI Plugin | 17.4 | ✅ Yes | ❌ No | ❌ No | ✅ Yes | All |
CIFilterMBS.FilterWithName(name as String) as CIFilterMBS
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
shared method | CoreImage | MBS MacCI Plugin | 7.3 | ✅ Yes | ❌ No | ❌ No | ✅ Yes | All |
Returns filter object for the name if found.
See also:
CIFilterMBS.FilterWithName(name as String, options as Dictionary) as CIFilterMBS
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
shared method | CoreImage | MBS MacCI Plugin | 17.4 | ✅ Yes | ❌ No | ❌ No | ✅ Yes | All |
The filter's input parameters are set from the dictionary of key-value pairs.
On OSX, any of the filter input parameters not specified in the dictionary will be undefined.
On iOS, any of the filter input parameters not specified in the dictionary will be set to default values.
Available in macOS 10.10 or newer.
See also:
CIFilterMBS.kCIActiveKeys as String
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
shared method | CoreImage | MBS MacCI Plugin | 17.4 | ✅ Yes | ❌ No | ❌ No | ✅ Yes | All |
Read-only array containing a list of keys that affect the output image.
Depending on the RAW decoder version (kCIInputDecoderVersionKey) and the input image type, some input keys might have no effect.
CIFilterMBS.kCIApplyOptionColorSpace as String
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
shared method | CoreImage | MBS MacCI Plugin | 16.0 | ✅ Yes | ❌ No | ❌ No | ✅ Yes | All |
If used, the value of the kCIApplyOptionColorSpace key be must be an RGB CGColorSpaceMBS.
Using this option specifies that the output of the kernel is in this color space.
If not specified, the output of the kernel is in the working color space of the rendering CIContextMBS.
CIFilterMBS.kCIApplyOptionDefinition as String
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
shared method | CoreImage | MBS MacCI Plugin | 7.3 | ✅ Yes | ❌ No | ❌ No | ✅ Yes | All |
CIFilterMBS.kCIApplyOptionExtent as String
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
shared method | CoreImage | MBS MacCI Plugin | 7.3 | ✅ Yes | ❌ No | ❌ No | ✅ Yes | All |
CIFilterMBS.kCIApplyOptionUserInfo as String
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
shared method | CoreImage | MBS MacCI Plugin | 7.3 | ✅ Yes | ❌ No | ❌ No | ✅ Yes | All |
CIFilterMBS.kCIAttributeClass as String
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
shared method | CoreImage | MBS MacCI Plugin | 7.3 | ✅ Yes | ❌ No | ❌ No | ✅ Yes | All |
The class name of the filter.
CIFilterMBS.kCIAttributeDefault as String
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
shared method | CoreImage | MBS MacCI Plugin | 7.3 | ✅ Yes | ❌ No | ❌ No | ✅ Yes | All |
The default value, specified as a floating-point value, for a filter parameter.
CIFilterMBS.kCIAttributeDescription as String
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
shared method | CoreImage | MBS MacCI Plugin | 16.0 | ✅ Yes | ❌ No | ❌ No | ✅ Yes | All |
The localized description of the filter. This description should inform the end user what the filter does and be short enough to display in the user interface for the filter. It is not intended to be technically detailed.
CIFilterMBS.kCIAttributeDisplayName as String
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
shared method | CoreImage | MBS MacCI Plugin | 7.3 | ✅ Yes | ❌ No | ❌ No | ✅ Yes | All |
The localized version of the filter name that is displayed in the user interface.
CIFilterMBS.kCIAttributeFilterAvailable_iOS as String
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
shared method | CoreImage | MBS MacCI Plugin | 16.0 | ✅ Yes | ❌ No | ❌ No | ✅ Yes | All |
The iOS version in which the filter first became available, specified as a string.
CIFilterMBS.kCIAttributeFilterAvailable_Mac as String
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
shared method | CoreImage | MBS MacCI Plugin | 16.0 | ✅ Yes | ❌ No | ❌ No | ✅ Yes | All |
The OS X version in which the filter first became available, specified as a string.
CIFilterMBS.kCIAttributeFilterCategories as String
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
shared method | CoreImage | MBS MacCI Plugin | 7.3 | ✅ Yes | ❌ No | ❌ No | ✅ Yes | All |
An array of filter category keys that specifies all the categories in which the filter is a member.
CIFilterMBS.kCIAttributeFilterDisplayName as String
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
shared method | CoreImage | MBS MacCI Plugin | 7.3 | ✅ Yes | ❌ No | ❌ No | ✅ Yes | All |
The localized display name of the attribute.
CIFilterMBS.kCIAttributeFilterName as String
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
shared method | CoreImage | MBS MacCI Plugin | 7.3 | ✅ Yes | ❌ No | ❌ No | ✅ Yes | All |
CIFilterMBS.kCIAttributeIdentity as String
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
shared method | CoreImage | MBS MacCI Plugin | 7.3 | ✅ Yes | ❌ No | ❌ No | ✅ Yes | All |
If supplied as a value for a parameter, the parameter has no effect on the input image.
CIFilterMBS.kCIAttributeMax as String
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
shared method | CoreImage | MBS MacCI Plugin | 7.3 | ✅ Yes | ❌ No | ❌ No | ✅ Yes | All |
The maximum value for a filter parameter, specified as a floating-point value.
CIFilterMBS.kCIAttributeMin as String
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
shared method | CoreImage | MBS MacCI Plugin | 7.3 | ✅ Yes | ❌ No | ❌ No | ✅ Yes | All |
The minimum value for a filter parameter, specified as a floating-point value.
CIFilterMBS.kCIAttributeName as String
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
shared method | CoreImage | MBS MacCI Plugin | 7.3 | ✅ Yes | ❌ No | ❌ No | ✅ Yes | All |
The name of the attribute.
CIFilterMBS.kCIAttributeReferenceDocumentation as String
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
shared method | CoreImage | MBS MacCI Plugin | 16.0 | ✅ Yes | ❌ No | ❌ No | ✅ Yes | All |
The localized reference documentation for the filter. The reference should provide developers with technical details.
CIFilterMBS.kCIAttributeSliderMax as String
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
shared method | CoreImage | MBS MacCI Plugin | 7.3 | ✅ Yes | ❌ No | ❌ No | ✅ Yes | All |
The maximum value, specified as a floating-point value, to use for a slider that controls input values for a filter parameter.
CIFilterMBS.kCIAttributeSliderMin as String
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
shared method | CoreImage | MBS MacCI Plugin | 7.3 | ✅ Yes | ❌ No | ❌ No | ✅ Yes | All |
The minimum value, specified as a floating-point value, to use for a slider that controls input values for a filter parameter.
CIFilterMBS.kCIAttributeType as string
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
shared method | CoreImage | MBS MacCI Plugin | 7.3 | ✅ Yes | ❌ No | ❌ No | ✅ Yes | All |
An attribute may have a type which defines what kind this attribute type is.
e.g. a number attribute may be a time or a distance.
CIFilterMBS.kCIAttributeTypeAngle as String
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
shared method | CoreImage | MBS MacCI Plugin | 7.3 | ✅ Yes | ❌ No | ❌ No | ✅ Yes | All |
An angle.
CIFilterMBS.kCIAttributeTypeBoolean as String
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
shared method | CoreImage | MBS MacCI Plugin | 7.3 | ✅ Yes | ❌ No | ❌ No | ✅ Yes | All |
A Boolean value.
CIFilterMBS.kCIAttributeTypeColor as String
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
shared method | CoreImage | MBS MacCI Plugin | 16.0 | ✅ Yes | ❌ No | ❌ No | ✅ Yes | All |
A Core Image color (CIColor object) that specifies red, green, and blue component values.
CIFilterMBS.kCIAttributeTypeCount as String
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
shared method | CoreImage | MBS MacCI Plugin | 16.0 | ✅ Yes | ❌ No | ❌ No | ✅ Yes | All |
A positive integer value.
CIFilterMBS.kCIAttributeTypeDistance as String
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
shared method | CoreImage | MBS MacCI Plugin | 7.3 | ✅ Yes | ❌ No | ❌ No | ✅ Yes | All |
A distance.
CIFilterMBS.kCIAttributeTypeGradient as String
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
shared method | CoreImage | MBS MacCI Plugin | 7.3 | ✅ Yes | ❌ No | ❌ No | ✅ Yes | All |
An n-by-1 gradient image used to describe a color ramp.
CIFilterMBS.kCIAttributeTypeImage as String
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
shared method | CoreImage | MBS MacCI Plugin | 16.0 | ✅ Yes | ❌ No | ❌ No | ✅ Yes | All |
A CIImage object.
CIFilterMBS.kCIAttributeTypeInteger as String
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
shared method | CoreImage | MBS MacCI Plugin | 16.0 | ✅ Yes | ❌ No | ❌ No | ✅ Yes | All |
An integer value.
CIFilterMBS.kCIAttributeTypeOffset as String
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
shared method | CoreImage | MBS MacCI Plugin | 7.3 | ✅ Yes | ❌ No | ❌ No | ✅ Yes | All |
An offset. (A 2-element vector type.)
CIFilterMBS.kCIAttributeTypeOpaqueColor as String
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
shared method | CoreImage | MBS MacCI Plugin | 7.3 | ✅ Yes | ❌ No | ❌ No | ✅ Yes | All |
A Core Image color (CIColor object) that specifies red, green, and blue component values. Use this key for colors with no alpha component. If the key is not present, Core Image assumes color with alpha.
CIFilterMBS.kCIAttributeTypePosition as String
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
shared method | CoreImage | MBS MacCI Plugin | 7.3 | ✅ Yes | ❌ No | ❌ No | ✅ Yes | All |
A two-dimensional location in the working coordinate space. (A 2-element vector type.)
CIFilterMBS.kCIAttributeTypePosition3 as String
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
shared method | CoreImage | MBS MacCI Plugin | 7.3 | ✅ Yes | ❌ No | ❌ No | ✅ Yes | All |
A three-dimensional location in the working coordinate space. (A 3-element vector type.)
CIFilterMBS.kCIAttributeTypeRectangle as String
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
shared method | CoreImage | MBS MacCI Plugin | 7.3 | ✅ Yes | ❌ No | ❌ No | ✅ Yes | All |
A Core Image vector that specifies the x and y values of the rectangle origin, and the width (w) and height (h) of the rectangle. The vector takes the form [x, y, w, h]. (A 4-element vector type.)
CIFilterMBS.kCIAttributeTypeScalar as String
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
shared method | CoreImage | MBS MacCI Plugin | 7.3 | ✅ Yes | ❌ No | ❌ No | ✅ Yes | All |
A scalar value.
CIFilterMBS.kCIAttributeTypeTime as String
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
shared method | CoreImage | MBS MacCI Plugin | 7.3 | ✅ Yes | ❌ No | ❌ No | ✅ Yes | All |
A parametric time for transitions, specified as a floating-point value in the range of 0.0 to 1.0.
CIFilterMBS.kCIAttributeTypeTransform as String
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
shared method | CoreImage | MBS MacCI Plugin | 16.0 | ✅ Yes | ❌ No | ❌ No | ✅ Yes | All |
An CGAffineTransform is associated with attribute.
CIFilterMBS.kCICategoryBlur as String
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
shared method | CoreImage | MBS MacCI Plugin | 7.3 | ✅ Yes | ❌ No | ❌ No | ✅ Yes | All |
A filter that softens images, decreasing the contrast between the edges in an image. Examples of blur filters are Gaussian blur and zoom blur.
CIFilterMBS.kCICategoryBuiltIn as String
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
shared method | CoreImage | MBS MacCI Plugin | 7.3 | ✅ Yes | ❌ No | ❌ No | ✅ Yes | All |
A filter provided by Core Image. This distinguishes built-in filters from plug-in filters.
The items on this page are in the following plugins: MBS MacCI Plugin.
