Contents

installName

The installation name for a dynamic library.

Declaration

var installName: String? { get }

Discussion

Metal ignores this property if the library’s type isn’t MTLLibraryType.dynamic. Otherwise this property is a non-nil value specifying a file system path to the dynamic library.

Metal uses the installation name whenever you create a pipeline state object that directly or indirectly relies on a dynamic library. Metal embeds the installation name into any Metal library that links against the dynamic library.

Specify one of the following:

  • An absolute path to a file containing the dynamic library. This option is appropriate when you serialize the dynamic library to the file system on the current device or Mac computer.

  • A path relative to @executable_path, where the system substitutes the directory containing the library that is creating the new pipeline state object.

  • A path relative to @loader_path, where the system substitutes the directory containing the Metal library that contains the reference to this dynamic library.

Use a relative path when you include the dynamic library as part of a bundle or app.

See Also

Querying basic library attributes