GVnc.Framebuffer

Implementations:

GVnc.BaseFramebuffer

Methods

	blt (src, rowstride, x, y, width, height)
	copyrect (srcx, srcy, dstx, dsty, width, height)
	fill (src, x, y, width, height)
	get_buffer ()
	get_height ()
	get_local_format ()
	get_remote_format ()
	get_rowstride ()
	get_width ()
	perfect_format_match ()
	rgb24_blt (src, rowstride, x, y, width, height)
	set_color_map (map)
	set_pixel_at (src, x, y)

Virtual Methods

	do_blt (src, rowstride, x, y, width, height)
	do_copyrect (srcx, srcy, dstx, dsty, width, height)
	do_fill (src, x, y, width, height)
	do_get_buffer ()
	do_get_height ()
	do_get_local_format ()
	do_get_remote_format ()
	do_get_rowstride ()
	do_get_width ()
	do_perfect_format_match ()
	do_rgb24_blt (src, rowstride, x, y, width, height)
	do_set_color_map (map)
	do_set_pixel_at (src, x, y)

Properties

None

Signals

None

Fields

None

Class Details

class GVnc.Framebuffer

Bases:

GObject.GInterface

Structure:

GVnc.FramebufferInterface

blt(src, rowstride, x, y, width, height)

Parameters:

• src (int) –

• rowstride (int) –

• x (int) –

• y (int) –

• width (int) –

• height (int) –

copyrect(srcx, srcy, dstx, dsty, width, height)

Parameters:

• srcx (int) – the horizontal starting pixel

• srcy (int) – the vertical starting pixel

• dstx (int) – the horizontal target pixel

• dsty (int) – the vertical target pixel

• width (int) – the width of the region

• height (int) – the height of the region

Copies data from the range (srcx, srcy) to (srcx+`width`, srcy+`height`) over to the range starting at (dstx, dsty).

fill(src, x, y, width, height)

Parameters:

• src (bytes) – the new pixel data

• x (int) – the horizontal pixel to start filling

• y (int) – the vertical pixel to start filling

• width (int) – the number of pixels to fill horizontally

• height (int) – the number of pixels to fill vertically

Fill all the pixels in the range (x, y) to (x + width, y + height) to the value in src. The number of bytes in src is determined by the remote pixel format

get_buffer()

Returns:

the framebuffer data

Return type:

bytes

Get a pointer to the framebuffer contents

get_height()

Returns:

the frambuffer height

Return type:

int

Query the height of the remote framebuffer

get_local_format()

Returns:

the local pixel format

Return type:

GVnc.PixelFormat

Get the pixel format used to store the framebuffer locally

get_remote_format()

Return type:

GVnc.PixelFormat

get_rowstride()

Returns:

the framebuffer row stride

Return type:

int

Get the number of bytes per line of the framebuffer

get_width()

Returns:

the framebuffer width

Return type:

int

Query the width of the remote framebuffer

perfect_format_match()

Returns:

True if the local and remote pixel formats match

Return type:

bool

Determine if the local and remote pixel formats match

rgb24_blt(src, rowstride, x, y, width, height)

Parameters:

• src (bytes) – the new pixel data

• rowstride (int) – the number of bytes per row

• x (int) – the horizontal pixel to start filling

• y (int) – the vertical pixel to start filling

• width (int) – the number of pixels to fill horizontally

• height (int) – the number of pixels to fill vertically

Fill all the pixels in the range (x, y) to (x + width, y + height) to the value in src. The number of bytes in src is always 3 as it must be in plain RGB24 format.

set_color_map(map)

Parameters:

map (GVnc.ColorMap) – the new color map

Set the color map to use for the framebuffer

set_pixel_at(src, x, y)

Parameters:

• src (bytes) – the new pixel data

• x (int) – the horizontal pixel to set

• y (int) – the vertical pixel to set

Sets a pixel in the framebuffer at (x, y) to the value in src. The number of bytes in src is determined by the remote pixel format

do_blt(src, rowstride, x, y, width, height) virtual

Parameters:

• src (int) –

• rowstride (int) –

• x (int) –

• y (int) –

• width (int) –

• height (int) –

do_copyrect(srcx, srcy, dstx, dsty, width, height) virtual

Parameters:

• srcx (int) – the horizontal starting pixel

• srcy (int) – the vertical starting pixel

• dstx (int) – the horizontal target pixel

• dsty (int) – the vertical target pixel

• width (int) – the width of the region

• height (int) – the height of the region

Copies data from the range (srcx, srcy) to (srcx+`width`, srcy+`height`) over to the range starting at (dstx, dsty).

do_fill(src, x, y, width, height) virtual

Parameters:

• src (bytes) – the new pixel data

• x (int) – the horizontal pixel to start filling

• y (int) – the vertical pixel to start filling

• width (int) – the number of pixels to fill horizontally

• height (int) – the number of pixels to fill vertically

Fill all the pixels in the range (x, y) to (x + width, y + height) to the value in src. The number of bytes in src is determined by the remote pixel format

do_get_buffer() virtual

Return type:

int

do_get_height() virtual

Returns:

the frambuffer height

Return type:

int

Query the height of the remote framebuffer

do_get_local_format() virtual

Returns:

the local pixel format

Return type:

GVnc.PixelFormat

Get the pixel format used to store the framebuffer locally

do_get_remote_format() virtual

Return type:

GVnc.PixelFormat

do_get_rowstride() virtual

Returns:

the framebuffer row stride

Return type:

int

Get the number of bytes per line of the framebuffer

do_get_width() virtual

Returns:

the framebuffer width

Return type:

int

Query the width of the remote framebuffer

do_perfect_format_match() virtual

Returns:

True if the local and remote pixel formats match

Return type:

bool

Determine if the local and remote pixel formats match

do_rgb24_blt(src, rowstride, x, y, width, height) virtual

Parameters:

• src (bytes) – the new pixel data

• rowstride (int) – the number of bytes per row

• x (int) – the horizontal pixel to start filling

• y (int) – the vertical pixel to start filling

• width (int) – the number of pixels to fill horizontally

• height (int) – the number of pixels to fill vertically

Fill all the pixels in the range (x, y) to (x + width, y + height) to the value in src. The number of bytes in src is always 3 as it must be in plain RGB24 format.

do_set_color_map(map) virtual

Parameters:

map (GVnc.ColorMap) – the new color map

Set the color map to use for the framebuffer

do_set_pixel_at(src, x, y) virtual

Parameters:

• src (bytes) – the new pixel data

• x (int) – the horizontal pixel to set

• y (int) – the vertical pixel to set

Sets a pixel in the framebuffer at (x, y) to the value in src. The number of bytes in src is determined by the remote pixel format