note "shift" in vips_cast_*() docs

Stars1233 · Feb 18, 2025 · 7228c33 · 7228c33
1 parent ee7f877
commit 7228c33
Showing 1 changed file with 24 additions and 0 deletions.
diff --git a/libvips/conversion/cast.c b/libvips/conversion/cast.c
@@ -603,6 +603,10 @@ vips_cast(VipsImage *in, VipsImage **out, VipsBandFormat format, ...)
  * @out: (out): output image
  * @...: %NULL-terminated list of optional named arguments
  *
+ * Optional arguments:
+ *
+ * * @shift: %gboolean, integer values are shifted
+ *
  * Convert @in to #VIPS_FORMAT_UCHAR. See vips_cast().
  *
  * Returns: 0 on success, -1 on error
@@ -626,6 +630,10 @@ vips_cast_uchar(VipsImage *in, VipsImage **out, ...)
  * @out: (out): output image
  * @...: %NULL-terminated list of optional named arguments
  *
+ * Optional arguments:
+ *
+ * * @shift: %gboolean, integer values are shifted
+ *
  * Convert @in to #VIPS_FORMAT_CHAR. See vips_cast().
  *
  * Returns: 0 on success, -1 on error
@@ -649,6 +657,10 @@ vips_cast_char(VipsImage *in, VipsImage **out, ...)
  * @out: (out): output image
  * @...: %NULL-terminated list of optional named arguments
  *
+ * Optional arguments:
+ *
+ * * @shift: %gboolean, integer values are shifted
+ *
  * Convert @in to #VIPS_FORMAT_USHORT. See vips_cast().
  *
  * Returns: 0 on success, -1 on error
@@ -672,6 +684,10 @@ vips_cast_ushort(VipsImage *in, VipsImage **out, ...)
  * @out: (out): output image
  * @...: %NULL-terminated list of optional named arguments
  *
+ * Optional arguments:
+ *
+ * * @shift: %gboolean, integer values are shifted
+ *
  * Convert @in to #VIPS_FORMAT_SHORT. See vips_cast().
  *
  * Returns: 0 on success, -1 on error
@@ -695,6 +711,10 @@ vips_cast_short(VipsImage *in, VipsImage **out, ...)
  * @out: (out): output image
  * @...: %NULL-terminated list of optional named arguments
  *
+ * Optional arguments:
+ *
+ * * @shift: %gboolean, integer values are shifted
+ *
  * Convert @in to #VIPS_FORMAT_UINT. See vips_cast().
  *
  * Returns: 0 on success, -1 on error
@@ -718,6 +738,10 @@ vips_cast_uint(VipsImage *in, VipsImage **out, ...)
  * @out: (out): output image
  * @...: %NULL-terminated list of optional named arguments
  *
+ * Optional arguments:
+ *
+ * * @shift: %gboolean, integer values are shifted
+ *
  * Convert @in to #VIPS_FORMAT_INT. See vips_cast().
  *
  * Returns: 0 on success, -1 on error