mir::scene::SurfaceCreationParameters Struct Reference

#include <surface_creation_parameters.h>

Public Member Functions
	SurfaceCreationParameters ()
SurfaceCreationParameters &	of_name (std::string const &new_name)
SurfaceCreationParameters &	of_size (geometry::Size new_size)
SurfaceCreationParameters &	of_size (geometry::Width::ValueType width, geometry::Height::ValueType height)
SurfaceCreationParameters &	of_position (geometry::Point const &top_left)
SurfaceCreationParameters &	of_buffer_usage (graphics::BufferUsage new_buffer_usage)
SurfaceCreationParameters &	of_pixel_format (MirPixelFormat new_pixel_format)
SurfaceCreationParameters &	with_input_mode (input::InputReceptionMode const &new_mode)
SurfaceCreationParameters &	with_output_id (graphics::DisplayConfigurationOutputId const &output_id)
SurfaceCreationParameters &	of_type (MirWindowType type)
SurfaceCreationParameters &	with_state (MirWindowState state)
SurfaceCreationParameters &	with_preferred_orientation (MirOrientationMode mode)
SurfaceCreationParameters &	with_parent_id (frontend::SurfaceId const &id)
SurfaceCreationParameters &	with_aux_rect (geometry::Rectangle const &rect)
SurfaceCreationParameters &	with_edge_attachment (MirEdgeAttachment edge)
SurfaceCreationParameters &	with_buffer_stream (frontend::BufferStreamId const &id)

Public Attributes
std::string	name
geometry::Size	size
geometry::Point	top_left
graphics::BufferUsage	buffer_usage
MirPixelFormat	pixel_format
input::InputReceptionMode	input_mode
graphics::DisplayConfigurationOutputId	output_id
mir::optional_value< MirWindowState >	state
mir::optional_value< MirWindowType >	type
mir::optional_value< MirOrientationMode >	preferred_orientation
mir::optional_value< frontend::SurfaceId >	parent_id
mir::optional_value< frontend::BufferStreamId >	content_id
mir::optional_value< geometry::Rectangle >	aux_rect
mir::optional_value< MirEdgeAttachment >	edge_attachment
optional_value< MirPlacementHints >	placement_hints
optional_value< MirPlacementGravity >	surface_placement_gravity
optional_value< MirPlacementGravity >	aux_rect_placement_gravity
optional_value< int >	aux_rect_placement_offset_x
optional_value< int >	aux_rect_placement_offset_y
std::weak_ptr< Surface >	parent
optional_value< geometry::Width >	min_width
optional_value< geometry::Height >	min_height
optional_value< geometry::Width >	max_width
optional_value< geometry::Height >	max_height
mir::optional_value< geometry::DeltaX >	width_inc
mir::optional_value< geometry::DeltaY >	height_inc
mir::optional_value< shell::SurfaceAspectRatio >	min_aspect
mir::optional_value< shell::SurfaceAspectRatio >	max_aspect
mir::optional_value< std::vector< geometry::Rectangle > >	input_shape
mir::optional_value< MirShellChrome >	shell_chrome
mir::optional_value< std::vector< shell::StreamSpecification > >	streams
mir::optional_value< MirPointerConfinementState >	confine_pointer

Detailed Description

Examples:

server_example_canonical_window_manager.cpp, and server_example_window_management.cpp.

Constructor & Destructor Documentation

mir::scene::SurfaceCreationParameters::SurfaceCreationParameters

(

)

Member Function Documentation

SurfaceCreationParameters& mir::scene::SurfaceCreationParameters::of_buffer_usage

(

graphics::BufferUsage

new_buffer_usage

)

Examples:

render_surfaces.cpp, and server_example_canonical_window_manager.cpp.

SurfaceCreationParameters& mir::scene::SurfaceCreationParameters::of_name

(

std::string const &

new_name

)

Examples:

server_example_canonical_window_manager.cpp.

SurfaceCreationParameters& mir::scene::SurfaceCreationParameters::of_pixel_format

(

MirPixelFormat

new_pixel_format

)

Examples:

render_surfaces.cpp, and server_example_canonical_window_manager.cpp.

SurfaceCreationParameters& mir::scene::SurfaceCreationParameters::of_position

(

geometry::Point const &

top_left

)

Examples:

server_example_canonical_window_manager.cpp.

SurfaceCreationParameters& mir::scene::SurfaceCreationParameters::of_size

(

geometry::Size

new_size

)

Examples:

render_surfaces.cpp, and server_example_canonical_window_manager.cpp.

SurfaceCreationParameters& mir::scene::SurfaceCreationParameters::of_size	(	geometry::Width::ValueType	width,
		geometry::Height::ValueType	height
	)

