Mir
Public Member Functions | Protected Member Functions | List of all members
mir::scene::PixelBuffer Class Referenceabstract

Interface for extracting the pixels from a graphics::Buffer. More...

#include <pixel_buffer.h>

Inheritance diagram for mir::scene::PixelBuffer:
[legend]

Public Member Functions

virtual ~PixelBuffer ()=default
 
virtual void fill_from (graphics::Buffer &buffer)=0
 Fills the PixelBuffer with the contents of a graphics::Buffer. More...
 
virtual void const * as_argb_8888 ()=0
 The pixels in 0xAARRGGBB format. More...
 
virtual geometry::Size size () const =0
 The size of the pixel buffer. More...
 
virtual geometry::Stride stride () const =0
 The stride of the pixel buffer. More...
 

Protected Member Functions

 PixelBuffer ()=default
 
 PixelBuffer (PixelBuffer const &)=delete
 
PixelBufferoperator= (PixelBuffer const &)=delete
 

Detailed Description

Interface for extracting the pixels from a graphics::Buffer.

Constructor & Destructor Documentation

virtual mir::scene::PixelBuffer::~PixelBuffer ( )
virtualdefault
mir::scene::PixelBuffer::PixelBuffer ( )
protecteddefault
mir::scene::PixelBuffer::PixelBuffer ( PixelBuffer const &  )
protecteddelete

Member Function Documentation

virtual void const* mir::scene::PixelBuffer::as_argb_8888 ( )
pure virtual

The pixels in 0xAARRGGBB format.

The pixel data is owned by the PixelBuffer object and is only valid until the next call to fill_from().

This method may involve transformation of the extracted data.

Implemented in mir::scene::GLPixelBuffer.

virtual void mir::scene::PixelBuffer::fill_from ( graphics::Buffer buffer)
pure virtual

Fills the PixelBuffer with the contents of a graphics::Buffer.

Parameters
[in]bufferthe buffer to get the pixels of

Implemented in mir::scene::GLPixelBuffer.

PixelBuffer& mir::scene::PixelBuffer::operator= ( PixelBuffer const &  )
protecteddelete
virtual geometry::Size mir::scene::PixelBuffer::size ( ) const
pure virtual

The size of the pixel buffer.

Implemented in mir::scene::GLPixelBuffer.

virtual geometry::Stride mir::scene::PixelBuffer::stride ( ) const
pure virtual

The stride of the pixel buffer.

Implemented in mir::scene::GLPixelBuffer.


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

Copyright © 2012-2015 Canonical Ltd.
Generated on Wed Mar 30 00:29:56 UTC 2016