PKStroke

randomSeed

get randomSeed(): number

var randomSeed: UInt32 { get set }

The random seed for drawing strokes that use randomized effects.

randomSeed

set randomSeed(value: number)

var randomSeed: UInt32 { get set }

The random seed for drawing strokes that use randomized effects.

renderState

get renderState(): (PKStroke_RenderState) | null

var renderState: PKStroke.RenderState? { get set }

Contains information about the render details (such as particle positioning) of this stroke, which can be useful when manipulating the model in certain ways. For example, this may be set on substrokes returned by `substroke(range:)`. nil uses default rendering.

renderState

set renderState(value: (PKStroke_RenderState) | null)

var renderState: PKStroke.RenderState? { get set }

Contains information about the render details (such as particle positioning) of this stroke, which can be useful when manipulating the model in certain ways. For example, this may be set on substrokes returned by `substroke(range:)`. nil uses default rendering.

renderBounds

get renderBounds(): { x: number; y: number; width: number; height: number }

var renderBounds: CGRect { get }

The bounds of the rendered stroke. This includes the width & ink of the stroke after the transform is applied.

renderGroupID

get renderGroupID(): (string) | null

var renderGroupID: UUID? { get set }

Strokes with certain inks (such as marker) can composite to look as if they were drawn while the previous stroke with the same ink was still wet. This UUID may be set to a single value for a run of strokes which should be rendered together in this manner.

renderGroupID

set renderGroupID(value: (string) | null)

var renderGroupID: UUID? { get set }

Strokes with certain inks (such as marker) can composite to look as if they were drawn while the previous stroke with the same ink was still wet. This UUID may be set to a single value for a run of strokes which should be rendered together in this manner.

maskedPathRanges

get maskedPathRanges(): Array<"animatableData" | SDKHandle>

var maskedPathRanges: [ClosedRange<CGFloat>] { get }

These are the parametric parameter ranges of points in `strokePath` that intersect the stroke's mask.

requiredContentVersion

get requiredContentVersion(): PKContentVersion

var requiredContentVersion: PKContentVersion { get }

The PencilKit version required to use this stroke.

id

get id(): string

var id: UUID { get set }

The unique identity of the stroke.

id

set id(value: string)

var id: UUID { get set }

The unique identity of the stroke.

init

static initInkPathTransformMaskRandomSeedIdRenderGroupIDRenderState(ink: PKInk, path: PKStrokePath, transform?: _CoreFoundation_CGAffineTransform, mask?: (_UIKit_UIBezierPath) | null, randomSeed?: number, id?: string, renderGroupID?: (string) | null, renderState?: (PKStroke_RenderState) | null): PKStroke

init(ink: PKInk, path: PKStrokePath, transform: CGAffineTransform = .identity, mask: UIBezierPath? = nil, randomSeed: UInt32 = UInt32.random(in: 0...UInt32.max), id: UUID = UUID(), renderGroupID: UUID? = nil, renderState: PKStroke.RenderState? = nil)

init

static initInkPathTransformMaskRandomSeed(ink: PKInk, path: PKStrokePath, transform: _CoreFoundation_CGAffineTransform, mask: (_UIKit_UIBezierPath) | null, randomSeed: number): PKStroke

init(ink: PKInk, path: PKStrokePath, transform: CGAffineTransform = .identity, mask: UIBezierPath? = nil, randomSeed: UInt32)

init

static initInkPathTransformMask(ink: PKInk, path: PKStrokePath, transform?: _CoreFoundation_CGAffineTransform, mask?: (_UIKit_UIBezierPath) | null): PKStroke

init(ink: PKInk, path: PKStrokePath, transform: CGAffineTransform = .identity, mask: UIBezierPath? = nil)

ink

get ink(): PKInk

var ink: PKInk { get set }

The ink used to render this stroke.

ink

set ink(value: PKInk)

var ink: PKInk { get set }

The ink used to render this stroke.

mask

get mask(): (_UIKit_UIBezierPath) | null

var mask: UIBezierPath? { get set }

mask

set mask(value: (_UIKit_UIBezierPath) | null)

var mask: UIBezierPath? { get set }

path

get path(): PKStrokePath

var path: PKStrokePath { get set }

The B-spline path data that describes this stroke.

path

set path(value: PKStrokePath)

var path: PKStrokePath { get set }

The B-spline path data that describes this stroke.

substroke

substroke(range: "animatableData" | SDKHandle): PKStroke

func substroke(range: ClosedRange<CGFloat>) -> PKStroke

Returns a copy of this stroke containing the control points in the given range. Maintains information for PencilKit rendering to make the copied part of the stroke render the same as the receiver. The returned stroke may have a `renderState` set to maintain this information. - Parameter range: The range of control points in the receiver to copy to the returned stroke. - Returns: A new stroke containing only the control points within the specified range.

transform

get transform(): _CoreFoundation_CGAffineTransform

var transform: CGAffineTransform { get set }

The affine transform of the stroke when rendered.

transform

set transform(value: _CoreFoundation_CGAffineTransform)

var transform: CGAffineTransform { get set }

The affine transform of the stroke when rendered.