dali/public-api/rendering/sampler.h

   1 #ifndef DALI_SAMPLER_H
   2 #define DALI_SAMPLER_H
   3
   4 /*
   5  * Copyright (c) 2016 Samsung Electronics Co., Ltd.
   6  *
   7  * Licensed under the Apache License, Version 2.0 (the "License");
   8  * you may not use this file except in compliance with the License.
   9  * You may obtain a copy of the License at
  10  *
  11  * http://www.apache.org/licenses/LICENSE-2.0
  12  *
  13  * Unless required by applicable law or agreed to in writing, software
  14  * distributed under the License is distributed on an "AS IS" BASIS,
  15  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  16  * See the License for the specific language governing permissions and
  17  * limitations under the License.
  18  *
  19  */
  20
  21 // INTERNAL INCLUDES
  22 #include <dali/public-api/object/handle.h>   // Dali::Handle
  23 #include <dali/public-api/actors/sampling.h>
  24
  25 namespace Dali
  26 {
  27
  28 namespace Internal DALI_INTERNAL
  29 {
  30 class Sampler;
  31 }
  32
  33 /**
  34  * @brief Sampler is a handle to an object that can be used to provide the sampling parameters to sample textures
  35  *
  36  * @SINCE_1_1.43
  37  */
  38 class DALI_IMPORT_API Sampler : public BaseHandle
  39 {
  40 public:
  41
  42   /**
  43    * @brief Creates a new Sampler object
  44    *
  45    * @SINCE_1_1.43
  46    */
  47   static Sampler New();
  48
  49   /**
  50    * @brief Default constructor, creates an empty handle
  51    *
  52    * @SINCE_1_1.43
  53    */
  54   Sampler();
  55
  56   /**
  57    * @brief Destructor
  58    *
  59    * @SINCE_1_1.43
  60    */
  61   ~Sampler();
  62
  63   /**
  64    * @brief Copy constructor, creates a new handle to the same object
  65    *
  66    * @SINCE_1_1.43
  67    * @param[in] handle Handle to an object
  68    */
  69   Sampler( const Sampler& handle );
  70
  71   /**
  72    * @brief Downcast to a sampler handle.
  73    * If not the returned handle is left uninitialized.
  74    *
  75    * @SINCE_1_1.43
  76    * @param[in] handle Handle to an object
  77    * @return Handle or an uninitialized handle
  78    */
  79   static Sampler DownCast( BaseHandle handle );
  80
  81   /**
  82    * @brief Assignment operator, changes this handle to point at the same object
  83    *
  84    * @SINCE_1_1.43
  85    * @param[in] handle Handle to an object
  86    * @return Reference to the assigned object
  87    */
  88   Sampler& operator=( const Sampler& handle );
  89
  90
  91   /**
  92    * @brief Set the filter modes for this sampler
  93    * Calling this function sets the properties MINIFICATION_FILTER and MAGNIFICATION_FILTER.
  94    *
  95    * @SINCE_1_1.43
  96    * @param[in] minFilter The minification filter that will be used
  97    * @param[in] magFilter The magnification filter that will be used
  98    */
  99   void SetFilterMode( FilterMode::Type minFilter, FilterMode::Type magFilter );
 100
 101   /**
 102    * @brief Set the wrap modes for this sampler
 103    *
 104    * @SINCE_1_1.43
 105    * param[in] uWrap Wrap mode for u coordinates
 106    * param[in] vWrap Wrap mode for v coordinates
 107    */
 108   void SetWrapMode( WrapMode::Type uWrap, WrapMode::Type vWrap );
 109
 110   /**
 111    * @brief Set the wrap modes for this sampler
 112    *
 113    * @SINCE_1_1.43
 114    * param[in] rWrap Wrap mode for the z direction
 115    * param[in] sWrap Wrap mode for the x direction
 116    * param[in] tWrap Wrap mode for the y direction
 117    */
 118   void SetWrapMode( WrapMode::Type rWrap, WrapMode::Type sWrap, WrapMode::Type tWrap );
 119
 120 public:
 121
 122   /**
 123    * @brief The constructor
 124    * @note  Not intended for application developers.
 125    * @SINCE_1_1.43
 126    * @param[in] pointer A pointer to a newly allocated Sampler
 127    */
 128   explicit DALI_INTERNAL Sampler( Internal::Sampler* pointer );
 129 };
 130
 131 } //namespace Dali
 132
 133 #endif // DALI_SAMPLER_H