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

#include <buffer_bundle.h>

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

Public Member Functions

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

 BufferAcquisition ()=default
 
 BufferAcquisition (BufferAcquisition const &)=delete
 
BufferAcquisitionoperator= (BufferAcquisition const &)=delete
 

Constructor & Destructor Documentation

virtual mir::compositor::BufferAcquisition::~BufferAcquisition ( )
virtualdefault
mir::compositor::BufferAcquisition::BufferAcquisition ( )
protecteddefault
mir::compositor::BufferAcquisition::BufferAcquisition ( BufferAcquisition const &  )
protecteddelete

Member Function Documentation

virtual std::shared_ptr<graphics::Buffer> mir::compositor::BufferAcquisition::compositor_acquire ( void const *  user_id)
pure virtual

Acquire the next buffer that's ready to display/composite.

Parameters
[in]user_idA unique identifier of who is going to use the buffer, to ensure that separate users representing separate monitors who need the same frame will get the same buffer. However consecutive calls for the same user will get different buffers. To avoid collisions, all callers should determine user_id in the same way (e.g. always use "this" pointer).

Implemented in mir::compositor::BufferQueue.

virtual void mir::compositor::BufferAcquisition::compositor_release ( std::shared_ptr< graphics::Buffer > const &  )
pure virtual
BufferAcquisition& mir::compositor::BufferAcquisition::operator= ( BufferAcquisition const &  )
protecteddelete
virtual std::shared_ptr<graphics::Buffer> mir::compositor::BufferAcquisition::snapshot_acquire ( )
pure virtual
virtual void mir::compositor::BufferAcquisition::snapshot_release ( std::shared_ptr< graphics::Buffer > const &  )
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