Platforms to show: All Mac Windows Linux Cross-Platform

NSVisualEffectViewMBS class

Super class: NSViewMBS

Type Topic Plugin Version macOS Windows Linux iOS Targets
class Cocoa MBS MacFrameworks Plugin 14.3 ✅ Yes ❌ No ❌ No ❌ No Desktop only
The class to use visual effect view.

The NSVisualEffectView is the basis for all visual effects, including "vibrant" appearances. You can optionally set the appearance to NSAppearanceMBS.appearanceNamed(NSAppearanceNameVibrantDark) (or Light) to get the desired light or dark appearance. Combine this with an appropriate light or dark material to get the desired vibrant look. Combining NSAppearanceNameVibrantDark with a light material will look bad, and should not be done.

Requires Mac OS X 10.10 or newer.

Please review Apple's documentation on this for details.
Subclass of the NSViewMBS class.

Background Styles

Constant Value Description
NSBackgroundStyleDark 1 Dark
NSBackgroundStyleLight 0 Light

Blending Modes

Constant Value Description
NSVisualEffectBlendingModeBehindWindow 0 Blends and blurs with the contents behind the window (such as the desktop or other windows). These can overlap, and the view lower in the hierarchy will "win".
NSVisualEffectBlendingModeWithinWindow 1 Blends and blurs with contents behind the view in the current window only. For now, these cannot overlap each other. This mode REQUIRES layer-backing with view.wantsLayer = true.

Materials

Constant Value Description
NSVisualEffectMaterialAppearanceBased 0 When NSVisualEffectMaterialAppearanceBased is set, the material color is determined by the current effectiveAppearance that is on the view.
NSVisualEffectMaterialContentBackground 18 The material for the background of opaque content. more
NSVisualEffectMaterialDark 2 Dark
NSVisualEffectMaterialFullScreenUI 15 The material for the background of a full-screen modal interface.
NSVisualEffectMaterialHeaderView 10 The material for in-line header or footer views.
NSVisualEffectMaterialHUDWindow 13 The material for the background of heads-up display (HUD) windows.
NSVisualEffectMaterialLight 1 Light
NSVisualEffectMaterialMenu 5 The material for menus.
NSVisualEffectMaterialPopover 6 The material for the background of popover windows.
NSVisualEffectMaterialSelection 4 The material used to indicate a selection.
NSVisualEffectMaterialSheet 11 The material for the background of sheet windows.
NSVisualEffectMaterialSidebar 7 The material for the background of window sidebars.
NSVisualEffectMaterialTitlebar 3 The material for a window’s titlebar.
NSVisualEffectMaterialToolTip 17 The material for the background of a tool tip.
NSVisualEffectMaterialUnderPageBackground 22 The material for the area behind the pages of a document. more
NSVisualEffectMaterialUnderWindowBackground 21 The material to show under a window's background. more
NSVisualEffectMaterialWindowBackground 12 The material for the background of opaque windows. more

States

Constant Value Description
NSVisualEffectStateActive 1 The backdrop is explicitly active, always.
NSVisualEffectStateFollowsWindowActiveState 0 The backdrop automatically appears active when the window is active, and inactive when it is not active.
NSVisualEffectStateInactive 2 The backdrop is explicitly inactive.

Super class NSViewMBS

Constants

Constant Value Description
NSBezelBorder 2 One of the constants to specify the type of a view's border. A concave border that makes the view look sunken.
NSFocusRingTypeDefault 0 One of the constants for the focusringtype property. The default focus ring type for NSView or NSCell.
NSFocusRingTypeExterior 2 One of the constants for the focusringtype property. The standard Aqua focus ring.
NSFocusRingTypeNone 1 One of the constants for the focusringtype property. No focus ring. If you set the focus ring type to this value, NSView and NSCell will not draw any focus ring.
NSGrooveBorder 3 One of the constants to specify the type of a view's border. A thin border that looks etched around the image.
NSLineBorder 1 One of the constants to specify the type of a view's border. A black line border around the view.
NSNoBorder 0 One of the constants to specify the type of a view's border. No border.
NSViewHeightSizable 16 One of the constants for the autoresizingMask property. The receiver's height is flexible.
NSViewLayerContentsRedrawBeforeViewResize 3 One of the view layer content redraw policy constants.
NSViewLayerContentsRedrawDuringViewResize 2 One of the view layer content redraw policy constants.
NSViewLayerContentsRedrawNever 0 One of the view layer content redraw policy constants.
NSViewLayerContentsRedrawOnSetNeedsDisplay 1 One of the view layer content redraw policy constants.
NSViewMaxXMargin 4 One of the constants for the autoresizingMask property. The right margin between the receiver and its superview is flexible.
NSViewMaxYMargin 32 One of the constants for the autoresizingMask property. The top margin between the receiver and its superview is flexible.
NSViewMinXMargin 1 One of the constants for the autoresizingMask property. The left margin between the receiver and its superview is flexible.
NSViewMinYMargin 8 One of the constants for the autoresizingMask property. The bottom margin between the receiver and its superview is flexible.
NSViewNotSizable 0 One of the constants for the autoresizingMask property. The receiver cannot be resized.
NSViewWidthSizable 2 One of the constants for the autoresizingMask property. The receiver's width is flexible.

Window Order Constants

Constant Value Description
NSWindowAbove 1 Moves the window above the indicated window.
NSWindowBelow -1 Moves the window below the indicated window.
NSWindowOut 0 Moves the window off the screen.

Super class NSResponderMBS

This class has no sub classes.

Some examples using this class:

Blog Entries

Release notes


The items on this page are in the following plugins: MBS MacBase Plugin, MBS MacFrameworks Plugin.


NSViewTooltipMBS   -   NSVoiceMBS


The biggest plugin in space...