Legacy Documentation: Version 2018.1 (Go to current version)
LanguageEnglish
  • C#
  • JS

Script language

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

CommandBuffer.DrawMeshInstanced

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

public method DrawMeshInstanced(mesh: Mesh, submeshIndex: int, material: Material, shaderPass: int, matrices: Matrix4x4[], count: int = matrices.Length, properties: MaterialPropertyBlock = null): void;
public void DrawMeshInstanced(Mesh mesh, int submeshIndex, Material material, int shaderPass, Matrix4x4[] matrices, int count = matrices.Length, MaterialPropertyBlock properties = null);

Parameters

meshThe Mesh to draw.
submeshIndexWhich subset of the mesh to draw. This applies only to meshes that are composed of several materials.
material Material to use.
shaderPassWhich pass of the shader to use, or -1 which renders all passes.
matricesThe array of object transformation matrices.
countThe number of instances to be drawn.
propertiesAdditional material properties to apply onto material just before this mesh will be drawn. See MaterialPropertyBlock.

Description

Add a "draw mesh with instancing" command.

The command will not immediately fail and throw an exception if Material.enableInstancing is false, but it will log an error and skips rendering each time the command is being executed if such a condition is detected.

InvalidOperationException will be thrown if the current platform doesn't support this API (i.e. if GPU instancing is not available). See SystemInfo.supportsInstancing.

See Also: DrawMesh, Graphics.DrawMeshInstanced, MaterialPropertyBlock.

Did you find this page useful? Please give it a rating:

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 © 2018 Unity Technologies. Publication: 2018.1-002N. Built: 2018-12-04.
TutorialsCommunity AnswersKnowledge BaseForumsAsset StoreLegalPrivacy PolicyCookiesDo Not Sell or Share My Personal Information