1 #ifndef DALI_INTERNAL_NATIVE_IMAGE_SOURCE_H
2 #define DALI_INTERNAL_NATIVE_IMAGE_SOURCE_H
5 * Copyright (c) 2021 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/internal/system/linux/dali-ecore-x.h>
25 #include <dali/internal/graphics/common/graphics-interface.h>
27 #include <dali/public-api/adaptor-framework/native-image-source.h>
29 #include <dali/internal/imaging/common/native-image-source-impl.h>
37 class EglImageExtensions;
40 * Dali internal NativeImageSource.
42 class NativeImageSourceX : public Internal::Adaptor::NativeImageSource
46 * Create a new NativeImageSource internally.
47 * Depending on hardware the width and height may have to be a power of two.
48 * @param[in] width The width of the image.
49 * @param[in] height The height of the image.
50 * @param[in] depth color depth of the image.
51 * @param[in] nativeImageSource contains either: pixmap of type X11 Pixmap , a Ecore_X_Pixmap or is empty
52 * @return A smart-pointer to a newly allocated image.
54 static NativeImageSourceX* New(uint32_t width,
56 Dali::NativeImageSource::ColorDepth depth,
57 Any nativeImageSource);
59 * @copydoc Dali::NativeImageSource::GetNativeImageSource()
61 Any GetNativeImageSource() const override;
64 * @copydoc Dali::NativeImageSource::GetPixels()
66 bool GetPixels(std::vector<unsigned char>& pixbuf, uint32_t& width, uint32_t& height, Pixel::Format& pixelFormat) const override;
69 * @copydoc Dali::NativeImageSource::SetSource( Any source )
71 void SetSource(Any source) override;
74 * @copydoc Dali::NativeImageSource::IsColorDepthSupported( ColorDepth colorDepth )
76 bool IsColorDepthSupported(Dali::NativeImageSource::ColorDepth colorDepth) override;
81 ~NativeImageSourceX() override;
84 * @copydoc Dali::NativeImageSource::CreateResource()
86 bool CreateResource() override;
89 * @copydoc Dali::NativeImageSource::DestroyResource()
91 void DestroyResource() override;
94 * @copydoc Dali::NativeImageSource::TargetTexture()
96 uint32_t TargetTexture() override;
99 * @copydoc Dali::NativeImageSource::PrepareTexture()
101 void PrepareTexture() override;
104 * @copydoc Dali::NativeImageSource::GetWidth()
106 uint32_t GetWidth() const override
112 * @copydoc Dali::NativeImageSource::GetHeight()
114 uint32_t GetHeight() const override
120 * @copydoc Dali::NativeImageSource::RequiresBlending()
122 bool RequiresBlending() const override
124 return mBlendingRequired;
128 * @copydoc Dali::NativeImageSource::GetTextureTarget()
130 int GetTextureTarget() const override;
133 * @copydoc Dali::NativeImageSource::ApplyNativeFragmentShader()
135 bool ApplyNativeFragmentShader(std::string& shader) override;
138 * @copydoc Dali::NativeImageSource::GetCustomSamplerTypename()
140 const char* GetCustomSamplerTypename() const override;
143 * @copydoc Dali::NativeImageSource::GetNativeImageHandle()
145 Any GetNativeImageHandle() const override;
148 * @copydoc Dali::NativeImageSource::SourceChanged()
150 bool SourceChanged() const override;
153 * @copydoc Dali::NativeImageInterface::GetExtension()
155 NativeImageInterface::Extension* GetNativeImageInterfaceExtension() override
161 * @copydoc Dali::Internal::Adaptor::NativeImageSource::AcquireBuffer()
163 uint8_t* AcquireBuffer(uint16_t& width, uint16_t& height, uint16_t& stride) override;
166 * @copydoc Dali::Internal::Adaptor::NativeImageSource::ReleaseBuffer()
168 bool ReleaseBuffer() override;
172 * Private constructor; @see NativeImageSource::New()
173 * @param[in] width The width of the image.
174 * @param[in] height The height of the image.
175 * @param[in] colour depth of the image.
176 * @param[in] nativeImageSource contains either: pixmap of type X11 Pixmap , a Ecore_X_Pixmap or is empty
178 NativeImageSourceX(uint32_t width,
180 Dali::NativeImageSource::ColorDepth depth,
181 Any nativeImageSource);
184 * 2nd phase construction.
189 * Uses X11 to get the default depth.
190 * @param depth the PixelImage depth enum
191 * @return default x11 pixel depth
193 int GetPixelDepth(Dali::NativeImageSource::ColorDepth depth) const;
196 * Gets the pixmap from the Any parameter
197 * @param pixmap contains either: pixmap of type X11 Pixmap , a Ecore_X_Pixmap or is empty
198 * @return pixmap x11 pixmap
200 Ecore_X_Pixmap GetPixmapFromAny(Any pixmap) const;
203 * Given an existing pixmap, the function uses X to find out
204 * the width, heigth and depth of that pixmap.
206 void GetPixmapDetails();
209 uint32_t mWidth; ///< image width
210 uint32_t mHeight; ///< image heights
211 bool mOwnPixmap; ///< Whether we created pixmap or not
212 Ecore_X_Pixmap mPixmap; ///< From Xlib
213 bool mBlendingRequired; ///< Whether blending is required
214 Dali::NativeImageSource::ColorDepth mColorDepth; ///< color depth of image
215 void* mEglImageKHR; ///< From EGL extension
216 EglImageExtensions* mEglImageExtensions; ///< The EGL Image Extensions
219 } // namespace Adaptor
221 } // namespace Internal
225 #endif // DALI_INTERNAL_NATIVE_IMAGE_SOURCE_H