@kayelaa/canvas API - v0.2.15
    Preparing search index...

    Interface KaylaLayerProps

    Props accepted by the <Layer> component

    interface KaylaLayerProps {
        key?: string;
        children?: KaylaElement<any> | KaylaElement<any>[];
        ref?: KaylaRef<KaylaRectEntity>;
        exportsRef?: KaylaRef<KaylaExports<any>>;
        name: string;
        z?: number;
        blend?: GlobalCompositeOperation;
        visible?: boolean;
        transform?: KMatrix2D;
        [key: string]: unknown;
    }

    Hierarchy (View Summary)

    Indexable

    • [key: string]: unknown
    Index

    Properties

    key? children? ref? exportsRef? name z? blend? visible? transform?

    Properties

    key?: string
    children?: KaylaElement<any> | KaylaElement<any>[]
    ref?: KaylaRef<KaylaRectEntity>
    exportsRef?: KaylaRef<KaylaExports<any>>
    name: string

    Required. Unique name identifying this layer

    z?: number

    Layer draw order (higher = later / on top)

    blend?: GlobalCompositeOperation

    Canvas blend mode for the whole layer

    visible?: boolean

    Toggle rendering of the entire layer

    transform?: KMatrix2D

    Transformation applied to rendering and input coordinates. Use KMatrix2D to build cameras, zoom views, parallax layers, rotated UI panels, etc.

    Settings

    Member Visibility

    On This Page

    Properties