Flags

Details

class Clutter.ActorFlags(value)

Bases: GObject.GFlags

Flags used to signal the state of an actor.

VISIBLE = 16

the actor has been shown by the application program

MAPPED = 2

the actor will be painted (is visible, and inside a toplevel, and all parents visible)

NO_LAYOUT = 32

the actor provides an explicit layout management policy for its children; this flag will prevent Clutter from automatic queueing of relayout and will defer all layouting to the actor itself

REALIZED = 4

the resources associated to the actor have been allocated

REACTIVE = 8

the actor ‘reacts’ to mouse events emmitting event signals

class Clutter.AllocationFlags(value)

Bases: GObject.GFlags

Flags passed to the Clutter.Actor.do_allocate() virtual function and to the Clutter.Actor.allocate() function.

New in version 1.0.

ALLOCATION_NONE = 0

No flag set

ABSOLUTE_ORIGIN_CHANGED = 2

Whether the absolute origin of the actor has changed; this implies that any ancestor of the actor has been moved.

DELEGATE_LAYOUT = 4

Whether the allocation should be delegated to the Clutter.LayoutManager instance stored inside the Clutter.Actor :layout-manager property of Clutter.Actor. This flag should only be used if you are subclassing Clutter.Actor and overriding the Clutter.Actor.do_allocate() virtual function, but you wish to use the default implementation of the virtual function inside Clutter.Actor. Added in Clutter 1.10.

class Clutter.ContentRepeat(value)

Bases: GObject.GFlags

Content repeat modes.

New in version 1.12.

NONE = 0

No repeat

X_AXIS = 1

Repeat the content on the X axis

Y_AXIS = 2

Repeat the content on the Y axis

BOTH = 3

Repeat the content on both axis

class Clutter.EffectPaintFlags(value)

Bases: GObject.GFlags

Flags passed to the ‘paint’ or ‘pick’ method of Clutter.Effect.

ACTOR_DIRTY = 1

The actor or one of its children has queued a redraw before this paint. This implies that the effect should call Clutter.Actor.continue_paint() to chain to the next effect and can not cache any results from a previous paint.

class Clutter.EventFlags(value)

Bases: GObject.GFlags

Flags for the Clutter.Event

New in version 0.6.

NONE = 0

No flag set

FLAG_SYNTHETIC = 1

Synthetic event

class Clutter.FeatureFlags(value)

Bases: GObject.GFlags

Runtime flags indicating specific features available via Clutter window system and graphics backend.

New in version 0.4.

OFFSCREEN = 1024

Set if the backend supports offscreen rendering.

STAGE_USER_RESIZE = 128

Set if stage is able to be user resized.

TEXTURE_YUV = 16

Set if YUV based textures supported.

STAGE_MULTIPLE = 2048

Set if multiple stages are supported.

STAGE_CURSOR = 256

Set if stage has a graphical cursor.

TEXTURE_READ_PIXELS = 32

Set if texture pixels can be read.

TEXTURE_NPOT = 4

Set if NPOTS textures supported.

SWAP_EVENTS = 4096

Set if the GLX_INTEL_swap_event is supported.

SHADERS_GLSL = 512

Set if the backend supports GLSL shaders.

STAGE_STATIC = 64

Set if stage size if fixed (i.e framebuffer)

SYNC_TO_VBLANK = 8

Set if vblank syncing supported.

class Clutter.FontFlags(value)

Bases: GObject.GFlags

Runtime flags to change the font quality. To be used with Clutter.set_font_flags().

New in version 1.0.

Deprecated since version 1.22: Use cairo.FontOptions instead

MIPMAPPING = 1

Set to use mipmaps for the glyph cache textures.

HINTING = 2

Set to enable hinting on the glyphs.

class Clutter.ModifierType(value)

Bases: GObject.GFlags

Masks applied to a Clutter.Event by modifiers.

Note that Clutter may add internal values to events which include reserved values such as Clutter.ModifierType.MODIFIER_RESERVED_13_MASK. Your code should preserve and ignore them. You can use Clutter.ModifierType.MODIFIER_MASK to remove all reserved values.

New in version 0.4.

SHIFT_MASK = 1

Mask applied by the Shift key

BUTTON3_MASK = 1024

Mask applied by the third pointer button

MODIFIER_RESERVED_20_MASK = 1048576
RELEASE_MASK = 1073741824

Mask applied during release

MOD5_MASK = 128

