diff options
author | Thomas Wood <thomas.wood@intel.com> | 2015-11-02 15:48:52 +0000 |
---|---|---|
committer | Thomas Wood <thomas.wood@intel.com> | 2015-11-11 14:21:12 +0000 |
commit | 2e5a43d29613fcb9e780b9c804d86b578bc8d56b (patch) | |
tree | a21dd99dda5b161893926dacf7f64579862e6992 /lib | |
parent | 5570060d331c0942405503a4398864241c1c55ef (diff) |
lib: add documentation for igt_display_init/fini
Signed-off-by: Thomas Wood <thomas.wood@intel.com>
Diffstat (limited to 'lib')
-rw-r--r-- | lib/igt_kms.c | 16 |
1 files changed, 16 insertions, 0 deletions
diff --git a/lib/igt_kms.c b/lib/igt_kms.c index 51d735d2..878e1fbe 100644 --- a/lib/igt_kms.c +++ b/lib/igt_kms.c @@ -962,6 +962,15 @@ static int get_drm_plane_type(int drm_fd, uint32_t plane_id) return DRM_PLANE_TYPE_OVERLAY; } +/** + * igt_display_init: + * @display: a pointer to an #igt_display_t structure + * @drm_fd: a drm file descriptor + * + * Initialize @display and allocate the various resources required. Use + * #igt_display_fini to release the resources when they are no longer required. + * + */ void igt_display_init(igt_display_t *display, int drm_fd) { drmModeRes *resources; @@ -1160,6 +1169,13 @@ static void igt_output_fini(igt_output_t *output) free(output->name); } +/** + * igt_display_fini: + * @display: a pointer to an #igt_display_t structure + * + * Release any resources associated with @display. This does not free @display + * itself. + */ void igt_display_fini(igt_display_t *display) { int i; |