SDLImageField Class Reference

Section Contents

Overview

A struct used in DisplayCapabilities describing the capability of an image field

name

The name that identifies the field.

Required

Objective-C

@property (nonatomic, strong) SDLImageFieldName _Nonnull name;

Swift

var name: SDLImageFieldName { get set }

imageTypeSupported

The image types that are supported in this field.

Required

Objective-C

@property (nonatomic, strong) NSArray<SDLFileType> *_Nonnull imageTypeSupported;

Swift

var imageTypeSupported: [SDLFileType] { get set }

imageResolution

The image resolution of this field

Optional

Objective-C

@property (nonatomic, strong, nullable) SDLImageResolution *imageResolution;

Swift

var imageResolution: SDLImageResolution? { get set }

-initWithName:imageTypeSupported:imageResolution:

Convenience initalizer for the ImageField RPC struct

Objective-C

- (nonnull instancetype)
          initWithName:(nonnull SDLImageFieldName)name
    imageTypeSupported:(nonnull NSArray<SDLFileType> *)imageTypeSupported
       imageResolution:(nullable SDLImageResolution *)imageResolution;

Swift

init(name: SDLImageFieldName, imageTypeSupported: [SDLFileType], imageResolution: SDLImageResolution?)

Parameters

name

The name identifying this image field

imageTypeSupported

The image data types this field supports

imageResolution

The native resolution of this image field