Enum MirPlacementHints

Enum Documentation

enum MirPlacementHints

Positioning hints for aligning a window relative to a rectangle.

These hints determine how the window should be positioned in the case that the surface would fall off-screen if placed in its ideal position.

For example, mir_placement_hints_flip_x will invert the x component of aux_rect_placement_offset and replace mir_placement_gravity_northwest with mir_placement_gravity_northeast and vice versa if the window extends beyond the left or right edges of the monitor.

If mir_placement_hints_slide_x is set, the window can be shifted horizontally to fit on-screen.

If mir_placement_hints_resize_x is set, the window can be shrunken horizontally to fit.

If mir_placement_hints_antipodes is set then the rect gravity may be substituted with the opposite corner (e.g. mir_placement_gravity_northeast to mir_placement_gravity_southwest) in combination with other options.

When multiple flags are set, flipping should take precedence over sliding, which should take precedence over resizing.


enumerator mir_placement_hints_flip_x

allow flipping anchors horizontally

enumerator mir_placement_hints_flip_y

allow flipping anchors vertically

enumerator mir_placement_hints_slide_x

allow sliding window horizontally

enumerator mir_placement_hints_slide_y

allow sliding window vertically

enumerator mir_placement_hints_resize_x

allow resizing window horizontally

enumerator mir_placement_hints_resize_y

allow resizing window vertically

enumerator mir_placement_hints_antipodes

allow flipping aux_anchor to opposite corner

enumerator mir_placement_hints_flip_any

allow flipping anchors on both axes

enumerator mir_placement_hints_slide_any

allow sliding window on both axes

enumerator mir_placement_hints_resize_any

allow resizing window on both axes