Mac Developer Library

Developer

Quartz Framework Reference QCCompositionLayer Class Reference

Options
Deployment Target:

On This Page
Language:

QCCompositionLayer

Inheritance


Conforms To


Import Statement


Swift

import Quartz

Objective-C

@import Quartz;

Availability


Available in OS X v10.5 and later.

The QCCompositionLayer class loads, plays, and controls Quartz Composer compositions in a Core Animation layer hierarchy. The composition tracks the Core Animation layer time and is rendered directly at the current dimensions of the QCCompositionLayer object.

An archived QCCompositionLayer object saves the composition that’s loaded at the time the layer is archived. It detects layer usage and pauses or resumes the composition appropriately. A QCCompositionLayer object starts rendering the composition automatically when the layer is placed in a visible layer hierarchy. The layer stops rendering when it is hidden or removed from the visible layer hierarchy.

You can pass data to the input ports, or retrieve data from the output ports, of the root patch of a composition by accessing the patch attribute of the QCCompositionLayer instance using methods provided by the QCCompositionRenderer protocol.

  • Creates and returns an instance of a composition layer using the Quartz Composer composition in the specified file.

    Declaration

    Objective-C

    + (QCCompositionLayer *)compositionLayerWithFile:(NSString *)path

    Parameters

    path

    A string that specifies the location of a Quartz Composer composition.

    Return Value

    An initialized QCCompositionLayer object or nil if initialization is not successful.

    Import Statement

    Objective-C

    @import Quartz;

    Availability

    Available in OS X v10.5 and later.

  • Creates and returns an instance of a composition layer using the provided Quartz Composer composition.

    Declaration

    Objective-C

    + (QCCompositionLayer *)compositionLayerWithComposition:(QCComposition *)composition

    Parameters

    composition

    The Quartz Composer composition to use as content.

    Return Value

    An initialized QCCompositionLayer object or nil if initialization is not successful.

    Import Statement

    Objective-C

    @import Quartz;

    Availability

    Available in OS X v10.5 and later.

  • Initializes and returns a composition layer using the Quartz Composer composition in the specified file.

    Declaration

    Swift

    init!(file path: String!)

    Objective-C

    - (id)initWithFile:(NSString *)path

    Parameters

    path

    A string that specifies the location of a Quartz Composer composition.

    Return Value

    The initialized QCCompositionLayer object or nil if initialization is not successful.

    Import Statement

    Objective-C

    @import Quartz;

    Swift

    import Quartz

    Availability

    Available in OS X v10.5 and later.

  • Initializes and returns a composition layer using the provided Quartz Composer composition.

    Declaration

    Swift

    init!(composition composition: QCComposition!)

    Objective-C

    - (id)initWithComposition:(QCComposition *)composition

    Parameters

    composition

    The Quartz Composer composition to use as content.

    Return Value

    The initialized QCCompositionLayer object or nil if initialization is not successful.

    Import Statement

    Objective-C

    @import Quartz;

    Swift

    import Quartz

    Availability

    Available in OS X v10.5 and later.

  • Returns the composition associated with the layer.

    Declaration

    Swift

    func composition() -> QCComposition!

    Objective-C

    - (QCComposition *)composition

    Return Value

    The composition object associated with the layer or nil if there is none.

    Import Statement

    Objective-C

    @import Quartz;

    Swift

    import Quartz

    Availability

    Available in OS X v10.5 and later.