Version
menu_open
Wwise SDK 2024.1.0
AkFPUtilities.h
Go to the documentation of this file.
1 /*******************************************************************************
2 The content of this file includes portions of the AUDIOKINETIC Wwise Technology
3 released in source code form as part of the SDK installer package.
4 
5 Commercial License Usage
6 
7 Licensees holding valid commercial licenses to the AUDIOKINETIC Wwise Technology
8 may use this file in accordance with the end user license agreement provided
9 with the software or, alternatively, in accordance with the terms contained in a
10 written agreement between you and Audiokinetic Inc.
11 
12 Apache License Usage
13 
14 Alternatively, this file may be used under the Apache License, Version 2.0 (the
15 "Apache License"); you may not use this file except in compliance with the
16 Apache License. You may obtain a copy of the Apache License at
17 http://www.apache.org/licenses/LICENSE-2.0.
18 
19 Unless required by applicable law or agreed to in writing, software distributed
20 under the Apache License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES
21 OR CONDITIONS OF ANY KIND, either express or implied. See the Apache License for
22 the specific language governing permissions and limitations under the License.
23 
24  Copyright (c) 2024 Audiokinetic Inc.
25 *******************************************************************************/
26 
27 /// \file
28 /// Floating point performance utilities.
29 
30 #ifndef _AK_FP_UTILS_H_
31 #define _AK_FP_UTILS_H_
32 
33 #include <AK/SoundEngine/Common/AkTypes.h>
34 
35 #define AK_FSEL( __a__, __b__, __c__) (((__a__) >= 0) ? (__b__) : (__c__))
36 
37 /// Branchless (where available) version returning minimum value between two AkReal32 values
38 static AkForceInline AkReal32 AK_FPMin( AkReal32 fA, AkReal32 fB )
39 {
40  return (fA < fB ? fA : fB);
41 }
42 
43 /// Branchless (where available) version returning maximum value between two AkReal32 values
44 static AkForceInline AkReal32 AK_FPMax( AkReal32 fA, AkReal32 fB )
45 {
46  return (fA > fB ? fA : fB);
47 }
48 
49 /// Branchless comparison (where available) setting 3rd argument to 4th argument if 1st argument is greater than 2nd argument.
50 static AkForceInline void AK_FPSetValGT( AkReal32 in_fComparandA, AkReal32 in_fComparandB, AkReal32 & io_fVariableToSet, AkReal32 in_fValueIfTrue )
51 {
52  if ( in_fComparandA > in_fComparandB )
53  io_fVariableToSet = in_fValueIfTrue;
54 }
55 
56 /// Branchless comparison (where available) setting 3rd argument to 4th argument if 1st argument is greater than equal 2nd argument.
57 static AkForceInline void AK_FPSetValGTE( AkReal32 in_fComparandA, AkReal32 in_fComparandB, AkReal32 & io_fVariableToSet, AkReal32 in_fValueIfTrue )
58 {
59  if ( in_fComparandA >= in_fComparandB )
60  io_fVariableToSet = in_fValueIfTrue;
61 }
62 
63 /// Branchless comparison (where available) setting 3rd argument to 4th argument if 1st argument is less than 2nd argument.
64 static AkForceInline void AK_FPSetValLT( AkReal32 in_fComparandA, AkReal32 in_fComparandB, AkReal32 & io_fVariableToSet, AkReal32 in_fValueIfTrue )
65 {
66  if ( in_fComparandA < in_fComparandB )
67  io_fVariableToSet = in_fValueIfTrue;
68 }
69 
70 /// Branchless comparison (where available) setting 3rd argument to 4th argument if 1st argument is less than equal 2nd argument.
71 static AkForceInline void AK_FPSetValLTE( AkReal32 in_fComparandA, AkReal32 in_fComparandB, AkReal32 & io_fVariableToSet, AkReal32 in_fValueIfTrue )
72 {
73  if ( in_fComparandA <= in_fComparandB )
74  io_fVariableToSet = in_fValueIfTrue;
75 }
76 
77 #endif //_AK_FP_UTILS_H_
78 
AK_FPSetValLTE
static AkForceInline void AK_FPSetValLTE(AkReal32 in_fComparandA, AkReal32 in_fComparandB, AkReal32 &io_fVariableToSet, AkReal32 in_fValueIfTrue)
Branchless comparison (where available) setting 3rd argument to 4th argument if 1st argument is less ...
Definition: AkFPUtilities.h:71
AkReal32
float AkReal32
32-bit floating point
Definition: AkNumeralTypes.h:46
AK_FPSetValGTE
static AkForceInline void AK_FPSetValGTE(AkReal32 in_fComparandA, AkReal32 in_fComparandB, AkReal32 &io_fVariableToSet, AkReal32 in_fValueIfTrue)
Branchless comparison (where available) setting 3rd argument to 4th argument if 1st argument is great...
Definition: AkFPUtilities.h:57
AK_FPMax
static AkForceInline AkReal32 AK_FPMax(AkReal32 fA, AkReal32 fB)
Branchless (where available) version returning maximum value between two AkReal32 values.
Definition: AkFPUtilities.h:44
AK_FPSetValGT
static AkForceInline void AK_FPSetValGT(AkReal32 in_fComparandA, AkReal32 in_fComparandB, AkReal32 &io_fVariableToSet, AkReal32 in_fValueIfTrue)
Branchless comparison (where available) setting 3rd argument to 4th argument if 1st argument is great...
Definition: AkFPUtilities.h:50
AK_FPMin
static AkForceInline AkReal32 AK_FPMin(AkReal32 fA, AkReal32 fB)
Branchless (where available) version returning minimum value between two AkReal32 values.
Definition: AkFPUtilities.h:38
AkForceInline
#define AkForceInline
Definition: AkTypes.h:63
AK_FPSetValLT
static AkForceInline void AK_FPSetValLT(AkReal32 in_fComparandA, AkReal32 in_fComparandB, AkReal32 &io_fVariableToSet, AkReal32 in_fValueIfTrue)
Branchless comparison (where available) setting 3rd argument to 4th argument if 1st argument is less ...
Definition: AkFPUtilities.h:64

Was this page helpful?

Need Support?

Questions? Problems? Need more info? Contact us, and we can help!

Visit our Support page

Tell us about your project. We're here to help.

Register your project and we'll help you get started with no strings attached!

Get started with Wwise