Mir
Public Member Functions | Public Attributes | List of all members
mir::scene::SurfaceCreationParameters Struct Reference

#include <surface_creation_parameters.h>

Public Member Functions

 SurfaceCreationParameters ()
 
SurfaceCreationParametersof_name (std::string const &new_name)
 
SurfaceCreationParametersof_size (geometry::Size new_size)
 
SurfaceCreationParametersof_size (geometry::Width::ValueType width, geometry::Height::ValueType height)
 
SurfaceCreationParametersof_position (geometry::Point const &top_left)
 
SurfaceCreationParametersof_buffer_usage (graphics::BufferUsage new_buffer_usage)
 
SurfaceCreationParametersof_pixel_format (MirPixelFormat new_pixel_format)
 
SurfaceCreationParameterswith_input_mode (input::InputReceptionMode const &new_mode)
 
SurfaceCreationParameterswith_output_id (graphics::DisplayConfigurationOutputId const &output_id)
 
SurfaceCreationParametersof_type (MirSurfaceType type)
 
SurfaceCreationParameterswith_state (MirSurfaceState state)
 
SurfaceCreationParameterswith_preferred_orientation (MirOrientationMode mode)
 
SurfaceCreationParameterswith_parent_id (frontend::SurfaceId const &id)
 
SurfaceCreationParameterswith_aux_rect (geometry::Rectangle const &rect)
 
SurfaceCreationParameterswith_edge_attachment (MirEdgeAttachment edge)
 
SurfaceCreationParameterswith_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< MirSurfaceStatestate
 
mir::optional_value< MirSurfaceTypetype
 
mir::optional_value< MirOrientationModepreferred_orientation
 
mir::optional_value< frontend::SurfaceIdparent_id
 
mir::optional_value< frontend::BufferStreamIdcontent_id
 
mir::optional_value< geometry::Rectangleaux_rect
 
mir::optional_value< MirEdgeAttachmentedge_attachment
 
optional_value< MirPlacementHintsplacement_hints
 
optional_value< MirPlacementGravitysurface_placement_gravity
 
optional_value< MirPlacementGravityaux_rect_placement_gravity
 
optional_value< int > aux_rect_placement_offset_x
 
optional_value< int > aux_rect_placement_offset_y
 
std::weak_ptr< Surfaceparent
 
optional_value< geometry::Widthmin_width
 
optional_value< geometry::Heightmin_height
 
optional_value< geometry::Widthmax_width
 
optional_value< geometry::Heightmax_height
 
mir::optional_value< geometry::DeltaXwidth_inc
 
mir::optional_value< geometry::DeltaYheight_inc
 
mir::optional_value< shell::SurfaceAspectRatiomin_aspect
 
mir::optional_value< shell::SurfaceAspectRatiomax_aspect
 
mir::optional_value< std::vector< geometry::Rectangle > > input_shape
 
mir::optional_value< MirShellChromeshell_chrome
 
mir::optional_value< std::vector< shell::StreamSpecification > > streams
 
mir::optional_value< MirPointerConfinementStateconfine_pointer
 

Detailed Description

Examples:
server_example_canonical_window_manager.cpp, and server_example_window_management.cpp.

Constructor & Destructor Documentation

§ SurfaceCreationParameters()

mir::scene::SurfaceCreationParameters::SurfaceCreationParameters ( )

Member Function Documentation

§ of_buffer_usage()

SurfaceCreationParameters& mir::scene::SurfaceCreationParameters::of_buffer_usage ( graphics::BufferUsage  new_buffer_usage)

§ of_name()

SurfaceCreationParameters& mir::scene::SurfaceCreationParameters::of_name ( std::string const &  new_name)

§ of_pixel_format()

SurfaceCreationParameters& mir::scene::SurfaceCreationParameters::of_pixel_format ( MirPixelFormat  new_pixel_format)

§ of_position()

SurfaceCreationParameters& mir::scene::SurfaceCreationParameters::of_position ( geometry::Point const &  top_left)

§ of_size() [1/2]

SurfaceCreationParameters& mir::scene::SurfaceCreationParameters::of_size ( geometry::Size  new_size)

§ of_size() [2/2]

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

§ of_type()

SurfaceCreationParameters& mir::scene::SurfaceCreationParameters::of_type ( MirSurfaceType  type)

§ with_aux_rect()

SurfaceCreationParameters& mir::scene::SurfaceCreationParameters::with_aux_rect ( geometry::Rectangle const &  rect)

§ with_buffer_stream()

SurfaceCreationParameters& mir::scene::SurfaceCreationParameters::with_buffer_stream ( frontend::BufferStreamId const &  id)

§ with_edge_attachment()

SurfaceCreationParameters& mir::scene::SurfaceCreationParameters::with_edge_attachment ( MirEdgeAttachment  edge)

§ with_input_mode()

SurfaceCreationParameters& mir::scene::SurfaceCreationParameters::with_input_mode ( input::InputReceptionMode const &  new_mode)

§ with_output_id()

SurfaceCreationParameters& mir::scene::SurfaceCreationParameters::with_output_id ( graphics::DisplayConfigurationOutputId const &  output_id)

§ with_parent_id()

SurfaceCreationParameters& mir::scene::SurfaceCreationParameters::with_parent_id ( frontend::SurfaceId const &  id)

§ with_preferred_orientation()

SurfaceCreationParameters& mir::scene::SurfaceCreationParameters::with_preferred_orientation ( MirOrientationMode  mode)

§ with_state()

SurfaceCreationParameters& mir::scene::SurfaceCreationParameters::with_state ( MirSurfaceState  state)

Member Data Documentation

§ aux_rect

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

§ aux_rect_placement_gravity

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

§ aux_rect_placement_offset_x

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

§ aux_rect_placement_offset_y

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

§ buffer_usage

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

§ confine_pointer

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

§ content_id

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

§ edge_attachment

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

§ height_inc

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

§ input_mode

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

§ input_shape

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

§ max_aspect

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

§ max_height

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

§ max_width

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

§ min_aspect

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

§ min_height

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

§ min_width

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

§ name

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

§ output_id

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

§ parent

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

§ parent_id

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

§ pixel_format

MirPixelFormat mir::scene::SurfaceCreationParameters::pixel_format

§ placement_hints

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

§ preferred_orientation

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

§ shell_chrome

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

§ size

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

§ state

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

§ streams

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

§ surface_placement_gravity

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

§ top_left

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

§ type

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

§ width_inc

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

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

Copyright © 2012-2016 Canonical Ltd.
Generated on Sat Dec 3 12:48:59 UTC 2016