Component: Offset (DSP Operators): Difference between revisions
Created page with "{| style="width:50%" |- | width="20%" style="color:gray;" | Author | Matrix Ltd |- | width="20%" style="color:gray;" | Version | 1.1 |- | width="20%" style="color:gray..." |
No edit summary |
||
| Line 20: | Line 20: | ||
==Detailed description== | ==Detailed description== | ||
| Line 36: | Line 38: | ||
==Examples== | ==Examples== | ||
| Line 53: | Line 57: | ||
== | ==Macro reference== | ||
{| class="wikitable" style="width:60%; background-color:#FFFFFF;" | {| class="wikitable" style="width:60%; background-color:#FFFFFF;" | ||
Revision as of 14:10, 20 January 2023
| Author | Matrix Ltd |
| Version | 1.1 |
| Category | DSP Operators |
Offset component
Allows the values in a single buffer to be offset uniformly. Functions include: Add, Subtract
Component Source Code
Please click here for the component source code: FC_Comp_Source_DSP_Offset.fcfx
Detailed description
No detailed description exists yet for this component
Examples
No additional examples
Macro reference
|
Calculate |
| Performs the selected offset on a value from the input buffer and passes to the output buffer. | |
 - VOID
|
Return |
|
|
CalculateArray |
| Performs the selected offset on an entire buffer. | |
| - VOID
|
Return |
|
|
SetOffset |
| Sets the Offset to be used when calling the calculate function. | |
 - INT
|
Offset |
| - VOID
|
Return |
Property reference
|
Properties |
|
Connect To |
| DSP component with output buffer to collect our data from. | |
|
Buffer Size |
| Number of individual elements the buffer can store, default 1. | |
|
|
Buffer Type |
| Sets the buffer data type. | |
|
|
Direction |
| Sets the data direction flow of the component | |
|
Offset |
|
|
Offset Type |
| Defines the type of calculation performed on the input buffer to obtain the output value. A left shift is essentially an optimised multiply with the multiplier being the 2^scaler A right shift is essentially an optimised divide with the divider being the 2^scaler | |
|
Rollover |
| Allow the output buffer to rollover. For example 128 + 128 = 256 which would equate to 0 using an 8-bit buffer with rollover enabled. With rollover disabled the output would be set to 255 which is the max representable value. | |
|
Initial Offset |