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

Encoding argument buffers on the GPU

At a glance

Item Summary
Purpose Use a compute pass to encode an argument buffer and access its arguments in a subsequent render pass.
App architecture Objective-C host code with Metal shaders; AAPLViewController hands work to AAPLRenderer, which owns GPU-side argument-buffer encoding before argument-consuming raster stages.
Main patterns Renderer boundary, GPU-driven resource binding, Host-shader data contract
Scope High-level review of 11 scanned source files and 11 detected declarations; build assets are omitted.

Project structure

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

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:133 — feature handoff or setup anchor

            [computeFunction newArgumentEncoderWithBufferIndex:AAPLComputeBufferIndexSourceTextures];

        // Determine the size of a texture argument in a buffer.
        NSUInteger textureArgumentSize = argumentEncoder.encodedLength;

        // Calculate the size of the array of texture arguments neccessary to fit all textures in the buffer.
        NSUInteger textureArgumentArrayLength = textureArgumentSize * AAPLNumTextures;

Interpretation

This is the dominant control/data path: platform code composes AAPLRenderer; that object controls GPU-side argument-buffer encoding; GPU-visible work ends in argument-consuming raster stages. The arrows summarize responsibility transfer, not a claim that every node directly calls the next.

Ownership and state

Ownership evidence

Application/AAPLViewController.m:47AAPLViewController creates and stores _renderer

    _renderer = [[AAPLRenderer alloc] initWithMetalKitView:_view];

    NSAssert(_renderer, @"Renderer failed initialization");

    // Initialize our renderer with the view size
    [_renderer mtkView:_view drawableSizeWillChange:_view.drawableSize];

    _view.delegate = _renderer;
Owner Object or state Relationship Mutation authority
AAPLViewController _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
AAPLViewController selects/configures the view and composes the feature objects. PlatformViewController Application/AAPLViewController.h:20
AAPLRenderer owns pipeline/resource setup and per-frame command encoding. NSObject, MTKViewDelegate Renderer/AAPLRenderer.h:13
AAPLAppDelegate handles application/window lifecycle callbacks. UIResponder, UIApplicationDelegate Application/AAPLAppDelegate.h:10
WindowSceneDelegate handles application/window lifecycle callbacks. UIResponder, UIWindowSceneDelegate Application/WindowSceneDelegate.h:11

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:10)
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)
AAPLShaders entry points Metal library boundary host code resolves named shader entry points; Swift access modifiers do not apply. Expose only named shader entry points needed by pipeline creation. (Renderer/AAPLShaders.metal:30)

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 AAPLViewControllerApplication/AAPLViewController.h:20 The type’s callbacks and stored state align with this responsibility.
Owns pipeline/resource setup and per-frame command encoding AAPLRendererRenderer/AAPLRenderer.h:13 The type’s callbacks and stored state align with this responsibility.
Handles application/window lifecycle callbacks AAPLAppDelegateApplication/AAPLAppDelegate.h:10 The type’s callbacks and stored state align with this responsibility.
Handles application/window lifecycle callbacks WindowSceneDelegateApplication/WindowSceneDelegate.h:11 The type’s callbacks and stored state align with this responsibility.
GPU-side argument-buffer encoding AAPLRenderer / Renderer/AAPLRenderer.m:133 Keeps Metal/framework setup and encoding out of entry or lifecycle code.
Argument-consuming raster stages Renderer/AAPLShaders.metal:30 GPU-parallel code remains in the Metal compilation boundary.

Shader boundary reference

Renderer/AAPLShaders.metal:30 — representative GPU entry/helper

kernel void

Design patterns

Pattern Source evidence Purpose or tradeoff
Renderer boundary Renderer/AAPLRenderer.m:133 UI/lifecycle code composes a renderer while GPU state and encoding stay together.
GPU-driven resource binding Application/AAPLViewController.m:47 Makes the sample’s GPU-side argument-buffer encoding an explicit, reviewable boundary.
Host-shader data contract Renderer/AAPLRenderer.h:9 Shared indices/structs and matching bindings couple host encoding to shader signatures deliberately.

Naming conventions

  • Role suffixes make ownership visible: AAPLViewController, AAPLRenderer, AAPLAppDelegate, WindowSceneDelegate.
  • Method names describe setup or encoding actions: application, viewDidAppear, viewDidLoad, scene, sceneDidDisconnect, initWithMetalKitView, newDescriptorFromTexture.
  • Shader entry points use stage/operation names: updateInstances.
  • 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 AAPLViewController focused on composition; AAPLRenderer is the owner of GPU-side argument-buffer encoding.
  • Treat argument-consuming raster stages as a separate execution/compilation boundary with explicit resource and data-layout contracts.
  • The verified ownership edge is AAPLViewController_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/AAPLViewController.m AAPLViewController
Renderer/AAPLShaders.metal InstanceArguments, SourceTextureArguments, RasterizerData
Application/main.m entry point or feature implementation
Application/WindowSceneDelegate.m WindowSceneDelegate
Renderer/AAPLShaderTypes.h entry point or feature implementation
Application/AAPLAppDelegate.h AAPLAppDelegate
Application/AAPLAppDelegate.m AAPLAppDelegate
Application/AAPLViewController.h AAPLViewController