Home

Metal

GPU Devices

• Getting the Default GPU
• protocol MTLDevice
• Choosing GPUs on Mac
  • Device Selection and Fallback for Graphics Rendering {sample code}
  • Device Selection and Fallback for Compute Processing {sample code}
  • About External GPUs
  • About Multi-GPU and Multi-Display Setups
  • About GPU Bandwidth
  • Handling External GPU Additions and Removals
  • Getting Different Types of GPUs
  • Getting the GPU that Drives a View's Display

Command Setup

• Setting Up a Command Structure
• Devices and Commands {sample code}
• Labeling Metal Objects and Commands
• protocol MTLCommandQueue
• protocol MTLCommandBuffer
• protocol MTLCommandEncoder
• Advanced Command Setup
  • First Steps
    • CPU and GPU Synchronization {sample code}
    • About Synchronization Events
  • Shareable Events
    • protocol MTLSharedEvent
    • class MTLSharedEventListener
    • class MTLSharedEventHandle
    • Synchronizing Events Across Multiple Devices
    • Synchronizing Events Between a GPU and the CPU
  • Nonshareable Events
    • protocol MTLEvent
    • Image Filter Graph with Heaps and Events {sample code}
    • Synchronizing Events Within a Single Device
  • Fences
    • Image Filter Graph with Heaps and Fences {sample code}
  • Indirect Command Buffers
    • Encoding Indirect Command Buffers on the CPU {sample code}
    • Encoding Indirect Command Buffers on the GPU {sample code}
    • protocol MTLIndirectCommandBuffer
    • class MTLIndirectCommandBufferDescriptor
    • protocol MTLIndirectRenderCommand
    • struct MTLIndirectCommandType

Graphics

• Hello Triangle {sample code}
• Basic Buffers {sample code}
• Basic Texturing {sample code}
• protocol MTLRenderCommandEncoder
• protocol MTLParallelRenderCommandEncoder
• Render Pass
  • Descriptor
    • class MTLRenderPassDescriptor
  • Render Target
    • class MTLRenderPassAttachmentDescriptor
    • class MTLRenderPassColorAttachmentDescriptor
    • class MTLRenderPassColorAttachmentDescriptorArray
    • class MTLRenderPassDepthAttachmentDescriptor
    • class MTLRenderPassStencilAttachmentDescriptor
  • Programmable Sample Positions
    • Using Programmable Sample Positions
    • Handling MSAA Depth with Programmable Sample Positions
  • Dependency Viewing
    • Seeing a Frame's Render Passes with the Dependency Viewer
  • Sample Code
    • Deferred Lighting {sample code}
• Render Pipeline
  • State & Descriptor
    • protocol MTLRenderPipelineState
    • class MTLRenderPipelineDescriptor
  • Color
    • class MTLRenderPipelineColorAttachmentDescriptor
    • class MTLRenderPipelineColorAttachmentDescriptorArray
  • Depth and Stencil
    • protocol MTLDepthStencilState
    • class MTLDepthStencilDescriptor
    • class MTLStencilDescriptor
  • Tile Shading
    • class MTLTileRenderPipelineDescriptor
    • class MTLTileRenderPipelineColorAttachmentDescriptor
    • class MTLTileRenderPipelineColorAttachmentDescriptorArray
  • Statistics Viewing
    • Viewing Pipeline Statistics of a Draw
    • Viewing Performance Metrics with GPU Counters
• Vertex Data
  • Vertex Data
    • Inspecting Vertices with the Geometry Viewer
    • class MTLVertexDescriptor
    • class MTLVertexAttribute
    • class MTLVertexAttributeDescriptor
    • class MTLVertexAttributeDescriptorArray
    • class MTLVertexBufferLayoutDescriptor
    • class MTLVertexBufferLayoutDescriptorArray
  • Model Data
    • class MTKMesh
    • class MTKMeshBuffer
    • class MTKMeshBufferAllocator
    • class MTKSubmesh
    • Conversion Functions
    • Model Errors
• Presentation Objects
  • Metal Drawables
    • protocol MTLDrawable
    • protocol CAMetalDrawable
  • MetalKit View
    • class MTKView
    • protocol MTKViewDelegate
  • Core Animation Layer
    • class CAMetalLayer

Parallel Computation

• Hello Compute {sample code}
• About Threads and Threadgroups
• Calculating Threadgroup and Grid Sizes
• class MTLComputePipelineDescriptor
• protocol MTLComputePipelineState
• protocol MTLComputeCommandEncoder

Custom Functions

