Contents

load(contentsOf:withName:)

Synchronously loads a texture resource from a URL.

Declaration

@MainActor @preconcurrency static func load(contentsOf url: URL, withName resourceName: String? = nil) throws -> TextureResource

Parameters

  • url:

    The path or address of the file to load.

  • resourceName:

    A unique name the method assigns to the resource it loads, for use in network synchronization.

Return Value

The loaded resource.

Discussion

Loading a TextureResource with this method blocks the main actor because it’s synchronous, so only call it from a command-line application. The method can stall a regular app, which makes it visibly hitch, and the system terminates an app if its UI becomes unresponsive. See init(named:in:) for an example that demonstrates how to safely load content.

This method loads the image that the URL specifies, and creates a texture resource from it. The method blocks until it finishes loading the image and creating the texture resource.

RealityKit uses the resource name to distinguish resources locally, and to match texture resources between networked peers. Specify a unique name for each texture resource you load or generate.

See Also

Loading a texture