Version: Unity 6.3 Beta (6000.3)
LanguageEnglish
  • C#

PolygonGeometry.CreatePolygons

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 static NativeArray<PolygonGeometry> CreatePolygons(ReadOnlySpan<Vector2> vertices, LowLevelPhysics2D.PhysicsTransform transform, Vector2 vertexScale, Unity.Collections.Allocator allocator);

Parameters

Parameter Description
vertices The vertices to create the polygons from..
transform The transform used to specify where the geometry is positioned.
vertexScale The scaling to be applied to the vertices.
allocator The memory allocator to use for the results. This can only be Allocator.Temp, Allocator.TempJob or Allocator.Persistent.

Returns

NativeArray<PolygonGeometry> The created polygon geometries. This NativeArray must be disposed of after use otherwise leaks will occur. The exception to this is if the array is empty.

Description

Create multiple Polygons from a set of vertices. The vertices are assumed to produce a closed loop but can describe a concave shape if required. There must be at least 3 vertices. A limit is imposed on small vertex distances so it is recommended that scaling is applied here rather than on the returned geometry so geometry is not discarded due to it being invalid.