Reference API Roblox

Engine API

Website

Related

Reference API Roblox

DepthOfFieldEffect

Simulates a camera lens by blurring parts of a scene not in focus.

Memory categoryInstances

Member index 4

HistoryMember
553FarIntensity: float
553FocusDistance: float
553InFocusRadius: float
553NearIntensity: float
inherited from PostEffect
553Enabled: bool
inherited from Instance
553Archivable: bool
670Capabilities: SecurityCapabilities
553Name: string
553Parent: Instance
670Sandboxed: bool
680UniqueId: UniqueId
576AddTag(tag: string): null
573ClearAllChildren(): null
462Clone(): Instance
573Destroy(): null
486FindFirstAncestor(name: string): Instance
486FindFirstAncestorOfClass(className: string): Instance
486FindFirstAncestorWhichIsA(className: string): Instance
486FindFirstChild(name: string, recursive: bool = false): Instance
486FindFirstChildOfClass(className: string): Instance
486FindFirstChildWhichIsA(className: string, recursive: bool = false): Instance
486FindFirstDescendant(name: string): Instance
563GetActor(): Actor
486GetAttribute(attribute: string): Variant
462GetAttributeChangedSignal(attribute: string): RBXScriptSignal
631GetAttributes(): Dictionary
648GetChildren(): Instances
462GetDebugId(scopeLength: int = 4): string
486GetDescendants(): Array
486GetFullName(): string
641GetStyled(name: string): Variant
657GetStyledPropertyChangedSignal(property: string): RBXScriptSignal
576GetTags(): Array
576HasTag(tag: string): bool
486IsAncestorOf(descendant: Instance): bool
486IsDescendantOf(ancestor: Instance): bool
664IsPropertyModified(property: string): bool
573Remove(): null
576RemoveTag(tag: string): null
664ResetPropertyToDefault(property: string): null
573SetAttribute(attribute: string, value: Variant): null
462WaitForChild(childName: string, timeOut: double): Instance
648children(): Instances
553clone(): Instance
573destroy(): null
553findFirstChild(name: string, recursive: bool = false): Instance
648getChildren(): Instances
553isDescendantOf(ancestor: Instance): bool
573remove(): null
462AncestryChanged(child: Instance, parent: Instance)
462AttributeChanged(attribute: string)
462ChildAdded(child: Instance)
462ChildRemoved(child: Instance)
462DescendantAdded(descendant: Instance)
462DescendantRemoving(descendant: Instance)
500Destroying()
657StyledPropertiesChanged()
553childAdded(child: Instance)
inherited from Object
647ClassName: string
647className: string
647GetPropertyChangedSignal(property: string): RBXScriptSignal
647IsA(className: string): bool
650isA(className: string): bool
647Changed(property: string)

Description

The DepthOfFieldEffect simulates a camera lens by blurring parts of a scene not in focus. Distant objects can be blurred or this effect can be used to focus on specific parts of a scene, like an item in an in-game shop.

Like other post-processing effects, DepthOfFieldEffect will only work while Enabled and when parented to Lighting or Workspace.CurrentCamera. Also, it may render differently on low-end devices or depending on your Studio settings (see the Quality Level settings in Rendering → Performance).

For more details on this effect and others, see Post-Processing Effects.

History 17

Members 4

FarIntensity

TypeDefault
float0.75

Intensity of the far field blur, moving out in distance from the FocusDistance point plus InFocusRadius value.

Thread safetyReadSafe
CategoryState
Loaded/Savedtrue

History 4

FocusDistance

TypeDefault
float0.0500000007

Controls the distance away from the camera (in studs) where objects are in focus.

Thread safetyReadSafe
CategoryState
Loaded/Savedtrue

History 4

InFocusRadius

TypeDefault
float10

Controls the distance away from the FocusDistance (on both sides) where no blur is applied. Measured in studs.

Thread safetyReadSafe
CategoryState
Loaded/Savedtrue

History 4

NearIntensity

TypeDefault
float0.75

Intensity of the near field blur, between the camera and the FocusDistance point minus InFocusRadius value.

Thread safetyReadSafe
CategoryState
Loaded/Savedtrue

History 4

Settings