• GPU Functions & Libraries
  • Functions
    • About the Metal Shading Language Filename Extension
    • Resolving Shader Issues with the Shader Debugger
    • Optimizing Performance with the Shader Profiler
    • protocol MTLFunction
    • class MTLFunctionConstant
    • class MTLFunctionConstantValues
  • Libraries
    • Building a Library with Metal's Command-Line Tools
    • protocol MTLLibrary
    • class MTLCompileOptions
  • Input/Output Data
    • class MTLStageInputOutputDescriptor
    • class MTLAttribute
    • class MTLAttributeDescriptor
    • class MTLAttributeDescriptorArray
    • class MTLBufferLayoutDescriptor
    • class MTLBufferLayoutDescriptorArray
  • Reflection Data
    • struct MTLPipelineOption
    • class MTLComputePipelineReflection
    • class MTLRenderPipelineReflection
    • class MTLArgument
    • class MTLType
    • class MTLStructType
    • class MTLStructMember
    • class MTLArrayType
    • class MTLPointerType
    • class MTLTextureReferenceType

Resource Management

• protocol MTLBlitCommandEncoder
• Resource Objects
  • First Steps
    • Setting Resource Storage Modes
    • protocol MTLResource
  • Buffers
    • Basic Buffers {sample code}
    • protocol MTLBuffer
    • class MTLPipelineBufferDescriptor
    • class MTLPipelineBufferDescriptorArray
  • Textures
    • Basic Texturing {sample code}
    • About Color-Renderable Pixel Format Sizes
    • protocol MTLTexture
    • class MTLTextureDescriptor
    • class MTKTextureLoader
    • class MTLSharedTextureHandle
    • enum MTLPixelFormat
  • Samplers
    • protocol MTLSamplerState
    • class MTLSamplerDescriptor
  • Resource Heaps
    • Image Filter Graph with Heaps and Fences {sample code}
    • protocol MTLHeap
    • class MTLHeapDescriptor
    • protocol MTLFence
    • struct MTLSizeAndAlign
  • Argument Buffers
    • About Argument Buffers
    • Basic Argument Buffers {sample code}
    • Argument Buffers with Arrays and Resource Heaps {sample code}
    • Argument Buffers with GPU Encoding {sample code}
    • Dynamic Terrain with Argument Buffers {sample code}
    • Indexing Argument Buffers
    • Tracking the Resource Residency of Argument Buffers
    • protocol MTLArgumentEncoder
    • class MTLArgumentDescriptor
• Resource Dimensions

Tools

• Tools, Profiling, and Debugging
  • Files and Libraries
    • About the Metal Shading Language Filename Extension
    • Building a Library with Metal's Command-Line Tools
  • Frame Capture
    • Metal GPU Capture
      • Configuring the GPU Frame Capture and Metal API Validation Tools
      • Assigning a Default Capture Scope
      • Performing a GPU Capture Programmatically
      • Performing a GPU Capture from the Debug Bar
      • Performing a GPU Capture from a Breakpoint
      • class MTLCaptureManager
      • protocol MTLCaptureScope
    • Labeling Metal Objects and Commands
    • Seeing a Frame's Render Passes with the Dependency Viewer
  • Debugging
    • Inspecting Vertices with the Geometry Viewer
    • Resolving Shader Issues with the Shader Debugger
  • Profiling and Metrics
    • GPU Activity Monitors
      • Monitoring Your App's Graphics Activity
      • Monitoring Your Mac's GPU Activity
    • Optimizing Performance with the Shader Profiler
    • Viewing Performance Metrics with GPU Counters
    • Viewing Pipeline Statistics of a Draw

Cookbook

• Deferred Lighting {sample code}
• Reflections with Layer Selection {sample code}
• LOD with Function Specialization {sample code}

Interoperability

• Mixing Metal and OpenGL Rendering in a View {sample code}

MetalKit

• View Management
  • class MTKView
  • protocol MTKViewDelegate
• Texture Loading
  • class MTKTextureLoader
• Model Handling
  • class MTKMesh
  • class MTKMeshBuffer
  • class MTKMeshBufferAllocator
  • class MTKSubmesh
  • Conversion Functions
  • Model Errors
• Reference
  • MetalKit Functions
  • MetalKit Data Types

Metal Performance Shaders

• Fundamentals
  • The MPSKernel Class
  • Tuning Hints
• Image Filters
• Neural Networks
  • class MPSImage
  • class MPSTemporaryImage
  • Objects that Simplify the Creation of Neural Networks
  • Convolutional Neural Network Kernels
  • Recurrent Neural Networks
• Matrices and Vectors
• Ray Tracing
  • Metal for Accelerating Ray Tracing {sample code}
  • class MPSRayIntersector
  • class MPSAccelerationStructureGroup
  • class MPSInstanceAccelerationStructure
  • class MPSTriangleAccelerationStructure
  • class MPSAccelerationStructure
• Kernel Base Classes
  • class MPSKernel
• Keyed Archivers
  • class NSKeyedArchiver
  • class MPSKeyedUnarchiver
  • protocol MPSDeviceProvider
• Reference
  • MetalPerformanceShaders Structures
  • MetalPerformanceShaders Enumerations
  • MetalPerformanceShaders Constants
  • MetalPerformanceShaders Functions
  • MetalPerformanceShaders Data Types

See Also

• Metal Programming Guide
• Metal Shading Language Specification
• Metal Best Practices Guide
• Metal Feature Set Tables
• Metal sample code
• Metal sample code (old)
• Metal videos
• Model I/O