<!--
{
  "availability" : [
    "iOS: 7.0.0 -",
    "iPadOS: 7.0.0 -",
    "macCatalyst: 13.1.0 -",
    "macOS: 10.9.0 -",
    "tvOS: 7.0.0 -",
    "visionOS: 1.0.0 -",
    "watchOS: 1.0.0 -"
  ],
  "documentType" : "symbol",
  "framework" : "Accelerate",
  "identifier" : "/documentation/Accelerate/vImagePermuteChannelsWithMaskedInsert_ARGB8888(_:_:_:_:_:_:)",
  "metadataVersion" : "0.1.0",
  "role" : "Function",
  "symbol" : {
    "kind" : "Function",
    "modules" : [
      "Accelerate"
    ],
    "preciseIdentifier" : "c:@F@vImagePermuteChannelsWithMaskedInsert_ARGB8888"
  },
  "title" : "vImagePermuteChannelsWithMaskedInsert_ARGB8888(_:_:_:_:_:_:)"
}
-->

# vImagePermuteChannelsWithMaskedInsert_ARGB8888(_:_:_:_:_:_:)

Permutes and overwrites the channels of an 8-bit-per-channel, 4-channel interleaved buffer.

```
func vImagePermuteChannelsWithMaskedInsert_ARGB8888(_ src: UnsafePointer<vImage_Buffer>, _ dest: UnsafePointer<vImage_Buffer>, _ permuteMap: UnsafePointer<UInt8>, _ copyMask: UInt8, _ backgroundColor: UnsafePointer<UInt8>, _ flags: vImage_Flags) -> vImage_Error
```

## Parameters

`src`

The source vImage buffer.

`dest`

A pointer to the destination vImage buffer structure. You’re responsible for filling out the [`height`](/documentation/Accelerate/vImage_Buffer/height), [`width`](/documentation/Accelerate/vImage_Buffer/width), and [`rowBytes`](/documentation/Accelerate/vImage_Buffer/rowBytes) fields of this structure, and for allocating a data buffer of the appropriate size. On return, the data buffer this structure points to contains the destination image data. When you no longer need the data buffer, deallocate the memory to prevent memory leaks.

`permuteMap`

An array of four 8-bit integers with the values `0`, `1`, `2`, and 3, in some order. Each value specifies the channel from the source image that the function copies to the destination channel at the corresponding index.

`copyMask`

A bitmask that specifies the channel or channels that the function overwrites with the corresponding channel in the `backgroundColor` parameter. The value `0x8` represents channel `0`, the value `0x4` represents channel `1`, the value `0x2` represents channel `2`, and the value `0x1` represents channel `3`.

`backgroundColor`

The 8-bit-per-channel ARGB value that the function writes to the destination based on the `copyMask` value.

`flags`

The options to use when performing the operation. If your code implements its own tiling or its own multithreading, pass [`kvImageDoNotTile`](/documentation/Accelerate/kvImageDoNotTile); otherwise, pass [`kvImageNoFlags`](/documentation/Accelerate/kvImageNoFlags).

## Return Value

[`kvImageNoError`](/documentation/Accelerate/kvImageNoError); otherwise, one of the error codes in <doc://com.apple.documentation/documentation/Accelerate/data-types-and-constants>.

## Discussion

This fused operation provides the same functionality as [`vImagePermuteChannels_ARGB8888(_:_:_:_:)`](/documentation/Accelerate/vImagePermuteChannels_ARGB8888(_:_:_:_:)) followed by [`vImageOverwriteChannelsWithScalar_ARGB8888(_:_:_:_:_:)`](/documentation/Accelerate/vImageOverwriteChannelsWithScalar_ARGB8888(_:_:_:_:_:)) but offers higher performance than calling the two functions separately.

The following code reverses the channel ordering of a pixel buffer and overwrites channel `0` of the destination with element `0` of the background color:

```swift
let pixelBuffer = vImage.PixelBuffer<vImage.Interleaved8x4>(
    pixelValues: [10, 20, 30, 40],
    size: .init(width: 1, height: 1))

let backgroundColor: [Pixel_8] = [101, 102, 103, 104]

pixelBuffer.withUnsafePointerToVImageBuffer { buf in
    _ = vImagePermuteChannelsWithMaskedInsert_ARGB8888(buf,
                                                       buf,
                                                       [3, 2, 1, 0],
                                                       0x8,
                                                       backgroundColor,
                                                       vImage_Flags(kvImageNoFlags))
}

// Prints "[101, 30, 20, 10]".
print(pixelBuffer.array)
```

---

Copyright &copy; 2026 Apple Inc. All rights reserved. | [Terms of Use](https://www.apple.com/legal/internet-services/terms/site.html) | [Privacy Policy](https://www.apple.com/privacy/privacy-policy)