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

#include <buffer_bundle.h>

Inheritance diagram for mir::compositor::BufferBundle:
[legend]

Public Member Functions

virtual ~BufferBundle () noexcept
 
virtual void client_acquire (std::function< void(graphics::Buffer *buffer)> complete)=0
 
virtual void client_release (graphics::Buffer *)=0
 
virtual graphics::BufferProperties properties () const =0
 
virtual void allow_framedropping (bool dropping_allowed)=0
 
virtual void force_requests_to_complete ()=0
 
virtual void resize (const geometry::Size &newsize)=0
 
virtual int buffers_ready_for_compositor (void const *user_id) const =0
 
virtual int buffers_free_for_client () const =0
 Return the number of client acquisitions that can be completed synchronously without blocking, before a compositor consumes one. More...
 
virtual void drop_old_buffers ()=0
 
virtual void drop_client_requests ()=0
 
- Public Member Functions inherited from mir::compositor::BufferAcquisition
virtual std::shared_ptr< graphics::Buffercompositor_acquire (void const *user_id)=0
 Acquire the next buffer that's ready to display/composite. More...
 
virtual void compositor_release (std::shared_ptr< graphics::Buffer > const &)=0
 
virtual std::shared_ptr< graphics::Buffersnapshot_acquire ()=0
 
virtual void snapshot_release (std::shared_ptr< graphics::Buffer > const &)=0
 
virtual ~BufferAcquisition ()=default
 

Protected Member Functions

 BufferBundle ()=default
 
 BufferBundle (BufferBundle const &)=delete
 
BufferBundleoperator= (BufferBundle const &)=delete
 
- Protected Member Functions inherited from mir::compositor::BufferAcquisition
 BufferAcquisition ()=default
 
 BufferAcquisition (BufferAcquisition const &)=delete
 
BufferAcquisitionoperator= (BufferAcquisition const &)=delete
 

Constructor & Destructor Documentation

virtual mir::compositor::BufferBundle::~BufferBundle ( )
inlinevirtualnoexcept
mir::compositor::BufferBundle::BufferBundle ( )
protecteddefault
mir::compositor::BufferBundle::BufferBundle ( BufferBundle const &  )
protecteddelete

Member Function Documentation

virtual void mir::compositor::BufferBundle::allow_framedropping ( bool  dropping_allowed)
pure virtual
virtual int mir::compositor::BufferBundle::buffers_free_for_client ( ) const
pure virtual

Return the number of client acquisitions that can be completed synchronously without blocking, before a compositor consumes one.

This is used for pre-filling the queue in tests. Don't assume it's always nbuffers-1 as it might be less.

Implemented in mir::compositor::BufferQueue.

virtual int mir::compositor::BufferBundle::buffers_ready_for_compositor ( void const *  user_id) const
pure virtual
virtual void mir::compositor::BufferBundle::client_acquire ( std::function< void(graphics::Buffer *buffer)>  complete)
pure virtual
virtual void mir::compositor::BufferBundle::client_release ( graphics::Buffer )
pure virtual
virtual void mir::compositor::BufferBundle::drop_client_requests ( )
pure virtual
virtual void mir::compositor::BufferBundle::drop_old_buffers ( )
pure virtual
virtual void mir::compositor::BufferBundle::force_requests_to_complete ( )
pure virtual
BufferBundle& mir::compositor::BufferBundle::operator= ( BufferBundle const &  )
protecteddelete
virtual graphics::BufferProperties mir::compositor::BufferBundle::properties ( ) const
pure virtual
virtual void mir::compositor::BufferBundle::resize ( const geometry::Size newsize)
pure virtual

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

Copyright © 2012-2015 Canonical Ltd.
Generated on Thu Oct 8 16:20:16 UTC 2015