• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
1.. _libweston-output:
2
3Outputs
4=======
5
6A :type:`weston_output` determines what part of the global compositor
7coordinate space will be composited into an image and when. That image is
8presented on the attached heads (weston_head).
9
10An output object is resposible for the framebuffer management, damage tracking,
11display timings, and the repaint state machine. Video mode, output scale and
12output transform are properties of an output.
13
14In display hardware, a weston_output represents a CRTC, but only if it has been
15successfully enabled. The CRTC may be switched to another during an output's
16lifetime.
17
18The lifetime of a weston_output is controlled by the libweston user.
19
20With at least a :type:`weston_head` attached, you can construct a
21:type:`weston_output` object which can be used by the compositor, by enabling
22the output using :func:`weston_output_enable`. The output **must not** be
23already enabled.
24
25The reverse operation, :func:`weston_output_disable`, should be used when there's
26a need to reconfigure the output or it will be destroyed.
27
28
29.. doxygengroup:: output
30   :content-only:
31