One Logo Pool Ball
ComputeGraph · IOS API REFERENCE

ComputeNodeGraph.Port.Options

struct · iOS 27.0+ · SDK 27.1

struct Options

Flags that modify how a port's value is treated during compilation and execution.

Members (9)

get

description

TypeScript
getDescription($self: ComputeNodeGraph_Port_Options): string
Swift declaration
var description: String { get }

A textual representation of this instance. Calling this property directly is discouraged. Instead, convert an instance of any type to a string by using the `String(describing:)` initializer. This initializer works with any type, and uses the custom `description` property for types that conform to `CustomStringConvertible`: struct Point: CustomStringConvertible { let x: Int, y: Int var description: String { return "(\(x), \(y))" } } let p = Point(x: 21, y: 30) let s = String(describing: p) print(s) // Prints "(21, 30)" The conversion of `p` to a string in the assignment to `s` uses the `Point` type's `description` property.

get

debugDescription

TypeScript
getDebugDescription($self: ComputeNodeGraph_Port_Options): string
Swift declaration
var debugDescription: String { get }

A textual representation of this instance, suitable for debugging. Calling this property directly is discouraged. Instead, convert an instance of any type to a string by using the `String(reflecting:)` initializer. This initializer works with any type, and uses the custom `debugDescription` property for types that conform to `CustomDebugStringConvertible`: struct Point: CustomDebugStringConvertible { let x: Int, y: Int var debugDescription: String { return "(\(x), \(y))" } } let p = Point(x: 21, y: 30) let s = String(reflecting: p) print(s) // Prints "(21, 30)" The conversion of `p` to a string in the assignment to `s` uses the `Point` type's `debugDescription` property.

get · iOS 27.0+

externalReference

TypeScript
get externalReference(): ComputeNodeGraph_Port_Options
Swift declaration
static let externalReference: ComputeNodeGraph.Port.Options

The port references a value outside of the graph, such as by filename

get · iOS 27.0+

compile

TypeScript
get compile(): ComputeNodeGraph_Port_Options
Swift declaration
static let compile: ComputeNodeGraph.Port.Options

Port affects compilation. Changes to ``compile`` values require recompiling the pipeline

get · iOS 27.0+

argument

TypeScript
get argument(): ComputeNodeGraph_Port_Options
Swift declaration
static let argument: ComputeNodeGraph.Port.Options

Port is an argument to a runtime function. These correspond to a function parameter.

get · iOS 27.0+

constant

TypeScript
get constant(): ComputeNodeGraph_Port_Options
Swift declaration
static let constant: ComputeNodeGraph.Port.Options

Port is constant and doesn't need to be changeable. Parameters with ``constant`` that are available at compile time can aid in optimization.

get · iOS 27.0+

optional

TypeScript
get optional(): ComputeNodeGraph_Port_Options
Swift declaration
static let optional: ComputeNodeGraph.Port.Options

The value of this port is optional (may be nil)

init · iOS 27.0+

init

TypeScript
init(rawValue: number): ComputeNodeGraph_Port_Options
Swift declaration
init(rawValue: UInt)

Creates a new option set from the given raw value. This initializer always succeeds, even if the value passed as `rawValue` exceeds the static properties declared as part of the option set. This example creates an instance of `ShippingOptions` with a raw value beyond the highest element, with a bit mask that effectively contains all the declared static members. let extraOptions = ShippingOptions(rawValue: 255) print(extraOptions.isStrictSuperset(of: .all)) // Prints "true" - Parameter rawValue: The raw value of the option set to create. Each bit of `rawValue` potentially represents an element of the option set, though raw values may include bits that are not defined as distinct values of the `OptionSet` type.

get · iOS 27.0+

rawValue

TypeScript
getRawValue($self: ComputeNodeGraph_Port_Options): number
Swift declaration
let rawValue: UInt

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 ComputeGraph types →