Open Asterune
LensDistortionEffect

LensDistortionEffect

Applies lens distortion and image scaling.

Creatable
Instance.new("LensDistortionEffect")
Inherits
PostEffectInstance
Replication
Standard

Behavior

LensDistortionEffect applies lens distortion and image scaling.

Summary

Members4
Properties3
  • Enabled: boolean = trueparallel read

    Whether this post-processing effect is applied to the rendered image.

  • Intensity: number = 0.2parallel read

    The strength of the rendered effect.

  • Zoom: number = 1parallel read

    The image scale applied with lens distortion.

Methods1

Properties

Enabled

LensDistortionEffect.Enabled: boolean = true

Whether this post-processing effect is applied to the rendered image.

Intensity

LensDistortionEffect.Intensity: number = 0.2

The strength of the rendered effect.

Zoom

LensDistortionEffect.Zoom: number = 1

The image scale applied with lens distortion.

Methods

GetExecutionGroup

LensDistortionEffect: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

Inherited47
Instance47
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

Related APIs

PostEffect