Compiz

From openSUSE

Compiz brings to life a variety of visual effects that make the Linux desktop easier to use, more powerful and intuitive, and more accessible for users with special needs. Compiz combines together a window manager and a composite manager using OpenGL for rendering. A "window manager" allows the manipulation of the multiple applications and dialog windows that are presented on the screen. A "composite manager" allows windows and other graphics to be combined together to create composite images. Compiz achieves its stunning effects by doing both of these functions.

What is Compiz?

Upto and including openSUSE 10.2 compiz only works in combination with Xgl. But from 10.3, Xorg alone is enough. Please see that wiki page for general installation instructions. Begining with compiz version 0.3.7 in the Factory and 10.2-Xorg7.2 trees it will run also with AIGLX out-of-the-box, but it needs a newer Mesa library (at least version 6.5.2-15) due to the new libIndirectGL.so.

Compiz plugins as well as window-decorators work with both major desktops, Gnome and KDE.

The compiz community websites can now be found on go-compiz.org and the community forums here Forum. Some time ago the old community at www.compiz.net announced a fork of compiz - the Beryl Project; see Beryl. More details on the beryl forums.

Using compiz and its plugins

First, Install and compile "startup-notification-0.9" because it is the only way to have your compiz to auto start when you start your system. To run and install Compiz on openSUSE 10.2 and later see Compiz Fusion Installation
To get compiz up and running for the first time on SUSE Linux 10.1 see Using compiz as your window manager
The rest of this page describes the available plugins and their keyboard/mouse shortcuts.

Available plugins

Cube

This is possibly the most anticipated plugin of compiz. It gives you four desktop spaces on a virtual cube that you can turn.

• Cube is useless without the rotate plugin, which provides the users ability to rotate the cube.
• Cube itself has only a keyboard control for changing to the next (or previous) image on the top face of the cube. Refer to the settings in csm for more on how to set this up.
• Use svg or png images for the top and bottom of the cube and png for the background (skydome), for example 1024x1024 png image for the background, enable animate option in cube configuration and enjoy the view.

Some Compiz Options:

• color -

• draw_caps - Toggle the top and bottom of the cube. Uncheck to keep them transparent and see-through to the skydome.

• images -

• images_bottom - Add the location to images here that will be displayed on the bottom of the cube.

• images_top - Add the location to images here that will be displayed on the top of the cube.

• in - Check the "in" checkbox to make it look like you are inside the cube when rotating (instead of outside)

• next_slide - Change the svg wallpaper displayed on top of the cube to the next one in your svgs string (see below)

• prev_slide - Same as above but previous image.

• rotate_images - Toggles rotation of the images to the direction of the cube.

• scale_image -

• scale_image_bottom - Whether images on the bottom of the cube should be scaled or not.

• scale_image_top - Whether images on the top of the cube should be scaled or not.

• skydome - Check to have an image displayed behind the cube when rotating with mouse.

• skydome_animated - Check to make it look like you are moving (not the cube) when rotating with mouse.

• skydome_image - Insert path to the image you want to be displayed behind the cube (must have Skydome checkbox checked).

Decoration

This plugin is used to provide support for Window decorations.

• Despite the name, window decorations are not something fancy. They are the simply the practical interface accomodations for any window: minimize, maximize, close, the title bar, and so on.
• Hint: if you don't have a title bar or other such conveniences, something is wrong with your window decorations.

Gconf options:

decor_theme -

shadow_offset_x - X-offset for shadows (can be negative for opposite direction).

shadow_offset_y - Y-offset for shadows (can be negative for opposite direction).

shadow_opacity - Opacity level of shadows.

shadow_radius - Radius value for shadows.

