Effecting People Occlusion in Custom Renderers
At a glance
| Item | Summary |
|---|---|
| Purpose | Occlude your app’s virtual content where ARKit recognizes people in the camera feed by using matte generator. |
| 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. |
Project structure
Source bundle/
├── ARMatteExampleSwift/
│ ├── Renderer.swift
│ ├── AppDelegate.swift
│ ├── ViewController.swift
│ ├── ARMatteExampleSwift-Bridging-Header.h
│ ├── ShaderTypes.h
│ ├── Shaders.metal
│ ├── Base.lproj/
│ │ ├── LaunchScreen.storyboard
│ │ └── Main.storyboard
│ └── Info.plist
├── ARMatteExampleSwift.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 6 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
ARMatteExampleSwift/AppDelegate.swift:10 — architecture anchor
@UIApplicationMain
class AppDelegate: UIResponder, UIApplicationDelegate {
// ...
}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 *-- Int : kMaxAnchorInstanceCount
Renderer *-- Int : kAlignedSharedUniformsSize
Renderer *-- Int : kAlignedInstanceUniformsSize
Ownership evidence
ARMatteExampleSwift/Renderer.swift:22 — stored dependency or nearest verified ownership anchor
let kMaxBuffersInFlight: Int = 3
// The max number anchors our uniform buffer will hold
let kMaxAnchorInstanceCount: Int = 64
// The 16 byte aligned size of our uniform structures
let kAlignedSharedUniformsSize: Int = (MemoryLayout<SharedUniforms>.size & ~0xFF) + 0x100| Owner | Object or state | Relationship | Mutation authority |
|---|---|---|---|
Renderer |
Int (kMaxBuffersInFlight) |
owns value state | Initialized by the owner; the binding is immutable |
Renderer |
Int (kMaxAnchorInstanceCount) |
owns value state | Initialized by the owner; the binding is immutable |
Renderer |
Int (kAlignedSharedUniformsSize) |
owns value state | Initialized by the owner; the binding is immutable |
Renderer |
Int (kAlignedInstanceUniformsSize) |
owns value state | 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.
Class and protocol design
ARMatteExampleSwift/Renderer.swift:13 — representative type boundary
protocol RenderDestinationProvider {
var currentRenderPassDescriptor: MTLRenderPassDescriptor? { get }
var currentDrawable: CAMetalDrawable? { get }
var colorPixelFormat: MTLPixelFormat { get set }
var depthStencilPixelFormat: 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 |
|---|---|---|---|
AppDelegate (ARMatteExampleSwift/AppDelegate.swift:11) |
implicit internal |
No explicit modifier means the Swift declaration is internal to the module. | Inference: app-target collaboration needs no exported library surface. |
RenderDestinationProvider (ARMatteExampleSwift/Renderer.swift:13) |
implicit internal |
No explicit modifier means the Swift declaration is internal to the module. | Inference: app-target collaboration needs no exported library surface. |
Renderer (ARMatteExampleSwift/Renderer.swift:39) |
implicit internal |
No explicit modifier means the Swift declaration is internal to the module. | Inference: app-target collaboration needs no exported library surface. |
ViewController (ARMatteExampleSwift/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
ARMatteExampleSwift/AppDelegate.swift:11 — representative boundary
class AppDelegate: UIResponder, UIApplicationDelegate {
// ...
}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 | ARMatteExampleSwift/ViewController.swift:16 |
A controller is the verified coordination boundary; this is MVC-style only where a separate model is present. |
| Protocol-oriented abstraction | ARMatteExampleSwift/ViewController.swift:13 |
A local protocol and concrete conformance create an explicit capability boundary. |
| Delegate or data-source callbacks | ARMatteExampleSwift/AppDelegate.swift:11 |
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,loadAssets,updateBufferStates,updateGameState,updateSharedUniforms,updateAnchors. - Files:
ARMatteExampleSwift/Renderer.swift,ARMatteExampleSwift/AppDelegate.swift,ARMatteExampleSwift/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 |
|---|---|
ARMatteExampleSwift/Renderer.swift |
RenderDestinationProvider, Renderer |
ARMatteExampleSwift/AppDelegate.swift |
AppDelegate |
ARMatteExampleSwift/ViewController.swift |
ViewController |
ARMatteExampleSwift/ARMatteExampleSwift-Bridging-Header.h |
Feature implementation |
ARMatteExampleSwift/ShaderTypes.h |
Feature implementation |
ARMatteExampleSwift/Shaders.metal |
Feature implementation |