Function

CGPathCreateWithRect

Create an immutable path of a rectangle.

Declaration

CGPathRef CGPathCreateWithRect(CGRect rect, const CGAffineTransform *transform);

Parameters

rect

The rectangle to add.

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 rectangle. Using this convenience function is more efficient than creating a mutable path and adding an rectangle to it.

Calling this function is equivalent to using CGRectGetMinX and related functions to find the corners of the rectangle, then using the CGPathMoveToPoint, CGPathAddLineToPoint, and CGPathCloseSubpath functions to draw the rectangle.

See Also

Creating and Managing Paths

CGPathCreateMutable

Creates a mutable graphics path.

CGPathCreateWithEllipseInRect

Create an immutable path of an ellipse.

CGPathCreateWithRoundedRect

Create an immutable path of a rounded 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.