Work in progress
Godot documentation is being updated to reflect the latest changes in version
4.0. Some documentation pages may
still state outdated information. This banner will tell you if you're reading one of such pages.
The contents of this page are up to date. If you can still find outdated information, please open an issue.
Inherits: Node2D < CanvasItem < Node < Object
Inherited By: VisibleOnScreenEnabler2D
Detects when the node extents are visible on screen.
The VisibleOnScreenNotifier2D detects when it is visible on the screen. It also notifies when its bounding rectangle enters or exits the screen or a viewport.
If you want nodes to be disabled automatically when they exit the screen, use VisibleOnScreenEnabler2D instead.
Note: VisibleOnScreenNotifier2D uses the render culling code to determine whether it's visible on screen, which also means that its CanvasItem.visible must be
true to work correctly.
is_on_screen ( ) const
screen_entered ( )
Emitted when the VisibleOnScreenNotifier2D enters the screen.
screen_exited ( )
Emitted when the VisibleOnScreenNotifier2D exits the screen.
Rect2 rect =
Rect2(-10, -10, 20, 20)
The VisibleOnScreenNotifier2D's bounding rectangle.
bool is_on_screen ( ) const
true, the bounding rectangle is on the screen.
Note: It takes one frame for the node's visibility to be assessed once added to the scene tree, so this method will return
false right after it is instantiated, even if it will be on screen in the draw pass.