Platforms to show: All Mac Windows Linux Cross-Platform

Back to CIFilterMBS class.

Next items

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

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

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
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

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
dim 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.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
One of the options for image filter initialization.

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
One of the apply options.

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
One of the apply options.

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
One of the apply options.

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
One of the apply options.

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
Class name of the filter.

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
Default value for the slider.

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
One of the filter attributes.

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
Display name of this attribute (localized).

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
One of the filter attributes.

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
One of the filter attributes.

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
Array of filter category names (see below)

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
Name of the filter intended for UI display (eg. localized).

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
The constant for the name of the filter.

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
The identity value for this attribute.

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
Maximum value for the attribute.

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
Minimum value for the attribute.

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
One of the filter attributes.

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
One of the filter attributes.

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
Default value for the slider.

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
Minimum value for the slider.

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
Type of the attribute.

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
One of the types for numbers.

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
One of the types for numbers.

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
One of the attribute data types.

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
One of the attribute data types.

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
One of the types for numbers.

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
One of the types for colors.

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
One of the attribute data types.

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
One of the attribute data types.

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
One of the types for 2-element vectors.

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
One of the types for colors.

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
One of the types for 2-element vectors.

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
One of the types for 3-element vectors.

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
One of the types for 4-element vectors.

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
One of the types for numbers.

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
One of the attribute data types.

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
One of the attribute data types.

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
One of the categories.

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
One of the categories.

A filter provided by Core Image. This distinguishes built-in filters from plug-in filters.

Next items

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


The biggest plugin in space...