util/X86LINUX64/cuda-6.5/include/surface_types.h

   1 /*
   2  * Copyright 1993-2012 NVIDIA Corporation.  All rights reserved.
   3  *
   4  * NOTICE TO LICENSEE:
   5  *
   6  * This source code and/or documentation ("Licensed Deliverables") are
   7  * subject to NVIDIA intellectual property rights under U.S. and
   8  * international Copyright laws.
   9  *
  10  * These Licensed Deliverables contained herein is PROPRIETARY and
  11  * CONFIDENTIAL to NVIDIA and is being provided under the terms and
  12  * conditions of a form of NVIDIA software license agreement by and
  13  * between NVIDIA and Licensee ("License Agreement") or electronically
  14  * accepted by Licensee.  Notwithstanding any terms or conditions to
  15  * the contrary in the License Agreement, reproduction or disclosure
  16  * of the Licensed Deliverables to any third party without the express
  17  * written consent of NVIDIA is prohibited.
  18  *
  19  * NOTWITHSTANDING ANY TERMS OR CONDITIONS TO THE CONTRARY IN THE
  20  * LICENSE AGREEMENT, NVIDIA MAKES NO REPRESENTATION ABOUT THE
  21  * SUITABILITY OF THESE LICENSED DELIVERABLES FOR ANY PURPOSE.  IT IS
  22  * PROVIDED "AS IS" WITHOUT EXPRESS OR IMPLIED WARRANTY OF ANY KIND.
  23  * NVIDIA DISCLAIMS ALL WARRANTIES WITH REGARD TO THESE LICENSED
  24  * DELIVERABLES, INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY,
  25  * NONINFRINGEMENT, AND FITNESS FOR A PARTICULAR PURPOSE.
  26  * NOTWITHSTANDING ANY TERMS OR CONDITIONS TO THE CONTRARY IN THE
  27  * LICENSE AGREEMENT, IN NO EVENT SHALL NVIDIA BE LIABLE FOR ANY
  28  * SPECIAL, INDIRECT, INCIDENTAL, OR CONSEQUENTIAL DAMAGES, OR ANY
  29  * DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS,
  30  * WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS
  31  * ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE
  32  * OF THESE LICENSED DELIVERABLES.
  33  *
  34  * U.S. Government End Users.  These Licensed Deliverables are a
  35  * "commercial item" as that term is defined at 48 C.F.R. 2.101 (OCT
  36  * 1995), consisting of "commercial computer software" and "commercial
  37  * computer software documentation" as such terms are used in 48
  38  * C.F.R. 12.212 (SEPT 1995) and is provided to the U.S. Government
  39  * only as a commercial end item.  Consistent with 48 C.F.R.12.212 and
  40  * 48 C.F.R. 227.7202-1 through 227.7202-4 (JUNE 1995), all
  41  * U.S. Government End Users acquire the Licensed Deliverables with
  42  * only those rights set forth herein.
  43  *
  44  * Any use of the Licensed Deliverables in individual and commercial
  45  * software must include, in the user documentation and internal
  46  * comments to the code, the above Disclaimer and U.S. Government End
  47  * Users Notice.
  48  */
  49
  50 #if !defined(__SURFACE_TYPES_H__)
  51 #define __SURFACE_TYPES_H__
  52
  53 /*******************************************************************************
  54 *                                                                              *
  55 *                                                                              *
  56 *                                                                              *
  57 *******************************************************************************/
  58
  59 #include "driver_types.h"
  60
  61 /**
  62  * \addtogroup CUDART_TYPES
  63  *
  64  * @{
  65  */
  66
  67 /*******************************************************************************
  68 *                                                                              *
  69 *                                                                              *
  70 *                                                                              *
  71 *******************************************************************************/
  72
  73 #define cudaSurfaceType1D              0x01
  74 #define cudaSurfaceType2D              0x02
  75 #define cudaSurfaceType3D              0x03
  76 #define cudaSurfaceTypeCubemap         0x0C
  77 #define cudaSurfaceType1DLayered       0xF1
  78 #define cudaSurfaceType2DLayered       0xF2
  79 #define cudaSurfaceTypeCubemapLayered  0xFC
  80
  81 /**
  82  * CUDA Surface boundary modes
  83  */
  84 enum __device_builtin__ cudaSurfaceBoundaryMode
  85 {
  86     cudaBoundaryModeZero  = 0,    /**< Zero boundary mode */
  87     cudaBoundaryModeClamp = 1,    /**< Clamp boundary mode */
  88     cudaBoundaryModeTrap  = 2     /**< Trap boundary mode */
  89 };
  90
  91 /**
  92  * CUDA Surface format modes
  93  */
  94 enum __device_builtin__  cudaSurfaceFormatMode
  95 {
  96     cudaFormatModeForced = 0,     /**< Forced format mode */
  97     cudaFormatModeAuto = 1        /**< Auto format mode */
  98 };
  99
 100 /**
 101  * CUDA Surface reference
 102  */
 103 struct __device_builtin__ surfaceReference
 104 {
 105     /**
 106      * Channel descriptor for surface reference
 107      */
 108     struct cudaChannelFormatDesc channelDesc;
 109 };
 110
 111 /**
 112  * CUDA Surface object
 113  */
 114 typedef __device_builtin__ unsigned long long cudaSurfaceObject_t;
 115
 116 /** @} */
 117 /** @} */ /* END CUDART_TYPES */
 118
 119 #endif /* !__SURFACE_TYPES_H__ */