Version: 5.6 (switch to 2017.1b)
LanguageEnglish
  • C#
  • JS

Script language

Select your preferred scripting language. All code snippets will be displayed in this language.

CommandBuffer.BeginSample

Other Versions
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

public function BeginSample(name: string): void;
public void BeginSample(string name);

Parameters

name Name of the profile information used for sampling.

Description

Adds a command to begin profile sampling.

Schedules a performance profiling to end when the command buffer execution reaches this point. This is useful for measuring CPU and GPU time spent by one or more commands in the command buffer.

A sampling started with BeginSample always has to be ended with a corresponding call to CommandBuffer.EndSample with the same name argument.

Leave Feedback

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 © 2017 Unity Technologies. Publication: 5.6-001M. Built: 2017-06-19.
Tutorials Community Answers Knowledge Base Forums Asset Store