PaperKit · IOS API REFERENCE

FeatureSet

struct · iOS 26.0+ · SDK 27.1

struct FeatureSet

The features PaperKit supports in its UI and data models.

Members (19)

get · iOS 26.0+

contentVersion

TypeScript

get contentVersion(): FeatureSet_ContentVersion

Swift declaration

var contentVersion: FeatureSet.ContentVersion

The PaperKit version the feature set supports.

set · iOS 26.0+

contentVersion

TypeScript

set contentVersion(value: FeatureSet_ContentVersion)

Swift declaration

var contentVersion: FeatureSet.ContentVersion

The PaperKit version the feature set supports.

get · iOS 26.0+

lineMarkerPositions

TypeScript

get lineMarkerPositions(): FeatureSet_LineMarkerPositions

Swift declaration

var lineMarkerPositions: FeatureSet.LineMarkerPositions

The allowed ends of line for arrows. Default is `.all`.

set · iOS 26.0+

lineMarkerPositions

TypeScript

set lineMarkerPositions(value: FeatureSet_LineMarkerPositions)

Swift declaration

var lineMarkerPositions: FeatureSet.LineMarkerPositions

The allowed ends of line for arrows. Default is `.all`.

get · iOS 26.0+

colorMaximumLinearExposure

TypeScript

get colorMaximumLinearExposure(): number

Swift declaration

var colorMaximumLinearExposure: CGFloat

The maximum exposure to allow for choosing colors. Default is 1.0, which is SDR.

set · iOS 26.0+

colorMaximumLinearExposure

TypeScript

set colorMaximumLinearExposure(value: number)

Swift declaration

var colorMaximumLinearExposure: CGFloat

The maximum exposure to allow for choosing colors. Default is 1.0, which is SDR.

get · iOS 26.0+

inks

TypeScript

get inks(): Array<_PencilKit_PKInkingTool_InkType>

Swift declaration

var inks: Set<PKInkingTool.InkType>

The supported ink types. Defaults to all inks.

set · iOS 26.0+

inks

TypeScript

set inks(value: Array<_PencilKit_PKInkingTool_InkType>)

Swift declaration

var inks: Set<PKInkingTool.InkType>

The supported ink types. Defaults to all inks.

get · iOS 26.0+

empty

TypeScript

static get empty(): FeatureSet

Swift declaration

static var empty: FeatureSet { get }

A maximally empty feature set.

method · iOS 26.0+

insert

TypeScript

insert(newFeature: FeatureSet_Feature): void

Swift declaration

mutating func insert(_ newFeature: FeatureSet.Feature)

Inserts the given feature in the set if it is not already present. - Parameter newFeature: A feature to insert into the set.

get · iOS 26.0+

latest

TypeScript

static get latest(): FeatureSet

Swift declaration

static var latest: FeatureSet { get }

A new feature set supporting all features. To automatically get the latest features that PaperKit adds in new releases use `.latest`, to avoid new releases adding unexpected functionality to your app use a specific version like `.version1`.

method · iOS 26.0+

remove

TypeScript

remove(feature: FeatureSet_Feature): void

Swift declaration

mutating func remove(_ feature: FeatureSet.Feature)

Removes the given feature. - Parameter feature: The feature to remove from the set.

get · iOS 26.0+

shapes

TypeScript

get shapes(): Array<ShapeConfiguration_Shape>

Swift declaration

var shapes: Set<ShapeConfiguration.Shape>

The supported shape types. Default is all shapes. Set to an empty set to disable all shapes.

set · iOS 26.0+

shapes

TypeScript

set shapes(value: Array<ShapeConfiguration_Shape>)

Swift declaration

var shapes: Set<ShapeConfiguration.Shape>

The supported shape types. Default is all shapes. Set to an empty set to disable all shapes.

method · iOS 26.0+

contains

TypeScript

contains(feature: FeatureSet_Feature): boolean

Swift declaration

func contains(_ feature: FeatureSet.Feature) -> Bool

Returns a Boolean value that indicates whether the given feature exists in the set. - Parameter feature: A feature to look for in the set. - Returns: `true` if member exists in the set; otherwise, `false`.

get · iOS 26.0+

features

TypeScript

get features(): Array<FeatureSet_Feature>

Swift declaration

var features: Set<FeatureSet.Feature>

The supported features. Default is all features.

set · iOS 26.0+

features

TypeScript

set features(value: Array<FeatureSet_Feature>)

Swift declaration

var features: Set<FeatureSet.Feature>

The supported features. Default is all features.

method · iOS 26.0+

isSubset

TypeScript

isSubset(other: FeatureSet): boolean

Swift declaration

func isSubset(of other: FeatureSet) -> Bool

Returns a Boolean value that indicates whether this feature set is a subset of the given feature set. - Parameter other: Another feature set. - Returns: `true` if the feature set is a subset of `other`; otherwise, `false`.

get · iOS 26.0+

version1

TypeScript

static get version1(): FeatureSet

Swift declaration

static var version1: FeatureSet { get }

A new feature set supporting all features in version 1. To automatically get the latest features that PaperKit adds in new releases use `.latest`, to avoid new releases adding unexpected functionality to your app use a specific version like `.version1`.

Skipped declarations

No declarations were skipped in this snapshot.

All PaperKit types →