Mir
Public Member Functions | List of all members
mir::scene::BasicSurface Class Reference

#include <basic_surface.h>

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

Public Member Functions

 BasicSurface (std::string const &name, geometry::Rectangle rect, bool nonrectangular, std::shared_ptr< compositor::BufferStream > const &buffer_stream, std::shared_ptr< input::InputChannel > const &input_channel, std::shared_ptr< input::InputSender > const &sender, std::shared_ptr< graphics::CursorImage > const &cursor_image, std::shared_ptr< SceneReport > const &report)
 
 BasicSurface (std::string const &name, geometry::Rectangle rect, std::weak_ptr< Surface > const &parent, bool nonrectangular, std::shared_ptr< compositor::BufferStream > const &buffer_stream, std::shared_ptr< input::InputChannel > const &input_channel, std::shared_ptr< input::InputSender > const &sender, std::shared_ptr< graphics::CursorImage > const &cursor_image, std::shared_ptr< SceneReport > const &report)
 
 ~BasicSurface () noexcept
 
std::string name () const override
 
void move_to (geometry::Point const &top_left) override
 
float alpha () const override
 
void set_hidden (bool is_hidden)
 
geometry::Size size () const override
 Size of the surface including window frame (if any) More...
 
geometry::Size client_size () const override
 Size of the client area of the surface (excluding any decorations) More...
 
MirPixelFormat pixel_format () const override
 
std::shared_ptr< graphics::Buffersnapshot_buffer () const
 
void swap_buffers (graphics::Buffer *old_buffer, std::function< void(graphics::Buffer *new_buffer)> complete) override
 
void force_requests_to_complete () override
 
bool supports_input () const override
 
int client_input_fd () const override
 
void allow_framedropping (bool) override
 
std::shared_ptr< input::InputChannelinput_channel () const override
 
input::InputReceptionMode reception_mode () const override
 
void set_reception_mode (input::InputReceptionMode mode) override
 
void set_input_region (std::vector< geometry::Rectangle > const &input_rectangles) override
 Sets the input region for this surface. More...
 
std::shared_ptr< compositor::BufferStreambuffer_stream () const
 
void resize (geometry::Size const &size) override
 
geometry::Point top_left () const override
 Top-left corner (of the window frame if present) More...
 
geometry::Rectangle input_bounds () const override
 
bool input_area_contains (geometry::Point const &point) const override
 
void consume (MirEvent const &event) override
 
void set_alpha (float alpha) override
 
void set_orientation (MirOrientation orientation) override
 
void set_transformation (glm::mat4 const &) override
 
bool visible () const override
 
std::unique_ptr< graphics::Renderablecompositor_snapshot (void const *compositor_id) const override
 
int buffers_ready_for_compositor (void const *compositor_id) const override
 
void with_most_recent_buffer_do (std::function< void(graphics::Buffer &)> const &exec) override
 
MirSurfaceType type () const override
 
MirSurfaceState state () const override
 
void take_input_focus (std::shared_ptr< shell::InputTargeter > const &targeter) override
 
int configure (MirSurfaceAttrib attrib, int value) override
 
int query (MirSurfaceAttrib attrib) override
 
void hide () override
 
void show () override
 
void set_cursor_image (std::shared_ptr< graphics::CursorImage > const &image) override
 
std::shared_ptr< graphics::CursorImagecursor_image () const override
 
void request_client_surface_close () override
 
std::shared_ptr< Surfaceparent () const override
 
void add_observer (std::shared_ptr< SurfaceObserver > const &observer) override
 
void remove_observer (std::weak_ptr< SurfaceObserver > const &observer) override
 
int dpi () const
 
- Public Member Functions inherited from mir::frontend::Surface
virtual ~Surface ()=default
 
- Public Member Functions inherited from mir::scene::SurfaceBufferAccess
virtual ~SurfaceBufferAccess ()=default
 

Additional Inherited Members

- Protected Member Functions inherited from mir::input::Surface
 Surface ()=default
 
