pygame documentation | || Home || Help Contents || || pygame || cdrom || constants || cursor || display || draw || || event || font || image || joystick || key || mixer || || mixer_music || mouse || movie || sndarray || surfarray || time || || transform || || CD || Channel || Clock || Font || Joystick || Movie || || Overlay || Rect || Sound || Surface || || color || cursors || sprite ||

## Overlay

pygame.Overlay(pixeltype, [width, height]) -> Overlay Create a new video overlay object
This creates a new Overlay object. Overlays represent a basic interface for putting YUV image data into the graphics card's video overlay planes. This is a low level object intended for use by people who know what they are doing, and have pregenerated YUV image data. The pixeltype argument must be one of the pygame constants; YV12_OVERLAY, IYUV_OVERLAY, YUV2_OVERLAY, UYVY_OVERLAY, or YVYU_OVERLAY.

display | - display the yuv data
set_location | - set overlay location

display
`Overlay.display(y, u, v) -> None`

Display the yuv data in SDL's overlay planes. The y, u, and v arguments represents strings of byte data.

set_location
`Overlay.set_location(rectstyle) -> None`

Sets location for the overlay on a screen. This does not move or redraw any currently displayed data, it only sets the position for newly display() calls.