VignetteEffect
Darkens the edges of the rendered image.
- Creatable
Instance.new("VignetteEffect")- Inherits
- PostEffectInstance
- Replication
- Standard
Behavior
VignetteEffect darkens the edges of the rendered image.
Summary
The color applied when rendering this instance.
Whether this post-processing effect is applied to the rendered image.
The strength of the rendered effect.
The extent of the vignette into the rendered image.
The width of the transition between the center and vignette edges.
Returns this instance if it is an ExecutionGroup.
Properties
Color
VignetteEffect.Color: Color3 = Color3.new(0, 0, 0)The color applied when rendering this instance.
Enabled
VignetteEffect.Enabled: boolean = trueWhether this post-processing effect is applied to the rendered image.
Intensity
VignetteEffect.Intensity: number = 0.4The strength of the rendered effect.
Size
VignetteEffect.Size: number = 0.6The extent of the vignette into the rendered image.
Smoothness
VignetteEffect.Smoothness: number = 0.45The width of the transition between the center and vignette edges.
Methods
GetExecutionGroup
VignetteEffect:GetExecutionGroup(): ExecutionGroup?Returns this instance if it is an ExecutionGroup. Otherwise returns the nearest ancestor ExecutionGroup, or nil when no group contains the instance.
Inherited members
- Properties
- ArchivableClassNameNameParent
- Methods
- AddComponent()AddTag()ClearAllChildren()ClearTags()Clone()Destroy()FindFirstAncestor()FindFirstAncestorOfClass()FindFirstAncestorWhichIsA()FindFirstChild()FindFirstChildOfClass()FindFirstChildWhichIsA()FindFirstDescendant()GetAttribute()GetAttributeChangedSignal()GetAttributes()GetChildren()GetComponent()GetComponentChangedSignal()GetComponents()GetDebugId()GetDescendants()GetFullName()GetPropertyChangedSignal()GetReferencing()GetTags()HasComponent()HasTag()IsA()IsAncestorOf()IsDescendantOf()RemoveComponent()RemoveTag()SetAttribute()WaitForChild()
- Events
- AncestryChangedAttributeChangedChangedChildAddedChildRemovedDescendantAddedDescendantRemovingDestroying