xref: /aosp_15_r20/external/intel-media-driver/media_driver/agnostic/common/cm/cm_sampler8x8.h (revision ba62d9d3abf0e404f2022b4cd7a85e107f48596f)
1 /*
2 * Copyright (c) 2007-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_sampler8x8.h
24 //! \brief     Contains CmSampler8x8 declarations.
25 //!
26 
27 #ifndef MEDIADRIVER_AGNOSTIC_COMMON_CM_CMSAMPLER8X8_H_
28 #define MEDIADRIVER_AGNOSTIC_COMMON_CM_CMSAMPLER8X8_H_
29 
30 #include "cm_def.h"
31 
32 namespace CMRT_UMD
33 {
34 //!
35 //! \brief      Abstaction of media sampler intrinsics and hardware.
36 //! \details    A CmSampler8x8 object is used to specify sampling operations to be
37 //!             performed by the media sampler kernel intrinsics.
38 //!
39 class CmSampler8x8
40 {
41 public:
42     //!
43     //! \brief      Retrieves pointer to the SamplerIndex associated with this
44     //!             CmSampler8x8.
45     //! \details    Each CmSampler8x8 is associated with a SamplerIndex containing a
46     //!             unique value to which the CmSampler8x8 is mapped to.
47     //!             CmDevice keeps the mapping between index value and CmSampler8x8.
48     //!             SamplerIndex is passed to CM kernel function as an argument to
49     //!             indicate this CmSampler8x8.
50     //! \param      [out] index
51     //!             Reference to SamplerIndex pointer. It'll point to the
52     //!             SamplerIndex associated with this CmSampler8x8.
53     //! \retval     CM_SUCCESS.
54     //!
55     CM_RT_API virtual int32_t GetIndex(SamplerIndex* &index) = 0;
56 };
57 }; //namespace
58 
59 #endif  // #ifndef #ifndef MEDIADRIVER_AGNOSTIC_COMMON_CM_CMSAMPLER8X8_H_
60