Phoc.Bling
Description: Reference for Phoc.Bling

### Interface

# PhocBling

#### Description [src]

    interface Phoc.Bling : GObject.Object

A `PhocBling` is additional render bling such as rectangles or other elements to be drawn by the compositor.

Blings are currently meant to be attached to `PhocView` but can be extended to other objects.

#### Prerequisite

In order to implement Bling, your type must inherit from`GObject`.

#### Implementations

- PhocColorRect
- PhocFocusFrame
- PhocSpinner
- PhocViewDeco
- PhocWorkspaceIndicator

#### Instance methods

###### phoc_bling_damage_box

A utility method to damage the entire bounding box region of a PhocBling.

###### phoc_bling_get_box

No description available.

###### phoc_bling_is_mapped

No description available.

###### phoc_bling_map

No description available.

###### phoc_bling_render

No description available.

###### phoc_bling_unmap

No description available.

#### Interface structure

    struct PhocBlingInterface {
      GTypeInterface parent_iface;
      PhocBox (* get_box) (
        PhocBling* self
      );
      void (* render) (
        PhocBling* self,
        PhocRenderContext* ctx
      );
      void (* map) (
        PhocBling* self
      );
      void (* unmap) (
        PhocBling* self
      );
      gboolean (* is_mapped) (
        PhocBling* self
      );

    }

No description available.

###### Interface members

`parent_iface` |
    GTypeInterface
| No description available.
`get_box` |
    PhocBox (* get_box) (
        PhocBling* self
      )
| No description available.
`render` |
    void (* render) (
        PhocBling* self,
        PhocRenderContext* ctx
      )
| No description available.
`map` |
    void (* map) (
        PhocBling* self
      )
| No description available.
`unmap` |
    void (* unmap) (
        PhocBling* self
      )
| No description available.
`is_mapped` |
    gboolean (* is_mapped) (
        PhocBling* self
      )
| No description available.

#### Virtual methods

###### Phoc.Bling.get_box

Get a minimal box in layout coordinates that contains the bling.

###### Phoc.Bling.is_mapped

Check whether the bling is mapped.

###### Phoc.Bling.map

Map the bling so it can be rendered.

###### Phoc.Bling.render

Render the bling. Scissoring is handled by the renderer prior to invoking this function.

###### Phoc.Bling.unmap

Umap the bling so it’s not rendered anymore.