Function cuArrayGetPlane

pub unsafe extern "C" fn cuArrayGetPlane(
    pPlaneArray: *mut CUarray,
    hArray: CUarray,
    planeIdx: c_uint,
) -> CUresult

\brief Gets a CUDA array plane from a CUDA array

Returns in \p pPlaneArray a CUDA array that represents a single format plane of the CUDA array \p hArray.

If \p planeIdx is greater than the maximum number of planes in this array or if the array does not have a multi-planar format e.g: ::CU_AD_FORMAT_NV12, then ::CUDA_ERROR_INVALID_VALUE is returned.

Note that if the \p hArray has format ::CU_AD_FORMAT_NV12, then passing in 0 for \p planeIdx returns a CUDA array of the same size as \p hArray but with one channel and ::CU_AD_FORMAT_UNSIGNED_INT8 as its format. If 1 is passed for \p planeIdx, then the returned CUDA array has half the height and width of \p hArray with two channels and ::CU_AD_FORMAT_UNSIGNED_INT8 as its format.

\param pPlaneArray - Returned CUDA array referenced by the \p planeIdx \param hArray - Multiplanar CUDA array \param planeIdx - Plane index

\return ::CUDA_SUCCESS, ::CUDA_ERROR_DEINITIALIZED, ::CUDA_ERROR_NOT_INITIALIZED, ::CUDA_ERROR_INVALID_CONTEXT, ::CUDA_ERROR_INVALID_VALUE, ::CUDA_ERROR_INVALID_HANDLE \notefnerr

\sa ::cuArrayCreate, ::cudaArrayGetPlane