ScreenPointToWorldPointInRectangle(RectTransform, Vector2, Camera, out Vector3)
Transform a screen space point to a position in world space that is on the plane of the given RectTransform.
Read time 1 minuteLast updated 4 days ago
Definition
- Type: Method
- Namespace: UnityEngine
- Assembly: UnityEngine.UIModule
ScreenPointToWorldPointInRectangle(RectTransform, Vector2, Camera, Vector3)
public static bool ScreenPointToWorldPointInRectangle(RectTransform rect, Vector2 screenPoint, Camera cam, out Vector3 worldPoint)
Parameters
The RectTransform to find a point inside.
Screen space position.
The camera associated with the screen space position.
Point in world space.
Returns
Type | Description |
|---|---|
| bool | Returns true if the plane of the RectTransform is hit, regardless of whether the point is inside the rectangle. |
Remarks
The cam parameter should be the camera associated with the screen point. For a RectTransform in a Canvas set to Screen Space - Overlay mode, the cam parameter should be null.
When ScreenPointToWorldPointInRectangle is used from within an event handler that provides a PointerEventData object, the correct camera can be obtained by using enterEventData (for hover functionality) or pressEventCamera (for click functionality). This will automatically use the correct camera (or null) for the given event.