Version: 2023.2
LanguageEnglish
  • C#

RenderPickingResult

struct in UnityEditor

Leave feedback
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

Description

This struct contains information to notify Unity the outcome of this render picking callback.

This struct type has to be returned from the RenderPickingCallback to notify Unity of:

  • The number of consecutive picking indices used during the callback
  • The ResolvePickingCallback delegate to invoke when the user clicks on a pixel, whose value is the selectionId encoded from the picking index used during the callback. Refer to resolver for more information.
  • Alternatively, you can use a ResolvePickingWithWorldPositionCallback delegate if you need the world space position or the depth value for the resolve callback to work. Refer to resolverWithWorldPos.

If nothing has been rendered, return RenderPickingResult.NoOperation.

Static Properties

NoOperationThe constant value to be returned from RenderPickingCallback delegates signifying that nothing has been rendered.

Properties

renderedPickingIndexCountThe number of consecutive picking indices used during the current RenderPickingCallback.
resolverThe callback to invoke to resolve a picking index into a GameObject reference.
resolverWithWorldPosThe callback to invoke to resolve a picking index into a GameObject reference.

Constructors

RenderPickingResultConstructs a RenderPickingResult value.

Is something described here not working as you expect it to? It might be a Known Issue. Please check with the Issue Tracker at issuetracker.unity3d.com.

Copyright ©2024 Unity Technologies. Publication Date: 2024-04-25.
Tutorials Community Answers Knowledge Base Forums Asset Store Terms of use Legal Privacy Policy Cookies Do Not Sell or Share My Personal Information