1 /* 2 * Copyright (c) 2017, Intel Corporation 3 * 4 * Permission is hereby granted, free of charge, to any person obtaining a 5 * copy of this software and associated documentation files (the "Software"), 6 * to deal in the Software without restriction, including without limitation 7 * the rights to use, copy, modify, merge, publish, distribute, sublicense, 8 * and/or sell copies of the Software, and to permit persons to whom the 9 * Software is furnished to do so, subject to the following conditions: 10 * 11 * The above copyright notice and this permission notice shall be included 12 * in all copies or substantial portions of the Software. 13 * 14 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS 15 * OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, 16 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL 17 * THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR 18 * OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, 19 * ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR 20 * OTHER DEALINGS IN THE SOFTWARE. 21 */ 22 //! 23 //! \file cm_sampler.h 24 //! \brief Contains CmSampler declarations. 25 //! 26 27 #ifndef MEDIADRIVER_AGNOSTIC_COMMON_CM_CMSAMPLER_H_ 28 #define MEDIADRIVER_AGNOSTIC_COMMON_CM_CMSAMPLER_H_ 29 30 #include "cm_def.h" 31 32 namespace CMRT_UMD 33 { 34 //! 35 //! 36 //! \brief Abstraction of 3D sampler intrinsics. 37 //! \details A CmSampler object is used to specify sampling operations to be 38 //! performed by the 3D sampler kernel intrinsics. 39 //! 40 class CmSampler 41 { 42 public: 43 //! 44 //! \brief Retrieves pointer to the SamplerIndex associated with this 45 //! CmSampler. 46 //! \details Each CmSampler is associated with a SamplerIndex containing a 47 //! unique value to which the CmSampler is mapped to. 48 //! CmDevice keeps the mapping between index value and CmSampler. 49 //! SamplerIndex is passed to CM kernel function as an argument to 50 //! indicate this CmSampler. 51 //! \param [out] index 52 //! Reference to SamplerIndex pointer. It'll point to the 53 //! SamplerIndex associated with this CmSampler. 54 //! \retval CM_SUCCESS. 55 //! 56 CM_RT_API virtual int32_t GetIndex(SamplerIndex* &index) = 0; 57 }; 58 };//namespace 59 60 #endif // #ifndef MEDIADRIVER_AGNOSTIC_COMMON_CM_CMSAMPLER_H_ 61