Streaming large images with Metal sparse textures
At a glance
| Item | Summary |
|---|---|
| Purpose | Limit texture memory usage for large textures by loading or unloading image detail on the basis of MIP and tile region. |
| App architecture | A C/Objective-C header, Metal, Objective-C, Objective-C++ sample with the source-visible chain main → AAPLViewController → AAPLRenderer → Metal APIs. |
| Main patterns | View-controller organization, Delegate or data-source callbacks |
| Project style | 19 scanned source file(s) across C/Objective-C header, Metal, Objective-C, Objective-C++, organized around ranked entry, type, and file boundaries. |
| Execution model | No structured execution marker indexed; callback threading requires source review. |
| State/event model | No structured observation or publisher-scheduling marker indexed. |
| Key frameworks/packages | UIKit, Cocoa, Metal, simd, stdlib.h; these are source dependencies, not architecture labels. |
Project structure
Source bundle/
├── Application/
│ ├── main.m
│ ├── AAPLAppDelegate.h
│ ├── AAPLAppDelegate.m
│ ├── AAPLViewController.h
│ ├── AAPLViewController.m
│ ├── WindowSceneDelegate.h
│ └── WindowSceneDelegate.m
└── Renderer/
├── AAPLRenderer.h
├── AAPLRenderer.m
├── Sparse Texture/
│ ├── AAPLSparseTexture.mm
│ └── AAPLStreamedTextureDataBacking.mm
└── Shaders/
└── AAPLShaders.metal
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, Objective-C, Objective-C++.
- The verified tree contains 8 project/configuration file(s) and 10 source declaration(s).
Overall architecture
flowchart LR
N1["main"]
N2["AAPLViewController"]
N3["AAPLRenderer"]
N4["Metal APIs"]
N1 --> N2
N2 --> N3
N3 --> N4
Reference code
Application/main.m:19 — architecture anchor
#if TARGET_OS_IOS
int main(int argc, char* argv[])
{
@autoreleasepool
{
return UIApplicationMain(argc, argv, nil, NSStringFromClass([AAPLAppDelegate class]));
}
}
#endifInterpretation
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 Metal.
Ownership and state
classDiagram
WindowSceneDelegate o-- UIWindow : window
AAPLRenderer o-- bool : animationEnabled
AAPLRenderer o-- NSString : infoString
AAPLSparseTexture o-- id : sparseTexture
Ownership evidence
Application/WindowSceneDelegate.h:18 — stored dependency or nearest verified ownership anchor
#if TARGET_OS_IPHONE
@property (nonatomic, strong) UIWindow *window;
#endif| Owner | Object or state | Relationship | Mutation authority |
|---|---|---|---|
WindowSceneDelegate |
UIWindow (window) |
retains or copies an assigned value | Header-visible collaborators |
AAPLRenderer |
bool (animationEnabled) |
stores or receives | Header-visible collaborators |
AAPLRenderer |
NSString (infoString) |
stores or receives | Header-visible collaborators |
AAPLSparseTexture |
id (sparseTexture) |
stores or receives | The declaring implementation writes; property clients read |
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.
No source-visible execution, scheduling, or synchronization boundary was found in the indexed source.
@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.
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 | UIKit |
The cited file imports this module; runtime use and architectural role are not inferred. | Application/AAPLAppDelegate.h:11 |
| Source import | Cocoa |
The cited file imports this module; runtime use and architectural role are not inferred. | Application/AAPLAppDelegate.h:19 |
| Source import | Metal |
The cited file imports this module; runtime use and architectural role are not inferred. | Application/AAPLViewController.h:9 |
| Source import | simd |
The cited file imports this module; runtime use and architectural role are not inferred. | Renderer/AAPLMathUtilities.h:11 |
| Source import | stdlib.h |
The cited file imports this module; runtime use and architectural role are not inferred. | Renderer/AAPLMathUtilities.h:10 |
| Source import | sys |
The cited file imports this module; runtime use and architectural role are not inferred. | Renderer/Sparse Texture/AAPLStreamedTextureDataBacking.mm:9 |
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
Application/AAPLAppDelegate.h:13 — representative type boundary
#if TARGET_OS_IOS
@interface AAPLAppDelegate : UIResponder <UIApplicationDelegate>
@end
#endif| Type | Responsibility | Depends on or conforms to |
|---|---|---|
AAPLAppDelegate |
Receives callback-driven events | UIResponder, UIApplicationDelegate |
AAPLViewController |
View lifecycle, callbacks, and feature coordination | PlatformViewController |
WindowSceneDelegate |
Receives callback-driven events | UIResponder, UIWindowSceneDelegate |
AAPLRenderer |
Owns drawing, GPU, or presentation processing | NSObject |
TextureTile |
Represents a feature value or composable behavior | Concrete collaborators/imported frameworks |
stat |
Represents a feature value or composable behavior | Concrete collaborators/imported frameworks |
FragmentIn |
Represents a feature value or composable behavior | Concrete collaborators/imported frameworks |
AAPLPointerLRUCache |
Owns feature behavior and collaborator lifecycle | Concrete collaborators/imported frameworks |
AAPLSparseTexture |
Defines a feature-specific type boundary | NSObject |
AAPLStreamedTextureDataBacking |
Defines a feature-specific type boundary | NSObject |
No local protocol conformance is claimed as protocol-oriented design; external framework conformances are listed only as dependencies.
Access control
| Symbol | Access | Verified effect | Likely rationale |
|---|---|---|---|
window (Application/WindowSceneDelegate.h:18) |
header-visible |
The declaration is exposed to translation units that import the header. | Inference: declare a contract needed by other Objective-C/C translation units. |
animationEnabled (Renderer/AAPLRenderer.h:21) |
header-visible |
The declaration is exposed to translation units that import the header. | Inference: declare a contract needed by other Objective-C/C translation units. |
infoString (Renderer/AAPLRenderer.h:24) |
header-visible |
The declaration is exposed to translation units that import the header. | Inference: declare a contract needed by other Objective-C/C translation units. |
sparseTexture (Renderer/Sparse Texture/AAPLSparseTexture.h:25) |
header-visible |
The declaration is exposed to translation units that import the header. | Inference: declare a contract needed by other Objective-C/C translation units. |
Reference code
Application/WindowSceneDelegate.h:18 — representative boundary
#if TARGET_OS_IPHONE
@property (nonatomic, strong) UIWindow *window;
#endifSwift 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 | AAPLViewController |
The source’s Controller suffix makes this role explicit. |
| Receives callback-driven events | AAPLAppDelegate, WindowSceneDelegate |
The source’s Delegate suffix makes this role explicit. |
| Owns drawing, GPU, or presentation processing | AAPLRenderer |
The source’s Renderer suffix makes this role explicit. |
Design patterns
| Pattern | Source evidence | Purpose or tradeoff |
|---|---|---|
| View-controller organization | Application/AAPLViewController.h:20 |
A controller is the verified coordination boundary; this is MVC-style only where a separate model is present. |
| Delegate or data-source callbacks | Application/AAPLAppDelegate.h:13 |
Callback protocols invert event delivery back into the sample’s owner. |
Main application flow
sequenceDiagram
participant AAPLSparseTexture
participant _commandQueue
participant cmdBuffer
participant _sparseTextureBacking
participant MTLTextureDescriptor
participant _device
participant NSData
AAPLSparseTexture->>_commandQueue: commandBuffer()
AAPLSparseTexture->>cmdBuffer: blitCommandEncoder()
AAPLSparseTexture->>_sparseTextureBacking: calculateMipmapRegion()
AAPLSparseTexture->>MTLTextureDescriptor: alloc()
AAPLSparseTexture->>_device: newTextureWithDescriptor()
AAPLSparseTexture->>NSData: dataWithBytesNoCopy()
AAPLSparseTexture->>cmdBuffer: commit()
AAPLSparseTexture->>cmdBuffer: waitUntilCompleted()
Reference code
Renderer/Sparse Texture/AAPLSparseTexture.mm:813 — blitMipmapTails()
[cmdBuffer commit];
Naming conventions
- Types: Controller: AAPLViewController; Delegate: AAPLAppDelegate, WindowSceneDelegate; Renderer: AAPLRenderer.
- Protocols: no local protocol declaration in the scanned source.
- Methods:
application,applicationDidFinishLaunching,applicationWillTerminate,applicationShouldTerminateAfterLastWindowClosed,viewDidLoad,optionsChanged,mtkView,drawInMTKView. - Files:
Application/AAPLAppDelegate.h,Application/AAPLAppDelegate.m,Application/AAPLViewController.h,Application/AAPLViewController.m,Application/WindowSceneDelegate.h,Application/WindowSceneDelegate.m.
Architecture takeaways
mainis the main source-visible entry or composition anchor for this sample.- Framework work reaches UIKit, Cocoa, Metal, simd 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.
- The source does not justify labeling the design protocol-oriented.
Source map
| Source file | Relevant symbols |
|---|---|
Application/main.m |
Cited implementation, Feature implementation |
Application/WindowSceneDelegate.h |
Cited implementation, window, WindowSceneDelegate |
Application/AAPLAppDelegate.h |
AAPLAppDelegate, Cited implementation, UIKit, Cocoa |
Renderer/AAPLRenderer.h |
animationEnabled, infoString, AAPLRenderer |
Renderer/Sparse Texture/AAPLSparseTexture.h |
sparseTexture, AAPLSparseTexture |
Application/AAPLViewController.h |
AAPLViewController, Metal |
Renderer/AAPLMathUtilities.h |
simd, stdlib.h, Feature implementation |
Renderer/Sparse Texture/AAPLStreamedTextureDataBacking.mm |
sys, AAPLStreamedTextureDataBacking, stat |
Application/AAPLAppDelegate.m |
AAPLAppDelegate |
Application/AAPLViewController.m |
AAPLViewController |
Application/WindowSceneDelegate.m |
WindowSceneDelegate |
Renderer/AAPLRenderer.m |
AAPLRenderer |
Renderer/Sparse Texture/AAPLSparseTexture.mm |
TextureTile, AAPLSparseTexture |
Renderer/Shaders/AAPLShaders.metal |
FragmentIn |
Renderer/Sparse Texture/AAPLPointerLRUCache.h |
AAPLPointerLRUCache |
Renderer/Sparse Texture/AAPLStreamedTextureDataBacking.h |
AAPLStreamedTextureDataBacking |