Texture Management [Deprecated]#
Functions | |
hipError_t | hipBindTextureToMipmappedArray (const textureReference *tex, hipMipmappedArray_const_t mipmappedArray, const hipChannelFormatDesc *desc) |
Binds a mipmapped array to a texture. | |
hipError_t | hipGetTextureReference (const textureReference **texref, const void *symbol) |
Gets the texture reference related with the symbol. | |
hipError_t | hipTexRefGetBorderColor (float *pBorderColor, const textureReference *texRef) |
Gets the border color used by a texture reference. | |
hipError_t | hipTexRefGetArray (hipArray_t *pArray, const textureReference *texRef) |
Gets the array bound to a texture reference. | |
hipError_t | hipTexRefSetAddressMode (textureReference *texRef, int dim, enum hipTextureAddressMode am) |
Sets address mode for a texture reference. | |
hipError_t | hipTexRefSetArray (textureReference *tex, hipArray_const_t array, unsigned int flags) |
Binds an array as a texture reference. | |
hipError_t | hipTexRefSetFilterMode (textureReference *texRef, enum hipTextureFilterMode fm) |
Set filter mode for a texture reference. | |
hipError_t | hipTexRefSetFlags (textureReference *texRef, unsigned int Flags) |
Set flags for a texture reference. | |
hipError_t | hipTexRefSetFormat (textureReference *texRef, hipArray_Format fmt, int NumPackedComponents) |
Set format for a texture reference. | |
hipError_t | hipBindTexture (size_t *offset, const textureReference *tex, const void *devPtr, const hipChannelFormatDesc *desc, size_t size) |
Binds a memory area to a texture. | |
hipError_t | hipBindTexture2D (size_t *offset, const textureReference *tex, const void *devPtr, const hipChannelFormatDesc *desc, size_t width, size_t height, size_t pitch) |
Binds a 2D memory area to a texture. | |
hipError_t | hipBindTextureToArray (const textureReference *tex, hipArray_const_t array, const hipChannelFormatDesc *desc) |
Binds a memory area to a texture. | |
hipError_t | hipGetTextureAlignmentOffset (size_t *offset, const textureReference *texref) |
Get the offset of the alignment in a texture. | |
hipError_t | hipUnbindTexture (const textureReference *tex) |
Unbinds a texture. | |
hipError_t | hipTexRefGetAddress (hipDeviceptr_t *dev_ptr, const textureReference *texRef) |
Gets the address for a texture reference. | |
hipError_t | hipTexRefGetAddressMode (enum hipTextureAddressMode *pam, const textureReference *texRef, int dim) |
Gets the address mode for a texture reference. | |
hipError_t | hipTexRefGetFilterMode (enum hipTextureFilterMode *pfm, const textureReference *texRef) |
Gets filter mode for a texture reference. | |
hipError_t | hipTexRefGetFlags (unsigned int *pFlags, const textureReference *texRef) |
Gets flags for a texture reference. | |
hipError_t | hipTexRefGetFormat (hipArray_Format *pFormat, int *pNumChannels, const textureReference *texRef) |
Gets texture format for a texture reference. | |
hipError_t | hipTexRefGetMaxAnisotropy (int *pmaxAnsio, const textureReference *texRef) |
Gets the maximum anisotropy for a texture reference. | |
hipError_t | hipTexRefGetMipmapFilterMode (enum hipTextureFilterMode *pfm, const textureReference *texRef) |
Gets the mipmap filter mode for a texture reference. | |
hipError_t | hipTexRefGetMipmapLevelBias (float *pbias, const textureReference *texRef) |
Gets the mipmap level bias for a texture reference. | |
hipError_t | hipTexRefGetMipmapLevelClamp (float *pminMipmapLevelClamp, float *pmaxMipmapLevelClamp, const textureReference *texRef) |
Gets the minimum and maximum mipmap level clamps for a texture reference. | |
hipError_t | hipTexRefGetMipMappedArray (hipMipmappedArray_t *pArray, const textureReference *texRef) |
Gets the mipmapped array bound to a texture reference. | |
hipError_t | hipTexRefSetAddress (size_t *ByteOffset, textureReference *texRef, hipDeviceptr_t dptr, size_t bytes) |
Sets an bound address for a texture reference. | |
hipError_t | hipTexRefSetAddress2D (textureReference *texRef, const HIP_ARRAY_DESCRIPTOR *desc, hipDeviceptr_t dptr, size_t Pitch) |
Set a bind an address as a 2D texture reference. | |
hipError_t | hipTexRefSetMaxAnisotropy (textureReference *texRef, unsigned int maxAniso) |
Sets the maximum anisotropy for a texture reference. | |
hipError_t | hipTexRefSetBorderColor (textureReference *texRef, float *pBorderColor) |
Sets border color for a texture reference. | |
hipError_t | hipTexRefSetMipmapFilterMode (textureReference *texRef, enum hipTextureFilterMode fm) |
Sets mipmap filter mode for a texture reference. | |
hipError_t | hipTexRefSetMipmapLevelBias (textureReference *texRef, float bias) |
Sets mipmap level bias for a texture reference. | |
hipError_t | hipTexRefSetMipmapLevelClamp (textureReference *texRef, float minMipMapLevelClamp, float maxMipMapLevelClamp) |
Sets mipmap level clamp for a texture reference. | |
hipError_t | hipTexRefSetMipmappedArray (textureReference *texRef, struct hipMipmappedArray *mipmappedArray, unsigned int Flags) |
Binds mipmapped array to a texture reference. | |
Detailed Description
This section describes the deprecated texture management functions of HIP runtime API.
Function Documentation
◆ hipBindTexture()
hipError_t hipBindTexture | ( | size_t * | offset, |
const textureReference * | tex, | ||
const void * | devPtr, | ||
const hipChannelFormatDesc * | desc, | ||
size_t | size | ||
) |
Binds a memory area to a texture.
- Parameters
-
[in] offset Offset in bytes. [in] tex Texture to bind. [in] devPtr Pointer of memory on the device. [in] desc Pointer of channel format descriptor. [in] size Size of memory in bites.
- Warning
- This API is deprecated.
◆ hipBindTexture2D()
hipError_t hipBindTexture2D | ( | size_t * | offset, |
const textureReference * | tex, | ||
const void * | devPtr, | ||
const hipChannelFormatDesc * | desc, | ||
size_t | width, | ||
size_t | height, | ||
size_t | pitch | ||
) |
Binds a 2D memory area to a texture.
- Parameters
-
[in] offset Offset in bytes. [in] tex Texture to bind. [in] devPtr Pointer of 2D memory area on the device. [in] desc Pointer of channel format descriptor. [in] width Width in texel units. [in] height Height in texel units. [in] pitch Pitch in bytes.
- Warning
- This API is deprecated.
◆ hipBindTextureToArray()
hipError_t hipBindTextureToArray | ( | const textureReference * | tex, |
hipArray_const_t | array, | ||
const hipChannelFormatDesc * | desc | ||
) |
Binds a memory area to a texture.
- Parameters
-
[in] tex Pointer of texture reference. [in] array Array to bind. [in] desc Pointer of channel format descriptor.
- Warning
- This API is deprecated.
◆ 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
◆ hipGetTextureAlignmentOffset()
hipError_t hipGetTextureAlignmentOffset | ( | size_t * | offset, |
const textureReference * | texref | ||
) |
Get the offset of the alignment in a texture.
- Parameters
-
[in] offset Offset in bytes. [in] texref Pointer of texture reference.
- Warning
- This API is deprecated.
◆ hipGetTextureReference()
hipError_t hipGetTextureReference | ( | const textureReference ** | texref, |
const void * | symbol | ||
) |
Gets the texture reference related with the symbol.
- Parameters
-
[out] texref texture reference [in] symbol pointer to the symbol related with the texture for the reference
- Returns
- hipSuccess, hipErrorInvalidValue
- Warning
- This API is deprecated.
◆ hipTexRefGetAddress()
hipError_t hipTexRefGetAddress | ( | hipDeviceptr_t * | dev_ptr, |
const textureReference * | texRef | ||
) |
Gets the address for a texture reference.
- Parameters
-
[out] dev_ptr Pointer of device address. [in] texRef Pointer of texture reference.
- Warning
- This API is deprecated.
◆ hipTexRefGetAddressMode()
hipError_t hipTexRefGetAddressMode | ( | enum hipTextureAddressMode * | pam, |
const textureReference * | texRef, | ||
int | dim | ||
) |
Gets the address mode for a texture reference.
- Parameters
-
[out] pam Pointer of address mode. [in] texRef Pointer of texture reference. [in] dim Dimension.
- Warning
- This API is deprecated.
◆ hipTexRefGetArray()
hipError_t hipTexRefGetArray | ( | hipArray_t * | pArray, |
const textureReference * | texRef | ||
) |
Gets the array bound to a texture reference.
- Parameters
-
[in] pArray Returned array. [in] texRef texture reference.
- Returns
- hipSuccess, hipErrorInvalidValue
- Warning
- This API is deprecated.
◆ hipTexRefGetBorderColor()
hipError_t hipTexRefGetBorderColor | ( | float * | pBorderColor, |
const textureReference * | texRef | ||
) |
Gets the border color used by a texture reference.
- Parameters
-
[out] pBorderColor Returned Type and Value of RGBA color. [in] texRef Texture reference.
- Returns
- hipSuccess, hipErrorInvalidValue
- Warning
- This API is deprecated.
◆ hipTexRefGetFilterMode()
hipError_t hipTexRefGetFilterMode | ( | enum hipTextureFilterMode * | pfm, |
const textureReference * | texRef | ||
) |
Gets filter mode for a texture reference.
- Parameters
-
[out] pfm Pointer of filter mode. [in] texRef Pointer of texture reference.
- Warning
- This API is deprecated.
◆ hipTexRefGetFlags()
hipError_t hipTexRefGetFlags | ( | unsigned int * | pFlags, |
const textureReference * | texRef | ||
) |
Gets flags for a texture reference.
- Parameters
-
[out] pFlags Pointer of flags. [in] texRef Pointer of texture reference.
- Warning
- This API is deprecated.
◆ hipTexRefGetFormat()
hipError_t hipTexRefGetFormat | ( | hipArray_Format * | pFormat, |
int * | pNumChannels, | ||
const textureReference * | texRef | ||
) |
Gets texture format for a texture reference.
- Parameters
-
[out] pFormat Pointer of the format. [out] pNumChannels Pointer of number of channels. [in] texRef Pointer of texture reference.
- Warning
- This API is deprecated.
◆ hipTexRefGetMaxAnisotropy()
hipError_t hipTexRefGetMaxAnisotropy | ( | int * | pmaxAnsio, |
const textureReference * | texRef | ||
) |
Gets the maximum anisotropy for a texture reference.
- Parameters
-
[out] pmaxAnsio Pointer of the maximum anisotropy. [in] texRef Pointer of texture reference.
- Warning
- This API is deprecated.
◆ hipTexRefGetMipmapFilterMode()
hipError_t hipTexRefGetMipmapFilterMode | ( | enum hipTextureFilterMode * | pfm, |
const textureReference * | texRef | ||
) |
Gets the mipmap filter mode for a texture reference.
- Parameters
-
[out] pfm Pointer of the mipmap filter mode. [in] texRef Pointer of texture reference.
- Warning
- This API is deprecated.
◆ hipTexRefGetMipmapLevelBias()
hipError_t hipTexRefGetMipmapLevelBias | ( | float * | pbias, |
const textureReference * | texRef | ||
) |
Gets the mipmap level bias for a texture reference.
- Parameters
-
[out] pbias Pointer of the mipmap level bias. [in] texRef Pointer of texture reference.
- Warning
- This API is deprecated.
◆ hipTexRefGetMipmapLevelClamp()
hipError_t hipTexRefGetMipmapLevelClamp | ( | float * | pminMipmapLevelClamp, |
float * | pmaxMipmapLevelClamp, | ||
const textureReference * | texRef | ||
) |
Gets the minimum and maximum mipmap level clamps for a texture reference.
- Parameters
-
[out] pminMipmapLevelClamp Pointer of the minimum mipmap level clamp. [out] pmaxMipmapLevelClamp Pointer of the maximum mipmap level clamp. [in] texRef Pointer of texture reference.
- Warning
- This API is deprecated.
◆ hipTexRefGetMipMappedArray()
hipError_t hipTexRefGetMipMappedArray | ( | hipMipmappedArray_t * | pArray, |
const textureReference * | texRef | ||
) |
Gets the mipmapped array bound to a texture reference.
- Parameters
-
[out] pArray Pointer of the mipmapped array. [in] texRef Pointer of texture reference.
- Warning
- This API is deprecated.
◆ hipTexRefSetAddress()
hipError_t hipTexRefSetAddress | ( | size_t * | ByteOffset, |
textureReference * | texRef, | ||
hipDeviceptr_t | dptr, | ||
size_t | bytes | ||
) |
Sets an bound address for a texture reference.
- Parameters
-
[out] ByteOffset Pointer of the offset in bytes. [in] texRef Pointer of texture reference. [in] dptr Pointer of device address to bind. [in] bytes Size in bytes.
- Returns
- hipSuccess, hipErrorInvalidValue
- Warning
- This API is deprecated.
◆ hipTexRefSetAddress2D()
hipError_t hipTexRefSetAddress2D | ( | textureReference * | texRef, |
const HIP_ARRAY_DESCRIPTOR * | desc, | ||
hipDeviceptr_t | dptr, | ||
size_t | Pitch | ||
) |
Set a bind an address as a 2D texture reference.
- Parameters
-
[in] texRef Pointer of texture reference. [in] desc Pointer of array descriptor. [in] dptr Pointer of device address to bind. [in] Pitch Pitch in bytes.
- Warning
- This API is deprecated.
◆ hipTexRefSetAddressMode()
hipError_t hipTexRefSetAddressMode | ( | textureReference * | texRef, |
int | dim, | ||
enum hipTextureAddressMode | am | ||
) |
Sets address mode for a texture reference.
- Parameters
-
[in] texRef texture reference. [in] dim Dimension of the texture. [in] am Value of the texture address mode.
- Returns
- hipSuccess, hipErrorInvalidValue
- Warning
- This API is deprecated.
◆ hipTexRefSetArray()
hipError_t hipTexRefSetArray | ( | textureReference * | tex, |
hipArray_const_t | array, | ||
unsigned int | flags | ||
) |
Binds an array as a texture reference.
- Parameters
-
[in] tex Pointer texture reference. [in] array Array to bind. [in] flags Flags should be set as HIP_TRSA_OVERRIDE_FORMAT, as a valid value.
- Returns
- hipSuccess, hipErrorInvalidValue
- Warning
- This API is deprecated.
◆ hipTexRefSetBorderColor()
hipError_t hipTexRefSetBorderColor | ( | textureReference * | texRef, |
float * | pBorderColor | ||
) |
Sets border color for a texture reference.
- Parameters
-
[in] texRef Pointer of texture reference. [in] pBorderColor Pointer of border color.
- Warning
- This API is deprecated.
◆ hipTexRefSetFilterMode()
hipError_t hipTexRefSetFilterMode | ( | textureReference * | texRef, |
enum hipTextureFilterMode | fm | ||
) |
Set filter mode for a texture reference.
- Parameters
-
[in] texRef Pointer texture reference. [in] fm Value of texture filter mode.
- Returns
- hipSuccess, hipErrorInvalidValue
- Warning
- This API is deprecated.
◆ hipTexRefSetFlags()
hipError_t hipTexRefSetFlags | ( | textureReference * | texRef, |
unsigned int | Flags | ||
) |
Set flags for a texture reference.
- Parameters
-
[in] texRef Pointer texture reference. [in] Flags Value of flags.
- Returns
- hipSuccess, hipErrorInvalidValue
- Warning
- This API is deprecated.
◆ hipTexRefSetFormat()
hipError_t hipTexRefSetFormat | ( | textureReference * | texRef, |
hipArray_Format | fmt, | ||
int | NumPackedComponents | ||
) |
Set format for a texture reference.
- Parameters
-
[in] texRef Pointer texture reference. [in] fmt Value of format. [in] NumPackedComponents Number of components per array.
- Returns
- hipSuccess, hipErrorInvalidValue
- Warning
- This API is deprecated.
◆ hipTexRefSetMaxAnisotropy()
hipError_t hipTexRefSetMaxAnisotropy | ( | textureReference * | texRef, |
unsigned int | maxAniso | ||
) |
Sets the maximum anisotropy for a texture reference.
- Parameters
-
[in] texRef Pointer of texture reference. [out] maxAniso Value of the maximum anisotropy.
- Warning
- This API is deprecated.
◆ hipTexRefSetMipmapFilterMode()
hipError_t hipTexRefSetMipmapFilterMode | ( | textureReference * | texRef, |
enum hipTextureFilterMode | fm | ||
) |
Sets mipmap filter mode for a texture reference.
- Parameters
-
[in] texRef Pointer of texture reference. [in] fm Value of filter mode.
- Warning
- This API is deprecated.
◆ hipTexRefSetMipmapLevelBias()
hipError_t hipTexRefSetMipmapLevelBias | ( | textureReference * | texRef, |
float | bias | ||
) |
Sets mipmap level bias for a texture reference.
- Parameters
-
[in] texRef Pointer of texture reference. [in] bias Value of mipmap bias.
- Warning
- This API is deprecated.
◆ hipTexRefSetMipmapLevelClamp()
hipError_t hipTexRefSetMipmapLevelClamp | ( | textureReference * | texRef, |
float | minMipMapLevelClamp, | ||
float | maxMipMapLevelClamp | ||
) |
Sets mipmap level clamp for a texture reference.
- Parameters
-
[in] texRef Pointer of texture reference. [in] minMipMapLevelClamp Value of minimum mipmap level clamp. [in] maxMipMapLevelClamp Value of maximum mipmap level clamp.
- Warning
- This API is deprecated.
◆ hipTexRefSetMipmappedArray()
hipError_t hipTexRefSetMipmappedArray | ( | textureReference * | texRef, |
struct hipMipmappedArray * | mipmappedArray, | ||
unsigned int | Flags | ||
) |
Binds mipmapped array to a texture reference.
- Parameters
-
[in] texRef Pointer of texture reference to bind. [in] mipmappedArray Pointer of mipmapped array to bind. [in] Flags Flags should be set as HIP_TRSA_OVERRIDE_FORMAT, as a valid value.
- Returns
- hipSuccess, hipErrorInvalidValue
- Warning
- This API is deprecated.
◆ hipUnbindTexture()
hipError_t hipUnbindTexture | ( | const textureReference * | tex | ) |
Unbinds a texture.
- Parameters
-
[in] tex Texture to unbind.
- Warning
- This API is deprecated.