Phoc.Output
Description: Reference for Phoc.Output

### Class

# PhocOutput

#### Description [src]

    class Phoc.Output : GObject.Object
      implements Gio.Initable, Phoc.Animatable {
      wlr_output* wlr_output,
      wl_list link,
      PhocView* fullscreen_view,
      wl_list layer_surfaces,
      wlr_box usable_area,
      int lx,
      int ly,
      wl_listener commit,
      wl_listener output_destroy
    }

The output region of a compositor (typically a monitor).

See wlroot’s #wlr_output.

#### Hierarchy

#### Ancestors

- GObject

#### Implements

- GInitable
- PhocAnimatable

#### Constructors

###### phoc_output_new

No description available.

#### Functions

###### phoc_output_handle_gamma_control_set_gamma

No description available.

###### phoc_output_handle_output_power_manager_set_mode

No description available.

#### Instance methods

###### phoc_output_add_bling

By adding a `PhocBling` to an output you ensure that it gets rendered just before the output if the output is active and the bling is mapped.

###### phoc_output_add_frame_callback

No description available.

###### phoc_output_damage_box

If damage overlaps with output add it and schedule a frame.

###### phoc_output_damage_from_drag_icon

Adds a drag icon’s damage to the damaged area of `self`. We always damage the whole surface.

###### phoc_output_damage_from_layer_surface

Adds a `PhocLayerSurface`‘s damage to the damaged area of `self`. If `whole` is `TRUE` the whole surface area is explicitly damaged. Otherwise only already present damage is collected.

###### phoc_output_damage_from_surface

Adds a surface’s damage to the damaged area of `self`. If `whole` is `TRUE` the whole surface area is explicitly damaged. Otherwise only already present damage is collected.

###### phoc_output_damage_from_view

Adds a `PhocView`‘s damage to the damaged area of `self`. If `whole` is `TRUE` the whole surface area is explicitly damaged. Otherwise only already present damage is collected.

###### phoc_output_damage_region

If damage overlaps with output add it and schedule a frame.

###### phoc_output_damage_whole

No description available.

###### phoc_output_drag_icons_for_each_surface

Iterate over the surface tree of the drag icon’s surface of an input’s seats.

###### phoc_output_force_shell_reveal

Allows to force shell reveal status regardless of whether other conditions are being fulfilled.

###### phoc_output_get_blings

Gets the output’s current list of blings.

###### phoc_output_get_cutout_boxes

Checks whether view overlaps with any cutouts of the output.

###### phoc_output_get_cutout_corners

Get the cutout corners if the surfaces touches the screen edge.

###### phoc_output_get_debug_damage

Get the current list of debug damage regions.

###### phoc_output_get_identifier

No description available.

###### phoc_output_get_layer_surfaces_for_layer

Get a list of `PhocLayerSurface`s on this output in the given `layer` in rendering order.

###### phoc_output_get_name

No description available.

###### phoc_output_get_scale

No description available.

###### phoc_output_get_texture_filter_mode

No description available.

###### phoc_output_get_wlr_output

No description available.

###### phoc_output_has_frame_callbacks

No description available.

###### phoc_output_has_layer

No description available.

###### phoc_output_has_shell_revealed

No description available.

###### phoc_output_is_builtin

No description available.

###### phoc_output_is_match

Checks if an output matches the given vendor/product/serial information. This is usually used to match on an outputs EDID information.

###### phoc_output_layer_surface_for_each_surface

Iterate over a `PhocLayerSurface` and its popups.

###### phoc_output_lower_shield

Lowers an output shield that is in place to hide the outputs current content.

###### phoc_output_raise_shield

Raise an output shield will be put in place to hide the outputs current content. A spinner can be displayed on the raised shield.

###### phoc_output_remove_bling

Removes the given bling from the output.

###### phoc_output_remove_frame_callback

No description available.

###### phoc_output_remove_frame_callbacks_by_animatable

Remove all frame callbacks for the given `PhocAnimatable`.

###### phoc_output_set_fullscreen_view

No description available.

###### phoc_output_set_layer_dirty

Invalidate the ordering of layer surfaces.

###### phoc_output_surface_for_each_surface

Iterate over surfaces in a `wlr_surface`s surface tree.

###### phoc_output_transform_box

Transforms the given box according to the output’s transform.

###### phoc_output_transform_damage

Transforms the given damage region according to the output’s transform.

###### phoc_output_unmanaged_for_each_surface

Iterate over surfaces in a `PhocXWaylandUnmanaged`s surface tree.

###### phoc_output_update_shell_reveal

Updates shell reveal status of given output.

###### phoc_output_view_for_each_surface

Iterate over surfaces in a `PhocView`s surface tree.

###### phoc_output_xdg_surface_for_each_surface

Iterate over surfaces in a `wlr_xdg_surface`s surface tree.

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

Please see GObject for a full list of methods.

##### Methods inherited from GInitable (1)

###### g_initable_init

Initializes the object implementing the interface.

##### 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.

#### Properties

###### Phoc.Output:wlr-output

The wlroots output backing this output.

#### Signals

###### Phoc.Output::output-destroyed

No description available.

##### 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 PhocOutputClass {
      GObjectClass parent_class;

    }

No description available.

###### Class members

`parent_class: GObjectClass`

  No description available.