Sample CodeiOS, iPadOS, Mac Catalyst, macOSReviewed 2026-07-21View on Apple Developer

Creating a Metal dynamic library

At a glance

Item Summary
Purpose Compile a library of shaders and write it to a file as a dynamically linked library.
App architecture Objective-C host code with Metal shaders; AAPLEditViewController hands work to AAPLRenderer, which owns runtime Metal library linking before functions loaded from a dynamic library.
Main patterns Renderer boundary, Runtime shader composition, Configuration-driven pipeline
Scope High-level review of 20 scanned source files and 16 detected declarations; build assets are omitted.

Project structure

Source bundle/
├── Renderer/
│   ├── AAPLRenderer.m
│   ├── AAPLShaders.metal
│   └── AAPLShaderTypes.h
└── Application/
    ├── AAPLRenderViewController.m
    ├── main.m
    ├── iOS/
    │   └── AAPLSplitViewController.m
    ├── WindowSceneDelegate.m
    ├── AAPLAppDelegate.h
    └── AAPLAppDelegate.m

Structure observations

  • The entry/composition boundary and renderer or operation boundary are separate in the source; AAPLRenderer is the principal feature coordinator.
  • GPU-specific logic stays in Metal shader files; shared headers bridge host/shader layouts where present.
  • The tree above is intentionally pruned to composition, resource, and shader files.

Overall architecture

Reference code

Renderer/AAPLRenderer.m:515 — feature handoff or setup anchor

    id<MTLDynamicLibrary> dynamicLib = [_device newDynamicLibrary:lib
                                                            error:&error];
    if(!dynamicLib && error)
    {
        NSLog(@"Error creating dynamic library from source library: %@", error);
        return;
    }

Interpretation

This is the dominant control/data path: platform code composes AAPLRenderer; that object controls runtime Metal library linking; GPU-visible work ends in functions loaded from a dynamic library. The arrows summarize responsibility transfer, not a claim that every node directly calls the next.

Ownership and state

Ownership evidence

Application/AAPLRenderViewController.m:50AAPLRenderViewController creates and stores _renderer

@implementation AAPLRenderViewController
// ...
    _renderer = [[AAPLRenderer alloc] initWithMetalKitView:_view];
// ...
@end
Owner Object or state Relationship Mutation authority
AAPLRenderViewController _renderer / AAPLRenderer Creates and stores; the diagram uses composition because construction is source-visible. The declaring scope performs setup and replacement.
AAPLRenderer Feature-specific framework and Metal resources Operation-local calls or stored state; exclusive lifetime is not assumed beyond cited evidence. Feature setup/encoding code controls mutation and command submission.

Class and protocol design

Type Responsibility Depends on or conforms to Source
AAPLEditViewController selects/configures the view and composes the feature objects. PlatformViewController Application/AAPLEditViewController.h:20
AAPLRenderViewController selects/configures the view and composes the feature objects. PlatformViewController Application/AAPLRenderViewController.h:18
AAPLSplitViewController selects/configures the view and composes the feature objects. UISplitViewController Application/iOS/AAPLSplitViewController.h:12
AAPLRenderer owns pipeline/resource setup and per-frame command encoding. NSObject, MTKViewDelegate Renderer/AAPLRenderer.h:14
AAPLAppDelegate handles application/window lifecycle callbacks. PlatformAppDelegate Application/AAPLAppDelegate.h:18
WindowSceneDelegate handles application/window lifecycle callbacks. UIResponder, UIWindowSceneDelegate Application/WindowSceneDelegate.h:15

Framework delegate conformance is a callback seam; the source does not justify calling the whole app protocol-oriented.

Access control

Symbol Access Verified effect Design reason
AAPLAppDelegate header-visible available to translation units that import the header; this is not Swift public. Keep the usable surface no wider than the collaboration requires. (Application/AAPLAppDelegate.h:18)
AAPLRenderer implementation details implementation-only native helpers, stored state, or registration code stays out of the imported header contract. Hide native implementation details from importing translation units. (Renderer/AAPLRenderer.m:1)
AAPLUserDylib function Metal dynamic-library boundary the host preloads a runtime-created library whose symbol satisfies the base pipeline’s linked call. Keep the replaceable function at the dynamic-library seam. (Renderer/AAPLUserDylib.metal:12)

