distortionEffect

Returns a new view that applies shader to self as a geometric distortion effect on the location of each pixel.

View ModifieriOS 17.0+macOS 14.0+tvOS 17.0+distortionEffect(_:maxSampleOffset:isEnabled:) in SwiftUI

Declaration

React
compose().distortionEffect(
  shader: SwiftUI.Shader,
  options: {
    maxSampleOffset: CGSize;
    isEnabled?: boolean;
  }
)
Swift
nonisolated func distortionEffect(
    _ shader: Shader,
    maxSampleOffset: CGSize,
    isEnabled: Bool = true
) -> some View

Parameters

  • The shader to apply as a distortion effect.

  • options.maxSampleOffset*CGSize

    The maximum distance in each axis between the returned source pixel position and the destination pixel position, for all source pixels.

  • options.isEnabledboolean

    Whether the effect is enabled or not.

Return value

A new view that renders self with the shader applied as a distortion effect.

Discussion

For a shader function to act as a distortion effect it must have a function signature matching:

[[ stitchable ]] float2 name(float2 position, args...)

where position is the user-space coordinates of the destination pixel applied to the shader. args... should be compatible with the uniform arguments bound to shader. The function should return the user-space coordinates of the corresponding source pixel.

See also

More in Visual effects.