Texture Management#

HIP Runtime API Reference: Texture Management
Texture Management

This section describes the texture management functions of HIP runtime API. More...

Collaboration diagram for Texture Management:

Modules

 Texture Management [Deprecated]
 
 Texture Management [Not supported]
 

Functions

hipError_t hipBindTextureToMipmappedArray (const textureReference *tex, hipMipmappedArray_const_t mipmappedArray, const hipChannelFormatDesc *desc)
 Binds a mipmapped array to a texture. More...
 
hipError_t hipCreateTextureObject (hipTextureObject_t *pTexObject, const hipResourceDesc *pResDesc, const hipTextureDesc *pTexDesc, const struct hipResourceViewDesc *pResViewDesc)
 Creates a texture object. More...
 
hipError_t hipDestroyTextureObject (hipTextureObject_t textureObject)
 Destroys a texture object. More...
 
hipError_t hipGetChannelDesc (hipChannelFormatDesc *desc, hipArray_const_t array)
 Gets the channel descriptor in an array. More...
 
hipError_t hipGetTextureObjectResourceDesc (hipResourceDesc *pResDesc, hipTextureObject_t textureObject)
 Gets resource descriptor for the texture object. More...
 
hipError_t hipGetTextureObjectResourceViewDesc (struct hipResourceViewDesc *pResViewDesc, hipTextureObject_t textureObject)
 Gets resource view descriptor for the texture object. More...
 
hipError_t hipGetTextureObjectTextureDesc (hipTextureDesc *pTexDesc, hipTextureObject_t textureObject)
 Gets texture descriptor for the texture object. More...
 
hipError_t hipTexObjectCreate (hipTextureObject_t *pTexObject, const HIP_RESOURCE_DESC *pResDesc, const HIP_TEXTURE_DESC *pTexDesc, const HIP_RESOURCE_VIEW_DESC *pResViewDesc)
 Creates a texture object. More...
 
hipError_t hipTexObjectDestroy (hipTextureObject_t texObject)
 Destroys a texture object. More...
 
hipError_t hipTexObjectGetResourceDesc (HIP_RESOURCE_DESC *pResDesc, hipTextureObject_t texObject)
 Gets resource descriptor of a texture object. More...
 
hipError_t hipTexObjectGetResourceViewDesc (HIP_RESOURCE_VIEW_DESC *pResViewDesc, hipTextureObject_t texObject)
 Gets resource view descriptor of a texture object. More...
 
hipError_t hipTexObjectGetTextureDesc (HIP_TEXTURE_DESC *pTexDesc, hipTextureObject_t texObject)
 Gets texture descriptor of a texture object. More...
 

Detailed Description

This section describes the texture management functions of HIP runtime API.



Function Documentation

◆ hipBindTextureToMipmappedArray()

hipError_t hipBindTextureToMipmappedArray ( const textureReference tex,
hipMipmappedArray_const_t  mipmappedArray,
const hipChannelFormatDesc desc 
)

Binds a mipmapped array to a texture.

Parameters
[in]texpointer to the texture reference to bind
[in]mipmappedArraymemory mipmapped array on the device
[in]descopointer to the channel format
Returns
hipSuccess, hipErrorInvalidValue

◆ hipCreateTextureObject()

hipError_t hipCreateTextureObject ( hipTextureObject_t pTexObject,
const hipResourceDesc pResDesc,
const hipTextureDesc pTexDesc,
const struct hipResourceViewDesc pResViewDesc 
)

Creates a texture object.

Parameters
[out]pTexObjectpointer to the texture object to create
[in]pResDescpointer to resource descriptor
[in]pTexDescpointer to texture descriptor
[in]pResViewDescpointer to resource view descriptor
Returns
hipSuccess, hipErrorInvalidValue, hipErrorNotSupported, hipErrorOutOfMemory
Note
3D liner filter isn't supported on GFX90A boards, on which the API hipCreateTextureObject will return hipErrorNotSupported.

