'\" t
.\"     Title: sub_sat
.\"    Author: The Khronos Group
.\" Generator: DocBook XSL Stylesheets vsnapshot <http://docbook.sf.net/>
.\"      Date: 01/14/2021
.\"    Manual: OpenCL Manual
.\"    Source: The Khronos Group
.\"  Language: English
.\"
.TH "SUB_SAT" "3clc" "01/14/2021" "The Khronos Group" "OpenCL Manual"
.\" -----------------------------------------------------------------
.\" * Define some portability stuff
.\" -----------------------------------------------------------------
.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.\" http://bugs.debian.org/507673
.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html
.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.ie \n(.g .ds Aq \(aq
.el       .ds Aq '
.\" -----------------------------------------------------------------
.\" * set default formatting
.\" -----------------------------------------------------------------
.\" disable hyphenation
.nh
.\" disable justification (adjust text to left margin only)
.ad l
.\" -----------------------------------------------------------------
.\" * MAIN CONTENT STARTS HERE *
.\" -----------------------------------------------------------------
.SH "NAME"
sub_sat \- Returns x \- y and saturates the result\&.
.SH ""
.HP \w'gentype\ sub_sat('u
.BI "gentype sub_sat(gentype\ " "x" ", gentype\ " "y" ");"
.SH "DESCRIPTION"
.PP
\fBsub_sat\fR
returns
\fIx\fR
\-
\fIy\fR
and saturates the result\&.
.SH "NOTES"
.PP
Built\-in integer functions take scalar or vector arguments\&. The vector versions of the integer functions operate component\-wise\&. The description is per component\&.
.PP
We use the generic type name
\fBgentype\fR
to indicate that the function can take
\fBchar\fR,
\fBchar{2|3|4|8|16}\fR,
\fBuchar\fR,
\fBuchar{2|3|4|8|16}\fR,
\fBshort\fR,
\fBshort{2|3|4|8|16}\fR,
\fBushort\fR,
\fBushort{2|3|4|8|16}\fR,
\fBint\fR,
\fBint{2|3|4|8|16}\fR,
\fBuint\fR,
\fBuint{2|3|4|8|16}\fR,
\fBlong\fR,
\fBlong{2|3|4|8|16}\fR,
\fBulong\fR, or
\fBulong{2|3|4|8|16}\fR
as the type for the arguments\&. We use the generic type name
\fBugentype\fR
to refer to unsigned versions of
\fBgentype\fR\&. For example, if
\fBgentype\fR
is
\fBchar4\fR,
\fBugentype\fR
is
\fBuchar4\fR\&.
.PP
We also use the generic type name
\fBsgentype\fR
to indicate that the function can take a scalar data type i\&.e\&.
\fBchar\fR,
\fBuchar\fR,
\fBshort\fR,
\fBushort\fR,
\fBint\fR,
\fBuint\fR,
\fBlong\fR, or
\fBulong\fR
as the type for the arguments\&. For built\-in integer functions that take
\fBgentype\fR
and
\fBsgentype\fR
arguments, the
\fBgentype\fR
argument must be a vector or scalar version of the
\fBsgentype\fR
argument\&. For example, if
\fBsgentype\fR
is
\fBuchar\fR,
\fBgentype\fR
must be
\fBuchar\fR
or
\fBuchar{2|3|4|8|16}\fR\&. For vector versions,
\fBsgentype\fR
is implicitly widened to
\fBgentype\fR
as described in section 6\&.3\&.a of the OpenCL specification\&.
.PP
For any specific use of a function, the actual type has to be the same for all arguments and the return type unless otherwise specified\&.
.SH "SPECIFICATION"
.PP
\m[blue]\fBOpenCL Specification\fR\m[]\&\s-2\u[1]\d\s+2
.SH "SEE ALSO"
.PP
\fBintegerFunctions\fR(3clc)
.SH "AUTHORS"
.PP
\fBThe Khronos Group\fR
.SH "COPYRIGHT"
.br
Copyright \(co 2007-2011 The Khronos Group Inc.
.br
Permission is hereby granted, free of charge, to any person obtaining a copy of this software and/or associated documentation files (the "Materials"), to deal in the Materials without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Materials, and to permit persons to whom the Materials are furnished to do so, subject to the condition that this copyright notice and permission notice shall be included in all copies or substantial portions of the Materials.
.sp
.SH "NOTES"
.IP " 1." 4
OpenCL Specification
.RS 4
\%page 256, section 6.12.3 - Integer Functions
.RE