Xojo Developer Conference
25/27th April 2018 in Denver.
MBS Xojo Conference
6/7th September 2018 in Munich, Germany.

Platforms to show: All Mac Windows Linux Cross-Platform

CIFilterGeneratorMBS.connectObject(sourceObject as Variant, sourceKey as string, targetObject as Variant, targetKey as String)
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
method CoreImage MBS MacCG Plugin 17.2 Yes No No Yes, macOS only No
Function: Adds an object to the filter chain.
Notes:
sourceObject: A CIFilterMBS object, a CIImageMBS object, or a the path (an string or folderitem object) to an image.
sourceKey: The key that specifies the source object. For example, if the source is the output image of a filter, pass the outputImage key. Pass nil if the source object is used directly.
targetObject: The object that to link the source object to.
targetKey: The key that specifies the target for the source. For example, if you are connecting the source to the input image of a CIFilterMBS object, you would pass the inputImage key.

Feedback, Comments & Corrections

CIFilterGeneratorMBS.Constructor
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
method CoreImage MBS MacCG Plugin 17.2 Yes No No Yes, macOS only No
Function: Creates and returns an empty filter generator object.
Notes: You use the returned object to connect two or more CIFilter objects and input images. It is also valid to have only one CIFilter object in a filter generator.

See also:

Feedback, Comments & Corrections

CIFilterGeneratorMBS.Constructor(File as folderItem)
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
method CoreImage MBS MacCG Plugin 17.2 Yes No No Yes, macOS only No
Function: Creates and returns a filter generator object and initializes it with the contents of a filter generator file.
Notes: Raises exception on failure.

See also:

Feedback, Comments & Corrections

CIFilterGeneratorMBS.Constructor(Handle as Integer)
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
method CoreImage MBS MacCG Plugin 17.2 Yes No No Yes, macOS only No
Function: Initializes Xojo object with given handle to CIFilterGenerator object.

See also:

Feedback, Comments & Corrections

CIFilterGeneratorMBS.Constructor(URL as string)
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
method CoreImage MBS MacCG Plugin 17.2 Yes No No Yes, macOS only No
Function: Creates and returns a filter generator object and initializes it with the contents of a filter generator file.
Notes: Raises exception on failure.

See also:

Feedback, Comments & Corrections

CIFilterGeneratorMBS.copy as CIFilterGeneratorMBS
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
method CoreImage MBS MacCG Plugin 17.2 Yes No No Yes, macOS only No
Function: Creates a copy of the object.

Feedback, Comments & Corrections

CIFilterGeneratorMBS.disconnectObject(sourceObject as Variant, sourceKey as string, targetObject as Variant, targetKey as String)
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
method CoreImage MBS MacCG Plugin 17.2 Yes No No Yes, macOS only No
Function: Removes the connection between two objects in the filter chain.
Notes:
sourceObject: A CIFilterMBS object, a CIImageMBS object, or a the path (an string or folderitem object) to an image.
sourceKey: The key that specifies the source object. Pass nil if the source object is used directly.
targetObject: The object that you want to disconnect the source object from.
targetKey: The key that specifies the target that the source object is currently connected to.

Feedback, Comments & Corrections

CIFilterGeneratorMBS.exportKey(key as string, targetObject as Variant, exportedKeyName as String)
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
method CoreImage MBS MacCG Plugin 17.2 Yes No No Yes, macOS only No
Function: Exports an input or output key of an object in the filter chain.
Notes:
key: The key to export from the target object (for example, inputImage).
targetObject: The object associated with the key (for example, the filter).
exportedKeyName: A unique name to use for the exported key. Pass "" to use the original key name.

When you create a CIFilterMBS object from a CIFilterGeneratorMBS object, you might want the filter client to be able to set some of the parameters associated with the filter chain. You can make a parameter settable by exporting the key associated with the parameter. If the exported key represents an input parameter of the filter, the key is exported as an input key. If the key represents an output parameter, it is exported as an output key.

Feedback, Comments & Corrections

CIFilterGeneratorMBS.filterWithName(name as String) as CIFilterMBS
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
method CoreImage MBS MacCG Plugin 17.4 Yes No No Yes, macOS only No
Function: Queries filter based on it's name.
Notes: Returns nil in case of error.

Feedback, Comments & Corrections

CIFilterGeneratorMBS.registerFilterName(name as string)
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
method CoreImage MBS MacCG Plugin 17.2 Yes No No Yes, macOS only No
Function: Registers the name associated with a filter chain.
Notes:
name: A unique name for the filter chain you want to register.

This method allows you to register the filter chain as a named filter in the Core Image filter repository. You can then create a CIFilterMBS object from it using the the filterWithName method of the CIFilterMBS class.

Feedback, Comments & Corrections

CIFilterGeneratorMBS.removeExportedKey(exportedKeyName as string)
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
method CoreImage MBS MacCG Plugin 17.2 Yes No No Yes, macOS only No
Function: Removes a key that was previously exported.

Feedback, Comments & Corrections

CIFilterGeneratorMBS.setAttributes(attributes as dictionary, ExportedKey as string)
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
method CoreImage MBS MacCG Plugin 17.2 Yes No No Yes, macOS only No
Function: Sets a dictionary of attributes for an exported key.
Notes:
attributes: A dictionary that describes the attributes associated with the specified key.
key: The exported key whose attributes you want to set.

By default, the exported key inherits the attributes from its original key and target object. You can use this method to change one or more of the existing attributes for the key, such as the default value or maximum value. For more information on attributes, see CIFilterMBS and Core Image Programming Guide.

Feedback, Comments & Corrections

CIFilterGeneratorMBS.writeToFile(File as Folderitem, atomically as Boolean = true) as Boolean
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
method CoreImage MBS MacCG Plugin 17.2 Yes No No Yes, macOS only No
Function: Archives a filter generator object to a filter generator file.
Notes:
File: A location for the file generator file.
atomically: Pass true to specify that Core Image should create an interim file to avoid overwriting an existing file.

Returns true if the the object is successfully archived to the file.
Use this method to save your filter chain to a file for later use.

Feedback, Comments & Corrections

CIFilterGeneratorMBS.writeToURL(URL as String, atomically as Boolean = true) as Boolean
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
method CoreImage MBS MacCG Plugin 17.2 Yes No No Yes, macOS only No
Function: Archives a filter generator object to a filter generator file.
Notes:
URL: A location for the file generator file.
atomically: Pass true to specify that Core Image should create an interim file to avoid overwriting an existing file.

Returns true if the the object is successfully archived to the file.
Use this method to save your filter chain to a file for later use.

Feedback, Comments & Corrections

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




Links
MBS Xojo Plugins