struct · iOS 15.0+ · SDK 27.1
@frozen struct BlendModeThe ways that a graphics context combines new content with background content. Use one of these values to set the ``GraphicsContext/blendMode-swift.property`` property of a ``GraphicsContext``. The value that you set affects how content that you draw replaces or combines with content that you previously drew into the context.
get colorDodge(): GraphicsContext_BlendModestatic var colorDodge: GraphicsContext.BlendMode { get }A mode that brightens the background image samples to reflect the source image samples. Source image sample values that specify black do not produce a change.
get difference(): GraphicsContext_BlendModestatic var difference: GraphicsContext.BlendMode { get }A mode that subtracts the brighter of the source image sample color or the background image sample color from the other. Source image sample values that are black produce no change; white inverts the background color values.
get luminosity(): GraphicsContext_BlendModestatic var luminosity: GraphicsContext.BlendMode { get }A mode that uses the hue and saturation of the background with the luminance of the source image. This mode creates an effect that is inverse to the effect created by the ``color`` mode.
get plusDarker(): GraphicsContext_BlendModestatic var plusDarker: GraphicsContext.BlendMode { get }A mode that adds the inverse of the color components of the source and background images, and then inverts the result, producing a darkened composite. This mode implements the equation `R = MAX(0, 1 - ((1 - D) + (1 - S)))` where * `R` is the composite image. * `S` is the source image. * `D` is the background.
get saturation(): GraphicsContext_BlendModestatic var saturation: GraphicsContext.BlendMode { get }A mode that uses the luminance and hue values of the background with the saturation of the source image. Areas of the background that have no saturation --- namely, pure gray areas --- don't produce a change.
get sourceAtop(): GraphicsContext_BlendModestatic var sourceAtop: GraphicsContext.BlendMode { get }A mode that you use to paint the opaque parts of the source image onto the opaque parts of the background. This mode implements the equation `R = S*Da + D*(1 - Sa)` where * `R` is the composite image. * `S` is the source image. * `D` is the background. * `Sa` is the source image's alpha value. * `Da` is the source background's alpha value.
get plusLighter(): GraphicsContext_BlendModestatic var plusLighter: GraphicsContext.BlendMode { get }A mode that adds the components of the source and background images, resulting in a lightened composite. This mode implements the equation `R = MIN(1, S + D)` where * `R` is the composite image. * `S` is the source image. * `D` is the background.
get destinationIn(): GraphicsContext_BlendModestatic var destinationIn: GraphicsContext.BlendMode { get }A mode that you use to erase any of the background that isn't covered by opaque source pixels. This mode implements the equation `R = D*Sa` where * `R` is the composite image. * `S` is the source image. * `Da` is the source background's alpha value.
get destinationOut(): GraphicsContext_BlendModestatic var destinationOut: GraphicsContext.BlendMode { get }A mode that you use to erase any of the background that is covered by opaque source pixels. This mode implements the equation `R = D*(1 - Sa)` where * `R` is the composite image. * `D` is the background. * `Sa` is the source image's alpha value.
get destinationAtop(): GraphicsContext_BlendModestatic var destinationAtop: GraphicsContext.BlendMode { get }A mode that you use to paint the source image under the background, while erasing any of the background not matched by opaque pixels from the source image. This mode implements the equation `R = S*(1 - Da) + D*Sa` where * `R` is the composite image. * `S` is the source image. * `D` is the background. * `Sa` is the source image's alpha value. * `Da` is the source background's alpha value.
get destinationOver(): GraphicsContext_BlendModestatic var destinationOver: GraphicsContext.BlendMode { get }A mode that you use to paint the source image under the background. This mode implements the equation `R = S*(1 - Da) + D` where * `R` is the composite image. * `S` is the source image. * `D` is the background. * `Da` is the source background's alpha value.
get hue(): GraphicsContext_BlendModestatic var hue: GraphicsContext.BlendMode { get }A mode that uses the luminance and saturation values of the background with the hue of the source image.
get xor(): GraphicsContext_BlendModestatic var xor: GraphicsContext.BlendMode { get }A mode that you use to clear pixels where both the source and background images are opaque. This mode implements the equation `R = S*(1 - Da) + D*(1 - Sa)` where * `R` is the composite image. * `S` is the source image. * `D` is the background. * `Sa` is the source image's alpha value. * `Da` is the source background's alpha value. This XOR mode is only nominally related to the classical bitmap XOR operation, which SwiftUI doesn't support.
get copy(): GraphicsContext_BlendModestatic var copy: GraphicsContext.BlendMode { get }A mode that replaces background image samples with source image samples. Unlike the ``normal`` mode, the source image completely replaces the background, so that even transparent pixels in the source image replace opaque pixels in the background, rather than letting the background show through. This mode implements the equation `R = S` where * `R` is the composite image. * `S` is the source image.
get clear(): GraphicsContext_BlendModestatic var clear: GraphicsContext.BlendMode { get }A mode that clears any pixels that the source image overwrites. With this mode, you can use the source image like an eraser. This mode implements the equation `R = 0` where `R` is the composite image.
get color(): GraphicsContext_BlendModestatic var color: GraphicsContext.BlendMode { get }A mode that uses the luminance values of the background with the hue and saturation values of the source image. This mode preserves the gray levels in the image. You can use this mode to color monochrome images or to tint color images.
get darken(): GraphicsContext_BlendModestatic var darken: GraphicsContext.BlendMode { get }A mode that creates composite image samples by choosing the darker samples from either the source image or the background. When you draw in this mode, source image samples that are darker than the background replace the background. Otherwise, the background image samples remain unchanged.
get normal(): GraphicsContext_BlendModestatic var normal: GraphicsContext.BlendMode { get }A mode that paints source image samples over the background image samples. This is the default blend mode.
get screen(): GraphicsContext_BlendModestatic var screen: GraphicsContext.BlendMode { get }A mode that multiplies the inverse of the source image samples with the inverse of the background image samples. Drawing in this mode results in colors that are at least as light as either of the two contributing sample colors.
get lighten(): GraphicsContext_BlendModestatic var lighten: GraphicsContext.BlendMode { get }A mode that creates composite image samples by choosing the lighter samples from either the source image or the background. When you draw in this mode, source image samples that are lighter than the background replace the background. Otherwise, the background image samples remain unchanged.
get overlay(): GraphicsContext_BlendModestatic var overlay: GraphicsContext.BlendMode { get }A mode that either multiplies or screens the source image samples with the background image samples, depending on the background color. Drawing in this mode overlays the existing image samples while preserving the highlights and shadows of the background. The background color mixes with the source image to reflect the lightness or darkness of the background.
get multiply(): GraphicsContext_BlendModestatic var multiply: GraphicsContext.BlendMode { get }A mode that multiplies the source image samples with the background image samples. Drawing in this mode results in colors that are at least as dark as either of the two contributing sample colors.
init(rawValue: number): GraphicsContext_BlendModeinit(rawValue: Int32)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.
getRawValue($self: GraphicsContext_BlendMode): numberlet rawValue: Int32The 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"
get sourceIn(): GraphicsContext_BlendModestatic var sourceIn: GraphicsContext.BlendMode { get }A mode that you use to paint the source image, including its transparency, onto the opaque parts of the background. This mode implements the equation `R = S*Da` where * `R` is the composite image. * `S` is the source image. * `Da` is the source background's alpha value.
get colorBurn(): GraphicsContext_BlendModestatic var colorBurn: GraphicsContext.BlendMode { get }A mode that darkens background image samples to reflect the source image samples. Source image sample values that specify white do not produce a change.
get exclusion(): GraphicsContext_BlendModestatic var exclusion: GraphicsContext.BlendMode { get }A mode that produces an effect similar to that produced by the difference blend mode, but with lower contrast. Source image sample values that are black don't produce a change; white inverts the background color values.
get hardLight(): GraphicsContext_BlendModestatic var hardLight: GraphicsContext.BlendMode { get }A mode that either multiplies or screens colors, depending on the source image sample color. If the source image sample color is lighter than 50% gray, the background is lightened, similar to screening. If the source image sample color is darker than 50% gray, the background is darkened, similar to multiplying. If the source image sample color is equal to 50% gray, the source image is not changed. Image samples that are equal to pure black or pure white result in pure black or white. The overall effect is similar to what you'd achieve by shining a harsh spotlight on the source image. Use this to add highlights to a scene.
get softLight(): GraphicsContext_BlendModestatic var softLight: GraphicsContext.BlendMode { get }A mode that either darkens or lightens colors, depending on the source image sample color. If the source image sample color is lighter than 50% gray, the background is lightened, similar to dodging. If the source image sample color is darker than 50% gray, the background is darkened, similar to burning. If the source image sample color is equal to 50% gray, the background is not changed. Image samples that are equal to pure black or pure white produce darker or lighter areas, but do not result in pure black or white. The overall effect is similar to what you'd achieve by shining a diffuse spotlight on the source image. Use this to add highlights to a scene.
get sourceOut(): GraphicsContext_BlendModestatic var sourceOut: GraphicsContext.BlendMode { get }A mode that you use to paint the source image onto the transparent parts of the background, while erasing the background. This mode implements the equation `R = S*(1 - Da)` where * `R` is the composite image. * `S` is the source image. * `Da` is the source background's alpha value.
No declarations were skipped in this snapshot.