Class SceneDepthReaderAlpha

Reads the scene depth of a camera back to the CPU.

A sample is the distance from the camera to the surface at that point, in world units, measured along the camera's view direction.

Reads are asynchronous and land a frame or two later. Any number of them may be in flight at once, so a read can be issued every frame without waiting for the previous one to finish.

Note that something has to be rendering the depth for there to be anything to read: an effect which consumes it, or CameraComponent#requestSceneDepthMap.

const reader = new pc.SceneDepthReader(camera.camera);
const rect = new pc.Vec4(0.45, 0.45, 0.1, 0.1);

app.on('update', () => {
    reader.read(rect, 8, 8)?.then((samples) => {
        const hit = samples.filter(Number.isFinite);
        console.log(hit.length ? Math.min(...hit) : 'nothing in view');
    });
});
Copy