Documentation

Unity Engine


User Manual

Script Reference

Unity Engine


CastRay(CastRayInput, QueryFilter, WorldCastMode, Allocator)

Returns the shape(s) that intersect the specified Ray. Technically this is a line-segment and not an infinite ray. See PhysicsQuery.QueryFilter, PhysicsQuery.WorldCastMode, PhysicsQuery.WorldCastResult and Allocator.
Read time 1 minuteLast updated 12 days ago

Definition

public NativeArray<PhysicsQuery.WorldCastResult> CastRay(PhysicsQuery.CastRayInput input, PhysicsQuery.QueryFilter filter, PhysicsQuery.WorldCastMode castMode = WorldCastMode.Closest, Allocator allocator = Allocator.Temp)

Parameters

The configuration of the ray to cast.

The filter to control what results are returned.

Controls how many and in what order the results are returned.

allocator

The memory allocator to use for the results. This can only be Allocator.Temp, Allocator.TempJob or Allocator.Persistent.

Returns

Type

Description

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