summaryrefslogtreecommitdiff
path: root/lib/igt_draw.c
diff options
context:
space:
mode:
authorThomas Wood <thomas.wood@intel.com>2015-05-14 16:00:25 +0100
committerThomas Wood <thomas.wood@intel.com>2015-05-14 17:00:40 +0100
commit6141aa2dad814ba8e1254c8e8213f1ba3ae6835a (patch)
tree201599dcd8d2c595f61c8defe434625fe1fc6b75 /lib/igt_draw.c
parent1f6f6c07bd5bed8540dd309c3f5eac9270955f72 (diff)
docs: various documentation fixes
Fix various typos, add missing parameter documentation, include the igt_draw section and update the list of ignored headers. Signed-off-by: Thomas Wood <thomas.wood@intel.com>
Diffstat (limited to 'lib/igt_draw.c')
-rw-r--r--lib/igt_draw.c12
1 files changed, 12 insertions, 0 deletions
diff --git a/lib/igt_draw.c b/lib/igt_draw.c
index 14e470f4..51dce4b6 100644
--- a/lib/igt_draw.c
+++ b/lib/igt_draw.c
@@ -68,6 +68,7 @@ struct rect {
/**
* igt_draw_get_method_name:
+ * @method: draw method
*
* Simple function to transform the enum into a string. Useful when naming
* subtests and printing debug messages.
@@ -533,6 +534,17 @@ void igt_draw_rect(int fd, drm_intel_bufmgr *bufmgr, drm_intel_context *context,
/**
* igt_draw_rect_fb:
+ * @fd: the DRM file descriptor
+ * @bufmgr: the libdrm bufmgr, only required for IGT_DRAW_BLT and
+ * IGT_DRAW_RENDER
+ * @context: the context, can be NULL if you don't want to think about it
+ * @fb: framebuffer
+ * @method: method you're going to use to write to the buffer
+ * @rect_x: horizontal position on the buffer where your rectangle starts
+ * @rect_y: vertical position on the buffer where your rectangle starts
+ * @rect_w: width of the rectangle
+ * @rect_h: height of the rectangle
+ * @color: color of the rectangle
*
* This is exactly the same as igt_draw_rect, but you can pass an igt_fb instead
* of manually providing its details. See igt_draw_rect.