diff options
| author | Daniel Vetter <daniel.vetter@ffwll.ch> | 2016-07-27 13:54:06 +0200 |
|---|---|---|
| committer | Daniel Vetter <daniel.vetter@ffwll.ch> | 2016-07-27 15:43:25 +0200 |
| commit | 45cbdbc178dc232534a9bd047864f95029f53d6e (patch) | |
| tree | 5cc3f63a8f4e6060e25c480da2548ea92d4852d5 /lib/igt_fb.h | |
| parent | 582ce4cd19c627606047b1a8fdd987c4dc07353c (diff) | |
lib: Update docs for igt_fb
- Again match names of paramaters
- structs need a typedef to work in gtk-doc
- gtk-doc doesn't know about unsigned, expects unsigned int instead
Cc: Paulo Zanoni <paulo.r.zanoni@intel.com
Signed-off-by: Daniel Vetter <daniel.vetter@ffwll.ch>
Diffstat (limited to 'lib/igt_fb.h')
| -rw-r--r-- | lib/igt_fb.h | 41 |
1 files changed, 34 insertions, 7 deletions
diff --git a/lib/igt_fb.h b/lib/igt_fb.h index ce2cc0f7..e1c4c1fa 100644 --- a/lib/igt_fb.h +++ b/lib/igt_fb.h @@ -43,8 +43,24 @@ typedef struct _cairo cairo_t; #include <i915_drm.h> -/* helpers to create nice-looking framebuffers */ -struct igt_fb { +/** + * igt_fb_t: + * @fb_id: KMS ID of the framebuffer + * @fd: DRM device fd this framebuffer is created on + * @gem_handle: GEM handler of the underlying backing storage + * @is_dumb: Whether this framebuffer was allocated using the dumb buffer API + * @drm_format: DRM FOURCC code + * @width: width in pixels + * @height: height in pixels + * @stride: line stride in bytes + * @tiling: tiling mode as a DRM framebuffer modifier + * @size: size in bytes of the underlying backing storage + * @cairo_surface: optionally attached cairo drawing surface + * @domain: current domain for cache flushing tracking on i915.ko + * + * Tracking structure for KMS framebuffer objects. + */ +typedef struct igt_fb { uint32_t fb_id; int fd; uint32_t gem_handle; @@ -52,13 +68,24 @@ struct igt_fb { uint32_t drm_format; int width; int height; - unsigned stride; + unsigned int stride; uint64_t tiling; - unsigned size; + unsigned int size; cairo_surface_t *cairo_surface; - unsigned domain; -}; + unsigned int domain; +} igt_fb_t; +/** + * igt_text_align: + * @align_left: align left + * @align_right: align right + * @align_bottom: align bottom + * @align_top: align top + * @align_vcenter: align vcenter + * @align_hcenter: align hcenter + * + * Alignment mode for text drawing using igt_cairo_printf_line(). + */ enum igt_text_align { align_left, align_bottom = align_left, @@ -99,7 +126,7 @@ int igt_dirty_fb(int fd, struct igt_fb *fb); int igt_create_bo_with_dimensions(int fd, int width, int height, uint32_t format, uint64_t modifier, unsigned stride, - unsigned *stride_out, unsigned *size_out, + unsigned *stride_ret, unsigned *size_ret, bool *is_dumb); /* cairo-based painting */ |