BeginSample
Adds a command to begin profile sampling.
Read time 3 minutesLast updated 6 days ago
Definition
- Type: Method
- Namespace: UnityEngine.Rendering
- Assembly: UnityEngine.CoreModule
BeginSample(string)
Adds a command to begin profile sampling.
public void BeginSample(string name)
Parameters
Name of the profile information used for sampling.
Remarks
Schedules a performance profiling sample to begin when the Command Buffer reaches this point. This is useful for measuring CPU and GPU time spent by one or more commands in the Command Buffer.
A profiling sample that starts with BeginSample must always end with a call to CommandBuffer.EndSample with the same argument.
When passing a , the Profiler associates the provided Unity Object (for example, a Texture or a Mesh) with the profiling sample. This is similar to the way that ProfilerMarker.Begin(Object) handles the parameter.
contextObjectcontextObjectBeginSample(CustomSampler)
Adds a command to begin profile sampling.
public void BeginSample(CustomSampler sampler)
Parameters
The CustomSampler that the CommandBuffer uses for sampling.
Remarks
Schedules a performance profiling sample to begin when the Command Buffer reaches this point. This is useful for measuring CPU and GPU time spent by one or more commands in the Command Buffer.
A profiling sample that starts with BeginSample must always end with a call to CommandBuffer.EndSample with the same argument.
When passing a , the Profiler associates the provided Unity Object (for example, a Texture or a Mesh) with the profiling sample. This is similar to the way that ProfilerMarker.Begin(Object) handles the parameter.
contextObjectcontextObjectBeginSample(ProfilerMarker)
Adds a command to begin profile sampling.
[Conditional("ENABLE_PROFILER")]public void BeginSample(ProfilerMarker marker)
Parameters
The ProfilerMarker that the CommandBuffer uses for sampling.
Remarks
Schedules a performance profiling sample to begin when the Command Buffer reaches this point. This is useful for measuring CPU and GPU time spent by one or more commands in the Command Buffer.
A profiling sample that starts with BeginSample must always end with a call to CommandBuffer.EndSample with the same argument.
When passing a , the Profiler associates the provided Unity Object (for example, a Texture or a Mesh) with the profiling sample. This is similar to the way that ProfilerMarker.Begin(Object) handles the parameter.
contextObjectcontextObjectBeginSample(ProfilerMarker, Object)
Adds a command to begin profile sampling.
[Conditional("ENABLE_PROFILER")]public void BeginSample(ProfilerMarker marker, Object contextObject)
Parameters
The ProfilerMarker that the CommandBuffer uses for sampling.
Object associated with the operation. The Profiler displays this object in the sample hierarchy, allowing you to identify which specific resource the sample was recorded for.
Remarks
Schedules a performance profiling sample to begin when the Command Buffer reaches this point. This is useful for measuring CPU and GPU time spent by one or more commands in the Command Buffer.
A profiling sample that starts with BeginSample must always end with a call to CommandBuffer.EndSample with the same argument.
When passing a , the Profiler associates the provided Unity Object (for example, a Texture or a Mesh) with the profiling sample. This is similar to the way that ProfilerMarker.Begin(Object) handles the parameter.
contextObjectcontextObject