MetalPerformanceShaders · IOS API REFERENCE

MPSImage

class · iOS 10.0+ · SDK 27.1

class MPSImage

Members (32)

static · iOS 10.0+

defaultAllocator

TypeScript

static defaultAllocator(): SDKHandle

Swift declaration

class func defaultAllocator() -> any MPSImageAllocator

method · iOS 10.0+

batchRepresentation

TypeScript

batchRepresentation(): Array<MPSImage>

Swift declaration

func batchRepresentation() -> [MPSImage]

method · iOS 10.0+

batchRepresentation

TypeScript

batchRepresentationWithSubRange(subRange: SDKHandle): Array<MPSImage>

Swift declaration

func batchRepresentation(withSubRange subRange: NSRange) -> [MPSImage]

init · iOS 10.0+

init

TypeScript

static initDeviceImageDescriptor(device: SDKHandle, imageDescriptor: MPSImageDescriptor): MPSImage

Swift declaration

convenience init(device: any MTLDevice, imageDescriptor: MPSImageDescriptor)

init · iOS 10.0+

init

TypeScript

static initParentImageSliceRangeFeatureChannels(parent: MPSImage, sliceRange: SDKHandle, featureChannels: number): MPSImage

Swift declaration

init(parentImage parent: MPSImage, sliceRange: NSRange, featureChannels: Int)

init · iOS 10.0+

init

TypeScript

static initTextureFeatureChannels(texture: SDKHandle, featureChannels: number): MPSImage

Swift declaration

convenience init(texture: any MTLTexture, featureChannels: Int)

method · iOS 11.0+

readBytes

TypeScript

readBytesDataLayoutBytesPerRowBytesPerImageRegionFeatureChannelInfoImageIndex(dataBytes: SDKHandle, dataLayout: MPSDataLayout, bytesPerRow: number, bytesPerImage: number, region: _Metal_MTLRegion, featureChannelInfo: MPSImageReadWriteParams, imageIndex: number): void

Swift declaration

func readBytes(_ dataBytes: UnsafeMutableRawPointer, dataLayout: MPSDataLayout, bytesPerRow: Int, bytesPerImage: Int, region: MTLRegion, featureChannelInfo: MPSImageReadWriteParams, imageIndex: Int)

method · iOS 11.0+

readBytes

TypeScript

readBytesDataLayoutBytesPerRowRegionFeatureChannelInfoImageIndex(dataBytes: SDKHandle, dataLayout: MPSDataLayout, bytesPerRow: number, region: _Metal_MTLRegion, featureChannelInfo: MPSImageReadWriteParams, imageIndex: number): void

Swift declaration

func readBytes(_ dataBytes: UnsafeMutableRawPointer, dataLayout: MPSDataLayout, bytesPerRow: Int, region: MTLRegion, featureChannelInfo: MPSImageReadWriteParams, imageIndex: Int)

method · iOS 11.0+

readBytes

TypeScript

readBytesDataLayoutImageIndex(dataBytes: SDKHandle, dataLayout: MPSDataLayout, imageIndex: number): void

Swift declaration

func readBytes(_ dataBytes: UnsafeMutableRawPointer, dataLayout: MPSDataLayout, imageIndex: Int)

method · iOS 11.0+

resourceSize

TypeScript

resourceSize(): number

Swift declaration

func resourceSize() -> Int

method · iOS 10.0+

setPurgeableState

TypeScript

setPurgeableState(state: MPSPurgeableState): MPSPurgeableState

Swift declaration

func setPurgeableState(_ state: MPSPurgeableState) -> MPSPurgeableState

method · iOS 10.0+

subImage

TypeScript

subImage(range: SDKHandle): MPSImage

Swift declaration

func subImage(withFeatureChannelRange range: NSRange) -> MPSImage

method · iOS 11.3+

synchronize

TypeScript

synchronize(commandBuffer: SDKHandle): void

Swift declaration

func synchronize(on commandBuffer: any MTLCommandBuffer)

method · iOS 13.0+

writeBytes

TypeScript

writeBytesDataLayoutBytesPerColumnBytesPerRowBytesPerImageRegionFeatureChannelInfoImageIndex(dataBytes: SDKHandle, dataLayout: MPSDataLayout, bytesPerColumn: number, bytesPerRow: number, bytesPerImage: number, region: _Metal_MTLRegion, featureChannelInfo: MPSImageReadWriteParams, imageIndex: number): void

