mir Namespace Reference

Namespaces
namespace	compositor
namespace	detail
namespace	frontend
namespace	geometry
	Basic geometry types. Types for dimensions, displacements, etc. and the operations that they support.
namespace	graphics
namespace	input
namespace	scene
namespace	shell

Classes
class	AbnormalExit
	Indicates Mir should exit with an error message printed to stderr. More...
class	AnonymousShmFile
class	ExitWithOutput
	Indicates Mir should exit with the given output (such as help text) printed to stdout. More...
class	FatalErrorStrategy
class	Fd
struct	IntOwnedFd
class	IntWrapper
class	optional_value
class	ProofOfMutexLock
	A method can take an instance of this class by reference to require callers to hold a mutex lock, without requiring a specific type of lock. More...
class	ShmFile
class	Synchronised
	An object that enforces unique access to the data it contains. More...

Typedefs
typedef std::unique_ptr< MirEvent, void(*)(MirEvent *)>	EventUPtr

Functions
template<typename T >
bool	operator== (optional_value< T > const &lhs, optional_value< T > const &rhs)
template<typename T >
bool	operator!= (optional_value< T > const &lhs, optional_value< T > const &rhs)
template<typename T >
bool	operator== (optional_value< T > const &lhs, T const &rhs)
template<typename T >
bool	operator!= (optional_value< T > const &lhs, T const &rhs)
template<typename T >
bool	operator== (T const &lhs, optional_value< T > const &rhs)
template<typename T >
bool	operator!= (T const &lhs, optional_value< T > const &rhs)
void	fatal_error_except (char const *reason,...)
	Throws an exception that will typically kill the Mir server and propagate from mir::run_mir. More...
void	fatal_error_abort (char const *reason,...)
	An alternative to fatal_error_except() that kills the program and dump core as cleanly as possible. More...
template<typename Tag , typename ValueType >
std::ostream &	operator<< (std::ostream &out, IntWrapper< Tag, ValueType > const &value)
template<typename Tag , typename ValueType >
constexpr bool	operator== (IntWrapper< Tag, ValueType > const &lhs, IntWrapper< Tag, ValueType > const &rhs)
template<typename Tag , typename ValueType >
constexpr bool	operator!= (IntWrapper< Tag, ValueType > const &lhs, IntWrapper< Tag, ValueType > const &rhs)
template<typename Tag , typename ValueType >
constexpr bool	operator<= (IntWrapper< Tag, ValueType > const &lhs, IntWrapper< Tag, ValueType > const &rhs)
template<typename Tag , typename ValueType >
constexpr bool	operator>= (IntWrapper< Tag, ValueType > const &lhs, IntWrapper< Tag, ValueType > const &rhs)
template<typename Tag , typename ValueType >
constexpr bool	operator< (IntWrapper< Tag, ValueType > const &lhs, IntWrapper< Tag, ValueType > const &rhs)
auto	mir_depth_layer_get_index (MirDepthLayer depth_layer) -> unsigned int
	Returns the height of a MirDepthLayer. More...

Variables
void(*	fatal_error )(char const *reason,...)
	fatal_error() is strictly for "this should never happen" situations that you cannot recover from. More...

Typedef Documentation

EventUPtr

typedef std::unique_ptr<MirEvent, void(*)(MirEvent*)> mir::EventUPtr

Function Documentation

fatal_error_abort()

void mir::fatal_error_abort	(	char const *	reason,
			...
	)

An alternative to fatal_error_except() that kills the program and dump core as cleanly as possible.

Parameters

[in]

reason

A printf-style format string.

fatal_error_except()

void mir::fatal_error_except	(	char const *	reason,
			...
	)

Throws an exception that will typically kill the Mir server and propagate from mir::run_mir.

Parameters

[in]

reason

A printf-style format string.

mir_depth_layer_get_index()

auto mir::mir_depth_layer_get_index

(

MirDepthLayer

depth_layer

)

-> unsigned int

Returns the height of a MirDepthLayer.

As the name implies, the returned value is usable as an array index (0 is returned for the bottommost layer and there are no gaps between layers). The values returned for each layer are in no way stable across Mir versions, and are only meaningful relative to each other.

operator!=() [1/4]

template<typename Tag , typename ValueType >

constexpr bool mir::operator!= ( IntWrapper< Tag, ValueType > const &  lhs, IntWrapper< Tag, ValueType > const &  rhs  )

inlineconstexpr

operator!=() [2/4]

template<typename T >

bool mir::operator!= ( optional_value< T > const &  lhs, optional_value< T > const &  rhs  )

inline

operator!=() [3/4]

template<typename T >

bool mir::operator!= ( optional_value< T > const &  lhs, T const &  rhs  )

inline

operator!=() [4/4]

template<typename T >

bool mir::operator!= ( T const &  lhs, optional_value< T > const &  rhs  )

inline

operator<()

template<typename Tag , typename ValueType >

constexpr bool mir::operator< ( IntWrapper< Tag, ValueType > const &  lhs, IntWrapper< Tag, ValueType > const &  rhs  )

inlineconstexpr

operator<<()

template<typename Tag , typename ValueType >

std::ostream & mir::operator<<	(	std::ostream &	out,
		IntWrapper< Tag, ValueType > const &	value
	)

operator<=()

template<typename Tag , typename ValueType >

constexpr bool mir::operator<= ( IntWrapper< Tag, ValueType > const &  lhs, IntWrapper< Tag, ValueType > const &  rhs  )

inlineconstexpr

operator==() [1/4]

template<typename Tag , typename ValueType >

constexpr bool mir::operator== ( IntWrapper< Tag, ValueType > const &  lhs, IntWrapper< Tag, ValueType > const &  rhs  )

inlineconstexpr

operator==() [2/4]

template<typename T >

bool mir::operator== ( optional_value< T > const &  lhs, optional_value< T > const &  rhs  )

inline

operator==() [3/4]

template<typename T >

bool mir::operator== ( optional_value< T > const &  lhs, T const &  rhs  )

inline

operator==() [4/4]

template<typename T >

bool mir::operator== ( T const &  lhs, optional_value< T > const &  rhs  )

inline

operator>=()

template<typename Tag , typename ValueType >

constexpr bool mir::operator>= ( IntWrapper< Tag, ValueType > const &  lhs, IntWrapper< Tag, ValueType > const &  rhs  )

inlineconstexpr

Variable Documentation

fatal_error

void(* mir::fatal_error) (char const *reason,...) ( char const *  reason,   ...  )

extern

fatal_error() is strictly for "this should never happen" situations that you cannot recover from.

By default it points at fatal_error_abort(). Note the reason parameter is a simple char* so its value is clearly visible in stack trace output.

Remarks

There is no attempt to make this thread-safe, if it needs to be changed that should be done before spinning up the Mir server.

Parameters

[in]

reason

A printf-style format string.