Mir
Public Member Functions | Public Attributes | List of all members
mir::shell::SurfaceSpecification Struct Reference

Specification of surface properties requested by client. More...

#include <surface_specification.h>

Public Member Functions

bool is_empty () const
 

Public Attributes

optional_value< geometry::Widthwidth
 
optional_value< geometry::Heightheight
 
optional_value< MirPixelFormatpixel_format
 
optional_value< graphics::BufferUsagebuffer_usage
 
optional_value< std::stringname
 
optional_value< graphics::DisplayConfigurationOutputIdoutput_id
 
optional_value< MirWindowTypetype
 
optional_value< MirWindowStatestate
 
optional_value< MirOrientationModepreferred_orientation
 
optional_value< frontend::SurfaceIdparent_id
 
optional_value< geometry::Rectangleaux_rect
 
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
 
optional_value< geometry::Widthmin_width
 
optional_value< geometry::Heightmin_height
 
optional_value< geometry::Widthmax_width
 
optional_value< geometry::Heightmax_height
 
optional_value< geometry::DeltaXwidth_inc
 
optional_value< geometry::DeltaYheight_inc
 
optional_value< SurfaceAspectRatiomin_aspect
 
optional_value< SurfaceAspectRatiomax_aspect
 
optional_value< std::vector< StreamSpecification > > streams
 
optional_value< std::weak_ptr< scene::Surface > > parent
 
optional_value< std::vector< geometry::Rectangle > > input_shape
 
optional_value< MirShellChromeshell_chrome
 
optional_value< MirPointerConfinementStateconfine_pointer
 
optional_value< std::shared_ptr< graphics::CursorImage > > cursor_image
 
optional_value< StreamCursorstream_cursor
 

Detailed Description

Specification of surface properties requested by client.

Examples:
server_example_window_management.cpp.

Member Function Documentation

◆ is_empty()

bool mir::shell::SurfaceSpecification::is_empty ( ) const

Member Data Documentation

◆ aux_rect

optional_value<geometry::Rectangle> mir::shell::SurfaceSpecification::aux_rect

◆ aux_rect_placement_gravity

optional_value<MirPlacementGravity> mir::shell::SurfaceSpecification::aux_rect_placement_gravity

◆ aux_rect_placement_offset_x

optional_value<int> mir::shell::SurfaceSpecification::aux_rect_placement_offset_x

◆ aux_rect_placement_offset_y

optional_value<int> mir::shell::SurfaceSpecification::aux_rect_placement_offset_y

◆ buffer_usage

optional_value<graphics::BufferUsage> mir::shell::SurfaceSpecification::buffer_usage

◆ confine_pointer

optional_value<MirPointerConfinementState> mir::shell::SurfaceSpecification::confine_pointer

◆ cursor_image

optional_value<std::shared_ptr<graphics::CursorImage> > mir::shell::SurfaceSpecification::cursor_image

◆ edge_attachment

optional_value<MirEdgeAttachment> mir::shell::SurfaceSpecification::edge_attachment

◆ height

optional_value<geometry::Height> mir::shell::SurfaceSpecification::height

◆ height_inc

optional_value<geometry::DeltaY> mir::shell::SurfaceSpecification::height_inc

◆ input_shape

optional_value<std::vector<geometry::Rectangle> > mir::shell::SurfaceSpecification::input_shape

◆ max_aspect

optional_value<SurfaceAspectRatio> mir::shell::SurfaceSpecification::max_aspect

◆ max_height

optional_value<geometry::Height> mir::shell::SurfaceSpecification::max_height

◆ max_width

optional_value<geometry::Width> mir::shell::SurfaceSpecification::max_width

◆ min_aspect

optional_value<SurfaceAspectRatio> mir::shell::SurfaceSpecification::min_aspect

◆ min_height

optional_value<geometry::Height> mir::shell::SurfaceSpecification::min_height

◆ min_width

optional_value<geometry::Width> mir::shell::SurfaceSpecification::min_width

◆ name

optional_value<std::string> mir::shell::SurfaceSpecification::name

◆ output_id

optional_value<graphics::DisplayConfigurationOutputId> mir::shell::SurfaceSpecification::output_id

◆ parent

optional_value<std::weak_ptr<scene::Surface> > mir::shell::SurfaceSpecification::parent

◆ parent_id

optional_value<frontend::SurfaceId> mir::shell::SurfaceSpecification::parent_id

◆ pixel_format

optional_value<MirPixelFormat> mir::shell::SurfaceSpecification::pixel_format

◆ placement_hints

optional_value<MirPlacementHints> mir::shell::SurfaceSpecification::placement_hints

◆ preferred_orientation

optional_value<MirOrientationMode> mir::shell::SurfaceSpecification::preferred_orientation

◆ shell_chrome

optional_value<MirShellChrome> mir::shell::SurfaceSpecification::shell_chrome

◆ state

optional_value<MirWindowState> mir::shell::SurfaceSpecification::state

◆ stream_cursor

optional_value<StreamCursor> mir::shell::SurfaceSpecification::stream_cursor

◆ streams

optional_value<std::vector<StreamSpecification> > mir::shell::SurfaceSpecification::streams

◆ surface_placement_gravity

optional_value<MirPlacementGravity> mir::shell::SurfaceSpecification::surface_placement_gravity

◆ type

optional_value<MirWindowType> mir::shell::SurfaceSpecification::type

◆ width

optional_value<geometry::Width> mir::shell::SurfaceSpecification::width

◆ width_inc

optional_value<geometry::DeltaX> mir::shell::SurfaceSpecification::width_inc

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

Copyright © 2012-2016 Canonical Ltd.
Generated on Mon Mar 27 12:06:55 UTC 2017