Creating a fog effect using scene depth
At a glance
| Item | Summary |
|---|---|
| Purpose | Apply virtual fog to the physical environment. |
| App architecture | A C/Objective-C header, Metal, Swift sample with the source-visible chain AppDelegate → ViewController → RenderDestinationProvider → ARKit APIs. |
| Main patterns | View-controller organization, Protocol-oriented abstraction, Delegate or data-source callbacks |
| Project style | 6 scanned source file(s) across C/Objective-C header, Metal, Swift, organized around ranked entry, type, and file boundaries. |
| Execution model | Source-visible boundaries: DispatchSemaphore, DispatchQueue.main.async; none alone proves a background thread. |
| State/event model | No structured observation or publisher-scheduling marker indexed. |
| Key frameworks/packages | ARKit, Metal, MetalKit, simd, UIKit; these are source dependencies, not architecture labels. |
Project structure
Source bundle/
├── ARDepthDataExample/
│ ├── Renderer.swift
│ ├── AppDelegate.swift
│ ├── ViewController.swift
│ ├── ARDepthDataExampleSwift-Bridging-Header.h
│ ├── ShaderTypes.h
│ ├── Shaders.metal
│ ├── Base.lproj/
│ │ └── Main.storyboard
│ └── Info.plist
├── ARDepthDataExample.xcodeproj/
│ ├── .xcodesamplecode.plist
│ └── project.pbxproj
└── Configuration/
└── SampleCode.xcconfig
Structure observations
- Architecturally prominent files are ranked from entry points and role-named declarations; resource-only paths are omitted.
- Primary languages: C/Objective-C header, Metal, Swift.
- The verified tree contains 5 project/configuration file(s) and 4 source declaration(s).
Overall architecture
flowchart LR
N1["AppDelegate"]
N2["ViewController"]
N3["RenderDestinationProvider"]
N4["ARKit APIs"]
N1 --> N2
N2 --> N3
N3 --> N4
Reference code
ARDepthDataExample/AppDelegate.swift:11 — architecture anchor
@UIApplicationMain
class AppDelegate: UIResponder, UIApplicationDelegate {
var window: UIWindow?
func application(_ application: UIApplication, didFinishLaunchingWithOptions launchOptions: [UIApplication.LaunchOptionsKey: Any]?) -> Bool {
if !ARWorldTrackingConfiguration.supportsFrameSemantics(.sceneDepth) ||
!ARWorldTrackingConfiguration.supportsFrameSemantics(.smoothedSceneDepth) {
// Ensure that the device supports scene depth and present
// an error-message view controller, if not.
let storyboard = UIStoryboard(name: "Main", bundle: nil)
window?.rootViewController = storyboard.instantiateViewController(withIdentifier: "unsupportedDeviceMessage")
}
return true
}
}Interpretation
The arrows summarize the source-visible entry, role-named types or folders, and framework direction; when nodes come from structural folders, the sequence is a high-level interpretation rather than proof that every adjacent node calls the next. Ownership is claimed only where the next section cites a stored property or assignment. The diagram is intentionally limited to the dominant path into ARKit.
Ownership and state
classDiagram
Renderer *-- Int : kMaxBuffersInFlight
Renderer *-- Array : kImagePlaneVertexData
Renderer o-- ARSession : session
Renderer o-- MTLDevice : device
Ownership evidence
ARDepthDataExample/Renderer.swift:22 — stored dependency or nearest verified ownership anchor
let kMaxBuffersInFlight: Int = 3| Owner | Object or state | Relationship | Mutation authority |
|---|---|---|---|
Renderer |
Int (kMaxBuffersInFlight) |
owns value state | Initialized by the owner; the binding is immutable |
Renderer |
Array (kImagePlaneVertexData) |
owns value state | Initialized by the owner; the binding is immutable |
Renderer |
ARSession (session) |
stores or receives | Initialized by the owner; the binding is immutable |
Renderer |
MTLDevice (device) |
stores or receives | Initialized by the owner; the binding is immutable |
Composition arrows indicate a source-visible construction expression or locally owned value state; aggregation means the owner stores or receives a dependency without proving exclusive lifetime ownership.
Concurrency, scheduling, and thread safety
Evidence limit: actor isolation, async/await, or Task creation does not by itself prove background-thread execution; Sendable conformance alone does not prove thread-safe mutation.
| Concern | Source mechanism | Verified placement or handoff | Evidence |
|---|---|---|---|
| Synchronization | DispatchSemaphore |
The source references a synchronization primitive; the protected state requires surrounding review. | ARDepthDataExample/Renderer.swift:35 |
| Queue scheduling | DispatchQueue.main.async |
The source addresses the main dispatch queue. | ARDepthDataExample/ViewController.swift:89 |
@MainActor/MainActor.run, DispatchQueue.main, and RunLoop.main are reported as distinct isolation, queue, and event-loop mechanisms. A plain Task is kept separate from Task.detached; neither is labeled as a background thread.
Reference code
ARDepthDataExample/Renderer.swift:35 — representative execution boundary
class Renderer {
// ...
let inFlightSemaphore = DispatchSemaphore(value: kMaxBuffersInFlight)
// ...
}State propagation, frameworks, and dependencies
Evidence limit: an import proves a source-level compilation dependency at the cited line; it does not prove runtime use, architectural adoption, or whether a Swift package is a direct application dependency.
| Category | Mechanism or module | Verified role | Evidence |
|---|---|---|---|
| Source import | ARKit |
The cited file imports this module; runtime use and architectural role are not inferred. | ARDepthDataExample/AppDelegate.swift:9 |
| Source import | Metal |
The cited file imports this module; runtime use and architectural role are not inferred. | ARDepthDataExample/Renderer.swift:9 |
| Source import | MetalKit |
The cited file imports this module; runtime use and architectural role are not inferred. | ARDepthDataExample/Renderer.swift:10 |
| Source import | simd |
The cited file imports this module; runtime use and architectural role are not inferred. | ARDepthDataExample/ShaderTypes.h:11 |
| Source import | UIKit |
The cited file imports this module; runtime use and architectural role are not inferred. | ARDepthDataExample/AppDelegate.swift:8 |
| Source import | Foundation |
The cited file imports this module; runtime use and architectural role are not inferred. | ARDepthDataExample/Renderer.swift:8 |
receive(on:) describes downstream delivery scheduling, while subscribe(on:) describes upstream subscription/request/cancel scheduling. An import Combine alone establishes neither behavior nor a Store, reducer, Redux, or other application architecture.
Class and protocol design
ARDepthDataExample/Renderer.swift:14 — representative type boundary
protocol RenderDestinationProvider {
var currentRenderPassDescriptor: MTLRenderPassDescriptor? { get }
var currentDrawable: CAMetalDrawable? { get }
var colorPixelFormat: MTLPixelFormat { get set }
var sampleCount: Int { get set }
}| Type | Responsibility | Depends on or conforms to |
|---|---|---|
AppDelegate |
Receives callback-driven events | UIResponder, UIApplicationDelegate |
RenderDestinationProvider |
Defines a capability or collaboration contract | Concrete collaborators/imported frameworks |
Renderer |
Owns drawing, GPU, or presentation processing | Concrete collaborators/imported frameworks |
ViewController |
View lifecycle, callbacks, and feature coordination | UIViewController, MTKViewDelegate, ARSessionDelegate |
The source explicitly defines local protocol relationships: MTKView → RenderDestinationProvider.
Access control
| Symbol | Access | Verified effect | Likely rationale |
|---|---|---|---|
setMTLPixelFormat (ARDepthDataExample/Renderer.swift:226) |
fileprivate |
Use is restricted to this source file. | Inference: share with same-file helpers or extensions without exposing the symbol module-wide. |
ViewController (ARDepthDataExample/ViewController.swift:8) |
implicit internal |
No explicit modifier means the Swift declaration is internal to the module. | Inference: app-target collaboration needs no exported library surface. |
Reference code
ARDepthDataExample/Renderer.swift:226 — representative boundary
fileprivate func setMTLPixelFormat(_ texturePixelFormat: inout MTLPixelFormat?, basedOn pixelBuffer: CVPixelBuffer!) {
// ...
texturePixelFormat = .r32Float
// ...
}Swift declarations without a modifier are internal; explicit private, fileprivate, private(set), public, or open entries above are interpreted by language semantics. Objective-C/C samples instead rely on header and implementation boundaries, which are not equivalent to Swift lexical privacy.
Logic ownership and placement
| Logic | Owning type or file | Placement rationale |
|---|---|---|
| View lifecycle, callbacks, and feature coordination | ViewController |
The source’s Controller suffix makes this role explicit. |
| Receives callback-driven events | AppDelegate |
The source’s Delegate suffix makes this role explicit. |
| Supplies a capability or framework resource | RenderDestinationProvider |
The source’s Provider suffix makes this role explicit. |
| Owns drawing, GPU, or presentation processing | Renderer |
The source’s Renderer suffix makes this role explicit. |
Design patterns
| Pattern | Source evidence | Purpose or tradeoff |
|---|---|---|
| View-controller organization | ARDepthDataExample/ViewController.swift:16 |
A controller is the verified coordination boundary; this is MVC-style only where a separate model is present. |
| Protocol-oriented abstraction | ARDepthDataExample/ViewController.swift:13 |
A local protocol and concrete conformance create an explicit capability boundary. |
| Delegate or data-source callbacks | ARDepthDataExample/AppDelegate.swift:12 |
Callback protocols invert event delivery back into the sample’s owner. |
Naming conventions
- Types: Controller: ViewController; Delegate: AppDelegate; Provider: RenderDestinationProvider; Renderer: Renderer.
- Protocols:
RenderDestinationProvider. - Methods:
drawRectResized,update,loadMetal,updateAppState,updateCameraImageTextures,setMTLPixelFormat,updateARDepthTexures,createTexture. - Files:
ARDepthDataExample/Renderer.swift,ARDepthDataExample/AppDelegate.swift,ARDepthDataExample/ViewController.swift.
Architecture takeaways
AppDelegateis the main source-visible entry or composition anchor for this sample.- Framework work reaches ARKit, Metal, MetalKit, UIKit through a deliberately small high-level chain; the detailed API graph remains inside the cited implementation files.
- Stored-property evidence identifies lifecycle collaboration; it does not by itself prove exclusive object ownership.
- Access-control conclusions separate verified language visibility from the likely design rationale.
- Local protocol relationships provide an explicit substitution boundary.
Source map
| Source file | Relevant symbols |
|---|---|
ARDepthDataExample/AppDelegate.swift |
Cited implementation, ARKit, UIKit, AppDelegate |
ARDepthDataExample/Renderer.swift |
Cited implementation, RenderDestinationProvider, DispatchSemaphore, Metal, MetalKit, Foundation, Renderer |
ARDepthDataExample/ViewController.swift |
ViewController, Cited implementation, DispatchQueue.main.async |
ARDepthDataExample/ShaderTypes.h |
simd, Feature implementation |
ARDepthDataExample/ARDepthDataExampleSwift-Bridging-Header.h |
Feature implementation |
ARDepthDataExample/Shaders.metal |
Feature implementation |