/home/docs/checkouts/readthedocs.org/user_builds/advanced-micro-devices-hip/checkouts/latest/include/hip/surface_types.h Source File#

HIP Runtime API Reference: /home/docs/checkouts/readthedocs.org/user_builds/advanced-micro-devices-hip/checkouts/latest/include/hip/surface_types.h Source File
surface_types.h
Go to the documentation of this file.
1 /*
2 Copyright (c) 2022 - 2023 Advanced Micro Devices, Inc. All rights reserved.
3 Permission is hereby granted, free of charge, to any person obtaining a copy
4 of this software and associated documentation files (the "Software"), to deal
5 in the Software without restriction, including without limitation the rights
6 to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
7 copies of the Software, and to permit persons to whom the Software is
8 furnished to do so, subject to the following conditions:
9 The above copyright notice and this permission notice shall be included in
10 all copies or substantial portions of the Software.
11 THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
12 IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
13 FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
14 AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
15 LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
16 OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
17 THE SOFTWARE.
18 */
19 
25 #ifndef HIP_INCLUDE_HIP_SURFACE_TYPES_H
26 #define HIP_INCLUDE_HIP_SURFACE_TYPES_H
27 
28 #if defined(__clang__)
29 #pragma clang diagnostic push
30 #pragma clang diagnostic ignored "-Wreserved-identifier"
31 #endif
32 
33 #if !defined(__HIPCC_RTC__)
34 #include <hip/driver_types.h>
35 #endif
36 
40 struct __hip_surface;
41 typedef struct __hip_surface* hipSurfaceObject_t;
42 
46 struct surfaceReference {
47  hipSurfaceObject_t surfaceObject;
48 };
49 
53 enum hipSurfaceBoundaryMode {
54  hipBoundaryModeZero = 0,
55  hipBoundaryModeTrap = 1,
56  hipBoundaryModeClamp = 2
57 };
58 
59 #if defined(__clang__)
60 #pragma clang diagnostic pop
61 #endif
62 
63 #endif /* !HIP_INCLUDE_HIP_SURFACE_TYPES_H */
driver_types.h
surfaceReference
Definition: surface_types.h:46
surfaceReference::surfaceObject
hipSurfaceObject_t surfaceObject
Definition: surface_types.h:47
hipSurfaceBoundaryMode
hipSurfaceBoundaryMode
Definition: surface_types.h:53
hipBoundaryModeClamp
@ hipBoundaryModeClamp
Definition: surface_types.h:56
hipBoundaryModeTrap
@ hipBoundaryModeTrap
Definition: surface_types.h:55
hipBoundaryModeZero
@ hipBoundaryModeZero
Definition: surface_types.h:54
hipSurfaceObject_t
struct __hip_surface * hipSurfaceObject_t
Definition: surface_types.h:41