GVnc.BaseFramebuffer¶

Subclasses:: None

Methods¶

Inherited:: GObject.Object (37), GVnc.Framebuffer (13)
Structs:: GObject.ObjectClass (5)

class

new (buffer, width, height, rowstride, localFormat, remoteFormat)

Virtual Methods¶

Inherited:: GObject.Object (7), GVnc.Framebuffer (13)

Properties¶

Name	Type	Flags	Short Description
`buffer`	`int`	r/w/co	The framebuffer memory region
`color-map`	`GVnc.ColorMap`	r/w	The color map
`height`	`int`	r/w/co	Height of the framebuffer in pixels
`local-format`	`GVnc.PixelFormat`	r/w/co	The local pixel format of the framebuffer
`remote-format`	`GVnc.PixelFormat`	r/w/co	The remote pixel format of the framebuffer
`rowstride`	`int`	r/w/co	Size of one framebuffer line in bytes
`width`	`int`	r/w/co	Width of the framebuffer in pixels

Signals¶

Inherited:: GObject.Object (1)

Fields¶

Inherited:: GObject.Object (1)

Name	Type	Access	Description
parent	`GObject.Object`	r

Class Details¶

class GVnc.BaseFramebuffer(**kwargs)¶

Bases:: GObject.Object, GVnc.Framebuffer
Abstract:: No
Structure:: GVnc.BaseFramebufferClass

classmethod new(buffer, width, height, rowstride, localFormat, remoteFormat)¶

Parameters:

buffer (bytes) – the buffer representing the screen
width (int) – the width of the screen
height (int) – the height of the screen
rowstride (int) – the number of bytes per line in buffer
localFormat (GVnc.PixelFormat) – the format for data stored in buffer
remoteFormat (GVnc.PixelFormat) – the format for data before storage in buffer

Returns:

the new framebuffer

Return type:

GVnc.BaseFramebuffer

Allocate a new general purpose framebuffer object storing screen updates in buffer. buffer must be height * rowstride bytes in size. The returned object will store a pointer to buffer, so it should not be free’d for as long as the framebuffer object exists

Property Details¶

GVnc.BaseFramebuffer.props.buffer¶

Name:: buffer
Type:: int
Default Value:: None
Flags:: READABLE, WRITABLE, CONSTRUCT_ONLY

The framebuffer memory region

GVnc.BaseFramebuffer.props.color_map¶

Name:: color-map
Type:: GVnc.ColorMap
Default Value:: None
Flags:: READABLE, WRITABLE

The color map

GVnc.BaseFramebuffer.props.height¶

Name:: height
Type:: int
Default Value:: 0
Flags:: READABLE, WRITABLE, CONSTRUCT_ONLY

Height of the framebuffer in pixels

GVnc.BaseFramebuffer.props.local_format¶

Name:: local-format
Type:: GVnc.PixelFormat
Default Value:: None
Flags:: READABLE, WRITABLE, CONSTRUCT_ONLY

The local pixel format of the framebuffer

GVnc.BaseFramebuffer.props.remote_format¶

Name:: remote-format
Type:: GVnc.PixelFormat
Default Value:: None
Flags:: READABLE, WRITABLE, CONSTRUCT_ONLY

The remote pixel format of the framebuffer

GVnc.BaseFramebuffer.props.rowstride¶

Name:: rowstride
Type:: int
Default Value:: 0
Flags:: READABLE, WRITABLE, CONSTRUCT_ONLY

Size of one framebuffer line in bytes

GVnc.BaseFramebuffer.props.width¶

Name:: width
Type:: int
Default Value:: 0
Flags:: READABLE, WRITABLE, CONSTRUCT_ONLY

Width of the framebuffer in pixels