CreateFromSprite
Create polygon shapes using the selected sprite.
Read time 4 minutesLast updated 5 days ago
Definition
- Type: Method
- Namespace: UnityEngine
- Assembly: UnityEngine.Physics2DModule
CreateFromSprite(Sprite, float, byte, bool)
Create polygon shapes using the selected sprite.
public bool CreateFromSprite(Sprite sprite, float detail, byte alphaTolerance, bool holeDetection)
Parameters
The sprite to extract the polygon shape data from.
The detail used when tessellating the sprite outline, in the range [0, 1]. This is only used if the doesn't already have its own PhysicsShape outline(s) or is false. This value has the same meaning as the similarly named property in the Sprite Editor.
spriteusePhysicsShapesThe alpha tolerance used to separate the sprite from its background, in the range [0, 255]. This is only used if the doesn't already have its own PhysicsShape outline(s) or is false. This value has the same meaning as the similarly named property in the Sprite Editor.
spriteusePhysicsShapesSelects whether internal holes should be detected when creating the sprite outlines. This is only used if the doesn't already have its own PhysicsShape outline(s) or is false. This value has the same meaning as the similarly named property in the Sprite Editor.
spriteusePhysicsShapesReturns
Type | Description |
|---|---|
| bool | Returns |
Remarks
If the selected already has its own PhysicShape(s) defined in the Sprite Editor then that outline will be tessellated into polygon shapes to be used here.
spriteIf the selected does not have its own PhysicsShape(s) then a new outline will be created using the additional arguments provided. This takes additional time and in all cases, it is preferred that each Sprite has its own PhysicsShape(s) defined.
spriteNOTE: If PhysicsShape(s) are not available in the Sprite and the additional arguments are used in a player build then the Sprite.texture must have read/write enabled in the importer so it is readable.
Additional Resources: Sprite, Sprite.GetPhysicsShapeCount, Sprite.GetPhysicsShape and Sprite.GetPhysicsShapePointCount.
CreateFromSprite(Sprite, float, byte, bool, bool)
Create polygon shapes using the selected sprite.
public bool CreateFromSprite(Sprite sprite, float detail = 0.25, byte alphaTolerance = 200, bool holeDetection = true, bool usePhysicsShapes = true)
Parameters
The sprite to extract the polygon shape data from.
The detail used when tessellating the sprite outline, in the range [0, 1]. This is only used if the doesn't already have its own PhysicsShape outline(s) or is false. This value has the same meaning as the similarly named property in the Sprite Editor.
spriteusePhysicsShapesThe alpha tolerance used to separate the sprite from its background, in the range [0, 255]. This is only used if the doesn't already have its own PhysicsShape outline(s) or is false. This value has the same meaning as the similarly named property in the Sprite Editor.
spriteusePhysicsShapesSelects whether internal holes should be detected when creating the sprite outlines. This is only used if the doesn't already have its own PhysicsShape outline(s) or is false. This value has the same meaning as the similarly named property in the Sprite Editor.
spriteusePhysicsShapesSelects whether the outline should use the PhysicsShape outline(s) defined in the . If true, they are used (if available) however if false then they are never used even if available.
spriteReturns
Type | Description |
|---|---|
| bool | Returns |
Remarks
If the selected already has its own PhysicShape(s) defined in the Sprite Editor then that outline will be tessellated into polygon shapes to be used here.
spriteIf the selected does not have its own PhysicsShape(s) then a new outline will be created using the additional arguments provided. This takes additional time and in all cases, it is preferred that each Sprite has its own PhysicsShape(s) defined.
spriteNOTE: If PhysicsShape(s) are not available in the Sprite and the additional arguments are used in a player build then the Sprite.texture must have read/write enabled in the importer so it is readable.
Additional Resources: Sprite, Sprite.GetPhysicsShapeCount, Sprite.GetPhysicsShape and Sprite.GetPhysicsShapePointCount.