Mir
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Modules Pages
buffer_bundle.h
Go to the documentation of this file.
1 /*
2  * Copyright © 2013 Canonical Ltd.
3  *
4  * This program is free software: you can redistribute it and/or modify it
5  * under the terms of the GNU General Public License version 3,
6  * as published by the Free Software Foundation.
7  *
8  * This program is distributed in the hope that it will be useful,
9  * but WITHOUT ANY WARRANTY; without even the implied warranty of
10  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
11  * GNU General Public License for more details.
12  *
13  * You should have received a copy of the GNU General Public License
14  * along with this program. If not, see <http://www.gnu.org/licenses/>.
15  *
16  * Authored by:
17  * Kevin DuBois <kevin.dubois@canonical.com>
18  */
19 
20 #ifndef MIR_COMPOSITOR_BUFFER_BUNDLE_H_
21 #define MIR_COMPOSITOR_BUFFER_BUNDLE_H_
22 
24 #include <memory>
25 
26 namespace mir
27 {
28 namespace graphics { class Buffer; struct BufferProperties; }
29 
30 namespace compositor
31 {
32 
34 {
35 public:
36  virtual ~BufferBundle() noexcept {}
37  virtual void client_acquire(std::function<void(graphics::Buffer* buffer)> complete) = 0;
38  virtual void client_release(graphics::Buffer*) = 0;
39 
51  virtual std::shared_ptr<graphics::Buffer>
52  compositor_acquire(void const* user_id) = 0;
53  virtual void compositor_release(std::shared_ptr<graphics::Buffer> const&) = 0;
54  virtual std::shared_ptr<graphics::Buffer> snapshot_acquire() = 0;
55  virtual void snapshot_release(std::shared_ptr<graphics::Buffer> const&) = 0;
56 
57  virtual graphics::BufferProperties properties() const = 0;
58  virtual void allow_framedropping(bool dropping_allowed) = 0;
59  virtual void force_requests_to_complete() = 0;
60  virtual void resize(const geometry::Size &newsize) = 0;
61  virtual int buffers_ready_for_compositor() const = 0;
62 
69  virtual int buffers_free_for_client() const = 0;
70  virtual void drop_old_buffers() = 0;
71 
72 protected:
73  BufferBundle() = default;
74  BufferBundle(BufferBundle const&) = delete;
75  BufferBundle& operator=(BufferBundle const&) = delete;
76 };
77 }
78 }
79 
80 #endif /*MIR_COMPOSITOR_BUFFER_BUNDLE_H_*/
Definition: size.h:30
All things Mir.
Definition: aging_buffer.h:24
virtual void client_acquire(std::function< void(graphics::Buffer *buffer)> complete)=0
Definition: buffer_bundle.h:33
virtual void resize(const geometry::Size &newsize)=0
virtual int buffers_free_for_client() const =0
Return the number of client acquisitions that can be completed synchronously without blocking...
virtual void force_requests_to_complete()=0
virtual void allow_framedropping(bool dropping_allowed)=0
virtual std::shared_ptr< graphics::Buffer > snapshot_acquire()=0
virtual int buffers_ready_for_compositor() const =0
virtual void client_release(graphics::Buffer *)=0
BufferBundle & operator=(BufferBundle const &)=delete
virtual graphics::BufferProperties properties() const =0
virtual ~BufferBundle() noexcept
Definition: buffer_bundle.h:36
virtual void drop_old_buffers()=0
Buffer creation properties.
Definition: buffer_properties.h:48
Definition: buffer.h:34
virtual std::shared_ptr< graphics::Buffer > compositor_acquire(void const *user_id)=0
Acquire the next buffer that's ready to display/composite.
virtual void snapshot_release(std::shared_ptr< graphics::Buffer > const &)=0
virtual void compositor_release(std::shared_ptr< graphics::Buffer > const &)=0

Copyright © 2012,2013 Canonical Ltd.
Generated on Fri Oct 10 14:07:14 UTC 2014