Screen

public final class Screen : ScreenObjectContainerConvertible

An object that manages offscreen rendering a foundation.

  • The default screen size.

    Declaration

    Swift

    public static let size: CGSize

  • The total of child counts.

    Declaration

    Swift

    public var childCounts: Int { get }

  • Specifies the delegate object.

    Declaration

    Swift

    public weak var delegate: (any ScreenDelegate)?

  • Specifies the video size to use when output a video.

    Declaration

    Swift

    public var size: CGSize { get set }

  • Specifies the background color.

    Declaration

    Swift

    public var backgroundColor: CGColor { get set }

  • Specifies the background color.

  • Creates a screen object.

    Declaration

    Swift

    public init()

  • Adds the specified screen object as a child of the current screen object container.

    Declaration

    Swift

    public func addChild(_ child: ScreenObject?) throws

  • Removes the specified screen object as a child of the current screen object container.

    Declaration

    Swift

    public func removeChild(_ child: ScreenObject?)

  • Registers a video effect.

    Declaration

    Swift

    public func registerVideoEffect(_ effect: some VideoEffect) -> Bool

  • Unregisters a video effect.

    Declaration

    Swift

    public func unregisterVideoEffect(_ effect: some VideoEffect) -> Bool