#include <basic_surface.h>

Inheritance diagram for mir::scene::BasicSurface:

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< SurfaceConfigurator > const &configurator, 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

std::shared_ptr< graphics::Buffer >	snapshot_buffer () const

void	swap_buffers (graphics::Buffer old_buffer, std::function< void(graphics::Buffer new_buffer)> complete)

void	force_requests_to_complete ()

bool	supports_input () const

int	client_input_fd () const

void	allow_framedropping (bool)

std::shared_ptr < input::InputChannel >	input_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::BufferStream >	buffer_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)

void	set_alpha (float alpha) override

void	set_orientation (MirOrientation orientation) override

void	set_transformation (glm::mat4 const &) override

bool	visible () const

std::unique_ptr < graphics::Renderable >	compositor_snapshot (void const *compositor_id) const

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)

std::shared_ptr < graphics::CursorImage >	cursor_image () const

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

void	swap_buffers_blocking (graphics::Buffer *&buffer)
	swap_buffers_blocking() is a convenience wrapper around swap_buffers() it forces the current thread to block until complete() is called. More...

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

Surface &	operator= (const Surface &)=delete

Protected Member Functions inherited from mir::frontend::Surface
	Surface ()=default

	Surface (Surface const &)=delete

Surface &	operator= (Surface const &)=delete

Protected Member Functions inherited from mir::scene::SurfaceBufferAccess
	SurfaceBufferAccess ()=default

	SurfaceBufferAccess (SurfaceBufferAccess const &)=delete

SurfaceBufferAccess &	operator= (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< SurfaceConfigurator > const &	configurator,
		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 )

virtual

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::client_input_fd ( ) const

virtual

Implements mir::frontend::Surface.

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

virtual

Implements mir::scene::Surface.

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

overridevirtual

Implements mir::frontend::Surface.

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

virtual

Implements mir::input::Surface.

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

virtual

Implements mir::scene::Surface.

int mir::scene::BasicSurface::dpi ( ) const

void mir::scene::BasicSurface::force_requests_to_complete ( )

virtual

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.

MirPixelFormat mir::scene::BasicSurface::pixel_format ( ) const

virtual

Implements mir::frontend::Surface.

int mir::scene::BasicSurface::query ( MirSurfaceAttrib attrib )

overridevirtual

Implements mir::frontend::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::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 )

virtual

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