From 85a01bfd9b59c762dfdbd064083fa7be55cd1c80 Mon Sep 17 00:00:00 2001 From: Camilla Berglund Date: Mon, 17 Aug 2015 21:04:19 +0200 Subject: [PATCH] Document image data being non-premultiplied Fixes #426. --- docs/input.dox | 5 +++-- include/GLFW/glfw3.h | 6 +++--- 2 files changed, 6 insertions(+), 5 deletions(-) diff --git a/docs/input.dox b/docs/input.dox index 1d622da1..6633a54f 100644 --- a/docs/input.dox +++ b/docs/input.dox @@ -296,8 +296,9 @@ GLFWcursor* cursor = glfwCreateCursor(&image, 0, 0); If cursor creation fails, `NULL` will be returned, so it is necessary to check the return value. -The image data is 32-bit RGBA, i.e. eight bits per channel. The pixels are -arranged canonically as sequential rows, starting from the top-left corner. +The image data is 32-bit, little-endian, non-premultiplied RGBA, i.e. eight bits +per channel. The pixels are arranged canonically as sequential rows, starting +from the top-left corner. @subsubsection cursor_standard Standard cursor creation diff --git a/include/GLFW/glfw3.h b/include/GLFW/glfw3.h index 96222c63..ac963820 100644 --- a/include/GLFW/glfw3.h +++ b/include/GLFW/glfw3.h @@ -2601,9 +2601,9 @@ GLFWAPI void glfwSetCursorPos(GLFWwindow* window, double xpos, double ypos); * glfwSetCursor. The cursor can be destroyed with @ref glfwDestroyCursor. * Any remaining cursors are destroyed by @ref glfwTerminate. * - * The pixels are 32-bit little-endian RGBA, i.e. eight bits per channel. They - * are arranged canonically as packed sequential rows, starting from the - * top-left corner. + * The pixels are 32-bit, little-endian, non-premultiplied RGBA, i.e. eight + * bits per channel. They are arranged canonically as packed sequential rows, + * starting from the top-left corner. * * The cursor hotspot is specified in pixels, relative to the upper-left corner * of the cursor image. Like all other coordinate systems in GLFW, the X-axis