RenderPickingResult
This struct contains information to notify Unity the outcome of this render picking callback.
Read time 1 minuteLast updated 6 days ago
Definition
- Type: Struct
- Namespace: UnityEditor
- Assembly: UnityEditor.CoreModule
public readonly struct RenderPickingResult
Remarks
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 HandleUtility.ResolvePickingCallback delegate to invoke when the user clicks on a pixel, whose value is the encoded from the picking index used during the callback. Refer to resolver for more information.
selectionId - Alternatively, you can use a HandleUtility.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 Fields
Value | Description |
|---|---|
| NoOperation | The constant value to be returned from HandleUtility.RenderPickingCallback delegates signifying that nothing has been rendered. |
Constructors
Constructor | Description |
|---|---|
| RenderPickingResult(System.Int32,UnityEditor.HandleUtility.ResolvePickingCallback) | Constructs a |
| RenderPickingResult(System.Int32,UnityEditor.HandleUtility.ResolvePickingWithWorldPositionCallback) | Constructs a |
Properties
Property | Description |
|---|---|
| renderedPickingIndexCount | The number of consecutive picking indices used during the current HandleUtility.RenderPickingCallback. |
| resolver | The callback to invoke to resolve a picking index into a GameObject reference. |
| resolverWithWorldPos | The callback to invoke to resolve a picking index into a GameObject reference. |