Overlay.1.0

The overlay service can overlay painted areas over a Window.

Currently, only one overlay method is supported (Area), but additional methods may be added in the future.

Usage

Overlays are created with the CreateOverlay command. This command returns a overlayID, which must be used when removing the overlay with RemoveOverlay.

Paint Order

When creating the overlay, you must specify where the overlay should be inserted into the list of overlays. It is possible to insert the overlay in the front of all others, behind all others, or above/beneath a specific overlay in the list.

Area Overlay

Currently, the only supported overlay method is AREA. In this mode, you define an area of the document to be painted in a certain color. A border and grid color may also be specified.

CreateOverlay

Create a new overlay.

command CreateOverlay(CreateOverlayArg)

```
required uint32 windowID = 1;
```
```
 required OverlayType overlayType = 2;
```
The type of overlay we want to create.
```
{
```
- ```
AREA = 1;
```
  The overlay will be an AreaOverlay.
```
}
```
```
 required Insertion insertion = 3;
```
Where to insert this overlay in the list of overlays.
```
{
```
- ```
 required InsertionMethod method = 1;
```
  Specifies how an overlay should be inserted.
```
{
```
  - FRONT = 1;
    
    Insert the overlay at the front. This means this overlay will be rendered over all other overlays.
  - BACK = 2;
    
    Insert the overlay at the back. This means all other overlays will be rendered over this overlay.
  - ABOVE_TARGET = 3;
    
    Insert an overlay in front of another overlay. This means this overlay will be rendered over the other overlay.
  - BELOW_TARGET = 4;
    
    Insert an overlay behind another overlay. This means this overlay will be rendered below the other overlay.
```
}
```
- ```
optional uint32 overlayID = 2;
```
  If method is ABOVE_TARGET or BELOW_TARGET, then this field must be set, and refer to a valid overlay.
```
}
```
```
 optional AreaOverlay areaOverlay = 4;
```
Must be provided if overlayType is AREA.
```
{
```
- ```
 required Area area = 1;
```
  The area that should be painted.
```
{
```
  - required uint32 x = 1;
    
    The x-coordinate of the upper-left corner of the area, in document coordinates.
  - required uint32 y = 2;
    
    The y-coordinate of the upper-left corner of the area, in document coordinates.
  - required uint32 w = 3;
    
    The width of the area.
  - required uint32 h = 4;
    
    The height of the area.
```
}
```
- ```
 required Color backgroundColor = 2;
```
  The background color of the area.
```
{
```
  - required uint32 r = 1;
    
    The red component of the Color. (0 - 255).
  - required uint32 g = 2;
    
    The green component of the Color. (0 - 255).
  - required uint32 b = 3;
    
    The blue component of the Color. (0 - 255).
  - optional uint32 a = 4 [default = 255];
    
    The alpha component of the Color. (0 - 255).
```
}
```
- ```
 optional Color borderColor = 3;
```
  If set, draw a 1px border on the inside of the area.
```
{
```
  - required uint32 r = 1;
    
    The red component of the Color. (0 - 255).
  - required uint32 g = 2;
    
    The green component of the Color. (0 - 255).
  - required uint32 b = 3;
    
    The blue component of the Color. (0 - 255).
  - optional uint32 a = 4 [default = 255];
    
    The alpha component of the Color. (0 - 255).
```
}
```
- ```
 optional Color gridColor = 4;
```
  If set, draw a 1px wide lines intersecting the area edges and extending over whole window.
```
{
```
  - required uint32 r = 1;
    
    The red component of the Color. (0 - 255).
  - required uint32 g = 2;
    
    The green component of the Color. (0 - 255).
  - required uint32 b = 3;
    
    The blue component of the Color. (0 - 255).
  - optional uint32 a = 4 [default = 255];
    
    The alpha component of the Color. (0 - 255).
```
}
```
```
}
```

returns (OverlayID)

```
required uint32 overlayID = 1;
```
Non-zero ID for an overlay.

= 1;

RemoveOverlay

Remove a specific overlay, or, if no overlay ID is specified, remove all overlays for the given window.

command RemoveOverlay(RemoveOverlayArg)

```
required uint32 windowID = 1;
```
```
optional uint32 overlayID = 2 [default = 0];
```
The ID for the overlay to remove.

If not set, remove all overlays for the given window.

returns (Default)

= 2;

Overlay1.0

Commands

Events

Usage

Paint Order

Area Overlay

CreateOverlay

RemoveOverlay