Contents

CTRubyAnnotationCreate(_:_:_:_:)

Creates an immutable ruby annotation object.

Declaration

func CTRubyAnnotationCreate(_ alignment: CTRubyAlignment, _ overhang: CTRubyOverhang, _ sizeFactor: CGFloat, _ text: UnsafeMutablePointer<Unmanaged<CFString>?>) -> CTRubyAnnotation

Parameters

  • alignment:

    An alignment value that specifies how the ruby text and the base text align relative to each other.

  • overhang:

    An overhang value that specifies how the ruby text overhangs adjacent characters.

  • sizeFactor:

    A size factor that specifies the annotation text size as a percentage of the base text size.

  • text:

    An array of Cfstring objects, indexed by Ctrubyposition. Pass in NULL for any unused positions.

Return Value

A reference to a CTRubyAnnotation object.

Discussion

Use this function to create a ruby annotation object in the most straightforward and efficient way.

See Also

Functions