class in UnityEditor.Profiling
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.
CloseFor 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.
CloseAn object describing a selection made in a frame time sample based Profiler module.
Use ProfilerWindow.GetFrameTimeViewSampleSelectionController to get a frame time sample based Profiler module, then use IProfilerFrameTimeViewSampleSelectionController.selection to get an object describing the current selection. You can create a selection object and set the current selection in a frame time sample based Profiler module via IProfilerFrameTimeViewSampleSelectionController.SetSelection.
frameIndex | The 0 based frame index. Note that the Profiler Window UI shows the frame index as n+1. |
markerNamePath | A list of the names of all ProfilerMarkers that make up the Sample Stack of this selection. Unity populates this list on a selection object if it was passed to IProfilerFrameTimeViewSampleSelectionController.SetSelection and was accepted as a valid selection. |
markerPathDepth | A shorthand for _markerNamePath.Count. When _markerNamePath is null, this value is 0. |
rawSampleIndex | The raw index of a sample, i.e. the index as if would be used with RawFrameDataView and NOT an Item ID as it would be used with HierarchyFrameDataView. |
rawSampleIndices | A sample selected in Hierarchy view might correspond to multiple samples in RawFrameDataView. This is a list of all of these sample indices. |
sampleDisplayName | The name of the Sample as it is displayed in the Profiler Window. This might be a shorter version than the last item in _markerNamePath. |
threadGroupName | The name of the group of the thread this sample resides in. When the thread is not part of a thread group, this value is string.empty. |
threadId | The ID of the thread this sample resides in. |
threadName | The name of the thread this sample resides in. |
ProfilerTimeSampleSelection | Constructs a selection object that can be passed to IProfilerFrameTimeViewSampleSelectionController.SetSelection to change the selection. |
Did you find this page useful? Please give it a rating:
Thanks for rating this page!
What kind of problem would you like to report?
Thanks for letting us know! This page has been marked for review based on your feedback.
If you have time, you can provide more information to help us fix the problem faster.
Provide more information
You've told us this page needs code samples. If you'd like to help us further, you could provide a code sample, or tell us about what kind of code sample you'd like to see:
You've told us there are code samples on this page which don't work. If you know how to fix it, or have something better we could use instead, please let us know:
You've told us there is information missing from this page. Please tell us more about what's missing:
You've told us there is incorrect information on this page. If you know what we should change to make it correct, please tell us:
You've told us this page has unclear or confusing information. Please tell us more about what you found unclear or confusing, or let us know how we could make it clearer:
You've told us there is a spelling or grammar error on this page. Please tell us what's wrong:
You've told us this page has a problem. Please tell us more about what's wrong:
Thank you for helping to make the Unity documentation better!
Your feedback has been submitted as a ticket for our documentation team to review.
We are not able to reply to every ticket submitted.