2 // Copyright (c) 2016 Intel Corporation
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
8 // http://www.apache.org/licenses/LICENSE-2.0
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.
16 #ifndef WSI_OVERLAYBUFFER_H_
17 #define WSI_OVERLAYBUFFER_H_
19 #include <platformdefines.h>
23 #include "compositordefs.h"
27 namespace hwcomposer {
29 class FrameBufferManager;
30 class NativeBufferHandler;
31 class ResourceManager;
35 static std::shared_ptr<OverlayBuffer> CreateOverlayBuffer();
37 OverlayBuffer(OverlayBuffer&& rhs) = default;
38 OverlayBuffer& operator=(OverlayBuffer&& other) = default;
39 OverlayBuffer() = default;
41 virtual ~OverlayBuffer() {
44 virtual void InitializeFromNativeHandle(HWCNativeHandle handle,
45 ResourceManager* buffer_manager) = 0;
47 virtual uint32_t GetDataSpace() const = 0;
49 virtual uint32_t GetWidth() const = 0;
51 virtual uint32_t GetHeight() const = 0;
53 virtual uint32_t GetFormat() const = 0;
55 virtual HWCLayerType GetUsage() const = 0;
57 virtual uint32_t GetFb(bool* isNewCreated = NULL) = 0;
59 virtual uint32_t GetPrimeFD() const = 0;
61 virtual const uint32_t* GetPitches() const = 0;
63 virtual const uint32_t* GetOffsets() const = 0;
65 virtual uint32_t GetTilingMode() const = 0;
67 virtual void SetDataSpace(uint32_t dataspace) = 0;
69 virtual bool GetInterlace() = 0;
71 virtual void SetInterlace(bool isInterlaced) = 0;
73 // external_import should be true if this resource is not owned by HWC.
74 // If resource is owned by HWC, than the implementation needs to create
75 // frame buffer for this buffer.
76 virtual const ResourceHandle& GetGpuResource(GpuDisplay egl_display,
77 bool external_import) = 0;
79 virtual const ResourceHandle& GetGpuResource() = 0;
81 // Returns Media resource for this buffer which can be used by compositor.
82 // Surface will be clipped to width, height even if buffer size is
83 // greater than these values.
84 virtual const MediaResourceHandle& GetMediaResource(MediaDisplay display,
88 // Creates Framebuffer taking into account any Modifiers.
89 virtual bool CreateFrameBufferWithModifier(uint64_t modifier) = 0;
91 virtual HWCNativeHandle GetOriginalHandle() const = 0;
93 virtual void SetOriginalHandle(HWCNativeHandle handle) = 0;
95 virtual void Dump() = 0;
98 } // namespace hwcomposer
99 #endif // WSI_OVERLAYBUFFER_H_