Version: Unity 6.6 Alpha (6000.6)
LanguageEnglish
  • C#

CommandBuffer.BeginSample

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 BeginSample(string name);

Declaration

public void BeginSample(CustomSampler sampler);

Declaration

public void BeginSample(ProfilerMarker marker);

Declaration

public void BeginSample(ProfilerMarker marker, Object contextObject);

Parameters

Parameter Description
name Name of the profile information used for sampling.
sampler The CustomSampler that the CommandBuffer uses for sampling.
marker The ProfilerMarker that the CommandBuffer uses for sampling.
contextObject 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.

Description

Adds a command to begin profile sampling.

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 contextObject, 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 contextObject parameter.