Function

CGPathCreateWithRoundedRect

Create an immutable path of a rounded rectangle.

Declaration

CGPathRef CGPathCreateWithRoundedRect(CGRect rect, CGFloat cornerWidth, CGFloat cornerHeight, const CGAffineTransform *transform);

Parameters

rect

The rectangle to add.

cornerWidth

The width of the rounded corner sections.

cornerHeight

The height of the rounded corner sections.

transform

A pointer to an affine transformation matrix, or NULL if no transformation is needed. If specified, Core Graphics applies the transformation to the rectangle before it is added to the path.

Return Value

A new, immutable path. You are responsible for releasing this object.

Discussion

This is a convenience function that creates a path of an rounded rectangle. Using this convenience function is more efficient than creating a mutable path and adding an rectangle to it.

Each corner of the rounded rectangle is one-quarter of an ellipse with axes equal to the cornerWidth and cornerHeight parameters. The rounded rectangle forms a complete subpath and is oriented in the clockwise direction.

See Also

Creating and Managing Paths

CGPathCreateMutable

Creates a mutable graphics path.

CGPathCreateWithEllipseInRect

Create an immutable path of an ellipse.

CGPathCreateWithRect

Create an immutable path of a rectangle.

CGPathCreateCopy

Creates an immutable copy of a graphics path.

CGPathCreateCopyByTransformingPath

Creates an immutable copy of a graphics path transformed by a transformation matrix.

CGPathCreateCopyByDashingPath

Creates a dashed copy of another path.

CGPathCreateCopyByStrokingPath

Creates a stroked copy of another path.

CGPathCreateMutableCopy

Creates a mutable copy of an existing graphics path.

CGPathCreateMutableCopyByTransformingPath

Creates a mutable copy of a graphics path transformed by a transformation matrix.

CGPathRelease

Decrements the retain count of a graphics path.

CGPathRetain

Increments the retain count of a graphics path.