Surface Object

Functions

Surface Object

HIP API

Collaboration diagram for Surface Object:

Functions
hipError_t	hipCreateSurfaceObject (hipSurfaceObject_t *pSurfObject, const hipResourceDesc *pResDesc)
	Create a surface object.
hipError_t	hipDestroySurfaceObject (hipSurfaceObject_t surfaceObject)
	Destroy a surface object.
hipError_t	hipExtEnableLogging ()
	Enable HIP runtime logging.
hipError_t	hipExtDisableLogging ()
	Disable HIP runtime logging.
hipError_t	hipExtSetLoggingParams (size_t log_level, size_t log_size, size_t log_mask)
	Set HIP runtime logging parameters.

Detailed Description

---

---

This section describes surface object functions of HIP runtime API.

Note

APIs in this section are under development.

Function Documentation

◆ hipCreateSurfaceObject()

hipError_t hipCreateSurfaceObject	(	hipSurfaceObject_t *	pSurfObject,
		const hipResourceDesc *	pResDesc
	)

Create a surface object.

Parameters

[out]	pSurfObject	Pointer of surface object to be created.
[in]	pResDesc	Pointer of suface object descriptor.

Returns

hipSuccess, hipErrorInvalidValue

◆ hipDestroySurfaceObject()

hipError_t hipDestroySurfaceObject

(

hipSurfaceObject_t

surfaceObject

)

Destroy a surface object.

Parameters

[in]

surfaceObject

Surface object to be destroyed.

Returns

hipSuccess, hipErrorInvalidValue

◆ hipExtDisableLogging()

hipError_t hipExtDisableLogging

(

)

Disable HIP runtime logging.

This function disables the HIP runtime logging mechanism, stopping the capture of diagnostic and trace information during HIP API execution.

Returns

hipSuccess

See also

hipExtEnableLogging, hipExtSetLoggingParams

◆ hipExtEnableLogging()

hipError_t hipExtEnableLogging

(

)

Enable HIP runtime logging.

This function enables the HIP runtime logging mechanism, allowing diagnostic and trace information to be captured during HIP API execution.

Returns

hipSuccess

See also

hipExtDisableLogging, hipExtSetLoggingParams

◆ hipExtSetLoggingParams()

hipError_t hipExtSetLoggingParams	(	size_t	log_level,
		size_t	log_size,
		size_t	log_mask
	)

Set HIP runtime logging parameters.

This function configures the logging behavior of the HIP runtime, including the verbosity level, buffer size, and which components to log.

Parameters

[in]	log_level	The logging verbosity level. Higher values produce more detailed output.
[in]	log_size	Reserved for future use. Currently not implemented.
[in]	log_mask	A bitmask specifying which HIP runtime components to log.

Returns

hipSuccess, hipErrorInvalidValue

See also

hipExtEnableLogging, hipExtDisableLogging