1 #ifndef DALI_TOOLKIT_INTERNAL_VISUAL_URL_H
2 #define DALI_TOOLKIT_INTERNAL_VISUAL_URL_H
5 * Copyright (c) 2023 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.
34 * The type of the URL based on the string contents
49 LOCAL, ///< file in local file system
50 TEXTURE, ///< texture uploaded to texture manager
51 REMOTE, ///< remote image
52 BUFFER ///< encoded image buffer
56 * Default Constructor.
57 * Resulting URL is not valid
63 * Delete an external texture if if protocolType is TEXTURE.
69 * Determines type of visual and whether the url is local or remote
70 * Notify that it is using an external texture if if protocolType is TEXTURE.
72 * @param[in] url The URL to store and resolve
74 VisualUrl(const std::string& url);
78 * @param[in] url The VisualUrl to copy
80 VisualUrl(const VisualUrl& url);
84 * @param[in] url The VisualUrl to copy
86 VisualUrl& operator=(const VisualUrl& url);
90 * @param[in] url The VisualUrl to move
92 VisualUrl(VisualUrl&& url) noexcept;
95 * Move assignment operator
96 * @param[in] url The VisualUrl to move
98 VisualUrl& operator=(VisualUrl&& url) noexcept;
104 const std::string& GetUrl() const;
107 * Get the hash value of full URL
108 * @return The hash value of url
110 std::uint64_t GetUrlHash() const;
113 * Get the visual type of the URL
114 * @return The visual type of the URL
116 Type GetType() const;
119 * Is the URL is local to the device, or remote?
120 * @return the location of the resource
122 ProtocolType GetProtocolType() const;
126 * @return true if the URL has length
128 bool IsValid() const;
131 * @return true if the location is LOCAL, i.e. is loadable from local file system
133 bool IsLocalResource() const;
136 * @return true if the location is BUFFER, i.e. may contain EncodedImageBuffer
138 bool IsBufferResource() const;
141 * @return the location part of the url
143 std::string GetLocation() const;
146 * Helper to create a URL of type TEXTURE
147 * @param location the location of the texture
150 static std::string CreateTextureUrl(const std::string& location);
153 * Helper to create a URL of type BUFFER
154 * @param location the location of the texture
157 static std::string CreateBufferUrl(const std::string& location);
160 * Helper to get a ProtocolType from url
161 * @param url the url of the texture
162 * @return the protocol type
164 static VisualUrl::ProtocolType GetProtocolType(const std::string& url);
167 * Helper to get a location from url
168 * @param url the location of the texture
169 * @return the location
171 static std::string GetLocation(const std::string& url);
176 ProtocolType mLocation;
178 mutable std::uint64_t mUrlHash;
181 } // namespace Internal
183 } // namespace Toolkit
187 #endif /* DALI_TOOLKIT_INTERNAL_VISUAL_URL_H */