Difference between revisions of "Component: Offset (DSP)"

From Flowcode Help
Jump to navigationJump to search
(XML import)
 
 
(5 intermediate revisions by the same user not shown)
Line 1: Line 1:
−
 
+
{| style="width:50%"
−
 
 
−
{| width="50%"
 
 
|-
 
|-
−
| width="20%" style="color: gray;" | Author
+
| width="20%" style="color:gray;" | Author
 
| Matrix Ltd
 
| Matrix Ltd
 
|-
 
|-
−
| width="20%" style="color: gray;" | Version
+
| width="20%" style="color:gray;" | Version
−
| 1.1 (Release)
+
| 1.1
 
|-
 
|-
−
| width="20%" style="color: gray;" | Category
+
| width="20%" style="color:gray;" | Category
 
| DSP
 
| DSP
 
|}
 
|}
  
  
 +
==Offset component==
 +
Allows the values in a single buffer to be offset uniformly. Functions include: Add, Subtract
  
−
==[[File:Component Icon 88a7dbc4_af92_4205_8943_abaa77504462.png|Image]] Offset component==
+
==Component Pack==
−
Allows the values in a single buffer to be offset uniformly.
 
−
Functions include: Add, Subtract
 
  
−
==Examples==
+
DSP
−
''<span style="color:red;">No additional examples</span>''
 
  
 +
==Detailed description==
  
−
==Downloadable macro reference==
 
  
−
===<span style="font-weight: normal;"><u><tt>Calculate</tt></u></span>===
 
−
Performs the selected offset on a value from the input buffer and passes to the output buffer.
 
  
−
'''Parameters'''
 
  
−
:''This macro has no parameters''
 
  
  
−
'''Return value'''
 
  
−
:''This call does not return a value''
 
  
  
−
===<span style="font-weight: normal;"><u><tt>CalculateArray</tt></u></span>===
 
−
Performs the selected offset on an entire buffer.
 
  
−
'''Parameters'''
 
  
−
:''This macro has no parameters''
+
''No detailed description exists yet for this component''
  
 +
==Examples==
  
−
'''Return value'''
 
  
−
:''This call does not return a value''
 
  
  
−
===<span style="font-weight: normal;"><u><tt>SetOffset</tt></u></span>===
 
−
Sets the Offset to be used when calling the calculate function.
 
  
−
'''Parameters'''
 
  
−
:[[Variable Types|INT]] ''Offset''
 
  
  
−
'''Return value'''
 
  
−
:''This call does not return a value''
 
  
  
  
−
==Simulation macro reference==
+
''<span style="color:red;">No additional examples</span>''
  
−
''This component does not contain any simulation macros''
 
  
 +
==Downloadable macro reference==
  
−
==Property reference==
+
{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
−
<span style="font-weight: normal;"><u>Connect To</u></span>
+
|-
 +
| width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]]
 +
| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''Calculate'''
 +
|-
 +
| colspan="2" | Performs the selected offset on a value from the input buffer and passes to the output buffer.&nbsp;
 +
|-
 +
|-
 +
| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-void-icon.png]] - VOID
 +
| width="90%" style="border-top: 2px solid #000;" | ''Return''
 +
|}
  
−
This property is of type ''Panel object'' and can be referenced with the variable name ''ConnectTo''.
 
  
−
DSP component with output buffer to collect our data from.
+
{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
 +
|-
 +
| width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]]
 +
| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''CalculateArray'''
 +
|-
 +
| colspan="2" | Performs the selected offset on an entire buffer.&nbsp;
 +
|-
 +
|-
 +
| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-void-icon.png]] - VOID
 +
| width="90%" style="border-top: 2px solid #000;" | ''Return''
 +
|}
  
−
<span style="font-weight: normal;"><u>Buffer Size</u></span>
 
  
−
This property is of type ''Unsigned integer'' and can be referenced with the variable name ''BuffSize''.
+
{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
 +
|-
 +
| width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]]
 +
| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''SetOffset'''
 +
|-
 +
| colspan="2" | Sets the Offset to be used when calling the calculate function.&nbsp;
 +
|-
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-s16-icon.png]] - INT
 +
| width="90%" | Offset
 +
|-
 +
| colspan="2" | &nbsp;
 +
|-
 +
| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-void-icon.png]] - VOID
 +
| width="90%" style="border-top: 2px solid #000;" | ''Return''
 +
|}
  
−
Number of individual elements the buffer can store, default 1.
 
  
−
<span style="font-weight: normal;"><u>Buffer Type</u></span>
 
  
−
This property is of type ''Fixed list of ints'' and can be referenced with the variable name ''BuffType''.
 
  
−
Sets the buffer data type.
+
==Property reference==
  
−
<span style="font-weight: normal;"><u>Offset Type</u></span>
+
{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
−
 
+
|-
−
This property is of type ''Fixed list of ints'' and can be referenced with the variable name ''OffsetType''.
+
| width="10%" align="center" style="background-color:#D8C9D8;" | [[File:Fc9-prop-icon.png]]
−
 
+
| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''Properties'''  
−
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
+
| width="10%" align="center" | [[File:Fc9-type-16-icon.png]]
−
 
+
| width="90%" | Connect To
−
A right shift is essentially an optimised divide with the divider being the 2^scaler
+
|-
−
 
+
| colspan="2" | DSP component with output buffer to collect our data from.&nbsp;
−
<span style="font-weight: normal;"><u>Rollover</u></span>
+
|-
−
 
+
| width="10%" align="center" | [[File:Fc9-type-21-icon.png]]
−
This property is of type ''True or false'' and can be referenced with the variable name ''Rollover''.
+
| width="90%" | Buffer Size
−
 
+
|-
−
Allow the output buffer to rollover.
+
| colspan="2" | Number of individual elements the buffer can store, default 1.&nbsp;
−
 
+
|-
−
For example 128 + 128 = 256 which would equate to 0 using an 8-bit buffer with rollover enabled.
+
| width="10%" align="center" | [[File:Fc9-type-16-icon.png]]
−
 
+
| width="90%" | Buffer Type
−
With rollover disabled the output would be set to 255 which is the max representable value.
+
|-
−
 
+
| colspan="2" | Sets the buffer data type.&nbsp;
−
<span style="font-weight: normal;"><u>Initial Offset</u></span>
+
|-
−
 
+
| width="10%" align="center" style="background-color:#EAE1EA;" | [[File:Fc9-conn-icon.png]]
−
This property is of type ''Signed integer'' and can be referenced with the variable name ''InitialOffset''.
+
| width="90%" style="background-color:#EAE1EA; color:#4B008D;" | Offset
−
 
+
|-
−
''<span style="color:red;">No additional information</span>''
+
|-
 +
| width="10%" align="center" | [[File:Fc9-type-16-icon.png]]
 +
| width="90%" | Offset Type
 +
|-
 +
| colspan="2" | 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 &nbsp;
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-type-7-icon.png]]
 +
| width="90%" | Rollover
 +
|-
 +
| colspan="2" | 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.&nbsp;
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-type-14-icon.png]]
 +
| width="90%" | Initial Offset
 +
|-
 +
| colspan="2" | &nbsp;
 +
|}

Latest revision as of 17:19, 9 November 2022

Author Matrix Ltd
Version 1.1
Category DSP


Offset component

Allows the values in a single buffer to be offset uniformly. Functions include: Add, Subtract

Component Pack

DSP

Detailed description

No detailed description exists yet for this component

Examples

No additional examples


Downloadable macro reference

Fc9-comp-macro.png Calculate
Performs the selected offset on a value from the input buffer and passes to the output buffer. 
Fc9-void-icon.png - VOID Return


Fc9-comp-macro.png CalculateArray
Performs the selected offset on an entire buffer. 
Fc9-void-icon.png - VOID Return


Fc9-comp-macro.png SetOffset
Sets the Offset to be used when calling the calculate function. 
Fc9-s16-icon.png - INT Offset
 
Fc9-void-icon.png - VOID Return



Property reference

Fc9-prop-icon.png Properties
Fc9-type-16-icon.png Connect To
DSP component with output buffer to collect our data from. 
Fc9-type-21-icon.png Buffer Size
Number of individual elements the buffer can store, default 1. 
Fc9-type-16-icon.png Buffer Type
Sets the buffer data type. 
Fc9-conn-icon.png Offset
Fc9-type-16-icon.png 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  
Fc9-type-7-icon.png 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. 
Fc9-type-14-icon.png Initial Offset
 
Retrieved from "https://www.flowcode.co.uk/wikiv9/index.php?title=Component:_Offset_(DSP)&oldid=28541"