Deflect  0.11.1
A fast C++ library for streaming pixels and events
README.md
1 # Deflect
2 
3 Welcome to Deflect, a C++ library for streaming pixels to other Deflect-based
4 applications, for example
5 [Tide](https://github.com/BlueBrain/Tide).
6 Deflect offers a stable API marked with version 1.0 (for the client part).
7 
8 ## Features
9 
10 Deflect provides the following functionality:
11 
12 * Stream pixels to a remote Server from one or multiple sources
13 * Register for receiving events from the Server
14 * Compressed or uncompressed streaming
15 * Fast multi-threaded JPEG compression (using libjpeg-turbo)
16 
17 DeflectQt (optional) provides the following additional functionality:
18 
19 * Create QML applications which render offscreen and stream and receive events
20  via Deflect
21 
22 The following applications are provided which make use of the streaming API:
23 
24 * DesktopStreamer: A small utility that lets you stream your desktop.
25 * SimpleStreamer: A simple example to demonstrate streaming of an OpenGL
26  application.
27 * QmlStreamer (optional): An offscreen application to stream any given qml file.
28 
29 ## Building from source
30 
31 ~~~
32  git clone https://github.com/BlueBrain/Deflect.git
33  mkdir Deflect/build
34  cd Deflect/build
35  cmake ..
36  make
37 ~~~
38 
39 ## ChangeLog
40 
41 To keep track of the changes between releases check the @ref Changelog.
42 
43 ## About
44 
45 Deflect is a cross-platform library, designed to run on any modern operating
46 system, including all Unix variants. Deflect uses CMake to create a
47 platform-specific build environment. The following platforms and build
48 environments are tested:
49 
50 * Linux: Ubuntu 14.04 and RHEL 6 (Makefile, x64)
51 * Mac OS X: 10.7 - 10.10 (Makefile, x86_64)
52 
53 The [latest API documentation](http://bluebrain.github.io/Deflect-0.10/index.html)
54 can be found on [bluebrain.github.io](http://bluebrain.github.io).