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>
26 #include <dali/public-api/adaptor-framework/native-image-source.h>
27 #include <dali/internal/imaging/common/native-image-source-impl.h>
35 class EglImageExtensions;
38 * Dali internal NativeImageSource.
40 class NativeImageSourceX : public Internal::Adaptor::NativeImageSource
44 * Create a new NativeImageSource internally.
45 * Depending on hardware the width and height may have to be a power of two.
46 * @param[in] width The width of the image.
47 * @param[in] height The height of the image.
48 * @param[in] depth color depth of the image.
49 * @param[in] nativeImageSource contains either: pixmap of type X11 Pixmap , a Ecore_X_Pixmap or is empty
50 * @return A smart-pointer to a newly allocated image.
52 static NativeImageSourceX* New(uint32_t width,
54 Dali::NativeImageSource::ColorDepth depth,
55 Any nativeImageSource);
57 * @copydoc Dali::NativeImageSource::GetNativeImageSource()
59 Any GetNativeImageSource() const override;
62 * @copydoc Dali::NativeImageSource::GetPixels()
64 bool GetPixels(std::vector<unsigned char>& pixbuf, uint32_t& width, uint32_t& height, Pixel::Format& pixelFormat) const override;
67 * @copydoc Dali::NativeImageSource::SetSource( Any source )
69 void SetSource(Any source) override;
72 * @copydoc Dali::NativeImageSource::IsColorDepthSupported( ColorDepth colorDepth )
74 bool IsColorDepthSupported(Dali::NativeImageSource::ColorDepth colorDepth) override;
79 ~NativeImageSourceX() override;
82 * @copydoc Dali::NativeImageSource::CreateResource()
84 bool CreateResource() override;
87 * @copydoc Dali::NativeImageSource::DestroyResource()
89 void DestroyResource() override;
92 * @copydoc Dali::NativeImageSource::TargetTexture()
94 uint32_t TargetTexture() override;
97 * @copydoc Dali::NativeImageSource::PrepareTexture()
99 void PrepareTexture() override;
102 * @copydoc Dali::NativeImageSource::GetWidth()
104 uint32_t GetWidth() const override
110 * @copydoc Dali::NativeImageSource::GetHeight()
112 uint32_t GetHeight() const override
118 * @copydoc Dali::NativeImageSource::RequiresBlending()
120 bool RequiresBlending() const override
122 return mBlendingRequired;
126 * @copydoc Dali::NativeImageSource::GetTextureTarget()
128 int GetTextureTarget() const override;
131 * @copydoc Dali::NativeImageSource::ApplyNativeFragmentShader()
133 bool ApplyNativeFragmentShader(std::string& shader) override;
136 * @copydoc Dali::NativeImageSource::GetCustomSamplerTypename()
138 const char* GetCustomSamplerTypename() const override;
141 * @copydoc Dali::NativeImageSource::GetNativeImageHandle()
143 Any GetNativeImageHandle() const override;
146 * @copydoc Dali::NativeImageSource::SourceChanged()
148 bool SourceChanged() const override;
151 * @copydoc Dali::NativeImageInterface::GetExtension()
153 NativeImageInterface::Extension* GetNativeImageInterfaceExtension() override
159 * @copydoc Dali::Internal::Adaptor::NativeImageSource::AcquireBuffer()
161 uint8_t* AcquireBuffer(uint16_t& width, uint16_t& height, uint16_t& stride) override;
164 * @copydoc Dali::Internal::Adaptor::NativeImageSource::ReleaseBuffer()
166 bool ReleaseBuffer() override;
169 * @copydoc Dali::NativeImageSource::SetResourceDestructionCallback()
171 void SetResourceDestructionCallback(EventThreadCallback* callback) override;
175 * Private constructor; @see NativeImageSource::New()
176 * @param[in] width The width of the image.
177 * @param[in] height The height of the image.
178 * @param[in] colour depth of the image.
179 * @param[in] nativeImageSource contains either: pixmap of type X11 Pixmap , a Ecore_X_Pixmap or is empty
181 NativeImageSourceX(uint32_t width,
183 Dali::NativeImageSource::ColorDepth depth,
184 Any nativeImageSource);
187 * 2nd phase construction.
192 * Uses X11 to get the default depth.
193 * @param depth the PixelImage depth enum
194 * @return default x11 pixel depth
196 int GetPixelDepth(Dali::NativeImageSource::ColorDepth depth) const;
199 * Gets the pixmap from the Any parameter
200 * @param pixmap contains either: pixmap of type X11 Pixmap , a Ecore_X_Pixmap or is empty
201 * @return pixmap x11 pixmap
203 Ecore_X_Pixmap GetPixmapFromAny(Any pixmap) const;
206 * Given an existing pixmap, the function uses X to find out
207 * the width, heigth and depth of that pixmap.
209 void GetPixmapDetails();
212 uint32_t mWidth; ///< image width
213 uint32_t mHeight; ///< image heights
214 bool mOwnPixmap; ///< Whether we created pixmap or not
215 Ecore_X_Pixmap mPixmap; ///< From Xlib
216 bool mBlendingRequired; ///< Whether blending is required
217 Dali::NativeImageSource::ColorDepth mColorDepth; ///< color depth of image
218 void* mEglImageKHR; ///< From EGL extension
219 EglImageExtensions* mEglImageExtensions; ///< The EGL Image Extensions
220 std::unique_ptr<EventThreadCallback> mResourceDestructionCallback; ///< The Resource Destruction Callback
223 } // namespace Adaptor
225 } // namespace Internal
229 #endif // DALI_INTERNAL_NATIVE_IMAGE_SOURCE_H