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
Returns an array of filter objects de-serialized from XMP data.

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
Returns an array containing all published filter names that belong to all listed categories.

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
Returns an array containing all published filter names in a category.
Example
// load list of filters into Listbox

Var a() as string
Var 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

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
Creates a new filter object based on the given handle.
Example
// some filter
Var x as new CIFilterCropMBS

// create a copy
Var 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

Type Topic Plugin Version macOS Windows Linux iOS Targets
shared method CoreImage MBS MacCI Plugin 17.4 ✅ Yes ❌ No ❌ No ✅ Yes All
Returns a CIFilter that will in turn return a properly processed CIImage as "outputImage".

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
Returns a CIFilter that will in turn return a properly processed CIImage as "outputImage".

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
Returns a CIFilter that will in turn return a properly processed CIImage as "outputImage".

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
Creates a new filter of type 'name'. All input values will be undefined.
Example
Var cf as CIFilterMBS
// load this filter
cf=CIFilterMBS.FilterWithName("CIAffineTile")

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
Creates a new filter of type 'name'.

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.localizedDescriptionForFilterName(filterName as String) as String

Type Topic Plugin Version macOS Windows Linux iOS Targets
shared method CoreImage MBS MacCI Plugin 13.1 ✅ Yes ❌ No ❌ No ✅ Yes All
Returns the localized description of a filter for display in the user interface.
Example
MsgBox CIFilterMBS.localizedDescriptionForFilterName("CIComicEffect")

filterName: The filter name.
Returns the localized description of the filter.

Available in OS X v10.5 and later.

CIFilterMBS.LocalizedNameForCategory(name 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
The localized name of a category.

CIFilterMBS.LocalizedNameForFilterName(name 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
Returns the localized name of a filter.

CIFilterMBS.localizedReferenceDocumentationForFilterName(filterName as String) as String

Type Topic Plugin Version macOS Windows Linux iOS Targets
shared method CoreImage MBS MacCI Plugin 13.1 ✅ Yes ❌ No ❌ No ✅ Yes All
Returns the location of the localized reference documentation that describes the filter.
Example
MsgBox CIFilterMBS.localizedReferenceDocumentationForFilterName("CIComicEffect")

filterName: The filter name.

Returns an URL that specifies the location of the localized documentation, or "" if the filter does not provide localized reference documentation.

The URL can be a local file or a remote document on a web server. Because filters created prior to OS X v10.5 could return nil, you should be make sure that your code handles this case gracefully.

Available in OS X v10.5 and later.

CIFilterMBS.serializedXMPFromFilters(filters() as CIFilterMBS, extent as CGRectMBS) as Memoryblock

Type Topic Plugin Version macOS Windows Linux iOS Targets
shared method CoreImage MBS MacCI Plugin 14.1 ✅ Yes ❌ No ❌ No ✅ Yes All
Serializes filter parameters into XMP form that is suitable for embedding in an image.

filters: The array of filters to serialize. See Discussion for the filters that can be serialized.
extent: The extent of the input image to the filter.

At this time the only filters classes that can be serialized using this method are, CIAffineTransform, CICrop, and the filters returned by the CIImage methods autoAdjustmentFilters and autoAdjustmentFiltersWithOptions. The parameters of other filter classes will not be serialized.

Available in OS X v10.9 and later.

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


The biggest plugin in space...