Swift declaration

func writeBytes(_ dataBytes: UnsafeRawPointer, dataLayout: MPSDataLayout, bytesPerColumn: Int, bytesPerRow: Int, bytesPerImage: Int, region: MTLRegion, featureChannelInfo: MPSImageReadWriteParams, imageIndex: Int)

method · iOS 11.3+

writeBytes

TypeScript

writeBytesDataLayoutBytesPerRowBytesPerImageRegionFeatureChannelInfoImageIndex(dataBytes: SDKHandle, dataLayout: MPSDataLayout, bytesPerRow: number, bytesPerImage: number, region: _Metal_MTLRegion, featureChannelInfo: MPSImageReadWriteParams, imageIndex: number): void

Swift declaration

func writeBytes(_ dataBytes: UnsafeRawPointer, dataLayout: MPSDataLayout, bytesPerRow: Int, bytesPerImage: Int, region: MTLRegion, featureChannelInfo: MPSImageReadWriteParams, imageIndex: Int)

method · iOS 11.0+

writeBytes

TypeScript

writeBytesDataLayoutBytesPerRowRegionFeatureChannelInfoImageIndex(dataBytes: SDKHandle, dataLayout: MPSDataLayout, bytesPerRow: number, region: _Metal_MTLRegion, featureChannelInfo: MPSImageReadWriteParams, imageIndex: number): void

Swift declaration

func writeBytes(_ dataBytes: UnsafeRawPointer, dataLayout: MPSDataLayout, bytesPerRow: Int, region: MTLRegion, featureChannelInfo: MPSImageReadWriteParams, imageIndex: Int)

method · iOS 11.0+

writeBytes

TypeScript

writeBytesDataLayoutImageIndex(dataBytes: SDKHandle, dataLayout: MPSDataLayout, imageIndex: number): void

Swift declaration

func writeBytes(_ dataBytes: UnsafeRawPointer, dataLayout: MPSDataLayout, imageIndex: Int)

get · iOS 10.0+

device

TypeScript

get device(): SDKHandle

Swift declaration

var device: any MTLDevice { get }

get · iOS 10.0+

featureChannelFormat

TypeScript

get featureChannelFormat(): MPSImageFeatureChannelFormat

Swift declaration

var featureChannelFormat: MPSImageFeatureChannelFormat { get }

get · iOS 10.0+

featureChannels

TypeScript

get featureChannels(): number

Swift declaration

var featureChannels: Int { get }

get · iOS 10.0+

height

TypeScript

get height(): number

Swift declaration

var height: Int { get }

get · iOS 10.0+

label

TypeScript

get label(): (string) | null

Swift declaration

var label: String? { get set }

set · iOS 10.0+

label

TypeScript

set label(value: (string) | null)

Swift declaration

var label: String? { get set }

get · iOS 10.0+

numberOfImages

TypeScript

get numberOfImages(): number

Swift declaration

var numberOfImages: Int { get }

get · iOS 10.0+

parent

TypeScript

get parent(): (MPSImage) | null

Swift declaration

var parent: MPSImage? { get }

get · iOS 10.0+

pixelFormat

TypeScript

get pixelFormat(): _Metal_MTLPixelFormat

Swift declaration

var pixelFormat: MTLPixelFormat { get }

get · iOS 10.0+

pixelSize

TypeScript

get pixelSize(): number

Swift declaration

var pixelSize: Int { get }

get · iOS 10.0+

precision

TypeScript

get precision(): number

Swift declaration

var precision: Int { get }

get · iOS 10.0+

texture

TypeScript

get texture(): SDKHandle

Swift declaration

var texture: any MTLTexture { get }

get · iOS 10.0+

textureType

TypeScript

get textureType(): _Metal_MTLTextureType

Swift declaration

var textureType: MTLTextureType { get }

get · iOS 10.0+

usage

TypeScript

get usage(): _Metal_MTLTextureUsage

Swift declaration

var usage: MTLTextureUsage { get }

get · iOS 10.0+

width

TypeScript

get width(): number

Swift declaration

var width: Int { get }

Skipped declarations

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

MPSImage.init()

inherited init: cannot prove legal (class declares 3 custom initializers)

All MetalPerformanceShaders types →