ClutterX11.TexturePixmap¶

Subclasses:: None

Methods¶

Inherited:: Clutter.Texture (28), Clutter.Actor (238), GObject.Object (37), Clutter.Animatable (5), Clutter.Container (17), Clutter.Scriptable (4)
Structs:: GObject.ObjectClass (5)

class	`new` ()
class	`new_with_pixmap` (pixmap)
class	`new_with_window` (window)
	`set_automatic` (setting)
	`set_pixmap` (pixmap)
	`set_window` (window, automatic)
	`sync_window` ()
	`update_area` (x, y, width, height)

Virtual Methods¶

Inherited:: Clutter.Texture (3), Clutter.Actor (35), GObject.Object (7), Clutter.Animatable (5), Clutter.Container (13), Clutter.Scriptable (4)

do_update_area (x, y, width, height)

Properties¶

Inherited:: Clutter.Texture (12), Clutter.Actor (82)

Name	Type	Flags	Short Description
`automatic-updates`	`bool`	r/w	If the texture should be kept in sync with any pixmap changes.
`destroyed`	`bool`	r	If window has been destroyed
`pixmap`	`int`	r/w	The X11 Pixmap to be bound
`pixmap-depth`	`int`	r	The depth (in number of bits) of the pixmap bound to this texture
`pixmap-height`	`int`	r	The height of the pixmap bound to this texture
`pixmap-width`	`int`	r	The width of the pixmap bound to this texture
`window`	`int`	r/w	The X11 Window to be bound
`window-mapped`	`bool`	r	If window is mapped
`window-override-redirect`	`bool`	r	If this is an override-redirect window
`window-redirect-automatic`	`bool`	r/w	If composite window redirects are set to Automatic (or Manual if false)
`window-x`	`int`	r	X position of window on screen according to X11
`window-y`	`int`	r	Y position of window on screen according to X11

Signals¶

Inherited:: Clutter.Texture (3), Clutter.Actor (26), GObject.Object (1), Clutter.Container (3)

Name	Short Description
`queue-damage-redraw`	`::queue-damage-redraw` is emitted to notify that some sub-region of the texture has been changed (either by an automatic damage update or by an explicit call to `ClutterX11.TexturePixmap.update_area`).
`update-area`	The `::update-area` signal is emitted to ask the texture to update its content from its source pixmap.

Fields¶

Inherited:: Clutter.Texture (3), Clutter.Actor (26), GObject.Object (1), Clutter.Container (3)

Name	Type	Access	Description
parent	`Clutter.Texture`	r

Class Details¶

class ClutterX11.TexturePixmap(**kwargs)¶

Bases:: Clutter.Texture
Abstract:: No
Structure:: ClutterX11.TexturePixmapClass

The ClutterX11.TexturePixmap structure contains only private data

New in version 0.8.

classmethod new()¶

Returns:: A new ClutterX11.TexturePixmap
Return type:: Clutter.Actor

Creates a new ClutterX11.TexturePixmap which can be used to display the contents of an X11 Pixmap inside a Clutter scene graph

New in version 0.8.

classmethod new_with_pixmap(pixmap)¶

Parameters:: pixmap (int) – the X Pixmap to which this texture should be bound
Returns:: A new ClutterX11.TexturePixmap bound to the given X Pixmap
Return type:: Clutter.Actor

Creates a new ClutterX11.TexturePixmap for pixmap

New in version 0.8.

classmethod new_with_window(window)¶

Parameters:: window (int) – the X window to which this texture should be bound
Returns:: A new ClutterX11.TexturePixmap bound to the given X window.
Return type:: Clutter.Actor

Creates a new ClutterX11.TexturePixmap for window

New in version 0.8.

set_automatic(setting)¶

Parameters:: setting (bool) – True to enable automatic updates

Enables or disables the automatic updates ot self in case the backing pixmap or window is damaged

New in version 0.8.

set_pixmap(pixmap)¶

Parameters:: pixmap (int) – the X Pixmap to which the texture should be bound

Sets the X Pixmap to which the texture should be bound.

New in version 0.8.

set_window(window, automatic)¶

Parameters:

window (int) – the X window to which the texture should be bound
automatic (bool) – True for automatic window updates, False for manual.

Sets up a suitable pixmap for the window, using the composite and damage extensions if possible, and then calls ClutterX11.TexturePixmap.set_pixmap().

If you want to display a window in a Clutter.Texture, you probably want this function, or its older sister, clutter_glx_texture_pixmap_set_window().

This function has no effect unless the XComposite extension is available.

New in version 0.8.

