Console

DimensionStruct 

struct DimensionStruct

A set of dimensions for a background image.

  • The width, using the metric specified by the metric field.

    Declaration

    Swift

    let width: Float64

  • The height, using the metric specified by the metric field.

    Declaration

    Swift

    let height: Float64

  • The unit of measurement used for defining the dimensions. If the metric is [MetricTypeEnum.Percentage][ContentLauncherTrait.MetricTypeEnum.Percentage], the dimensions are expressed in terms of a percentage of the overall display dimensions. For example, a percentage width measurement of 50.0 against a display width of 1920 pixels would mean that the width in pixels is 960, which is 50.0% of 1920.

    Declaration

    Swift

    let metric: Matter.ContentLauncherTrait.MetricTypeEnum

  • Creates a new Struct instance using data read from the given TraitDecoder.

    Throws

    HomeError.parseError when parsing fails.

    Declaration

    Swift

    init(decoder: TraitDecoder) throws

    Parameters

    decoder

    The raw data representing this Struct.

  • Writes this Struct to the given TraitEncoder. Throws HomeError.parseError if the data could not be encoded.

    Declaration

    Swift

    func encode(with encoder: TraitEncoder) throws

  • Returns the field corresponding to the given field ID.

    Declaration

    Swift

    static func structField(id: UInt32) -> (any Field)?