virtual ~Surface ()=default
 
 Surface (const Surface &)=delete
 
Surfaceoperator= (const Surface &)=delete
 
- Protected Member Functions inherited from mir::frontend::Surface
 Surface ()=default
 
 Surface (Surface const &)=delete
 
Surfaceoperator= (Surface const &)=delete
 
- Protected Member Functions inherited from mir::scene::SurfaceBufferAccess
 SurfaceBufferAccess ()=default
 
 SurfaceBufferAccess (SurfaceBufferAccess const &)=delete
 
SurfaceBufferAccessoperator= (SurfaceBufferAccess const &)=delete
 

Constructor & Destructor Documentation

mir::scene::BasicSurface::BasicSurface ( std::string const &  name,
geometry::Rectangle  rect,
bool  nonrectangular,
std::shared_ptr< compositor::BufferStream > const &  buffer_stream,
std::shared_ptr< input::InputChannel > const &  input_channel,
std::shared_ptr< input::InputSender > const &  sender,
std::shared_ptr< graphics::CursorImage > const &  cursor_image,
std::shared_ptr< SceneReport > const &  report 
)
mir::scene::BasicSurface::BasicSurface ( std::string const &  name,
geometry::Rectangle  rect,
std::weak_ptr< Surface > const &  parent,
bool  nonrectangular,
std::shared_ptr< compositor::BufferStream > const &  buffer_stream,
std::shared_ptr< input::InputChannel > const &  input_channel,
std::shared_ptr< input::InputSender > const &  sender,
std::shared_ptr< graphics::CursorImage > const &  cursor_image,
std::shared_ptr< SceneReport > const &  report 
)
mir::scene::BasicSurface::~BasicSurface ( )
noexcept

Member Function Documentation

void mir::scene::BasicSurface::add_observer ( std::shared_ptr< SurfaceObserver > const &  observer)
overridevirtual

Implements mir::scene::Surface.

void mir::scene::BasicSurface::allow_framedropping ( bool  allow)
overridevirtual

Implements mir::scene::Surface.

float mir::scene::BasicSurface::alpha ( ) const
overridevirtual

Implements mir::scene::Surface.

std::shared_ptr< mc::BufferStream > mir::scene::BasicSurface::buffer_stream ( ) const
int mir::scene::BasicSurface::buffers_ready_for_compositor ( void const *  compositor_id) const
overridevirtual

Implements mir::scene::Surface.

int mir::scene::BasicSurface::client_input_fd ( ) const
overridevirtual
mir::geometry::Size mir::scene::BasicSurface::client_size ( ) const
overridevirtual

Size of the client area of the surface (excluding any decorations)

Implements mir::scene::Surface.

std::unique_ptr< mg::Renderable > mir::scene::BasicSurface::compositor_snapshot ( void const *  compositor_id) const
overridevirtual

Implements mir::scene::Surface.

int mir::scene::BasicSurface::configure ( MirSurfaceAttrib  attrib,
int  value 
)
overridevirtual

Implements mir::scene::Surface.

void mir::scene::BasicSurface::consume ( MirEvent const &  event)
overridevirtual

Implements mir::input::Surface.

std::shared_ptr< mg::CursorImage > mir::scene::BasicSurface::cursor_image ( ) const
overridevirtual

Implements mir::scene::Surface.

int mir::scene::BasicSurface::dpi ( ) const
void mir::scene::BasicSurface::force_requests_to_complete ( )
overridevirtual

Implements mir::scene::Surface.

void mir::scene::BasicSurface::hide ( )
overridevirtual

Implements mir::scene::Surface.

bool mir::scene::BasicSurface::input_area_contains ( geometry::Point const &  point) const
overridevirtual

Implements mir::input::Surface.

geom::Rectangle mir::scene::BasicSurface::input_bounds ( ) const
overridevirtual

Implements mir::scene::Surface.

std::shared_ptr< mi::InputChannel > mir::scene::BasicSurface::input_channel ( ) const
overridevirtual

Implements mir::scene::Surface.

