Version: 2021.3
LanguageEnglish
  • C#

PanelSettings.SetScreenToPanelSpaceFunction

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 void SetScreenToPanelSpaceFunction(Func<Vector2,Vector2> screentoPanelSpaceFunction);

Parameters

screentoPanelSpaceFunction The translation function. Set to null to revert to the default behavior.

Description

Sets the function that handles the transformation from screen space to panel space. For overlay panels, this function returns the input value.

If the panel's targetTexture is applied to 3D objects, one approach is to use a function that raycasts against MeshColliders in the Scene. The function can first check whether the GameObject that the ray hits has a MeshRenderer with a shader that uses this panel's target texture. It can then return the transformed RaycastHit.textureCoord in the texture's pixel space.