hip_texture.h

Go to the documentation of this file.

/*
Copyright (c) 2015-2016 Advanced Micro Devices, Inc. All rights reserved.

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in
all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.  IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
THE SOFTWARE.
*/
#pragma once

#include <limits.h>

#include <hip_runtime.h>

//----
//Texture - TODO - likely need to move this to a separate file only included with kernel compilation.
#define hipTextureType1D 1

typedef struct hipChannelFormatDesc {
    // TODO - this has 4-5 well-defined fields, we could just copy...
    int _dummy;
} hipChannelFormatDesc;

typedef enum hipTextureReadMode
{
  hipReadModeElementType,  
} hipTextureReadMode;

typedef enum hipTextureFilterMode
{
    hipFilterModePoint,  
} hipTextureFilterMode;

struct textureReference {
    hipTextureFilterMode filterMode;
    bool                 normalized;
    hipChannelFormatDesc channelDesc;
};

template <class T, int texType=hipTextureType1D, enum hipTextureReadMode=hipReadModeElementType>
struct texture : public textureReference {

    const T * _dataPtr;  // pointer to underlying data.

    //texture() : filterMode(hipFilterModePoint), normalized(false), _dataPtr(NULL) {};
};




#define tex1Dfetch(_tex, _addr) (_tex._dataPtr[_addr])




// These are C++ APIs - maybe belong in separate file.
// C API:
#if 0
hipChannelFormatDesc  hipBindTexture(size_t *offset, struct textureReference *tex, const void *devPtr, const struct hipChannelFormatDesc *desc, size_t size=UINT_MAX)
{
    tex->_dataPtr = devPtr;
}
#endif

/*
 * @brief Returns a channel descriptor with format f and number of bits of each ocmponent x,y,z and w.
 *
 * @par Parameters
 *      None.
 * @return Channel descriptor
 *
 *
 **/
template <class T>
hipChannelFormatDesc  hipCreateChannelDesc()
{
    hipChannelFormatDesc desc;
    return desc;
}

/*
 * @brief hipBindTexture Binds size bytes of the memory area pointed to by @p devPtr to the texture reference tex.
 *
 * @p desc describes how the memory is interpreted when fetching values from the texture. The @p offset parameter is an optional byte offset as with the low-level
 * hipBindTexture() function. Any memory previously bound to tex is unbound.
 *
 *  @param[in]  offset - Offset in bytes
 *  @param[out]  tex - texture to bind
 *  @param[in]  devPtr - Memory area on device
 *  @param[in]  desc - Channel format
 *  @param[in]  size - Size of the memory area pointed to by devPtr
 *  @return #hipSuccess, #hipErrorInvalidValue, #hipErrorMemoryFree, #hipErrorUnknown
 **/
template <class T, int dim, enum hipTextureReadMode readMode>
hipError_t  hipBindTexture(size_t *offset,
                                     struct texture<T, dim, readMode> &tex,
                                     const void *devPtr,
                                     const struct hipChannelFormatDesc *desc,
                                     size_t size=UINT_MAX)
{
    tex._dataPtr = static_cast<const T*>(devPtr);

    return hipSuccess;
}

/*
 * @brief hipBindTexture Binds size bytes of the memory area pointed to by @p devPtr to the texture reference tex.
 *
 * @p desc describes how the memory is interpreted when fetching values from the texture. The @p offset parameter is an optional byte offset as with the low-level
 * hipBindTexture() function. Any memory previously bound to tex is unbound.
 *
 *  @param[in]  offset - Offset in bytes
 *  @param[in]  tex - texture to bind
 *  @param[in]  devPtr - Memory area on device
 *  @param[in]  size - Size of the memory area pointed to by devPtr
 *  @return #hipSuccess, #hipErrorInvalidValue, #hipErrorMemoryFree, #hipErrorUnknown
 **/
template <class T, int dim, enum hipTextureReadMode readMode>
hipError_t  hipBindTexture(size_t *offset,
                                     struct texture<T, dim, readMode> &tex,
                                     const void *devPtr,
                                     size_t size=UINT_MAX)
{
    return  hipBindTexture(offset, tex, devPtr, &tex.channelDesc, size);
}


/*
 * @brief Unbinds the textuer bound to @p tex
 *
 *  @param[in]  tex - texture to unbind
 *
 *  @return #hipSuccess
 **/
template <class T, int dim, enum hipTextureReadMode readMode>
hipError_t  hipUnbindTexture(struct texture<T, dim, readMode> *tex)
{
    tex->_dataPtr = NULL;

    return hipSuccess;
}



// doxygen end Texture
// End doxygen API: