Class Xiron::Osd
In: ext/audioport.c
Parent: Object

Methods

clear   dispose   encoding=   has_freetype?   has_unscaled?   height   hide   image   line   new   palette   palette=   point   rect   set_size   show   stream   text   text_size   width  

Public Class methods

new( stream, x=0, y=0, w=stream.video_width, h=stream.video_height ) → object

Creates an osd drawable to draw into. If only particular optional parameters should be given, use a hash (e.g. "w" => 640, "h" => 480). By default, the new osd starts at 0,0 and has the size of the video.

Public Instance methods

clear() → nil

Erases the drawable.

dispose() → nil

Frees the osd. Be sure the osd isn’t used when call this and never be used again.

encoding="string"

Specifying encoding of texts. nil means current locale encoding (default).

has_freetype? → boolean

Is true, if the osd object is capable to render freetype2 fonts.

has_unscaled? → boolean

Is true, if the osd can be rendered independent from the video resolution.

height → number

The height of the osd.

hide ( vpts=0 ) → nil

Removes the osd from video window.

image ( x, y, image ) → nil

Draws given image at given position. The image is an array of arrays (lines) of palette indices.

line ( x1, y1, x2, y2, color=0 ) → nil

Draws a line with specified parameters.

palette → OsdPalette

Returns the currently used palette.

palette=OsdPalette

Sets the palette of the osd to the given one.

point ( x, y, color=0 ) → nil

Draws a point at given position.

rect ( x, y, w, h, color=0, filled=true ) → nil

Draws a rectangular with specified parameters.

set_size ( stream ) → nil
set_size ( w=0, h=0 ) → nil

Set the osd size to current framesize of stream or given size.

show ( x=0, y=0, vpts=0, unscaled=false ) → nil

Renders the osd into the video window at given position.

stream → Stream

The Stream, this Osd is connected with.

text ( x, y, text, color=0, font=, size= ) → nil

Draws a text with specified parameters. If font and fontsize given, it is saved for future call of Osd#text and Osd#text_size.

text_size ( text, font=, size= ) → [ width, height ]

Returns the amount of space that would be used, if the text would be rendered with given parameters. If font and fontsize given, it is saved for future call of Osd#text and Osd#text_size.

width → number

The width of the osd.

[Validate]