5 * Copyright (c) 2018 Samsung Electronics Co., Ltd.
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
11 * http://www.apache.org/licenses/LICENSE-2.0
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.
22 #include <dali/public-api/object/handle.h> // Dali::Handle
23 #include <dali/public-api/actors/sampling.h>
28 namespace Internal DALI_INTERNAL
34 * @brief Sampler is a handle to an object that can be used to provide the sampling parameters to sample textures.
38 class DALI_CORE_API Sampler : public BaseHandle
43 * @brief Creates a new Sampler object.
46 * @return A handle to the Sampler
51 * @brief Default constructor, creates an empty handle.
65 * @brief Copy constructor, creates a new handle to the same object.
68 * @param[in] handle Handle to an object
70 Sampler( const Sampler& handle );
73 * @brief Downcasts to a sampler handle.
74 * If not, the returned handle is left uninitialized.
77 * @param[in] handle Handle to an object
78 * @return Handle or an uninitialized handle
80 static Sampler DownCast( BaseHandle handle );
83 * @brief Assignment operator, changes this handle to point at the same object.
86 * @param[in] handle Handle to an object
87 * @return Reference to the assigned object
89 Sampler& operator=( const Sampler& handle );
93 * @brief Sets the filter modes for this sampler.
94 * Calling this function sets the properties MINIFICATION_FILTER and MAGNIFICATION_FILTER.
97 * @param[in] minFilter The minification filter that will be used
98 * @param[in] magFilter The magnification filter that will be used
100 void SetFilterMode( FilterMode::Type minFilter, FilterMode::Type magFilter );
103 * @brief Sets the wrap modes for this sampler.
106 * @param[in] uWrap Wrap mode for u coordinates
107 * @param[in] vWrap Wrap mode for v coordinates
109 void SetWrapMode( WrapMode::Type uWrap, WrapMode::Type vWrap );
112 * @brief Sets the wrap modes for this sampler.
115 * @param[in] rWrap Wrap mode for the z direction
116 * @param[in] sWrap Wrap mode for the x direction
117 * @param[in] tWrap Wrap mode for the y direction
119 void SetWrapMode( WrapMode::Type rWrap, WrapMode::Type sWrap, WrapMode::Type tWrap );
124 * @brief The constructor.
125 * @note Not intended for application developers.
127 * @param[in] pointer A pointer to a newly allocated Sampler
129 explicit DALI_INTERNAL Sampler( Internal::Sampler* pointer );
134 #endif // DALI_SAMPLER_H