---
name: "wxDCOverlay"
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/wxDCOverlay"
---

# wxDCOverlay(3erl)

Functions for wxDCOverlay class

## NAME

wxDCOverlay - Functions for wxDCOverlay class

## DESCRIPTION

Connects an overlay with a drawing DC.

See: *wxOverlay*, *wxDC*

wxWidgets docs: wxDCOverlay

## DATA TYPES

```
wxDCOverlay() = wx:wx_object()
```

## EXPORTS

```
new(Overlay, Dc) -> wxDCOverlay()
```

Types:

Overlay = wxOverlay:wxOverlay()\
 Dc = wxDC:wxDC()\

Convenience wrapper that behaves the same using the entire area of the dc.

```
new(Overlay, Dc, X, Y, Width, Height) -> wxDCOverlay()
```

Types:

Overlay = wxOverlay:wxOverlay()\
 Dc = wxDC:wxDC()\
 X = Y = Width = Height = integer()\

Connects this overlay to the corresponding drawing dc, if the overlay is not initialized yet this call will do so.

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

Removes the connection between the overlay and the dc.

```
clear(This) -> ok
```

Types:

This = wxDCOverlay()\

Clears the layer, restoring the state at the last init.