This sample does not use Swift private, fileprivate, or public for its native boundary. Objective-C/Objective-C++ use header versus implementation placement, C++ uses access specifiers/linkage, Python uses module conventions, and Metal entry points cross a compiled-library boundary; these are not Swift access levels.

Logic ownership and placement

Logic Owning type or file Why it lives there
Selects/configures the view and composes the feature objects AAPLEditViewControllerApplication/AAPLEditViewController.h:20 The type’s callbacks and stored state align with this responsibility.
Selects/configures the view and composes the feature objects AAPLRenderViewControllerApplication/AAPLRenderViewController.h:18 The type’s callbacks and stored state align with this responsibility.
Selects/configures the view and composes the feature objects AAPLSplitViewControllerApplication/iOS/AAPLSplitViewController.h:12 The type’s callbacks and stored state align with this responsibility.
Owns pipeline/resource setup and per-frame command encoding AAPLRendererRenderer/AAPLRenderer.h:14 The type’s callbacks and stored state align with this responsibility.
Runtime Metal library linking AAPLRenderer / Renderer/AAPLRenderer.m:515 Keeps Metal/framework setup and encoding out of entry or lifecycle code.
Functions loaded from a dynamic library Renderer/AAPLUserDylib.metal:12 The replaceable implementation remains in the Metal dynamic-library boundary.

Shader boundary reference

Renderer/AAPLUserDylib.metal:12 — default dynamically linked function implementation

float4 AAPLUserDylib::getFullScreenColor(float4 inColor)
{
    return float4(inColor.r, inColor.g, inColor.b, 0);
}

Design patterns

Pattern Source evidence Purpose or tradeoff
Renderer boundary Renderer/AAPLRenderer.m:515 UI/lifecycle code composes a renderer while GPU state and encoding stay together.
Runtime shader composition Application/AAPLRenderViewController.m:50 Makes the sample’s runtime Metal library linking an explicit, reviewable boundary.
Configuration-driven pipeline Renderer/AAPLUserDylib.metal:12 Keeps the replaceable function contract stable while the host swaps its library implementation.

Naming conventions

  • Role suffixes make ownership visible: AAPLEditViewController, AAPLRenderViewController, AAPLSplitViewController, AAPLRenderer, AAPLAppDelegate, WindowSceneDelegate.
  • Method names describe setup or encoding actions: application, applicationShouldTerminateAfterLastWindowClosed, viewDidLoad, onClick, registerForKeyboardNotifications, keyboardWasShown, keyboardWillBeHidden.
  • Shader entry points use stage/operation names: vertexShader, fragmentShader, dylibKernel.
  • AAPL is a sample namespace prefix, not a recommendation for production module naming; retain semantic suffixes such as Renderer, Manager, Scene, or Adapter.

Architecture takeaways

  • Keep AAPLEditViewController focused on composition; AAPLRenderer is the owner of runtime Metal library linking.
  • Treat functions loaded from a dynamic library as a separate execution/compilation boundary with explicit resource and data-layout contracts.
  • The verified ownership edge is AAPLRenderViewController_renderer; broader exclusive ownership is not inferred.
  • Access-control rationale follows concrete language boundaries rather than translating every header or shader symbol into Swift terms.

Source map

Source file Architectural role
Renderer/AAPLRenderer.m AAPLRenderer
Application/AAPLRenderViewController.m AAPLRenderViewController
Renderer/AAPLShaders.metal Vertex, ColorInOut
Application/main.m entry point or feature implementation
Application/iOS/AAPLSplitViewController.m AAPLSplitViewController, AAPLSplitViewController
Application/WindowSceneDelegate.m WindowSceneDelegate
Renderer/AAPLShaderTypes.h entry point or feature implementation
Application/AAPLAppDelegate.h AAPLAppDelegate
Application/AAPLAppDelegate.m AAPLAppDelegate, AAPLAppDelegate