colorEffect
Returns a new view that applies shader to self as a filter effect on the color of each pixel.
Declaration
compose().colorEffect(
shader: SwiftUI.Shader,
options?: {
isEnabled?: boolean;
}
)nonisolated func colorEffect(
_ shader: Shader,
isEnabled: Bool = true
) -> some ViewParameters
shader*SwiftUI.ShaderThe shader to apply to
selfas a color filter.options.isEnabledbooleanWhether the effect is enabled or not.
Return value
A new view that renders self with the shader applied as a color filter.
Discussion
For a shader function to act as a color filter it must have a function signature matching:
[[ stitchable ]] half4 name(float2 position, half4 color, args...)where position is the user-space coordinates of the pixel
applied to the shader and color its source color, as a
pre-multiplied color in the destination color space. args...
should be compatible with the uniform arguments bound to
shader. The function should return the modified color value.
See also
More in Visual effects.
- allowedDynamicRangeReturns a new view configured with the specified allowed dynamic range.
- backgroundExtensionEffectAdds the background extension effect to the view. The view will be duplicated into mirrored copies which will be placed around the view on any edge with available safe area. Additionally, a blur effect will be applied on top to blur out the copies.
- blurApplies a Gaussian blur to this view.
- brightnessBrightens this view by the specified amount.
- clippedClips this view to its bounding rectangular frame.
- colorInvertInverts the colors in this view.
- colorMultiplyAdds a color multiplication effect to this view.
- compositingGroupWraps this view in a compositing group.
- contrastSets the contrast and separation between similar colors in this view.
- distortionEffectReturns a new view that applies shader to self as a geometric distortion effect on the location of each pixel.
- drawingGroupComposites this view's contents into an offscreen image before final display.
- glassEffectApplies a glass effect to this view.