Man pages sections > man3 > CUDART_SURFACE

Surface Reference Management - surface reference management functions of the

Surface Reference Management(3) Doxygen Surface Reference Management(3)

NAME

Surface Reference Management - surface reference management functions of the CUDA runtime API (cuda_runtime_api.h)
 

Functions


cudaError_t cudaBindSurfaceToArray (const struct surfaceReference *surfref, cudaArray_const_t array, const struct cudaChannelFormatDesc *desc)
 
Binds an array to a surface. cudaError_t cudaGetSurfaceReference (const struct surfaceReference **surfref, const void *symbol)
 
Get the surface reference associated with a symbol.

Detailed Description

This section describes the low level surface reference management functions of the CUDA runtime application programming interface.
Some functions have overloaded C++ API template versions documented separately in the C++ API Routines module.

Function Documentation

cudaError_t cudaBindSurfaceToArray (const struct surfaceReference * surfref, cudaArray_const_t array, const struct cudaChannelFormatDesc * desc)

Binds the CUDA array array to the surface reference surfref. desc describes how the memory is interpreted when fetching values from the surface. Any CUDA array previously bound to surfref is unbound.
Parameters:
surfref - Surface to bind
 
array - Memory array on device
 
desc - Channel format
Returns:
cudaSuccess, cudaErrorInvalidValue, cudaErrorInvalidSurface
Note:
Note that this function may also return error codes from previous, asynchronous launches.
See also:
cudaBindSurfaceToArray (C++ API), cudaBindSurfaceToArray (C++ API, inherited channel descriptor), cudaGetSurfaceReference

cudaError_t cudaGetSurfaceReference (const struct surfaceReference ** surfref, const void * symbol)

Returns in *surfref the structure associated to the surface reference defined by symbol symbol.
Parameters:
surfref - Surface reference associated with symbol
 
symbol - Surface to get reference for
Returns:
cudaSuccess, cudaErrorInvalidSurface
Note:
Note that this function may also return error codes from previous, asynchronous launches.
Use of a string naming a variable as the symbol parameter was removed in CUDA 5.0.
See also:
cudaBindSurfaceToArray (C API)

Author

Generated automatically by Doxygen from the source code.
13 Jan 2017 Version 6.0