Public Member Functions | Public Attributes

# IFramebufferOverlay Interface Reference

The IFramebufferOverlay interface represents an alpha blended overlay for displaying status icons above an IFramebuffer. More...

Inheritance diagram for IFramebufferOverlay:

List of all members.

## Public Member Functions
void | move (in unsigned long x, in unsigned long y)
| Changes the overlay's position relative to the IFramebuffer.
## Public Attributes
readonly attribute unsigned long | x
| X position of the overlay, relative to the frame buffer.
readonly attribute unsigned long | y
| Y position of the overlay, relative to the frame buffer.
attribute boolean | visible
| Whether the overlay is currently visible.
attribute unsigned long | alpha
| The global alpha value for the overlay.

## Detailed Description

The IFramebufferOverlay interface represents an alpha blended overlay for displaying status icons above an IFramebuffer.

It is always created not visible, so that it must be explicitly shown. It only covers a portion of the IFramebuffer, determined by its width, height and co-ordinates. It is always in packed pixel little-endian 32bit ARGB (in that order) format, and may be written to directly. Do re-read the width though, after setting it, as it may be adjusted (increased) to make it more suitable for the front end.

Interface ID:
  `{0BCC1C7E-E415-47D2-BFDB-E4C705FB0F47}`

## Member Function Documentation

void IFramebufferOverlay::move | ( | in unsigned long | x,
|  | in unsigned long | y |
| ) |  |  |

Changes the overlay's position relative to the IFramebuffer.

## Member Data Documentation

readonly attribute unsigned long IFramebufferOverlay::x

X position of the overlay, relative to the frame buffer.

readonly attribute unsigned long IFramebufferOverlay::y

Y position of the overlay, relative to the frame buffer.

attribute boolean IFramebufferOverlay::visible

Whether the overlay is currently visible.

attribute unsigned long IFramebufferOverlay::alpha

The global alpha value for the overlay.

This may or may not be supported by a given front end.