Mask applied by the fifth Mod key

MODIFIER_RESERVED_17_MASK = 131072
HYPER_MASK = 134217728

Mask applied by the Hyper key

MODIFIER_MASK = 1543512063

A mask covering all modifier types

MOD2_MASK = 16

Mask applied by the second Mod key

MODIFIER_RESERVED_14_MASK = 16384
MODIFIER_RESERVED_24_MASK = 16777216
LOCK_MASK = 2

Mask applied by the Caps Lock key

BUTTON4_MASK = 2048

Mask applied by the fourth pointer button

MODIFIER_RESERVED_21_MASK = 2097152
BUTTON1_MASK = 256

Mask applied by the first pointer button

MODIFIER_RESERVED_18_MASK = 262144
META_MASK = 268435456

Mask applied by the Meta key

MOD3_MASK = 32

Mask applied by the third Mod key

MODIFIER_RESERVED_15_MASK = 32768
MODIFIER_RESERVED_25_MASK = 33554432
CONTROL_MASK = 4

Mask applied by the Control key

BUTTON5_MASK = 4096

Mask applied by the fifth pointer button

MODIFIER_RESERVED_22_MASK = 4194304
BUTTON2_MASK = 512

Mask applied by the second pointer button

MODIFIER_RESERVED_19_MASK = 524288
MODIFIER_RESERVED_29_MASK = 536870912
MOD4_MASK = 64

Mask applied by the fourth Mod key

MODIFIER_RESERVED_16_MASK = 65536
SUPER_MASK = 67108864

Mask applied by the Super key

MOD1_MASK = 8

Mask applied by the first Mod key

MODIFIER_RESERVED_13_MASK = 8192
MODIFIER_RESERVED_23_MASK = 8388608
class Clutter.OffscreenRedirect(value)

Bases: GObject.GFlags

Possible flags to pass to Clutter.Actor.set_offscreen_redirect().

New in version 1.8.

AUTOMATIC_FOR_OPACITY = 1

Only redirect the actor if it is semi-transparent and its has_overlaps() virtual returns True. This is the default.

ALWAYS = 2

Always redirect the actor to an offscreen buffer even if it is fully opaque.

class Clutter.RepaintFlags(value)

Bases: GObject.GFlags

Flags to pass to Clutter.threads_add_repaint_func_full().

New in version 1.10.

PRE_PAINT = 1

Run the repaint function prior to painting the stages

POST_PAINT = 2

Run the repaint function after painting the stages

QUEUE_REDRAW_ON_ADD = 4

Ensure that a new frame is queued after adding the repaint function

class Clutter.ScrollFinishFlags(value)

Bases: GObject.GFlags

Flags used to notify the axes that were stopped in a Clutter.ScrollEvent. These can be used to trigger post-scroll effects like kinetic scrolling.

New in version 1.26.

NONE = 0

no axis was stopped.

HORIZONTAL = 1

The horizontal axis stopped.

VERTICAL = 2

The vertical axis stopped.

class Clutter.ScrollMode(value)

Bases: GObject.GFlags

Scroll modes.

New in version 1.12.

NONE = 0

Ignore scrolling

HORIZONTALLY = 1

Scroll only horizontally

VERTICALLY = 2

Scroll only vertically

BOTH = 3

Scroll in both directions

class Clutter.StageState(value)

Bases: GObject.GFlags

Stage state masks, used by the Clutter.Event of type Clutter.EventType.STAGE_STATE.

New in version 0.4.

FULLSCREEN = 2

Fullscreen mask

OFFSCREEN = 4

Offscreen mask (deprecated)

ACTIVATED = 8

Activated mask

class Clutter.SwipeDirection(value)

Bases: GObject.GFlags

The main direction of the swipe gesture

New in version 1.8.

UP = 1

Upwards swipe gesture

DOWN = 2

Downwards swipe gesture

LEFT = 4

Leftwards swipe gesture

RIGHT = 8

Rightwards swipe gesture

class Clutter.TextureFlags(value)

Bases: GObject.GFlags

Flags for Clutter.Texture.set_from_rgb_data() and Clutter.Texture.set_from_yuv_data().

New in version 0.4.

Deprecated since version 1.22: The Clutter.Texture class was the only user of this API

NONE = 0

No flags

RGB_FLAG_BGR = 2

Unused flag

RGB_FLAG_PREMULT = 4

Unused flag

YUV_FLAG_YUV2 = 8

Unused flag