1 #ifndef DALI_NATIVE_IMAGE_INTERFACE_H
2 #define DALI_NATIVE_IMAGE_INTERFACE_H
5 * Copyright (c) 2020 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.
23 #include <cstdint> // uint32_t
26 #include <dali/public-api/object/ref-object.h>
27 #include <dali/public-api/object/any.h>
32 * @addtogroup dali_core_images
37 * @brief Abstract interface to provide platform-specific support for handling image data.
39 * For example, an implementation could use EGL extensions, etc.
42 class NativeImageInterface : public Dali::RefObject
46 class Extension; ///< Forward declare future extension interface
49 * @brief Creates the resource for the NativeImage.
51 * e.g. For the EglImageKHR extension, this corresponds to calling eglCreateImageKHR().
53 * @return false If the initialization fails
54 * @pre The graphics subsystem has been initialized
56 virtual bool CreateResource() = 0;
59 * @brief Destroys the resource for the NativeImage.
61 * e.g. For the EglImageKHR extension, this corresponds to calling eglDestroyImageKHR().
63 * @pre The graphics subsystem has been initialized
65 virtual void DestroyResource() = 0;
68 * @brief Uses the NativeImage as a texture for rendering.
71 * @return An error code from the graphics subsystem.
72 * @pre The graphics subsystem has been initialized
74 virtual uint32_t TargetTexture() = 0;
77 * @brief Called internally when the texture is bound in the GPU
79 * The correct texture sampler has already been bound before the function gets called.
81 * @pre The graphics subsystem has been initialized
83 virtual void PrepareTexture() = 0;
86 * @brief Returns the width of the NativeImage.
91 virtual uint32_t GetWidth() const = 0;
94 * @brief Returns the height of the NativeImage.
99 virtual uint32_t GetHeight() const = 0;
102 * @brief Queries whether blending is required.
104 * @return True if blending is required
106 virtual bool RequiresBlending() const = 0;
109 * @brief Get the texture target for binding native image as texture.
112 * @return Texture target.
114 virtual int GetTextureTarget() const = 0;
117 * @brief Get custom fragment prefix for rendering native image.
120 * @return Custom fragment prefix code as string.
122 virtual const char* GetCustomFragmentPrefix() const = 0;
125 * @brief Get custom sampler type name for rendering native image.
128 * @return Custom sampler type name.
130 virtual const char* GetCustomSamplerTypename() const = 0;
133 * @brief Retrieves the internal native image.
136 * @return Any object containing the internal native image source
138 virtual Any GetNativeImageHandle() const = 0;
141 * @brief Determine if the source for the native image has changed characteristics.
144 * @return true if the source data has modified any characteristics of the
145 * native image, for example if the size of the buffer has changed.
147 virtual bool SourceChanged() const = 0;
150 * @brief Retrieves the extension for the interface.
153 * @return The extension if available, NULL otherwise
155 virtual Extension* GetExtension()
163 * @brief A reference counted object may only be deleted by calling Unreference().
165 * The implementation should destroy the NativeImage resources.
168 virtual ~NativeImageInterface()
175 * @brief Pointer to Dali::NativeImageInterface.
178 using NativeImageInterfacePtr = Dali::IntrusivePtr<NativeImageInterface>;
185 #endif // DALI_NATIVE_IMAGE_INTERFACE_H