File: api.md

package info (click to toggle)
intel-gpu-tools 2.3-1
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid
  • size: 64,504 kB
  • sloc: xml: 781,458; ansic: 378,272; python: 8,407; yacc: 2,781; perl: 1,196; sh: 1,177; lex: 487; asm: 227; lisp: 35; makefile: 30
file content (29 lines) | stat: -rw-r--r-- 997 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
# IGT GPU Tools API

**IGT GPU Tools** provides a set of C libraries and helper macros for writing and
running test cases targeting the Linux graphics stack.

Generated documentation is available at:
[API Reference](https://drm.pages.freedesktop.org/igt-gpu-tools/api_reference/index.html)

## Purpose

The API is designed to:

 - Simplify interaction with kernel graphics drivers (e.g., via DRM ioctls)
 - Provide reusable infrastructure for writing test cases
 - Offer abstractions for managing displays, buffers, events, and execution contexts

## Key Components

 - `igt_assert`, `igt_skip`, `igt_require`: Macros for managing test flow
 - `igt_fixture`, `igt_subtest`: Infrastructure for setup/teardown and subtest isolation

Helper modules for:
  - Buffer objects (e.g., `intel_buf`)
  - Display configuration (e.g., `kmstest`, `igt_display`)
  - Memory mapping, fences, command streams, and performance counters

##  Examples

For code examples, browse the `tests/` and `lib/` directories.