Documentation Archive

Developer

Asset Catalog Format Reference

On This Page

Launch Image Type

Launch images contain the different sizes and resolutions for an app launch image. They are required for iOS 7.0 and earlier. New projects for iOS 8.0 and later default to using a launch screen storyboard.

Extension

.launchimage

Folder Contents

.png files.

Contents.json File (Required)

Metadata and attributes for the individual resource files (Table 21-1).

Table 21-1Launch image tags

Key

Type

Description

info

Dictionary

Metadata for the author and format version of the asset catalog.

   author

String

Use your bundle ID.

   version

Number

The format version of the asset catalog. Use 1.

data

Array of dictionaries

The launch images in the set.

   filename

String

The .png file for the launch screen image.

   idiom

Slot component

The device type for the launch image. For the values, see idiom in Image Set Type.

   orientation

Slot component

The valid device orientations for the launch image. For the values, see orientation below.

   scale

Slot component

The scale of the launch image. For the values, see scale in Image Set Type.

   subtype

Slot component

A subtype for the launch image. For the values, see subtype below.

   minimum-system-version

Slot component

The minimum system version for the launch image. For the values, see minimum-system-version below.

   extent

Slot component

The vertical extent of the launch image. For the values, see extent below.

Values for Enumerated Tags

idiom

See idiom in Image Set Type.

orientation

The device orientation for the launch image (Table 21-2).

Table 21-2orientation values

Value

Description

portrait

The launch image is for a device in portrait orientation.

landscape

The launch image is for a device in landscape orientation.

scale

See scale in Image Set Type.

subtype

The targeted iPhone screen height for the image (Table 21-3).

Table 21-3subtype values

Value

Description

Tag not included

The image is for a 3.5-inch iPhone screen.

retina4

The image is for a 4-inch iPhone screen.

667h

The image is for a 4.7-inch iPhone screen.

736h

The image is for a 5.5-inch iPhone screen.

minimum-system-version

The minimum system version for the launch image (Table 21-4).

Table 21-4minimum-system-version values

Value

Description

Tag not included

There is no minimum system version for the launch image.

7.0

The launch image is for iOS 7.0 or later.

8.0

The launch image is for iOS 8.0 or later.

9.0

The launch image is for iOS 9.0 or later.

extent

The extent of the image in the vertical dimension of the screen (Table 21-5).

Table 21-5extent values

Value

Description

to-status-bar

The launch image extends from the bottom of the screen to the bottom of the status bar.

full-screen

regular (deprecated)

The launch image extends the full height of the screen.

Sample Contents.json File

  1. {
  2. "images" : [
  3. {
  4. "filename" : "MyLaunchScreen-iPhone-portrait"
  5. "orientation" : "portrait"
  6. "idiom" : "iphone",
  7. "extent" : "full-screen"
  8. "minimum-system-version" : "8.0",
  9. "scale" : "3x",
  10. },
  11. ],
  12.   "info" : {
  13.       "author" : "com.developerName",
  14.       "version" : 1
  15.    }
  16. }