# wxDCOverlay

###
Module

wxDCOverlay

###
Module Summary

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.