diff options
Diffstat (limited to 'doc/sphinx/toc/libweston/output.rst')
| -rw-r--r-- | doc/sphinx/toc/libweston/output.rst | 22 |
1 files changed, 18 insertions, 4 deletions
diff --git a/doc/sphinx/toc/libweston/output.rst b/doc/sphinx/toc/libweston/output.rst index a89132ae..6bd4bf96 100644 --- a/doc/sphinx/toc/libweston/output.rst +++ b/doc/sphinx/toc/libweston/output.rst @@ -1,5 +1,21 @@ -Output -====== +.. _libweston-output: + +Outputs +======= + +A :type:`weston_output` determines what part of the global compositor +coordinate space will be composited into an image and when. That image is +presented on the attached heads (weston_head). + +An output object is resposible for the framebuffer management, damage tracking, +display timings, and the repaint state machine. Video mode, output scale and +output transform are properties of an output. + +In display hardware, a weston_output represents a CRTC, but only if it has been +successfully enabled. The CRTC may be switched to another during an output's +lifetime. + +The lifetime of a weston_output is controlled by the libweston user. With at least a :type:`weston_head` attached, you can construct a :type:`weston_output` object which can be used by the compositor, by enabling @@ -9,8 +25,6 @@ already enabled. The reverse operation, :func:`weston_output_disable`, should be used when there's a need to reconfigure the output or it will be destroyed. -Output API ----------- .. doxygengroup:: output :content-only: |