PencilKit · IOS API REFERENCE

PKInkingTool.InkType

enum · iOS 13.0+ · SDK 27.1

enum InkType

The type of ink mark that will be made.

Members (5)

get · iOS 13.0+

defaultWidth

TypeScript

getDefaultWidth($self: PKInkingTool_InkType): number

Swift declaration

var defaultWidth: CGFloat { get }

The default width for an ink type.

get · iOS 13.0+

validWidthRange

TypeScript

getValidWidthRange($self: PKInkingTool_InkType): "animatableData" | SDKHandle

Swift declaration

var validWidthRange: ClosedRange<CGFloat> { get }

The valid width range for an ink type.

get · iOS 17.0+

requiredContentVersion

TypeScript

getRequiredContentVersion($self: PKInkingTool_InkType): PKContentVersion

Swift declaration

var requiredContentVersion: PKContentVersion { get }

The PencilKit version required to use this ink type.

init · iOS 13.0+

init

TypeScript

init(rawValue: string): (PKInkingTool_InkType) | null

Swift declaration

init?(rawValue: String)

Creates a new instance with the specified raw value. If there is no value of the type that corresponds with the specified raw value, this initializer returns `nil`. For example: enum PaperSize: String { case A4, A5, Letter, Legal } print(PaperSize(rawValue: "Legal")) // Prints "Optional(PaperSize.Legal)" print(PaperSize(rawValue: "Tabloid")) // Prints "nil" - Parameter rawValue: The raw value to use for the new instance.

get · iOS 13.0+

rawValue

TypeScript

getRawValue($self: PKInkingTool_InkType): string

Swift declaration

var rawValue: String { get }

The corresponding value of the raw type. A new instance initialized with `rawValue` will be equivalent to this instance. For example: enum PaperSize: String { case A4, A5, Letter, Legal } let selectedSize = PaperSize.Letter print(selectedSize.rawValue) // Prints "Letter" print(selectedSize == PaperSize(rawValue: selectedSize.rawValue)!) // Prints "true"

Skipped declarations

No declarations were skipped in this snapshot.

All PencilKit types →