How to crop a sprite using SKCropNode

Paul Hudson    February 13th 2018    @twostraws

SpriteKit has a dedicated node type for handling cropping, and you can add things to it, position it where you want, then add it to your scene just like any other node.

However, its role is to crop the nodes it contains: when you assign a node to its maskNode property, SpriteKit looks at the colors of the mask and uses that to crop all the child nodes of the crop node. So, you might create an SKCropNode with five child nodes, then give it a circular mask node so that parts of the children are invisible. Everything that has a color in the mask won’t be cropped, and everything that is invisible will be.

Let’s look at some code. First you create and position your crop node:

let cropNode = SKCropNode()
cropNode.position = CGPoint(x: 50, y: 50)

Next you set its maskNode property to any SpriteKit node. Using a sprite node is easy enough:

cropNode.maskNode = SKSpriteNode(imageNamed: "cropMask")

Third you create a child node, position it inside the crop node, then add it to the crop node:

childNode = SKSpriteNode(imageNamed: "child")
childNode.position = CGPoint(x: 0, y: -90)
childNode.name = "character"
cropNode.addChild(childNode)

Finally add the crop node to your main scene:

addChild(cropNode)

Available from iOS 7.1

Did this solution work for you? Please pass it on!

Tweet

Other people are reading…

• How to warp a sprite using SKWarpGeometryGrid
• How to add pixel-perfect physics to an SKSpriteNode
• How to generate a random number with GKRandomSource
• How to made an SKSpriteNode render faster using blendMode
• How to roll a dice using GameplayKit and GKRandomDistribution

About the Swift Knowledge Base

This is part of the Swift Knowledge Base, a free, searchable collection of solutions for common iOS questions.