GlobalDefs

Typedefs
typedef enum hipGLDeviceList	hipGLDeviceList
typedef unsigned int	GLuint
typedef unsigned int	GLenum

Enumerations
enum	hipGLDeviceList { hipGLDeviceListAll = 1 , hipGLDeviceListCurrentFrame = 2 , hipGLDeviceListNextFrame = 3 }
hipError_t	hipGLGetDevices (unsigned int *pHipDeviceCount, int *pHipDevices, unsigned int hipDeviceCount, hipGLDeviceList deviceList)
	Queries devices associated with the current OpenGL context.
hipError_t	hipGraphicsGLRegisterBuffer (hipGraphicsResource **resource, GLuint buffer, unsigned int flags)
	Registers a GL Buffer for interop and returns corresponding graphics resource.
hipError_t	hipGraphicsGLRegisterImage (hipGraphicsResource **resource, GLuint image, GLenum target, unsigned int flags)
	Register a GL Image for interop and returns the corresponding graphic resource.

Detailed Description

Typedef Documentation

GLenum

typedef unsigned int GLenum

GLenum as uint.

GLuint

typedef unsigned int GLuint

GLuint as uint.

hipGLDeviceList

typedef enum hipGLDeviceList hipGLDeviceList

HIP Devices used by current OpenGL Context.

Enumeration Type Documentation

hipGLDeviceList

enum hipGLDeviceList

HIP Devices used by current OpenGL Context.

Enumerator
hipGLDeviceListAll	All hip devices used by current OpenGL context.
hipGLDeviceListCurrentFrame	frame Hip devices used by current OpenGL context in current
hipGLDeviceListNextFrame	frame. Hip devices used by current OpenGL context in next

Function Documentation

hipGLGetDevices()

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

Queries devices associated with the current OpenGL context.

Parameters

[out]	pHipDeviceCount	- Pointer of number of devices on the current GL context.
[out]	pHipDevices	- Pointer of devices on the current OpenGL context.
[in]	hipDeviceCount	- Size of device.
[in]	deviceList	- The setting of devices. It could be either hipGLDeviceListCurrentFrame for the devices used to render the current frame, or hipGLDeviceListAll for all devices. The default setting is Invalid deviceList value.

Returns

hipSuccess, hipErrorInvalidValue, hipErrorNotSupported

hipGraphicsGLRegisterBuffer()

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

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

Parameters

[out]	resource	- Returns pointer of graphics resource.
[in]	buffer	- Buffer to be registered.
[in]	flags	- Register flags.

Returns

hipSuccess, hipErrorInvalidValue, hipErrorUnknown, hipErrorInvalidResourceHandle

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.

Parameters

[out]	resource	- Returns pointer of graphics resource.
[in]	image	- Image to be registered.
[in]	target	- Valid target value Id.
[in]	flags	- Register flags.

Returns

hipSuccess, hipErrorInvalidValue, hipErrorUnknown, hipErrorInvalidResourceHandle