MAD_SAT(3clc)

💖 MAD_SAT — the OpenCL manual page, but make it make sense 💖

okay bestie, gather round, because we're doing mad_sat from the OpenCL Manual (that's the 3clc corner of the world) and honestly? it's giving "tiny function, huge type lore." let's get into it ✨

---

🌸 NAME 🌸

mad_sat — does a multiply, adds a thing, and saturates the result. that's the whole vibe. 🫶

---

✨ SYNOPSIS ✨

gentype mad_sat(gentype a, gentype b, gentype c);

three args, all the same generic type, one very well-behaved little return value. no cap.

---

💅 DESCRIPTION 💅

so mad_sat computes a*b+c and then saturates the result. literally that's it. multiply, add, clamp the energy. iconic behavior, no notes. 🔥

---

🎀 NOTES 🎀

okay here's where it gets juicy, because the built-in integer functions are not playing around:

• Built-in integer functions take scalar or vector arguments. 🦋
• The vector versions of the integer functions operate component-wise. The description is per component. (so like, each lane does its own thing, independently, minding its own business 💜)

now, the type names. we use the generic type name gentype to say "the function can take any of these as the type for the arguments":

char, char{2|3|4|8|16}, uchar, uchar{2|3|4|8|16}, short, short{2|3|4|8|16}, ushort, ushort{2|3|4|8|16}, int, int{2|3|4|8|16}, uint, uint{2|3|4|8|16}, long, long{2|3|4|8|16}, ulong, or ulong{2|3|4|8|16}.

and we use the generic type name ugentype to refer to unsigned versions of gentype. for example: if gentype is char4, then ugentype is uchar4. easy math, bestie. 🌈

we also use the generic type name sgentype to indicate that the function can take a scalar data type, i.e. char, uchar, short, ushort, int, uint, long, or ulong as the type for the arguments.

for built-in integer functions that take gentype and sgentype arguments, the gentype argument must be a vector or scalar version of the sgentype argument. for example: if sgentype is uchar, then gentype must be uchar or uchar{2|3|4|8|16}. and for vector versions, sgentype is implicitly widened to gentype, exactly as described in section 6.3.a of the OpenCL specification. 📖

and 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. so no mix-and-matching, babe, that's the rule. 💀

---

👑 SPECIFICATION 👑

OpenCL Specification[1]

---

🧚 SEE ALSO 🧚

integerFunctions(3clc)

---

⭐ AUTHORS ⭐

The Khronos Group

---

💜 COPYRIGHT 💜

Copyright © 2007-2011 The Khronos Group Inc.

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 following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Materials.

---

🍓 NOTES (the footnote edition) 🍓

1. OpenCL Specification — page 256, section 6.12.3 - Integer Functions

---

okay and that's the whole page, we ate and left absolutely zero crumbs 💅✨

<cute sign-off>sending you off with love from The Khronos Group, dated 01/14/2021 — this was MAD_SAT(3clc), and yes the manual name is right there in the title, we don't hide the lore. bye bestie, go saturate something 🌸🫶</cute sign-off>