MetalKit · IOS API REFERENCE

MTKView

class · iOS 9.0+ · SDK 27.1

@MainActor class MTKView

Members (47)

method · iOS 9.0+

draw

TypeScript

draw(): Promise<void>

Swift declaration

func draw()

init · iOS 9.0+

init

TypeScript

static initCoder(coder: _Foundation_NSCoder): Promise<MTKView>

Swift declaration

init(coder: NSCoder)

init · iOS 9.0+

init

TypeScript

static initFrameDevice(frameRect: { x: number; y: number; width: number; height: number }, device?: (SDKHandle) | null): Promise<MTKView>

Swift declaration

init(frame frameRect: CGRect, device: (any MTLDevice)?)

method · iOS 9.0+

releaseDrawables

TypeScript

releaseDrawables(): Promise<void>

Swift declaration

func releaseDrawables()

get · iOS 9.0+

autoResizeDrawable

TypeScript

get autoResizeDrawable(): Promise<boolean>

Swift declaration

var autoResizeDrawable: Bool { get set }

set · iOS 9.0+

autoResizeDrawable

TypeScript

setAutoResizeDrawable(value: boolean): Promise<void>

Swift declaration

var autoResizeDrawable: Bool { get set }

get · iOS 9.0+

clearColor

TypeScript

get clearColor(): Promise<_Metal_MTLClearColor>

Swift declaration

var clearColor: MTLClearColor { get set }

set · iOS 9.0+

clearColor

TypeScript

setClearColor(value: _Metal_MTLClearColor): Promise<void>

Swift declaration

var clearColor: MTLClearColor { get set }

get · iOS 9.0+

clearDepth

TypeScript

get clearDepth(): Promise<number>

Swift declaration

var clearDepth: Double { get set }

set · iOS 9.0+

clearDepth

TypeScript

setClearDepth(value: number): Promise<void>

Swift declaration

var clearDepth: Double { get set }

get · iOS 9.0+

clearStencil

TypeScript

get clearStencil(): Promise<number>

Swift declaration

var clearStencil: UInt32 { get set }

set · iOS 9.0+

clearStencil

TypeScript

setClearStencil(value: number): Promise<void>

Swift declaration

var clearStencil: UInt32 { get set }

get · iOS 9.0+

colorPixelFormat

TypeScript

get colorPixelFormat(): Promise<_Metal_MTLPixelFormat>

Swift declaration

var colorPixelFormat: MTLPixelFormat { get set }

set · iOS 9.0+

colorPixelFormat

TypeScript

setColorPixelFormat(value: _Metal_MTLPixelFormat): Promise<void>

Swift declaration

var colorPixelFormat: MTLPixelFormat { get set }

get · iOS 9.0+

currentDrawable

TypeScript

get currentDrawable(): Promise<(SDKHandle) | null>

Swift declaration

var currentDrawable: (any CAMetalDrawable)? { get }

get · iOS 9.0+

currentRenderPassDescriptor

TypeScript

get currentRenderPassDescriptor(): Promise<(_Metal_MTLRenderPassDescriptor) | null>

Swift declaration

var currentRenderPassDescriptor: MTLRenderPassDescriptor? { get }

get · iOS 9.0+

delegate

TypeScript

get delegate(): Promise<(SDKHandle) | null>

Swift declaration

weak var delegate: (any MTKViewDelegate)? { get set }

set · iOS 9.0+

delegate

TypeScript

setDelegate(value?: (Implements<MTKViewDelegate> | SDKHandle) | null): Promise<void>

Swift declaration

weak var delegate: (any MTKViewDelegate)? { get set }

get · iOS 13.0+

depthStencilAttachmentTextureUsage

TypeScript

get depthStencilAttachmentTextureUsage(): Promise<_Metal_MTLTextureUsage>

Swift declaration

var depthStencilAttachmentTextureUsage: MTLTextureUsage { get set }

set · iOS 13.0+

depthStencilAttachmentTextureUsage

TypeScript

setDepthStencilAttachmentTextureUsage(value: _Metal_MTLTextureUsage): Promise<void>

Swift declaration

var depthStencilAttachmentTextureUsage: MTLTextureUsage { get set }

get · iOS 9.0+

depthStencilPixelFormat

TypeScript

get depthStencilPixelFormat(): Promise<_Metal_MTLPixelFormat>

Swift declaration

var depthStencilPixelFormat: MTLPixelFormat { get set }

set · iOS 9.0+

depthStencilPixelFormat

TypeScript

setDepthStencilPixelFormat(value: _Metal_MTLPixelFormat): Promise<void>

Swift declaration

var depthStencilPixelFormat: MTLPixelFormat { get set }

get · iOS 16.0+

depthStencilStorageMode

TypeScript

get depthStencilStorageMode(): Promise<_Metal_MTLStorageMode>

Swift declaration

var depthStencilStorageMode: MTLStorageMode { get set }

