---
name: "wxOverlay"
section: "3erl"
platform: "linux"
package: "erlang-manpages"
version: "1:25.2.3+dfsg-1+deb12u4"
release: "Debian 12 (Bookworm)"
platforms: ["linux"]
url: "https://new.carta.tech/wxOverlay"
---

# wxOverlay(3erl)

Functions for wxOverlay class

## NAME

wxOverlay - Functions for wxOverlay class

## DESCRIPTION

Creates an overlay over an existing window, allowing for manipulations like rubberbanding, etc. On wxOSX the overlay is implemented with native platform APIs, on the other platforms it is simulated using *wxMemoryDC*.

See: *wxDCOverlay*, *wxDC*

wxWidgets docs: wxOverlay

## DATA TYPES

```
wxOverlay() = wx:wx_object()
```

## EXPORTS

```
new() -> wxOverlay()
```

```
destroy(This :: wxOverlay()) -> ok
```

```
reset(This) -> ok
```

Types:

This = wxOverlay()\

Clears the overlay without restoring the former state.

To be done, for example, when the window content has been changed and repainted.