Skip to content

Update environment_depth.rst with permissions info. Fix code typo. #424

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
m4gr3d merged 2 commits into from
Jan 5, 2026
Merged

Update environment_depth.rst with permissions info. Fix code typo. #424

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
0834764
Update environment_depth.rst with permissions info. Fix code typo.
The-Cyber-Captain Jan 1, 2026
a923303
Revert any update to permissions info. Fix definitive typos only.
The-Cyber-Captain Jan 4, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions docs/manual/meta/environment_depth.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -240,7 +240,7 @@ To request the data:
# Request the data every 1 second.
var timer := Timer.new()
timer.wait_time = 1.0
time.connect.timeout(_on_timer_timeout)
timer.timeout.connect(_on_timer_timeout)
add_child(timer)
timer.start()

Expand All @@ -256,6 +256,6 @@ To request the data:

# Do processing...

It's not recommend to request the depth map every frame, as it's not the most performant operation, but also, the depth map image won't change every frame anyway. The depth sensor captures at lower frame rate than we are rendering to the display, so will only update every few frames.
It's not recommended to request the depth map every frame, as it's not the most performant operation, but also, the depth map image won't change every frame anyway. The depth sensor captures at lower frame rate than we are rendering to the display, so will only update every few frames.

Also, due to this being an asynchronous operation, the data you receive won't be up-to-date for the current frame - most likely it'll be the data from the previous frame. So, if you need to use the depth map for rendering something on the current frame, it's recommended to do that in a shader instead (as described in the previous section).
Loading