← Back to branch summary

~ubuntu-branches/ubuntu/wily/mir/wily-proposed

« back to all changes in this revision

Viewing changes to src/include/server/mir/compositor/frame_dropping_policy.h

  • Committer: Package Import Robot
  • Author(s): Ubuntu daily release
  • Date: 2014-10-10 14:01:26 UTC
  • mto: This revision was merged to the branch mainline in revision 84.
  • Revision ID: package-import@ubuntu.com-20141010140126-n1czko8na1kuz4ll
Tags: upstream-0.8.0+14.10.20141010
Import upstream version 0.8.0+14.10.20141010

Show diffs side-by-side

added added

removed removed

Lines of Context:
src/include/server/mir/compositor/frame_dropping_policy.h
 
1
/*
 
2
 * Copyright © 2014 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: Christopher James Halse Rogers <christopher.halse.rogers@canonical.com>
 
17
 */
 
18
 
 
19
#ifndef MIR_COMPOSITOR_FRAME_DROPPING_POLICY_H_
 
20
#define MIR_COMPOSITOR_FRAME_DROPPING_POLICY_H_
 
21
 
 
22
#include <functional>
 
23
 
 
24
namespace mir
 
25
{
 
26
namespace compositor
 
27
{
 
28
/**
 
29
 * \brief Policy to determine when to drop a frame from a client
 
30
 *
 
31
 * The FrameDroppingPolicy objects are constructed from a
 
32
 * \ref FrameDroppingPolicyFactory
 
33
 *
 
34
 * The frame dropping mechanism is provided as the
 
35
 * \a drop_frames argument of \ref FrameDroppingPolicyFactory::create_policy
 
36
 *
 
37
 * The policy may decide to drop a frame any time that there is an outstanding
 
38
 * swap - namely, when there have been more calls to \ref swap_now_blocking
 
39
 * than to \ref swap_unblocked
 
40
 */
 
41
class FrameDroppingPolicy
 
42
{
 
43
public:
 
44
    virtual ~FrameDroppingPolicy() = default;
 
45
 
 
46
    FrameDroppingPolicy(FrameDroppingPolicy const&) = delete;
 
47
    FrameDroppingPolicy& operator=(FrameDroppingPolicy const&) = delete;
 
48
 
 
49
    /**
 
50
     * \brief Notify that a swap is now blocking
 
51
     */
 
52
    virtual void swap_now_blocking() = 0;
 
53
    /**
 
54
     * \brief Notify that previous swap is no longer blocking
 
55
     */
 
56
    virtual void swap_unblocked() = 0;
 
57
 
 
58
protected:
 
59
    /**
 
60
     * \note FrameDroppingPolicies should not be constructed directly;
 
61
     *       use a \ref FrameDroppingPolicyFactory
 
62
     */
 
63
    FrameDroppingPolicy() = default;
 
64
};
 
65
 
 
66
}
 
67
}
 
68
 
 
69
#endif // MIR_COMPOSITOR_FRAME_DROPPING_POLICY_H_