◆ hipDestroyTextureObject()

hipError_t hipDestroyTextureObject ( hipTextureObject_t  textureObject)

Destroys a texture object.

Parameters
[in]textureObjecttexture object to destroy
Returns
hipSuccess, hipErrorInvalidValue

◆ hipGetChannelDesc()

hipError_t hipGetChannelDesc ( hipChannelFormatDesc desc,
hipArray_const_t  array 
)

Gets the channel descriptor in an array.

Parameters
[in]descpointer to channel format descriptor
[out]arraymemory array on the device
Returns
hipSuccess, hipErrorInvalidValue

◆ hipGetTextureObjectResourceDesc()

hipError_t hipGetTextureObjectResourceDesc ( hipResourceDesc pResDesc,
hipTextureObject_t  textureObject 
)

Gets resource descriptor for the texture object.

Parameters
[out]pResDescpointer to resource descriptor
[in]textureObjecttexture object
Returns
hipSuccess, hipErrorInvalidValue

◆ hipGetTextureObjectResourceViewDesc()

hipError_t hipGetTextureObjectResourceViewDesc ( struct hipResourceViewDesc pResViewDesc,
hipTextureObject_t  textureObject 
)

Gets resource view descriptor for the texture object.

Parameters
[out]pResViewDescpointer to resource view descriptor
[in]textureObjecttexture object
Returns
hipSuccess, hipErrorInvalidValue

◆ hipGetTextureObjectTextureDesc()

hipError_t hipGetTextureObjectTextureDesc ( hipTextureDesc pTexDesc,
hipTextureObject_t  textureObject 
)

Gets texture descriptor for the texture object.

Parameters
[out]pTexDescpointer to texture descriptor
[in]textureObjecttexture object
Returns
hipSuccess, hipErrorInvalidValue

◆ hipTexObjectCreate()

hipError_t hipTexObjectCreate ( hipTextureObject_t pTexObject,
const HIP_RESOURCE_DESC *  pResDesc,
const HIP_TEXTURE_DESC *  pTexDesc,
const HIP_RESOURCE_VIEW_DESC *  pResViewDesc 
)

Creates a texture object.

Parameters
[out]pTexObjectpointer to texture object to create
[in]pResDescpointer to resource descriptor
[in]pTexDescpointer to texture descriptor
[in]pResViewDescpointer to resource view descriptor
Returns
hipSuccess, hipErrorInvalidValue

◆ hipTexObjectDestroy()

hipError_t hipTexObjectDestroy ( hipTextureObject_t  texObject)

Destroys a texture object.

Parameters
[in]texObjecttexture object to destroy
Returns
hipSuccess, hipErrorInvalidValue

◆ hipTexObjectGetResourceDesc()

hipError_t hipTexObjectGetResourceDesc ( HIP_RESOURCE_DESC *  pResDesc,
hipTextureObject_t  texObject 
)

Gets resource descriptor of a texture object.

Parameters
[out]pResDescpointer to resource descriptor
[in]texObjecttexture object
Returns
hipSuccess, hipErrorNotSupported, hipErrorInvalidValue

◆ hipTexObjectGetResourceViewDesc()

hipError_t hipTexObjectGetResourceViewDesc ( HIP_RESOURCE_VIEW_DESC *  pResViewDesc,
hipTextureObject_t  texObject 
)

Gets resource view descriptor of a texture object.

Parameters
[out]pResViewDescpointer to resource view descriptor
[in]texObjecttexture object
Returns
hipSuccess, hipErrorNotSupported, hipErrorInvalidValue

◆ hipTexObjectGetTextureDesc()

hipError_t hipTexObjectGetTextureDesc ( HIP_TEXTURE_DESC *  pTexDesc,
hipTextureObject_t  texObject 
)

Gets texture descriptor of a texture object.

Parameters
[out]pTexDescpointer to texture descriptor
[in]texObjecttexture object
Returns
hipSuccess, hipErrorNotSupported, hipErrorInvalidValue