Texture Management

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

Collaboration diagram for Texture Management:

Modules
	Texture Management [Deprecated]

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...
hipError_t	hipMipmappedArrayCreate (hipMipmappedArray_t *pHandle, HIP_ARRAY3D_DESCRIPTOR *pMipmappedArrayDesc, unsigned int numMipmapLevels)
	Create a mipmapped array. More...
hipError_t	hipMipmappedArrayDestroy (hipMipmappedArray_t hMipmappedArray)
	Destroy a mipmapped array. More...
hipError_t	hipMipmappedArrayGetLevel (hipArray_t *pLevelArray, hipMipmappedArray_t hMipMappedArray, unsigned int level)
	Get a mipmapped array on a mipmapped level. 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]	tex	pointer to the texture reference to bind
[in]	mipmappedArray	memory mipmapped array on the device
[in]	desc	opointer 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]	pTexObject	pointer to the texture object to create
[in]	pResDesc	pointer to resource descriptor
[in]	pTexDesc	pointer to texture descriptor
[in]	pResViewDesc	pointer 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]

textureObject

texture 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]	desc	pointer to channel format descriptor
[out]	array	memory 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]	pResDesc	pointer to resource descriptor
[in]	textureObject	texture object

Returns

hipSuccess, hipErrorInvalidValue

hipGetTextureObjectResourceViewDesc()

hipError_t hipGetTextureObjectResourceViewDesc	(	struct hipResourceViewDesc *	pResViewDesc,
		hipTextureObject_t	textureObject
	)

Gets resource view descriptor for the texture object.

Parameters

[out]	pResViewDesc	pointer to resource view descriptor
[in]	textureObject	texture object

Returns

hipSuccess, hipErrorInvalidValue

hipGetTextureObjectTextureDesc()

hipError_t hipGetTextureObjectTextureDesc	(	hipTextureDesc *	pTexDesc,
		hipTextureObject_t	textureObject
	)

Gets texture descriptor for the texture object.

Parameters

[out]	pTexDesc	pointer to texture descriptor
[in]	textureObject	texture object

Returns

hipSuccess, hipErrorInvalidValue

hipMipmappedArrayCreate()

hipError_t hipMipmappedArrayCreate	(	hipMipmappedArray_t *	pHandle,
		HIP_ARRAY3D_DESCRIPTOR *	pMipmappedArrayDesc,
		unsigned int	numMipmapLevels
	)

Create a mipmapped array.

Parameters

[out]	pHandle	pointer to mipmapped array
[in]	pMipmappedArrayDesc	mipmapped array descriptor
[in]	numMipmapLevels	mipmap level

Returns

hipSuccess, hipErrorNotSupported, hipErrorInvalidValue

hipMipmappedArrayDestroy()

hipError_t hipMipmappedArrayDestroy

(

hipMipmappedArray_t

hMipmappedArray

)

Destroy a mipmapped array.

Parameters

[out]

hMipmappedArray

pointer to mipmapped array to destroy

Returns

hipSuccess, hipErrorInvalidValue

hipMipmappedArrayGetLevel()

hipError_t hipMipmappedArrayGetLevel	(	hipArray_t *	pLevelArray,
		hipMipmappedArray_t	hMipMappedArray,
		unsigned int	level
	)

Get a mipmapped array on a mipmapped level.

Parameters

[in]	pLevelArray	Pointer of array
[out]	hMipMappedArray	Pointer of mipmapped array on the requested mipmap level
[out]	level	Mipmap level

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]	pTexObject	pointer to texture object to create
[in]	pResDesc	pointer to resource descriptor
[in]	pTexDesc	pointer to texture descriptor
[in]	pResViewDesc	pointer to resource view descriptor

Returns

hipSuccess, hipErrorInvalidValue

hipTexObjectDestroy()

hipError_t hipTexObjectDestroy

(

hipTextureObject_t

texObject

)

Destroys a texture object.

Parameters

[in]

texObject

texture 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]	pResDesc	pointer to resource descriptor
[in]	texObject	texture 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]	pResViewDesc	pointer to resource view descriptor
[in]	texObject	texture 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]	pTexDesc	pointer to texture descriptor
[in]	texObject	texture object

Returns

hipSuccess, hipErrorNotSupported, hipErrorInvalidValue