Phoc.LayerSurface
Description: Reference for Phoc.LayerSurface

### Class

# PhocLayerSurface

#### Description [src]

    class Phoc.LayerSurface : GObject.Object
      implements Phoc.Animatable, Phoc.ChildRoot {
      wlr_layer_surface_v1* layer_surface,
      wl_list link,
      wl_listener destroy,
      wl_listener map,
      wl_listener unmap,
      wl_listener surface_commit,
      wl_listener output_destroy,
      wl_listener new_popup,
      wl_listener new_subsurface,
      wl_list subsurfaces,
      wlr_box geo,
      zwlr_layer_shell_v1_layer layer,
      float alpha,
      bool mapped,
      gpointer child_surfaces,
      uint32_t pending_serial
    }

A Layer surface backed by the wlr-layer-surface wayland protocol.

For details on how to setup a layer surface see `phoc_handle_layer_shell_surface`.

This handles the events concerning individual surfaces like mapping and unmapping. For the actual layout of surfaces on a `PhocOutput` see `phoc_layer_shell_arrange()`.

#### Hierarchy

#### Ancestors

- GObject

#### Implements

- PhocAnimatable
- PhocChildRoot

#### Constructors

###### phoc_layer_surface_new

No description available.

#### Instance methods

###### phoc_layer_surface_covers_output

Check whether the given layer surface fully covers its output.

###### phoc_layer_surface_get_alpha

No description available.

###### phoc_layer_surface_get_geometry

No description available.

###### phoc_layer_surface_get_layer

Get the layer surface’s current layer.

###### phoc_layer_surface_get_mapped

Get whether the layer surface is currently mapped.

###### phoc_layer_surface_get_namespace

No description available.

###### phoc_layer_surface_get_output

No description available.

###### phoc_layer_surface_get_pending_serial

No description available.

###### phoc_layer_surface_send_configure

Send a configure event with the current width and height.

###### phoc_layer_surface_set_alpha

Sets the surfaces transparency.

##### Methods inherited from GObject (43)

Please see GObject for a full list of methods.

##### Methods inherited from PhocAnimatable (2)

###### phoc_animatable_add_frame_callback

Adds a callback to be called before each frame. Until the frame callback is removed, it will be at the frame rate of the output. The frame callback does not automatically imply any repaint. You need to damage the areas you want repainted.

###### phoc_animatable_remove_frame_callback

No description available.

##### Methods inherited from PhocChildRoot (6)

###### phoc_child_root_add_child

No description available.

###### phoc_child_root_apply_damage

No description available.

###### phoc_child_root_get_box

No description available.

###### phoc_child_root_is_mapped

No description available.

###### phoc_child_root_remove_child

No description available.

###### phoc_child_root_unconstrain_popup

No description available.

#### Properties

###### Phoc.LayerSurface:wlr-layer-surface

No description available.

#### Signals

##### Signals inherited from GObject (1)

###### GObject::notify

The notify signal is emitted on an object when one of its properties has its value set through g_object_set_property(), g_object_set(), et al.

#### Class structure

    struct PhocLayerSurfaceClass {
      GObjectClass parent_class;

    }

No description available.

###### Class members

`parent_class: GObjectClass`

  No description available.