'\" t
.\"     Title: mul24
.\"    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 "MUL24" "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"
mul24 \- Fast integer function to multiply 24\-bit integer values\&.
.SH ""
.HP \w'gentype\ mul24('u
.BI "gentype mul24(gentype\ " "x" ", gentype\ " "y" ");"
.SH "DESCRIPTION"
.PP
\fBmul24\fR
multiplies two 24\-bit integer values
\fIx\fR
and
\fIy\fR\&.
\fIx\fR
and
\fIy\fR
are 32\-bit integers but only the low 24\-bits are used to perform the multiplication\&.
\fBmul24\fR
should only be used when values in
\fIx\fR
and
\fIy\fR
are in the range [\-223, 223\-1] if
\fIx\fR
and
\fIy\fR
are signed integers and in the range [0, 224\-1] if
\fIx\fR
and
\fIy\fR
are unsigned integers\&. If
\fIx\fR
and
\fIy\fR
are not in this range, the multiplication result is implementation\-defined\&.
.SH "NOTES"
.PP
Fast integer functions can be used for optimizing performance of kernels\&. We use the generic type name
\fBgentype\fR
to indicate that the function can take
\fBint\fR,
\fBint2\fR,
\fBint3\fR,
\fBint4\fR,
\fBint8\fR,
\fBint16\fR,
\fBuint\fR,
\fBuint2\fR,
\fBuint3\fR,
\fBuint4\fR,
\fBuint8\fR, or
\fBuint16\fR
as the type for the arguments\&.
.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