• 1
• 2
• 3
• 4
• 5
• 6
• 7
• 8
• 9
• 10
• 11
• 12
• 13
• 14
• 15
• 16
• 17
• 18
• 19
• 20
• 21
• 22
• 23
• 24
• 25
• 26
• 27
• 28
• 29
• 30
• 31
• 32
• 33
• 34
• 35
• 36
• 37
• 38
• 39
• 40
• 41
• 42
• 43
• 44
• 45
• 46
• 47
• 48
• 49
• 50
• 51
• 52
• 53
• 54
• 55
• 56
• 57
• 58
• 59
• 60
• 61
• 62

import type { LINE_CAP, LINE_JOIN } from '@pixi/graphics';

/**
 * Internal, parsed form of painting attributes. If a paint attribute was not defined, it **must** be
 * `null` (not `undefined`).
 *
 * @public
 * @see https://www.w3.org/TR/SVG2/painting.html#Introduction
 */
export interface Paint
{
    /**
     * The interior paint for the shape.
     */
    readonly fill: number | string;

    /**
     * The opacity of the fill.
     */
    readonly opacity: number;

    /**
     * The color of the stroke outline applied on the shape.
     */
    readonly stroke: number | string;

    /**
     * The dash pattern for stroking the shape.
     */
    readonly strokeDashArray: number[];

    /**
     * The distance into the dash pattern at which the stroking is started.
     */
    readonly strokeDashOffset: number;

    /**
     * The line caps applied at the end of the stroke. This is not applied for closed shapes.
     */
    readonly strokeLineCap: LINE_CAP;

    /**
     * The line join applied at the joint to line segments.
     */
    readonly strokeLineJoin: LINE_JOIN;

    /**
     * The maximum miter distance.
     */
    readonly strokeMiterLimit: number;

    /**
     * The width of the stroke outline applied on the shape.
     */
    readonly strokeWidth: number;

    /**
     * Flags when the paint is updated.
     */
    readonly dirtyId: number;
}