canvas/README.md

   1 # UNO-based Graphics Backend
   2
   3 UNO-based graphics backend, lesser impedance to modern graphics APIs
   4 than vcl.
   5
   6 ## The canvas Framework
   7
   8 The `canvas` framework is the successor of the system GUI and graphics
   9 backend VCL. Basic functionality is available, supplying just as much
  10 features as necessary to provide a VCL-equivalent feature set (except
  11 proper BiDi/CTL support).
  12
  13 The `canvas` framework consists of the following two modules, `canvas` and
  14 `cppcanvas`. Additionally, a new generic graphics tooling is used (but
  15 not exclusively by the canvas, Armin's drawinglayer module also make
  16 use of it), which resides in `basegfx`.
  17
  18 The UNO API used by the canvas is primarily under
  19 `css::rendering`, with `css::rendering::XCanvas`
  20 being the central interface.
  21
  22 ## The slideshow Engine
  23
  24 The `slideshow` engine has replaced the former Impress-embedded
  25 presentation framework with a fully independent UNO component, and it
  26 is based on the canvas. Some features used there are only available
  27 from `canvas`, like double-buffering, and hardware-accelerated
  28 alpha-blending (currently not on all platforms).
  29
  30 ## Cairo canvas
  31
  32 Cairo `canvas` is one of backends of canvas component. `canvas` is mostly
  33 used for slideshow rendering and also for emf+ rendering. we hoped it
  34 will even be used by drawing layer, but it didn't happen (yet?) for
  35 API look at `offapi/com/sun/star/rendering/`, the implementation is in
  36 `canvas` and `cppcanvas` modules.
  37
  38 Cairo `canvas` backend uses Cairo library for rendering. Main advantage
  39 is support of alpha transparency and in some cases accelerated
  40 rendering.
  41
  42 The backend itself is quite old and stable, not many changes in that
  43 area lately, mostly changes for emf+ rendering, communication with
  44 vcl and bugfixes
  45
  46 ## Future Works
  47
  48 Look at Cairo `canvas` and situation when it is used
  49 (mostly slideshow).
  50
  51 ## TODO
  52 There still might be more cases when we
  53 can save some roundtrips when exchanging data with vcl.