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()
Function:
Returns an array of filter objects de-serialized from XMP data.
Notes:
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.
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
shared method | CoreImage | MBS MacCI Plugin | 14.1 | ✅ Yes | ❌ No | ❌ No | ✅ Yes | All |
Notes:
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()
Function:
Returns an array containing all published filter names that belong to all listed categories.
Notes:
categories: string array with the constants kCICategory*.
Returns nil on any error.
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
shared method | CoreImage | MBS MacCI Plugin | 7.3 | ✅ Yes | ❌ No | ❌ No | ✅ Yes | All |
Notes:
categories: string array with the constants kCICategory*.
Returns nil on any error.
CIFilterMBS.FilterNamesInCategory(category as String) as string()
Function:
Returns an array containing all published filter names in a category.
Example:
Notes:
nil on any error.
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
shared method | CoreImage | MBS MacCI Plugin | 7.3 | ✅ Yes | ❌ No | ❌ No | ✅ Yes | All |
Example:
// load list of filters into Listbox
dim a() as string
dim cf as CIFilterMBS
// get all image categories
a=ciFilterMBS.FilterNamesInCategory(CIFilterMBS.kCICategoryStillImage)
StaticText1.text=str(UBound(a))+" filters."
for each s as string in a
// add to listbox
Listbox1.AddRow s
// load this filter
cf=CIFilterMBS.FilterWithName(s)
// And look into the attributes for the Displayname
if cf<>nil then
Listbox1.cell(Listbox1.LastIndex,1)=cf.DisplayName
end if
next
Some examples using this method:
CIFilterMBS.FilterWithHandle(handle as Integer) as CIFilterMBS
Function:
Creates a new filter object based on the given handle.
Example:
Notes:
The object is retained.
Returns nil on error.
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
shared method | CoreImage | MBS MacCI Plugin | 10.4 | ✅ Yes | ❌ No | ❌ No | ✅ Yes | All |
Example:
// some filter
dim x as new CIFilterCropMBS
// create a copy
dim f as CIFilterMBS = CIFilterMBS.FilterWithHandle(x.Handle)
// and show name
MsgBox f.FilterName
The object is retained.
Returns nil on error.
CIFilterMBS.filterWithImageData(Data as MemoryBlock, options as Dictionary) as CIFilterMBS
Function:
Returns a CIFilter that will in turn return a properly processed CIImage as "outputImage".
Notes: 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.
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
shared method | CoreImage | MBS MacCI Plugin | 17.4 | ✅ Yes | ❌ No | ❌ No | ✅ Yes | All |
Notes: 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
Function:
Returns a CIFilter that will in turn return a properly processed CIImage as "outputImage".
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
Function:
Returns a CIFilter that will in turn return a properly processed CIImage as "outputImage".
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
Function:
Creates a new filter of type 'name'. All input values will be undefined.
Example:
Notes:
Returns filter object for the name if found.
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
shared method | CoreImage | MBS MacCI Plugin | 7.3 | ✅ Yes | ❌ No | ❌ No | ✅ Yes | All |
Example:
dim cf as CIFilterMBS
// load this filter
cf=CIFilterMBS.FilterWithName("CIAffineTile")
See also:
CIFilterMBS.FilterWithName(name as String, options as Dictionary) as CIFilterMBS
Function:
Creates a new filter of type 'name'.
Notes:
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.
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
shared method | CoreImage | MBS MacCI Plugin | 17.4 | ✅ Yes | ❌ No | ❌ No | ✅ Yes | All |
Notes:
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
Function:
One of the options for image filter initialization.
Notes:
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.
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
shared method | CoreImage | MBS MacCI Plugin | 17.4 | ✅ Yes | ❌ No | ❌ No | ✅ Yes | All |
Notes:
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
Function:
One of the apply options.
Notes:
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.
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
shared method | CoreImage | MBS MacCI Plugin | 16.0 | ✅ Yes | ❌ No | ❌ No | ✅ Yes | All |
Notes:
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
Function:
One of the apply options.
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
Function:
One of the apply options.
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
Function:
One of the apply options.
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
Function:
Class name of the filter.
Notes: The class name of the filter.
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
shared method | CoreImage | MBS MacCI Plugin | 7.3 | ✅ Yes | ❌ No | ❌ No | ✅ Yes | All |
Notes: The class name of the filter.
CIFilterMBS.kCIAttributeDefault as String
Function:
Default value for the slider.
Notes: The default value, specified as a floating-point value, for a filter parameter.
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
shared method | CoreImage | MBS MacCI Plugin | 7.3 | ✅ Yes | ❌ No | ❌ No | ✅ Yes | All |
Notes: The default value, specified as a floating-point value, for a filter parameter.
CIFilterMBS.kCIAttributeDescription as String
Function:
One of the filter attributes.
Notes: 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.
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
shared method | CoreImage | MBS MacCI Plugin | 16.0 | ✅ Yes | ❌ No | ❌ No | ✅ Yes | All |
Notes: 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
Function:
Display name of this attribute (localized).
Notes: The localized version of the filter name that is displayed in the user interface.
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
shared method | CoreImage | MBS MacCI Plugin | 7.3 | ✅ Yes | ❌ No | ❌ No | ✅ Yes | All |
Notes: The localized version of the filter name that is displayed in the user interface.
CIFilterMBS.kCIAttributeFilterAvailable_iOS as String
Function:
One of the filter attributes.
Notes: The iOS version in which the filter first became available, specified as a string.
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
shared method | CoreImage | MBS MacCI Plugin | 16.0 | ✅ Yes | ❌ No | ❌ No | ✅ Yes | All |
Notes: The iOS version in which the filter first became available, specified as a string.
CIFilterMBS.kCIAttributeFilterAvailable_Mac as String
Function:
One of the filter attributes.
Notes: The OS X version in which the filter first became available, specified as a string.
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
shared method | CoreImage | MBS MacCI Plugin | 16.0 | ✅ Yes | ❌ No | ❌ No | ✅ Yes | All |
Notes: The OS X version in which the filter first became available, specified as a string.
CIFilterMBS.kCIAttributeFilterCategories as String
Function:
Array of filter category names (see below)
Notes: An array of filter category keys that specifies all the categories in which the filter is a member.
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
shared method | CoreImage | MBS MacCI Plugin | 7.3 | ✅ Yes | ❌ No | ❌ No | ✅ Yes | All |
Notes: An array of filter category keys that specifies all the categories in which the filter is a member.
CIFilterMBS.kCIAttributeFilterDisplayName as String
Function:
Name of the filter intended for UI display (eg. localized).
Notes: The localized display name of the attribute.
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
shared method | CoreImage | MBS MacCI Plugin | 7.3 | ✅ Yes | ❌ No | ❌ No | ✅ Yes | All |
Notes: The localized display name of the attribute.
CIFilterMBS.kCIAttributeFilterName as String
Function:
The constant for the name of the filter.
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
Function:
The identity value for this attribute.
Notes: If supplied as a value for a parameter, the parameter has no effect on the input image.
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
shared method | CoreImage | MBS MacCI Plugin | 7.3 | ✅ Yes | ❌ No | ❌ No | ✅ Yes | All |
Notes: If supplied as a value for a parameter, the parameter has no effect on the input image.
CIFilterMBS.kCIAttributeMax as String
Function:
Maximum value for the attribute.
Notes: The maximum value for a filter parameter, specified as a floating-point value.
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
shared method | CoreImage | MBS MacCI Plugin | 7.3 | ✅ Yes | ❌ No | ❌ No | ✅ Yes | All |
Notes: The maximum value for a filter parameter, specified as a floating-point value.
CIFilterMBS.kCIAttributeMin as String
Function:
Minimum value for the attribute.
Notes: The minimum value for a filter parameter, specified as a floating-point value.
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
shared method | CoreImage | MBS MacCI Plugin | 7.3 | ✅ Yes | ❌ No | ❌ No | ✅ Yes | All |
Notes: The minimum value for a filter parameter, specified as a floating-point value.
CIFilterMBS.kCIAttributeName as String
Function:
One of the filter attributes.
Notes: The name of the attribute.
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
shared method | CoreImage | MBS MacCI Plugin | 7.3 | ✅ Yes | ❌ No | ❌ No | ✅ Yes | All |
Notes: The name of the attribute.
CIFilterMBS.kCIAttributeReferenceDocumentation as String
Function:
One of the filter attributes.
Notes: The localized reference documentation for the filter. The reference should provide developers with technical details.
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
shared method | CoreImage | MBS MacCI Plugin | 16.0 | ✅ Yes | ❌ No | ❌ No | ✅ Yes | All |
Notes: The localized reference documentation for the filter. The reference should provide developers with technical details.
CIFilterMBS.kCIAttributeSliderMax as String
Function:
Default value for the slider.
Notes: The maximum value, specified as a floating-point value, to use for a slider that controls input values for a filter parameter.
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
shared method | CoreImage | MBS MacCI Plugin | 7.3 | ✅ Yes | ❌ No | ❌ No | ✅ Yes | All |
Notes: The maximum value, specified as a floating-point value, to use for a slider that controls input values for a filter parameter.
The items on this page are in the following plugins: MBS MacCI Plugin.
