MirSurface Struct Reference

#include <mir_surface.h>

Public Member Functions
	MirSurface (MirSurface const &)=delete
MirSurface &	operator= (MirSurface const &)=delete
	MirSurface (std::string const &error)
	MirSurface (MirConnection *allocating_connection, mir::protobuf::DisplayServer::Stub &server, mir::protobuf::Debug::Stub *debug, std::shared_ptr< mir::client::ClientBufferStreamFactory > const &buffer_stream_factory, std::shared_ptr< mir::input::receiver::InputPlatform > const &input_platform, MirSurfaceSpec const &spec, mir_surface_callback callback, void *context)
	~MirSurface ()
MirWaitHandle *	release_surface (mir_surface_callback callback, void *context)
MirSurfaceParameters	get_parameters () const
char const *	get_error_message ()
int	id () const
MirWaitHandle *	next_buffer (mir_surface_callback callback, void *context)
MirWaitHandle *	get_create_wait_handle ()
MirNativeBuffer *	get_current_buffer_package ()
MirPlatformType	platform_type ()
std::shared_ptr< mir::client::ClientBuffer >	get_current_buffer ()
uint32_t	get_current_buffer_id () const
void	get_cpu_region (MirGraphicsRegion &region)
EGLNativeWindowType	generate_native_window ()
MirWaitHandle *	configure (MirSurfaceAttrib a, int value)
bool	translate_to_screen_coordinates (int x, int y, int *screen_x, int *screen_y)
int	attrib (MirSurfaceAttrib a) const
MirOrientation	get_orientation () const
MirWaitHandle *	set_preferred_orientation (MirOrientationMode mode)
MirWaitHandle *	configure_cursor (MirCursorConfiguration const *cursor)
void	set_event_handler (MirEventDelegate const *delegate)
void	handle_event (MirEvent const &e)
void	request_and_wait_for_next_buffer ()
void	request_and_wait_for_configure (MirSurfaceAttrib a, int value)

Static Public Member Functions
static bool	is_valid (MirSurface *query)

Detailed Description

Examples:

basic.c, and prompt_session.c.

Constructor & Destructor Documentation

MirSurface::MirSurface ( MirSurface const &  )

delete

MirSurface::MirSurface

(

std::string const &

error

)

MirSurface::MirSurface	(	MirConnection *	allocating_connection,
		mir::protobuf::DisplayServer::Stub &	server,
		mir::protobuf::Debug::Stub *	debug,
		std::shared_ptr< mir::client::ClientBufferStreamFactory > const &	buffer_stream_factory,
		std::shared_ptr< mir::input::receiver::InputPlatform > const &	input_platform,
		MirSurfaceSpec const &	spec,
		mir_surface_callback	callback,
		void *	context
	)

MirSurface::~MirSurface

(

)

Member Function Documentation

int MirSurface::attrib

(

MirSurfaceAttrib

a

)

const

MirWaitHandle * MirSurface::configure	(	MirSurfaceAttrib	a,
		int	value
	)

MirWaitHandle * MirSurface::configure_cursor

(

MirCursorConfiguration const *

cursor

)

EGLNativeWindowType MirSurface::generate_native_window

(

)

void MirSurface::get_cpu_region

(

MirGraphicsRegion &

region

)

MirWaitHandle * MirSurface::get_create_wait_handle

(

)

std::shared_ptr< mcl::ClientBuffer > MirSurface::get_current_buffer

(

)

uint32_t MirSurface::get_current_buffer_id

(

)

const

MirNativeBuffer * MirSurface::get_current_buffer_package

(

)

char const * MirSurface::get_error_message

(

)

MirOrientation MirSurface::get_orientation

(

)

const

MirSurfaceParameters MirSurface::get_parameters

(

)

const

void MirSurface::handle_event

(

MirEvent const &

e

)

int MirSurface::id

(

)

const

bool MirSurface::is_valid ( MirSurface *  query )

static

MirWaitHandle * MirSurface::next_buffer	(	mir_surface_callback	callback,
		void *	context
	)

MirSurface& MirSurface::operator= ( MirSurface const &  )

delete

MirPlatformType MirSurface::platform_type

(

)

MirWaitHandle * MirSurface::release_surface	(	mir_surface_callback	callback,
		void *	context
	)

void MirSurface::request_and_wait_for_configure	(	MirSurfaceAttrib	a,
		int	value
	)

void MirSurface::request_and_wait_for_next_buffer

(

)

void MirSurface::set_event_handler

(

MirEventDelegate const *

delegate

)

MirWaitHandle * MirSurface::set_preferred_orientation

(

MirOrientationMode

mode

)

bool MirSurface::translate_to_screen_coordinates	(	int	x,
		int	y,
		int *	screen_x,
		int *	screen_y
	)

---

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

• src/client/mir_surface.h
• src/client/mir_surface.cpp