Function rcudnn::cudaArrayGetPlane[][src]

pub unsafe extern "C" fn cudaArrayGetPlane(
    pPlaneArray: *mut *mut cudaArray,
    hArray: *mut cudaArray,
    planeIdx: u32
) -> cudaError
Expand description

\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: ::cudaChannelFormatKindNV12, then ::cudaErrorInvalidValue is returned.

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

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

\return ::cudaSuccess, ::cudaErrorInvalidValue ::cudaErrorInvalidResourceHandle \notefnerr

\sa ::cuArrayGetPlane