Open Asterune
DepthOfFieldEffect

DepthOfFieldEffect

Blurs geometry outside the configured focus range.

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

Behavior

DepthOfFieldEffect blurs geometry outside the configured focus range.

Summary

Members6
Properties5
  • Enabled: boolean = trueparallel read

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

  • FarIntensity: number = 0.75parallel read

    The blur intensity for geometry farther than the focus range.

  • FocusDistance: number = 25parallel read

    The distance from the camera at which geometry is in focus.

  • InFocusRadius: number = 10parallel read

    The depth range around the focus distance that remains in focus.

  • NearIntensity: number = 0.6parallel read

    The blur intensity for geometry nearer than the focus range.

Methods1

Properties

Enabled

DepthOfFieldEffect.Enabled: boolean = true

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

FarIntensity

DepthOfFieldEffect.FarIntensity: number = 0.75

The blur intensity for geometry farther than the focus range.

FocusDistance

DepthOfFieldEffect.FocusDistance: number = 25

The distance from the camera at which geometry is in focus.

InFocusRadius

DepthOfFieldEffect.InFocusRadius: number = 10

The depth range around the focus distance that remains in focus.

NearIntensity

DepthOfFieldEffect.NearIntensity: number = 0.6

The blur intensity for geometry nearer than the focus range.

Methods

GetExecutionGroup

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