sync_window()¶: Resets the texture’s pixmap from its window, perhaps in response to the pixmap’s invalidation as the window changed size.

New in version 0.8.

update_area(x, y, width, height)¶

Parameters:

x (int) – the X coordinate of the area to update
y (int) – the Y coordinate of the area to update
width (int) – the width of the area to update
height (int) – the height of the area to update

Performs the actual binding of texture to the current content of the pixmap. Can be called to update the texture if the pixmap content has changed.

New in version 0.8.

do_update_area(x, y, width, height) virtual¶

Parameters:

x (int) – the X coordinate of the area to update
y (int) – the Y coordinate of the area to update
width (int) – the width of the area to update
height (int) – the height of the area to update

Performs the actual binding of texture to the current content of the pixmap. Can be called to update the texture if the pixmap content has changed.

New in version 0.8.

Signal Details¶

ClutterX11.TexturePixmap.signals.queue_damage_redraw(texture_pixmap, x, y, width, height)¶

Signal Name:

queue-damage-redraw

Flags:

RUN_FIRST

Parameters:

texture_pixmap (ClutterX11.TexturePixmap) – The object which received the signal
x (int) – The top left x position of the damage region
y (int) – The top left y position of the damage region
width (int) – The width of the damage region
height (int) – The height of the damage region

::queue-damage-redraw is emitted to notify that some sub-region of the texture has been changed (either by an automatic damage update or by an explicit call to ClutterX11.TexturePixmap.update_area). This usually means a redraw needs to be queued for the actor.

The default handler will queue a clipped redraw in response to the damage, using the assumption that the pixmap is being painted to a rectangle covering the transformed allocation of the actor. If you sub-class and change the paint method so this isn’t true then you must also provide your own damage signal handler to queue a redraw that blocks this default behaviour.

New in version 1.2.

ClutterX11.TexturePixmap.signals.update_area(texture_pixmap, x, y, width, height)¶

Signal Name:

update-area

Flags:

RUN_FIRST

Parameters:

texture_pixmap (ClutterX11.TexturePixmap) – The object which received the signal
x (int) – X coordinate of the area to update
y (int) – Y coordinate of the area to update
width (int) – width of the area to update
height (int) – height of the area to update

The ::update-area signal is emitted to ask the texture to update its content from its source pixmap.

New in version 0.8.

Property Details¶

ClutterX11.TexturePixmap.props.automatic_updates¶

Name:: automatic-updates
Type:: bool
Default Value:: False
Flags:: READABLE, WRITABLE

If the texture should be kept in sync with any pixmap changes.

ClutterX11.TexturePixmap.props.destroyed¶

Name:: destroyed
Type:: bool
Default Value:: False
Flags:: READABLE

If window has been destroyed

ClutterX11.TexturePixmap.props.pixmap¶

Name:: pixmap
Type:: int
Default Value:: 0
Flags:: READABLE, WRITABLE

The X11 Pixmap to be bound

ClutterX11.TexturePixmap.props.pixmap_depth¶

Name:: pixmap-depth
Type:: int
Default Value:: 0
Flags:: READABLE

The depth (in number of bits) of the pixmap bound to this texture

ClutterX11.TexturePixmap.props.pixmap_height¶

Name:: pixmap-height
Type:: int
Default Value:: 0
Flags:: READABLE

The height of the pixmap bound to this texture

ClutterX11.TexturePixmap.props.pixmap_width¶

Name:: pixmap-width
Type:: int
Default Value:: 0
Flags:: READABLE

The width of the pixmap bound to this texture

ClutterX11.TexturePixmap.props.window¶

Name:: window
Type:: int
Default Value:: 0
Flags:: READABLE, WRITABLE

The X11 Window to be bound

ClutterX11.TexturePixmap.props.window_mapped¶

Name:: window-mapped
Type:: bool
Default Value:: False
Flags:: READABLE

If window is mapped

ClutterX11.TexturePixmap.props.window_override_redirect¶

Name:: window-override-redirect
Type:: bool
Default Value:: False
Flags:: READABLE

If this is an override-redirect window

ClutterX11.TexturePixmap.props.window_redirect_automatic¶

Name:: window-redirect-automatic
Type:: bool
Default Value:: True
Flags:: READABLE, WRITABLE

If composite window redirects are set to Automatic (or Manual if false)

ClutterX11.TexturePixmap.props.window_x¶

Name:: window-x
Type:: int
Default Value:: 0
Flags:: READABLE

X position of window on screen according to X11

ClutterX11.TexturePixmap.props.window_y¶

Name:: window-y
Type:: int
Default Value:: 0
Flags:: READABLE

Y position of window on screen according to X11