SurfaceCreationParameters& mir::scene::SurfaceCreationParameters::of_type

(

MirWindowType

type

)

Examples:

server_example_canonical_window_manager.cpp.

SurfaceCreationParameters& mir::scene::SurfaceCreationParameters::with_aux_rect

(

geometry::Rectangle const &

rect

)

SurfaceCreationParameters& mir::scene::SurfaceCreationParameters::with_buffer_stream

(

frontend::BufferStreamId const &

id

)

Examples:

server_example_canonical_window_manager.cpp.

SurfaceCreationParameters& mir::scene::SurfaceCreationParameters::with_edge_attachment

(

MirEdgeAttachment

edge

)

SurfaceCreationParameters& mir::scene::SurfaceCreationParameters::with_input_mode

(

input::InputReceptionMode const &

new_mode

)

SurfaceCreationParameters& mir::scene::SurfaceCreationParameters::with_output_id

(

graphics::DisplayConfigurationOutputId const &

output_id

)

SurfaceCreationParameters& mir::scene::SurfaceCreationParameters::with_parent_id

(

frontend::SurfaceId const &

id

)

SurfaceCreationParameters& mir::scene::SurfaceCreationParameters::with_preferred_orientation

(

MirOrientationMode

mode

)

SurfaceCreationParameters& mir::scene::SurfaceCreationParameters::with_state

(

MirWindowState

state

)

Member Data Documentation

mir::optional_value<geometry::Rectangle> mir::scene::SurfaceCreationParameters::aux_rect

optional_value<MirPlacementGravity> mir::scene::SurfaceCreationParameters::aux_rect_placement_gravity

optional_value<int> mir::scene::SurfaceCreationParameters::aux_rect_placement_offset_x

optional_value<int> mir::scene::SurfaceCreationParameters::aux_rect_placement_offset_y

graphics::BufferUsage mir::scene::SurfaceCreationParameters::buffer_usage

mir::optional_value<MirPointerConfinementState> mir::scene::SurfaceCreationParameters::confine_pointer

mir::optional_value<frontend::BufferStreamId> mir::scene::SurfaceCreationParameters::content_id

mir::optional_value<MirEdgeAttachment> mir::scene::SurfaceCreationParameters::edge_attachment

mir::optional_value<geometry::DeltaY> mir::scene::SurfaceCreationParameters::height_inc

input::InputReceptionMode mir::scene::SurfaceCreationParameters::input_mode

mir::optional_value<std::vector<geometry::Rectangle> > mir::scene::SurfaceCreationParameters::input_shape

mir::optional_value<shell::SurfaceAspectRatio> mir::scene::SurfaceCreationParameters::max_aspect

optional_value<geometry::Height> mir::scene::SurfaceCreationParameters::max_height

optional_value<geometry::Width> mir::scene::SurfaceCreationParameters::max_width

mir::optional_value<shell::SurfaceAspectRatio> mir::scene::SurfaceCreationParameters::min_aspect

optional_value<geometry::Height> mir::scene::SurfaceCreationParameters::min_height

optional_value<geometry::Width> mir::scene::SurfaceCreationParameters::min_width

std::string mir::scene::SurfaceCreationParameters::name

graphics::DisplayConfigurationOutputId mir::scene::SurfaceCreationParameters::output_id

std::weak_ptr<Surface> mir::scene::SurfaceCreationParameters::parent

mir::optional_value<frontend::SurfaceId> mir::scene::SurfaceCreationParameters::parent_id

MirPixelFormat mir::scene::SurfaceCreationParameters::pixel_format

optional_value<MirPlacementHints> mir::scene::SurfaceCreationParameters::placement_hints

mir::optional_value<MirOrientationMode> mir::scene::SurfaceCreationParameters::preferred_orientation

mir::optional_value<MirShellChrome> mir::scene::SurfaceCreationParameters::shell_chrome

geometry::Size mir::scene::SurfaceCreationParameters::size

Examples:

server_example_window_management.cpp.

mir::optional_value<MirWindowState> mir::scene::SurfaceCreationParameters::state

mir::optional_value<std::vector<shell::StreamSpecification> > mir::scene::SurfaceCreationParameters::streams

optional_value<MirPlacementGravity> mir::scene::SurfaceCreationParameters::surface_placement_gravity

geometry::Point mir::scene::SurfaceCreationParameters::top_left

Examples:

server_example_window_management.cpp.

mir::optional_value<MirWindowType> mir::scene::SurfaceCreationParameters::type

Examples:

server_example_canonical_window_manager.cpp.

mir::optional_value<geometry::DeltaX> mir::scene::SurfaceCreationParameters::width_inc

---

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

• include/server/mir/scene/surface_creation_parameters.h