updated readme-configuration files
[libgliar] / README
1 # libgliar - a library that can fake the OpenGL context info returned by
2 # the glGet OpenGL calls
3 #
4 # Copyright (C) 2013 Canonical Ltd
5 #
6 # This program is free software: you can redistribute it and/or modify
7 # it under the terms of the GNU General Public License as published by
8 # the Free Software Foundation, either version 3 of the License, or
9 # (at your option) any later version.
10
11 # This program is distributed in the hope that it will be useful,
12 # but WITHOUT ANY WARRANTY; without even the implied warranty of
13 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
14 # GNU General Public License for more details.
15
16 # You should have received a copy of the GNU General Public License
17 # along with this program.  If not, see <http://www.gnu.org/licenses/>.
18
19 # Author: Eleni Maria Stea <elene.mst@gmail.com>
20
21 For instructions on how to build the code, see the INSTALL file.
22
23 Usage:
24 ------
25 gliar <opengl_executable>
26
27 The library will read the gliar.conf file in the user's library directory or
28 the .gliar.conf file in the user's home directory.
29
30 Example gliar.conf:
31 -------------------
32 [key1]
33 value1
34 value2
35 .
36 .
37 .
38 valueN
39
40 [key2]
41 value1
42 .
43 .
44 .
45 valueN
46
47 [keyN]
48 value1
49 .
50 .
51 .
52 valueN
53
54 Currently supported keys:
55 vendor
56 renderer
57 version
58 sl version
59 extensions
60 major version
61 minor version
62 max texture units
63 max texture image units
64 max combined texture image units
65 max vertex texture image units
66 max texture size
67 max cube map texture size
68 max texture coordinates
69 max vertex attributes
70 max vertex uniform vectors
71 max fragment uniform vectors
72 max varying vectors
73 max color attachments
74 max renderbuffer size ext
75 max program attribs arb
76 v max program instructions arb
77 v max program native instructions arb
78 v max program temporaries arb
79 v max program native temporaries arb
80 v max program parameters arb
81 v max program native parameters arb
82 v max program attribs arb
83 v max program native attribs arb
84 v max program address registers arb
85 v max program native address registers arb
86 v max program local parameters arb
87 v max program env parameters arb
88 v max program alu instructions arb
89 v max program native alu instructions arb
90 f max program instructions arb
91 f max program native instructions arb
92 f max program temporaries arb
93 f max program native temporaries arb
94 f max program parameters arb
95 f max program native parameters arb
96 f max program attribs arb
97 f max program native attribs arb
98 f max program address registers arb
99 f max program native address registers arb
100 f max program local parameters arb
101 f max program env parameters arb
102 f max program alu instructions arb
103 f max program native alu instructions arb
104 max program instructions arb
105 max program native instructions arb
106 max program temporaries arb
107 max program native temporaries arb
108 max program parameters arb
109 max program native parameters arb
110 max program attribs arb
111 max program native attribs arb
112 max program address registers arb
113 max program native address registers arb
114 max program local parameters arb
115 max program env parameters arb
116 max program alu instructions arb
117 max program native alu instructions arb
118
119 Example configuration files can be found in the directory examples.
120 Example video: http://www.youtube.com/watch?v=v2UDGgb6AgA
121
122 Note: The library can only restrict the capabilities of a GPU, not "emulate" non supported extensions for 
123 example. If the gliar.conf contains an extension that is not supported by the user's real GPU, the library 
124 will return a warning and the user's program might crash.