set · iOS 16.0+

depthStencilStorageMode

TypeScript

setDepthStencilStorageMode(value: _Metal_MTLStorageMode): Promise<void>

Swift declaration

var depthStencilStorageMode: MTLStorageMode { get set }

get · iOS 9.0+

depthStencilTexture

TypeScript

get depthStencilTexture(): Promise<(SDKHandle) | null>

Swift declaration

var depthStencilTexture: (any MTLTexture)? { get }

get · iOS 9.0+

device

TypeScript

get device(): Promise<(SDKHandle) | null>

Swift declaration

var device: (any MTLDevice)? { get set }

set · iOS 9.0+

device

TypeScript

setDevice(value?: (SDKHandle) | null): Promise<void>

Swift declaration

var device: (any MTLDevice)? { get set }

get · iOS 9.0+

drawableSize

TypeScript

get drawableSize(): Promise<{ width: number; height: number }>

Swift declaration

var drawableSize: CGSize { get set }

set · iOS 9.0+

drawableSize

TypeScript

setDrawableSize(value: { width: number; height: number }): Promise<void>

Swift declaration

var drawableSize: CGSize { get set }

get · iOS 9.0+

enableSetNeedsDisplay

TypeScript

get enableSetNeedsDisplay(): Promise<boolean>

Swift declaration

var enableSetNeedsDisplay: Bool { get set }

set · iOS 9.0+

enableSetNeedsDisplay

TypeScript

setEnableSetNeedsDisplay(value: boolean): Promise<void>

Swift declaration

var enableSetNeedsDisplay: Bool { get set }

get · iOS 9.0+

framebufferOnly

TypeScript

get framebufferOnly(): Promise<boolean>

Swift declaration

var framebufferOnly: Bool { get set }

set · iOS 9.0+

framebufferOnly

TypeScript

setFramebufferOnly(value: boolean): Promise<void>

Swift declaration

var framebufferOnly: Bool { get set }

get · iOS 13.0+

multisampleColorAttachmentTextureUsage

TypeScript

get multisampleColorAttachmentTextureUsage(): Promise<_Metal_MTLTextureUsage>

Swift declaration

var multisampleColorAttachmentTextureUsage: MTLTextureUsage { get set }

set · iOS 13.0+

multisampleColorAttachmentTextureUsage

TypeScript

setMultisampleColorAttachmentTextureUsage(value: _Metal_MTLTextureUsage): Promise<void>

Swift declaration

var multisampleColorAttachmentTextureUsage: MTLTextureUsage { get set }

get · iOS 9.0+

multisampleColorTexture

TypeScript

get multisampleColorTexture(): Promise<(SDKHandle) | null>

Swift declaration

var multisampleColorTexture: (any MTLTexture)? { get }

get · iOS 9.0+

isPaused

TypeScript

get isPaused(): Promise<boolean>

Swift declaration

var isPaused: Bool { get set }

set · iOS 9.0+

isPaused

TypeScript

setIsPaused(value: boolean): Promise<void>

Swift declaration

var isPaused: Bool { get set }

get · iOS 13.0+

preferredDevice

TypeScript

get preferredDevice(): Promise<(SDKHandle) | null>

Swift declaration

var preferredDevice: (any MTLDevice)? { get }

get · iOS 9.0+

preferredDrawableSize

TypeScript

get preferredDrawableSize(): Promise<{ width: number; height: number }>

Swift declaration

var preferredDrawableSize: CGSize { get }

get · iOS 9.0+

preferredFramesPerSecond

TypeScript

get preferredFramesPerSecond(): Promise<number>

Swift declaration

var preferredFramesPerSecond: Int { get set }

set · iOS 9.0+

preferredFramesPerSecond

TypeScript

setPreferredFramesPerSecond(value: number): Promise<void>

Swift declaration

var preferredFramesPerSecond: Int { get set }

get · iOS 9.0+

presentsWithTransaction

TypeScript

get presentsWithTransaction(): Promise<boolean>

Swift declaration

var presentsWithTransaction: Bool { get set }

set · iOS 9.0+

presentsWithTransaction

TypeScript

setPresentsWithTransaction(value: boolean): Promise<void>

Swift declaration

var presentsWithTransaction: Bool { get set }

get · iOS 26.4+

residencySet

TypeScript

get residencySet(): Promise<SDKHandle>

Swift declaration

var residencySet: any MTLResidencySet { get }

get · iOS 9.0+

sampleCount

TypeScript

get sampleCount(): Promise<number>

Swift declaration

var sampleCount: Int { get set }

set · iOS 9.0+

sampleCount

TypeScript

setSampleCount(value: number): Promise<void>

Swift declaration

var sampleCount: Int { get set }

Skipped declarations

1 declarations were excluded from these bindings. Each reason comes from the generator or the iOS SDK compiler.

MTKView.init()

inherited init: cannot prove legal (class declares 1 custom initializer)

All MetalKit types →