<!--
{
  "availability" : [
    "iOS: 17.0.0 -",
    "iPadOS: 17.0.0 -",
    "macCatalyst: 17.0.0 -",
    "macOS: 14.0.0 -",
    "tvOS: 17.0.0 -",
    "visionOS: 1.0.0 -",
    "watchOS: 10.0.0 -"
  ],
  "documentType" : "symbol",
  "framework" : "Symbols",
  "identifier" : "/documentation/Symbols/NSSymbolPulseEffect",
  "metadataVersion" : "0.1.0",
  "role" : "Class",
  "symbol" : {
    "kind" : "Class",
    "modules" : [
      "Symbols"
    ],
    "preciseIdentifier" : "c:objc(cs)NSSymbolPulseEffect"
  },
  "title" : "NSSymbolPulseEffect"
}
-->

# NSSymbolPulseEffect

A type that fades the opacity of some or all layers in a symbol-based image.

```
@interface NSSymbolPulseEffect : NSSymbolEffect
```

## Overview

A pulse animation applies an opacity ramp to the layers in a symbol. You can choose to animate only layers marked as “always-pulses” or all layers simultaneously. Participating layers reduce their opacity to a minimum value before returning to fully opaque.

```objc
// Add an effect in AppKit and UIKit.
// Pulse only layers marked as "always-pulse."
NSSymbolEffectOptions *options = [NSSymbolEffectOptions optionsWithNonRepeating];
[self.imageView1 addSymbolEffect:NSSymbolPulseEffect.effect options: options];

// Pulse all layers three times simultaneously.
NSSymbolEffectOptions *options = [NSSymbolEffectOptions optionsWithRepeatCount:3];
[self.imageView2 addSymbolEffect:[NSSymbolPulseEffect.effect effectWithWholeSymbol] options:options];
```

## Topics

### Accessing symbol effects

[`effect`](/documentation/Symbols/NSSymbolPulseEffect/effect)

The default pulse effect, determined by the system.

### Determining effect scope

[`effectWithByLayer`](/documentation/Symbols/NSSymbolPulseEffect/effectWithByLayer)

A copy of the effect requesting an animation that pulses only the layers marked to always pulse.

[`effectWithWholeSymbol`](/documentation/Symbols/NSSymbolPulseEffect/effectWithWholeSymbol)

A copy of the effect requesting an animation that pulses all layers simultaneously.



---

Copyright &copy; 2026 Apple Inc. All rights reserved. | [Terms of Use](https://www.apple.com/legal/internet-services/terms/site.html) | [Privacy Policy](https://www.apple.com/privacy/privacy-policy)