SwiftUICore · IOS API REFERENCE

GraphicsContext.GradientOptions

struct · iOS 15.0+ · SDK 27.1

@frozen struct GradientOptions

Options that affect the rendering of color gradients. Use these options to affect how SwiftUI manages a gradient that you create for a ``Shading`` instance for use in a ``GraphicsContext``.

Members (5)

get · iOS 15.0+

linearColor

TypeScript

get linearColor(): GraphicsContext_GradientOptions

Swift declaration

static var linearColor: GraphicsContext.GradientOptions { get }

An option that interpolates between colors in a linear color space.

get · iOS 15.0+

mirror

TypeScript

get mirror(): GraphicsContext_GradientOptions

Swift declaration

static var mirror: GraphicsContext.GradientOptions { get }

An option that repeats the gradient outside its nominal range, reflecting every other instance. Use this option to cause the gradient to repeat its pattern in areas that exceed the bounds of its start and end points. The repetitions alternately reverse the start and end points, producing a pattern like `0 -> 1`, `1 -> 0`, `0 -> 1`, and so on. Without either this option or ``repeat``, the gradient stops at the end of its range. This option takes precendence if you set both this one and ``repeat``.

get · iOS 15.0+

repeat

TypeScript

get repeat(): GraphicsContext_GradientOptions

Swift declaration

static var `repeat`: GraphicsContext.GradientOptions { get }

An option that repeats the gradient outside its nominal range. Use this option to cause the gradient to repeat its pattern in areas that exceed the bounds of its start and end points. The repetitions use the same start and end value for each repetition. Without this option or ``mirror``, the gradient stops at the end of its range. The ``mirror`` option takes precendence if you set both this one and that one.

init · iOS 15.0+

init

TypeScript

init(rawValue: number): GraphicsContext_GradientOptions

Swift declaration

init(rawValue: UInt32)

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 15.0+

rawValue

TypeScript

getRawValue($self: GraphicsContext_GradientOptions): number

Swift declaration

let rawValue: UInt32

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