ADD_SAT(3clc)

💖 NAME 💖

okay bestie, gather round, because this one is short and iconic 🎀

add_sat — add two values and saturate the result. that's it. that's the whole job. no cap.

gentype add_sat(gentype x, gentype y);

---

✨ DESCRIPTION ✨

so add_sat returns x+y and saturates the result. she adds, she clamps, she serves 💅 that's the whole function, main character energy fr fr.

---

📝 NOTES 📝

okay this is the part where we get into the type lore, stay with me 🦋

• 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, every lane does its own little thing, no drama between them ✨
• We use the generic type name gentype to indicate that the function can take 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} as the type for the arguments. and we use the generic type name ugentype to refer to unsigned versions of gentype. for example, if gentype is char4, ugentype is uchar4. iykyk 🧚
• 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, gentype must be uchar or uchar{2|3|4|8|16}. For vector versions, sgentype is implicitly widened to gentype as described in section 6.3.a of the OpenCL specification. she grows 🦋✨
• 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. no mixing, bestie, she's monogamous 💀

---

📜 SPECIFICATION 📜

OpenCL Specification[1] — yeah she's official, she's certified 👑

---

👀 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.

bestie this is the legal bit, don't skip it, it's giving "read the terms" but make it cute 🎀

---

🔖 NOTES 🔖

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

---

and that's the whole page, babe 🌈 this was brought to you by The Khronos Group, dated 01/14/2021, and it lives at ADD_SAT(3clc) in the OpenCL Manual. go saturate something, responsibly 💖✨👑