void mir::scene::BasicSurface::move_to ( geometry::Point const &  top_left)
overridevirtual

Implements mir::scene::Surface.

std::string mir::scene::BasicSurface::name ( ) const
overridevirtual

Implements mir::scene::Surface.

std::shared_ptr< ms::Surface > mir::scene::BasicSurface::parent ( ) const
overridevirtual

Implements mir::scene::Surface.

MirPixelFormat mir::scene::BasicSurface::pixel_format ( ) const
overridevirtual
int mir::scene::BasicSurface::query ( MirSurfaceAttrib  attrib)
overridevirtual

Implements mir::scene::Surface.

mi::InputReceptionMode mir::scene::BasicSurface::reception_mode ( ) const
overridevirtual

Implements mir::input::Surface.

void mir::scene::BasicSurface::remove_observer ( std::weak_ptr< SurfaceObserver > const &  observer)
overridevirtual

Implements mir::scene::Surface.

void mir::scene::BasicSurface::request_client_surface_close ( )
overridevirtual

Implements mir::scene::Surface.

void mir::scene::BasicSurface::resize ( geometry::Size const &  size)
overridevirtual

Implements mir::scene::Surface.

void mir::scene::BasicSurface::set_alpha ( float  alpha)
overridevirtual

Implements mir::scene::Surface.

void mir::scene::BasicSurface::set_cursor_image ( std::shared_ptr< graphics::CursorImage > const &  image)
overridevirtual

Implements mir::scene::Surface.

void mir::scene::BasicSurface::set_hidden ( bool  is_hidden)
void mir::scene::BasicSurface::set_input_region ( std::vector< geometry::Rectangle > const &  region)
overridevirtual

Sets the input region for this surface.

The input region is expressed in coordinates relative to the surface (i.e., use (0,0) for the top left point of the surface).

By default the input region is the whole surface. To unset a custom input region and revert to the default set an empty input region, i.e., set_input_region({}). To disable input set a non-empty region containing an empty rectangle, i.e., set_input_region({geom::Rectangle{}}).

Implements mir::scene::Surface.

void mir::scene::BasicSurface::set_orientation ( MirOrientation  orientation)
overridevirtual

Implements mir::scene::Surface.

void mir::scene::BasicSurface::set_reception_mode ( input::InputReceptionMode  mode)
overridevirtual

Implements mir::scene::Surface.

void mir::scene::BasicSurface::set_transformation ( glm::mat4 const &  t)
overridevirtual

Implements mir::scene::Surface.

void mir::scene::BasicSurface::show ( )
overridevirtual

Implements mir::scene::Surface.

mir::geometry::Size mir::scene::BasicSurface::size ( ) const
overridevirtual

Size of the surface including window frame (if any)

Implements mir::scene::Surface.

std::shared_ptr< mg::Buffer > mir::scene::BasicSurface::snapshot_buffer ( ) const
MirSurfaceState mir::scene::BasicSurface::state ( ) const
overridevirtual

Implements mir::scene::Surface.

bool mir::scene::BasicSurface::supports_input ( ) const
overridevirtual
void mir::scene::BasicSurface::swap_buffers ( graphics::Buffer old_buffer,
std::function< void(graphics::Buffer *new_buffer)>  complete 
)
overridevirtual
void mir::scene::BasicSurface::take_input_focus ( std::shared_ptr< shell::InputTargeter > const &  targeter)
overridevirtual

Implements mir::scene::Surface.

geom::Point mir::scene::BasicSurface::top_left ( ) const
overridevirtual

Top-left corner (of the window frame if present)

Implements mir::scene::Surface.

MirSurfaceType mir::scene::BasicSurface::type ( ) const
overridevirtual

Implements mir::scene::Surface.

bool mir::scene::BasicSurface::visible ( ) const
overridevirtual

Implements mir::scene::Surface.

void mir::scene::BasicSurface::with_most_recent_buffer_do ( std::function< void(graphics::Buffer &)> const &  exec)
overridevirtual

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

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