---
title: "vImageClipToAlpha_Planar8(_:_:_:_:)"
framework: accelerate
role: symbol
role_heading: Function
path: "accelerate/vimagecliptoalpha_planar8(_:_:_:_:)"
---

# vImageClipToAlpha_Planar8(_:_:_:_:)

Clamps the values of an 8-bit planar buffer to the corresponding alpha values.

## Declaration

```swift
func vImageClipToAlpha_Planar8(_ src: UnsafePointer<vImage_Buffer>, _ alpha: UnsafePointer<vImage_Buffer>, _ dest: UnsafePointer<vImage_Buffer>, _ flags: vImage_Flags) -> vImage_Error
```

## Parameters

- `src`: The source vImage buffer.
- `alpha`: The vImage buffer that provides the source alpha.
- `dest`: A pointer to the destination vImage buffer structure. You’re responsible for filling out the doc://com.apple.accelerate/documentation/Accelerate/vImage_Buffer/height, doc://com.apple.accelerate/documentation/Accelerate/vImage_Buffer/width, and doc://com.apple.accelerate/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.
- `flags`: The options to use when performing the operation. If your code implements its own tiling or its own multithreading, pass doc://com.apple.accelerate/documentation/Accelerate/kvImageDoNotTile; otherwise, pass doc://com.apple.accelerate/documentation/Accelerate/kvImageNoFlags.

## Return Value

Return Value kvImageNoError; otherwise, one of the error codes in Data Types and Constants.

## Discussion

Discussion On return of this function, the value of each pixel in the destination buffer is: color_result = MIN( color, alpha )

## See Also

### Clipping color values to alpha

- [vImageClipToAlpha_PlanarF(_:_:_:_:)](accelerate/vimagecliptoalpha_planarf(_:_:_:_:).md)
- [vImageClipToAlpha_ARGB8888(_:_:_:)](accelerate/vimagecliptoalpha_argb8888(_:_:_:).md)
- [vImageClipToAlpha_RGBA8888(_:_:_:)](accelerate/vimagecliptoalpha_rgba8888(_:_:_:).md)
- [vImageClipToAlpha_ARGBFFFF(_:_:_:)](accelerate/vimagecliptoalpha_argbffff(_:_:_:).md)
- [vImageClipToAlpha_RGBAFFFF(_:_:_:)](accelerate/vimagecliptoalpha_rgbaffff(_:_:_:).md)