Mac Developer Library

Developer

QuartzCore Framework Reference CIPlugInRegistration Protocol Reference

Options
Deployment Target:

On This Page
Language:

CIPlugInRegistration

Inheritance


Not Applicable

Conforms To


Not Applicable

Import Statement


Swift

import QuartzCore

Objective-C

@import QuartzCore;

Availability


OS X v10.4 and later

The CIPlugInRegistration protocol defines a method for loading Core Image image units. The principal class of an image unit bundle must support this protocol.

  • load(_:) - load: Required

    Loads and initializes an image unit, performing custom tasks as needed. (required)

    Declaration

    Swift

    func load(_ host: UnsafeMutablePointer<Void>) -> Bool

    Objective-C

    - (BOOL)load:(void *)host

    Parameters

    host

    Reserved for future use.

    Return Value

    Returns true if the image unit is successfully initialized

    Discussion

    The load method is called once by the host to initialize the image unit when the first filter in the image unit is instantiated. The method provides the image unit with an opportunity to perform custom initialization, such as a registration check.

    Import Statement

    Objective-C

    @import QuartzCore;

    Swift

    import QuartzCore

    Availability

    OS X v10.4 and later.