shadow_color - Sets the color of the shadow (#000000 - #ffffff).

Fade

Gives specific windows and other GUI elements a fade-in/fade-out effect when they appear/disappear

• This is probably the most subtle compiz plugin currently available.

Gconf options:

• Fade Speed - Window fade speed (0.0-10.0)

• Fullscreen Visual Bell - Fullscreen fade effect on system beep.

• Urgent - Flashing Fade effect on urgent windows.

• Urgent Center - Center Percentage of Brightness for Urgent Flashing (0-100)

• Urgent Count - Number of Flashes for Urgent Flashing (0=forever) (0-15)

• Urgent Speed - Window Urgent Flash Speed (5-50)

• Urgent Swing - Max Swing Percentage for Urgent Flashing (0-100)

• Visual Bell - Fade effect on system beep

Gconf

Stores settings for compiz and its plugins inside the gconf registry.

• When compiz is started with gconf, any other plugin names that follow gconf get ignored because compiz loads plugins according to the gconf registry.
  • So, when you run compiz for the first time, use:

compiz --replace glib gconf

• • When you add compiz as part of gnome-session-properties, use only:

compiz --replace glib gconf cube rotate scale fade minimize zoom place move...

• To make changes, you must use gconf-editor. The keys are under '/apps/compiz/'.
• Some of the most useful keys:
  • '/apps/compiz/general/allscreens/options/active_plugins' = list key defining which plugins are currently loaded
  • '/apps/compiz/plugins/cube/screen0/options/color' = top and bottom faces bg color (#cccccc format)
  • '/apps/compiz/plugins/cube/screen0/options/svgs' = (list) defines paths to svgs files to be rendered on the top face of the cube
  • '/apps/compiz/plugins/fade/screen0/options/window_types' = (list) defining the window types using fade
  • '/apps/compiz/plugins/fade/screen0/options/fade_speed' = speed at which the fade is executed. The lower the value the slower the fade will be (0 to 5,00)

There are many more, happy digging.

Also run this command to activate Windows Decoration

gtk-window-decorator --replace &

• Use the top of the cube

First of all, make sure the snap-top option is enabled. in gconf-editor go to the key apps -> compiz -> plugins -> rotate -> screen0 -> options Enable the snap-top key

You can put one or more svg files/slides on top of the cube: go to the key apps -> compiz -> plugins -> cube -> screen0 -> options edit the "svgs" keys, and add the slides seperate

howto screenshots

Minimize

Renders windows from and to the Window list during minimizing and maximizing them.

Gconf settings:

speed - The speed of the minimize effect.

timestep -

Toolbar -

window_types - Select the windows you want the effect to apply to.

zoom_created_windows - Check to make the effect apply to created windows. Note: This takes priority over wobbly creation.

zoom_created_windows_from_center - Check to make windows zoom in and out from/to their center, not from/to the mouse pointer.

Move

Allows for windows to be moved from one cube faces to another.

Place

Places windows at the appropriate positions when mapped.

• How to use
  • Information needed

Resize

Allows you to resize a window.

• In addition to moving windows by grabbing the window's title bar, using the correct key allows you to grab a window anywhere to resize it. That means that a window with an off-screen titlebar is now easy to move back down to complete visibility.
• How to use
  • Alt + left-click, then drag moves window
  • Ctrl + Shift + left-click, then drag moves window, with snap to screen and window borders
  • Alt + middle-click resizes window

Rotate

Allows you to switch between Cube faces.

• Also has the ability to snap to the top face of the cube.
• How to use:
  • Ctrl + Alt + Left/Right Arrow switches between desktops
  • Ctrl + Shift + Alt + Left/Right Arrow switches between desktop, taking active window along
  • Ctrl + Alt + left-click rotates cube manually

Gconf options:

• acceleration - Set the acceleration of the cube-rotation. Can be set from 1 to 19.

• edge_flip - Enable edge of screen reactivity

• flip_move -

• flip_time - Time taken to flip

• initiate - Set key combination to rotate the cube with the mouse. You have to click on the desktop, it will not work by clicking in a window.

• invert_x & invert_y - Invert mouse-axis while rotating the cube.

• rotate_left & rotate_right - Set key combination to rotate the cube with keys.

• rotate_left_window & rotate_right_window - Defined keys keep the active window on top while rotating the cube.

• rotate_to_1 & rotate_to_1_window etc.. -

• sensitivity - Changes the mouse-sensitivity on cube-rotating. Can be set from 1 to 100.

• snap_bottom - Makes it possible to rotate to the bottom of the cube and have it stop in that position after releasing the mouse button. Can be used for slideshows of images listed under cube.

• snap_top - Makes it possible to rotate to the top of the cube and have it stop in that position after releasing the mouse button. Can be used for slideshows of images listed under cube.

• speed - Set the speed with which the cube rotates (1-49)

• terminate - Set key combination to terminate the function described in "initiate".

• timestep - not tested yet.

Scale

Provides an easy way to quickly identify, select and switch to a desired window.

• Moving the pointer to a screen corner activates it.
• User can then click any required window, causing all the other windows to return to their previous positions behind the one selected.
• Similar to the former Expose plugin.
• How to use:
  • By default you can activate it by moving the pointer to the top right screen corner. (F9 for SUSE Linux Enterprise Desktop 10)
  • Click a window to select it
  • Can be used in combination with the Taskswitcher (alt+tab)

Switcher

Changes Alt-Tab window switching into a film-strip style preview. Also, all the windows except the currently selected one become translucent.

• How to use:
  • Alt-Tab

Water

Makes it so that the mouse cursor causes ripples on the screen as though it were water.

• Hold Ctrl+Super key
• Rain effect causes random droplets to "fall" onto the screen surface. (Shift-F9)
  • when it's raining, switch Wiper Blades on with Shift-F8

Wobbly

Makes windows seem gelatinous when grabbed, moved or resized.

• Only move is enabled by default.
• Keyboard shortcuts.

Maximize and minimize windows to see it wobble and try out various friction and spring_k values and have fun. Checkout unofficial experimental wobbly plugin for extra wobble settings for menus and tooltips.

Zoom

Provides capability for user to zoom in and out of screen areas, as well as scroll screen while zoomed.

• This increases accessibility for the Linux desktop, providing a powerful tool to visually impaired users. Zoom keeps text and images very smooth when magnified.
• Designers and others who count pixels may enjoy this plugin, too.
• How to use:
  • Super-key + right-click zooms-in once
  • Super-key + wheel mouse up zooms in manually
  • Super-key + wheel mouse down zooms out manually (you must have zoomed in to zoom back out)

Opacity Control

• Opacity (Opaque/Transparent)
  • In recent version use shortcut: Alt + Mousewheel Up/down over an window to set opacity level.
  • Right click the title bar to set opacity of any window.

Default plugin keyboard shortcuts

There are many configuration options under Compiz->General->Screen0->Options.

• Switch windows = Alt + Tab
• Arrange and View All Windows = Moving the pointer to the top right screen corner turns on or off; clicking a window will zoom it to the front
• Switch desktops on cube = Ctrl + Alt + Left/Right Arrow
• Switch desktops on cube - with active window following = Ctrl + Shift + Alt + Left/Right Arrow
• Rotate cube manually = Ctrl + Alt + left-click and grab an empty desktopspace.
• Make window translucent/opaque = possible with the "transset" utility or Alt + wheel mouse
• Zoom-in once = Super-key right-click
• Zoom-in manually = Super-key + wheel mouse up
• Zoom-out manually = Super-key + wheel mouse down
• Move window = Alt + left-click
• Snap Move window (will stick to borders) = Ctrl + Shift + left-click
• Resize window = Alt + right-click
• Bring up the window below the top window = Alt + middle-click
• Slow-motion = Shift + F10
• Water = hold Ctrl+Super key
  • Rain = Shift-F9

"Super-key" means the Linux respectively Win**** key.
If you know of others, please add them here.

• Film effect - changing dekstop = Ctrl+Alt+Down Arrow (hold the Ctrl+Alt then for changing desktop + Left/Right arrow. You can also hold down the left mousebutton to move the "film") Can be used in combination with the "Switcher".

See Also

• Xgl
• Beryl
• Xwinwrap
• Using Xgl on openSUSE
• Using Xgl on older versions of SUSE Linux
• Xgl Troubleshooting
• Getting newest versions of Compiz
• Compiz-Fusion

External Links

• opensuse-xgl-settings