3820630b0bc9f5dfc482875293ee554acfea47ab
[apitrace-tests] / apps / README.markdown
1 These directories contain many drawing-api-specific test applications.
2
3 Within each directory's CMakeLists.txt file are you will see
4 definitions of tests such as the following:
5
6     add_app_test (
7         NAME "gl_default_sb"
8         TARGET gl_tri
9         ARGS -sb
10         REF default_sb.ref.txt
11     )
12
13 This block specifies a test with NAME "gl_default_sb" that involves
14 executing the TARGET program "gl_tri" with ARGS of "-sb". The REF
15 script contains a reference trance that should result from tracing the
16 given program, along with specifications for additional checks to be
17 peformed.
18
19 The actual execution of the test (and parsing of the REF script) is
20 performed by the python program in ../app_driver.py. This driver
21 program runs the application with the given arguments, performs a
22 trace of the application, checks the trace against the reference
23 script, and then run a "retrace" of the application (replaying the
24 commands in the trace).
25
26 In addition to a dump of the expected trace content, the reference
27 file can contain directives to cause the driver program to perform
28 additional checking. Some of the available directives are:
29
30   #image: Dump the current framebuffer image and compare against the
31           given file.
32
33   #state: Dump the current state in JSON format and compare against
34           the given file.