1 /*
2  * Copyright (C) 2020 The Android Open Source Project
3  *
4  * Licensed under the Apache License, Version 2.0 (the "License");
5  * you may not use this file except in compliance with the License.
6  * You may obtain a copy of the License at
7  *
8  *      http://www.apache.org/licenses/LICENSE-2.0
9  *
10  * Unless required by applicable law or agreed to in writing, software
11  * distributed under the License is distributed on an "AS IS" BASIS,
12  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13  * See the License for the specific language governing permissions and
14  * limitations under the License.
15  */
16 
17 #ifndef _UI_SPRITE_ICON_H
18 #define _UI_SPRITE_ICON_H
19 
20 #include <android/graphics/bitmap.h>
21 #include <gui/Surface.h>
22 #include <input/Input.h>
23 
24 namespace android {
25 
26 /*
27  * Icon that a sprite displays, including its hotspot.
28  */
29 struct SpriteIcon {
30     explicit SpriteIcon() = default;
SpriteIconSpriteIcon31     explicit SpriteIcon(const graphics::Bitmap& bitmap, PointerIconStyle style, float hotSpotX,
32                         float hotSpotY, bool drawNativeDropShadow)
33           : bitmap(bitmap),
34             style(style),
35             hotSpotX(hotSpotX),
36             hotSpotY(hotSpotY),
37             drawNativeDropShadow(drawNativeDropShadow) {}
38 
39     graphics::Bitmap bitmap{};
40     PointerIconStyle style{PointerIconStyle::TYPE_NULL};
41     float hotSpotX{};
42     float hotSpotY{};
43     bool drawNativeDropShadow{};
44 
isValidSpriteIcon45     inline bool isValid() const { return bitmap.isValid() && !bitmap.isEmpty(); }
46 
widthSpriteIcon47     inline int32_t width() const { return bitmap.getInfo().width; }
heightSpriteIcon48     inline int32_t height() const { return bitmap.getInfo().height; }
49 
50     // Draw the bitmap onto the given surface. Returns true if it's successful, or false otherwise.
51     // Note it doesn't set any metadata to the surface.
52     bool draw(const sp<Surface> surface) const;
53 };
54 
55 } // namespace android
56 
57 #endif // _UI_SPRITE_ICON_H
58