/home/docs/checkouts/readthedocs.org/user_builds/advanced-micro-devices-hip/checkouts/clr/hipamd/include/hip/amd_detail/amd_hip_gl_interop.h Source File

• clr
• hipamd
• include
• hip
• amd_detail

amd_hip_gl_interop.h

Go to the documentation of this file.

1 /*

2 Copyright (c) 2023 Advanced Micro Devices, Inc. All rights reserved.

3 

4 Permission is hereby granted, free of charge, to any person obtaining a copy

5 of this software and associated documentation files (the "Software"), to deal

6 in the Software without restriction, including without limitation the rights

7 to use, copy, modify, merge, publish, distribute, sublicense, and/or sell

8 copies of the Software, and to permit persons to whom the Software is

9 furnished to do so, subject to the following conditions:

10 

11 The above copyright notice and this permission notice shall be included in

12 all copies or substantial portions of the Software.

13 

14 THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR

15 IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,

16 FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE

17 AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER

18 LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,

19 OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN

20 THE SOFTWARE.

21 */

22 

23 #ifndef HIP_INCLUDE_AMD_HIP_GL_INTEROP_H

24 #define HIP_INCLUDE_AMD_HIP_GL_INTEROP_H

25 

26 #if defined(__cplusplus)

27 extern "C" {

28 #endif

29 

40 typedef enum hipGLDeviceList {

41  hipGLDeviceListAll = 1,

42  hipGLDeviceListCurrentFrame = 2,

44  hipGLDeviceListNextFrame = 3

46 } hipGLDeviceList;

47 

48 

50 typedef unsigned int GLuint;

52 typedef unsigned int GLenum;

75 hipError_t hipGLGetDevices(unsigned int* pHipDeviceCount, int* pHipDevices,

76  unsigned int hipDeviceCount, hipGLDeviceList deviceList);

87 hipError_t hipGraphicsGLRegisterBuffer(hipGraphicsResource** resource, GLuint buffer,

88  unsigned int flags);

100 hipError_t hipGraphicsGLRegisterImage(hipGraphicsResource** resource, GLuint image,

101  GLenum target, unsigned int flags);

105 #if defined(__cplusplus)

106 }

107 #endif /* __cplusplus */

108 #endif /* HIP_INCLUDE_AMD_HIP_GL_INTEROP_H */

hipGLGetDevices

hipError_t hipGLGetDevices(unsigned int *pHipDeviceCount, int *pHipDevices, unsigned int hipDeviceCount, hipGLDeviceList deviceList)

Queries devices associated with the current OpenGL context.

hipGraphicsGLRegisterImage

hipError_t hipGraphicsGLRegisterImage(hipGraphicsResource **resource, GLuint image, GLenum target, unsigned int flags)

Register a GL Image for interop and returns the corresponding graphic resource.

hipGraphicsGLRegisterBuffer

hipError_t hipGraphicsGLRegisterBuffer(hipGraphicsResource **resource, GLuint buffer, unsigned int flags)

Registers a GL Buffer for interop and returns corresponding graphics resource.

hipGLDeviceList

hipGLDeviceList

Definition: amd_hip_gl_interop.h:40

hipError_t

enum __HIP_NODISCARD hipError_t hipError_t

Definition: hip_runtime_api.h:287

GLenum

unsigned int GLenum

Definition: amd_hip_gl_interop.h:52

GLuint

unsigned int GLuint

Definition: amd_hip_gl_interop.h:50

hipGraphicsResource

struct _hipGraphicsResource hipGraphicsResource

Definition: hip_runtime_api.h:1209

hipGLDeviceListNextFrame

@ hipGLDeviceListNextFrame

frame.

Definition: amd_hip_gl_interop.h:44

hipGLDeviceListAll

@ hipGLDeviceListAll

All hip devices used by current OpenGL context.

Definition: amd_hip_gl_interop.h:41

hipGLDeviceListCurrentFrame

@ hipGLDeviceListCurrentFrame

frame

Definition: amd_hip_gl_interop.h:42