One Logo Pool Ball
X
Github
Discord

System

MetalPerformanceShaders · IOS API REFERENCE

MPSNDArray

class · iOS 13.0+ · SDK 27.1

class MPSNDArray

Members (26)

static · iOS 13.0+

defaultAllocator

TypeScript
static defaultAllocator(): SDKHandle
Swift declaration
class func defaultAllocator() -> any MPSNDArrayAllocator
method · iOS 13.0+

arrayView

TypeScript
arrayViewWithDescriptorAliasing(cmdBuf: SDKHandle, descriptor: MPSNDArrayDescriptor, aliasing: MPSAliasingStrategy): (MPSNDArray) | null
Swift declaration
func arrayView(with cmdBuf: any MTLCommandBuffer, descriptor: MPSNDArrayDescriptor, aliasing: MPSAliasingStrategy) -> MPSNDArray?
method · iOS 18.0+

arrayView

TypeScript
arrayViewWith(descriptor: MPSNDArrayDescriptor): (MPSNDArray) | null
Swift declaration
func arrayView(with descriptor: MPSNDArrayDescriptor) -> MPSNDArray?
method · iOS 18.0+

arrayView

TypeScript
arrayViewWithDimensionCountDimensionSizesStrides(numberOfDimensions: number, dimensionSizes: SDKHandle, dimStrides: SDKHandle): (MPSNDArray) | null
Swift declaration
func arrayView(withDimensionCount numberOfDimensions: Int, dimensionSizes: UnsafePointer<Int>, strides dimStrides: UnsafePointer<Int>) -> MPSNDArray?
method · iOS 18.0+

arrayView

TypeScript
arrayViewWithShapeStrides(shape: (Array<_Foundation_NSNumber>) | null, strides: Array<_Foundation_NSNumber>): (MPSNDArray) | null
Swift declaration
func arrayView(withShape shape: [NSNumber]?, strides: [NSNumber]) -> MPSNDArray?
method · iOS 13.0+

descriptor

TypeScript
descriptor(): MPSNDArrayDescriptor
Swift declaration
func descriptor() -> MPSNDArrayDescriptor
method · iOS 13.0+

exportData

TypeScript
exportDataWithToDestinationDataTypeOffsetRowStrides(cmdBuf: SDKHandle, buffer: SDKHandle, destinationDataType: MPSDataType, offset: number, rowStrides?: (SDKHandle) | null): void
Swift declaration
func exportData(with cmdBuf: any MTLCommandBuffer, to buffer: any MTLBuffer, destinationDataType: MPSDataType, offset: Int, rowStrides: UnsafeMutablePointer<Int>?)
method · iOS 13.0+

exportData

TypeScript
exportDataWithToOffset(cmdBuf: SDKHandle, images: Array<MPSImage>, offset: MPSImageCoordinate): void
Swift declaration
func exportData(with cmdBuf: any MTLCommandBuffer, to images: [MPSImage], offset: MPSImageCoordinate)
method · iOS 13.0+

importData

TypeScript
importDataWithFromSourceDataTypeOffsetRowStrides(cmdBuf: SDKHandle, buffer: SDKHandle, sourceDataType: MPSDataType, offset: number, rowStrides?: (SDKHandle) | null): void
Swift declaration
func importData(with cmdBuf: any MTLCommandBuffer, from buffer: any MTLBuffer, sourceDataType: MPSDataType, offset: Int, rowStrides: UnsafeMutablePointer<Int>?)
method · iOS 13.0+

importData

TypeScript
importDataWithFromOffset(cmdBuf: SDKHandle, images: Array<MPSImage>, offset: MPSImageCoordinate): void
Swift declaration
func importData(with cmdBuf: any MTLCommandBuffer, from images: [MPSImage], offset: MPSImageCoordinate)
init · iOS 18.0+

init

TypeScript
static initBufferOffsetDescriptor(buffer: SDKHandle, offset: number, descriptor: MPSNDArrayDescriptor): MPSNDArray
Swift declaration
convenience init(buffer: any MTLBuffer, offset: Int, descriptor: MPSNDArrayDescriptor)
init · iOS 13.0+

init

TypeScript
static initDeviceDescriptor(device: SDKHandle, descriptor: MPSNDArrayDescriptor): MPSNDArray
Swift declaration
init(device: any MTLDevice, descriptor: MPSNDArrayDescriptor)
init · iOS 13.0+

init

TypeScript
static initDeviceScalar(device: SDKHandle, value: number): MPSNDArray
Swift declaration
convenience init(device: any MTLDevice, scalar value: Double)
method · iOS 13.0+

length

TypeScript
length(dimensionIndex: number): number
Swift declaration
func length(ofDimension dimensionIndex: Int) -> Int
method · iOS 13.0+

readBytes

TypeScript
readBytes(buffer: SDKHandle, strideBytesPerDimension?: (SDKHandle) | null): void
Swift declaration
func readBytes(_ buffer: UnsafeMutableRawPointer, strideBytes strideBytesPerDimension: UnsafeMutablePointer<Int>?)
method · iOS 13.0+

resourceSize

TypeScript
resourceSize(): number
Swift declaration
func resourceSize() -> Int
method · iOS 13.0+

synchronize

TypeScript
synchronize(commandBuffer: SDKHandle): void
Swift declaration
func synchronize(on commandBuffer: any MTLCommandBuffer)
method · iOS 18.0+

userBuffer

TypeScript
userBuffer(): (SDKHandle) | null
Swift declaration
func userBuffer() -> (any MTLBuffer)?
method · iOS 13.0+

writeBytes

TypeScript
writeBytes(buffer: SDKHandle, strideBytesPerDimension?: (SDKHandle) | null): void
Swift declaration
func writeBytes(_ buffer: UnsafeMutableRawPointer, strideBytes strideBytesPerDimension: UnsafeMutablePointer<Int>?)
get · iOS 13.0+

dataType

TypeScript
get dataType(): MPSDataType
Swift declaration
var dataType: MPSDataType { get }
get · iOS 13.0+

dataTypeSize

TypeScript
get dataTypeSize(): number
Swift declaration
var dataTypeSize: Int { get }
get · iOS 13.0+

device

TypeScript
get device(): SDKHandle
Swift declaration
var device: any MTLDevice { get }
get · iOS 13.0+

label

TypeScript
get label(): (string) | null
Swift declaration
var label: String? { get set }
set · iOS 13.0+

label

TypeScript
set label(value: (string) | null)
Swift declaration
var label: String? { get set }
get · iOS 13.0+

numberOfDimensions

TypeScript
get numberOfDimensions(): number
Swift declaration
var numberOfDimensions: Int { get }
get · iOS 13.0+

parent

TypeScript
get parent(): (MPSNDArray) | null
Swift declaration
var parent: MPSNDArray? { get }

Skipped declarations

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

MPSNDArray.init()

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

All MetalPerformanceShaders types →