This page contains proposed changes for a future release of ROCm. Read the latest Linux release of ROCm documentation for your production environments.

Surface Object

Surface Object#

HIP Runtime API Reference: Surface Object
Surface Object
Collaboration diagram for Surface Object:

Functions

hipError_t hipCreateSurfaceObject (hipSurfaceObject_t *pSurfObject, const hipResourceDesc *pResDesc)
 Create a surface object. More...
 
hipError_t hipDestroySurfaceObject (hipSurfaceObject_t surfaceObject)
 Destroy a surface object. More...
 

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]pSurfObjectPointer of surface object to be created.
[in]pResDescPointer of suface object descriptor.
Returns
hipSuccess, hipErrorInvalidValue

◆ hipDestroySurfaceObject()

hipError_t hipDestroySurfaceObject ( hipSurfaceObject_t  surfaceObject)

Destroy a surface object.

Parameters
[in]surfaceObjectSurface object to be destroyed.
Returns
hipSuccess, hipErrorInvalidValue