Version: 2022.3
LanguageEnglish
  • C#

CommandBuffer.BeginSample

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

Declaration

public void BeginSample(string name);

Declaration

public void BeginSample(Profiling.CustomSampler sampler);

Declaration

public void BeginSample(Unity.Profiling.ProfilerMarker marker);

Parameters

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.

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.

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-12-04.
Tutorials Community Answers Knowledge Base Forums Asset Store Terms of use Legal Privacy Policy Cookies Do Not Sell or Share My Personal Information