Version: Unity 6.3 Beta (6000.3)
LanguageEnglish
  • C#

PhysicsWorld.OverlapShape

Suggest a change

Success!

Thank you for helping us improve the quality of Unity Documentation. Although we cannot accept all submissions, we do read each suggested change from our users and will make updates where applicable.

Close

Submission failed

For some reason your suggested change could not be submitted. Please <a>try again</a> in a few minutes. And thank you for taking the time to help us improve the quality of Unity Documentation.

Close

Cancel

Declaration

public NativeArray<WorldOverlapResult> OverlapShape(LowLevelPhysics2D.PhysicsShape shape, LowLevelPhysics2D.PhysicsQuery.QueryFilter filter, Unity.Collections.Allocator allocator);

Parameters

Parameter Description
shape The shape used to check overlap.
filter The filter to control what results are returned.
allocator The memory allocator to use for the results. This can only be Allocator.Temp, Allocator.TempJob or Allocator.Persistent.

Returns

NativeArray<WorldOverlapResult> The query overlap results. This NativeArray must be disposed of after use otherwise leaks will occur. The exception to this is if the array is empty.

Description

Returns all shapes that overlap the provided shape. See PolygonGeometry, QueryFilter, see cref="LowLevelPhysics2D.PhysicsQuery.WorldOverlapResult"/> and Allocator.