Mir
Public Member Functions | Protected Member Functions | List of all members
mir::compositor::FrameDroppingPolicy Class Referenceabstract

Policy to determine when to drop a frame from a client. More...

#include <frame_dropping_policy.h>

Public Member Functions

virtual ~FrameDroppingPolicy ()=default
 
 FrameDroppingPolicy (FrameDroppingPolicy const &)=delete
 
FrameDroppingPolicyoperator= (FrameDroppingPolicy const &)=delete
 
virtual void swap_now_blocking ()=0
 Notify that a swap is now blocking. More...
 
virtual void swap_unblocked ()=0
 Notify that previous swap is no longer blocking. More...
 

Protected Member Functions

 FrameDroppingPolicy ()=default
 

Detailed Description

Policy to determine when to drop a frame from a client.

The FrameDroppingPolicy objects are constructed from a FrameDroppingPolicyFactory

The frame dropping mechanism is provided as the drop_frames argument of FrameDroppingPolicyFactory::create_policy

The policy may decide to drop a frame any time that there is an outstanding swap - namely, when there have been more calls to swap_now_blocking than to swap_unblocked

Constructor & Destructor Documentation

virtual mir::compositor::FrameDroppingPolicy::~FrameDroppingPolicy ( )
virtualdefault
mir::compositor::FrameDroppingPolicy::FrameDroppingPolicy ( FrameDroppingPolicy const &  )
delete
mir::compositor::FrameDroppingPolicy::FrameDroppingPolicy ( )
protecteddefault
Note
FrameDroppingPolicies should not be constructed directly; use a FrameDroppingPolicyFactory

Member Function Documentation

FrameDroppingPolicy& mir::compositor::FrameDroppingPolicy::operator= ( FrameDroppingPolicy const &  )
delete
virtual void mir::compositor::FrameDroppingPolicy::swap_now_blocking ( )
pure virtual

Notify that a swap is now blocking.

virtual void mir::compositor::FrameDroppingPolicy::swap_unblocked ( )
pure virtual

Notify that previous swap is no longer blocking.


The documentation for this class was generated from the following file:

Copyright © 2012,2013 Canonical Ltd.
Generated on Tue Mar 24 16:15:19 UTC 2015