VideoOverlay.setRenderRectangle

Configure a subregion as a video target within the window set by VideoOverlay.setWindowHandle. If this is not used or not supported the video will fill the area of the window set as the overlay to 100%. By specifying the rectangle, the video can be overlayed to a specific region of that window only. After setting the new rectangle one should call VideoOverlay.expose to force a redraw. To unset the region pass -1 for the width and height parameters.

This method is needed for non fullscreen video overlay in UI toolkits that do not support subwindows.

class VideoOverlay
bool
setRenderRectangle
(
int x
,
int y
,
int width
,
int height
)

Parameters

x int

the horizontal offset of the render area inside the window

y int

the vertical offset of the render area inside the window

width int

the width of the render area inside the window

height int

the height of the render area inside the window

Return Value

Type: bool

FALSE if not supported by the sink.