Only include objects with a Z coordinate (depth) greater than this value.

maxDepth

Only include objects with a Z coordinate (depth) less than this value.

Returns

int
Returns the number of results placed in the results array.

Description

Casts a capsule into the Scene, returning colliders that contact with it into the provided results array.

This function is similar to the CapsuleCastAll function except that the results are returned in the supplied array. The integer return value is the number of objects that intersect the capsule (possibly zero) but the results array will not be resized if it doesn't contain enough elements to report all the results. The significance of this is that no memory is allocated for the results and so garbage collection performance is improved when performed frequently.

The returned RaycastHit2D returns both the point and normal of the contact where the capsule would touch the collider. It also returns the centroid where the capsule would be positioned for it to contact at that point.