Difference between revisions of "Component: DSPBufferRef (DSP)"
From Flowcode Help
Jump to navigationJump to search| (11 intermediate revisions by the same user not shown) | |||
| Line 17: | Line 17: | ||
==Component Source Code== | ==Component Source Code== | ||
| − | Please click here | + | Please click here to download the component source project: [https://www.flowcode.co.uk/wiki/componentsource/FC_Comp_Source_DSP_Buff_Ref.fcfx FC_Comp_Source_DSP_Buff_Ref.fcfx] |
| + | |||
| + | Please click here to view the component source code (Beta): [https://www.flowcode.co.uk/FlowchartView/?wfile=componentsource/FC_Comp_Source_DSP_Buff_Ref.fcfx FC_Comp_Source_DSP_Buff_Ref.fcfx] | ||
==Detailed description== | ==Detailed description== | ||
| + | |||
| + | |||
| + | |||
| + | |||
| + | |||
| + | |||
| + | |||
| + | |||
| + | |||
| + | |||
| + | |||
| + | |||
| Line 34: | Line 48: | ||
==Examples== | ==Examples== | ||
| + | |||
| + | |||
| + | |||
| + | |||
| + | |||
| + | |||
| + | |||
| + | |||
| + | |||
| + | |||
| + | |||
| + | |||
| Line 47: | Line 73: | ||
''<span style="color:red;">No additional examples</span>'' | ''<span style="color:red;">No additional examples</span>'' | ||
| − | |||
| + | |||
| + | |||
| + | |||
| + | |||
| + | |||
| + | |||
| + | |||
| + | |||
| + | |||
| + | |||
| + | |||
| + | |||
| + | |||
| + | ==Macro reference== | ||
| + | |||
| + | ===Prv_GetConsole=== | ||
{| class="wikitable" style="width:60%; background-color:#FFFFFF;" | {| class="wikitable" style="width:60%; background-color:#FFFFFF;" | ||
|- | |- | ||
| width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]] | | width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]] | ||
| − | | width="90%" style="background-color:#D8C9D8; color:#4B008D;" | ''' | + | | width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''Prv_GetConsole''' |
|- | |- | ||
| colspan="2" | | | colspan="2" | | ||
| Line 62: | Line 103: | ||
| colspan="2" | | | colspan="2" | | ||
|- | |- | ||
| − | + | | width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-u32-icon.png]] - ULONG | |
| − | |||
| − | |||
| − | |||
| − | |||
| − | | width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9- | ||
| width="90%" style="border-top: 2px solid #000;" | ''Return'' | | width="90%" style="border-top: 2px solid #000;" | ''Return'' | ||
|} | |} | ||
| + | ===Prv_GetPropStr=== | ||
{| class="wikitable" style="width:60%; background-color:#FFFFFF;" | {| class="wikitable" style="width:60%; background-color:#FFFFFF;" | ||
|- | |- | ||
| width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]] | | width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]] | ||
| − | | width="90%" style="background-color:#D8C9D8; color:#4B008D;" | ''' | + | | width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''Prv_GetPropStr''' |
|- | |- | ||
| colspan="2" | | | colspan="2" | | ||
| Line 85: | Line 122: | ||
| colspan="2" | | | colspan="2" | | ||
|- | |- | ||
| − | + | | width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-u16-icon.png]] - UINT | |
| − | |||
| − | |||
| − | |||
| − | |||
| − | | width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9- | ||
| width="90%" style="border-top: 2px solid #000;" | ''Return'' | | width="90%" style="border-top: 2px solid #000;" | ''Return'' | ||
|} | |} | ||
| + | ===Prv_PutConsole=== | ||
{| class="wikitable" style="width:60%; background-color:#FFFFFF;" | {| class="wikitable" style="width:60%; background-color:#FFFFFF;" | ||
|- | |- | ||
| width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]] | | width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]] | ||
| − | | width="90%" style="background-color:#D8C9D8; color:#4B008D;" | ''' | + | | width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''Prv_PutConsole''' |
|- | |- | ||
| − | | colspan="2" | | + | | colspan="2" | |
|- | |- | ||
|- | |- | ||
| Line 108: | Line 141: | ||
| colspan="2" | | | colspan="2" | | ||
|- | |- | ||
| − | | width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9- | + | | width="10%" align="center" | [[File:Fc9-u32-icon.png]] - ULONG |
| + | | width="90%" | Val | ||
| + | |- | ||
| + | | colspan="2" | | ||
| + | |- | ||
| + | | 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'' | | width="90%" style="border-top: 2px solid #000;" | ''Return'' | ||
|} | |} | ||
| + | ===Prv_PutPropStr=== | ||
{| class="wikitable" style="width:60%; background-color:#FFFFFF;" | {| class="wikitable" style="width:60%; background-color:#FFFFFF;" | ||
|- | |- | ||
| width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]] | | width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]] | ||
| − | | width="90%" style="background-color:#D8C9D8; color:#4B008D;" | ''' | + | | width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''Prv_PutPropStr''' |
|- | |- | ||
| − | | colspan="2" | | + | | colspan="2" | |
|- | |- | ||
|- | |- | ||
| Line 126: | Line 165: | ||
| colspan="2" | | | colspan="2" | | ||
|- | |- | ||
| − | | width="10%" align="center" | [[File:Fc9- | + | | width="10%" align="center" | [[File:Fc9-u16-icon.png]] - UINT |
| width="90%" | Val | | width="90%" | Val | ||
|- | |- | ||
| Line 136: | Line 175: | ||
| + | ===SetHandle=== | ||
{| class="wikitable" style="width:60%; background-color:#FFFFFF;" | {| class="wikitable" style="width:60%; background-color:#FFFFFF;" | ||
|- | |- | ||
| width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]] | | width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]] | ||
| − | | width="90%" style="background-color:#D8C9D8; color:#4B008D;" | ''' | + | | width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''SetHandle''' |
|- | |- | ||
| − | | colspan="2" | | + | | colspan="2" | |
|- | |- | ||
|- | |- | ||
| − | | width="10%" align="center" | [[File:Fc9- | + | | width="10%" align="center" | [[File:Fc9-h32-icon.png]] - HANDLE |
| − | | width="90%" | | + | | width="90%" | Handle |
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
|- | |- | ||
| colspan="2" | | | colspan="2" | | ||
| Line 159: | Line 194: | ||
| + | ===get=== | ||
{| class="wikitable" style="width:60%; background-color:#FFFFFF;" | {| class="wikitable" style="width:60%; background-color:#FFFFFF;" | ||
|- | |- | ||
| width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]] | | width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]] | ||
| − | | width="90%" style="background-color:#D8C9D8; color:#4B008D;" | ''' | + | | width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''get''' |
|- | |- | ||
| − | | colspan="2" | | + | | colspan="2" | Embedded - Get/Set uses Type Specified to maintain efficiency Sim - Reverts to long type so 8/16 bit will also fit |
|- | |- | ||
|- | |- | ||
| Line 172: | Line 208: | ||
| colspan="2" | | | colspan="2" | | ||
|- | |- | ||
| − | | width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9- | + | | width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-s32-icon.png]] - LONG |
| width="90%" style="border-top: 2px solid #000;" | ''Return'' | | width="90%" style="border-top: 2px solid #000;" | ''Return'' | ||
|} | |} | ||
| + | ===get_float=== | ||
{| class="wikitable" style="width:60%; background-color:#FFFFFF;" | {| class="wikitable" style="width:60%; background-color:#FFFFFF;" | ||
|- | |- | ||
| width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]] | | width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]] | ||
| − | | width="90%" style="background-color:#D8C9D8; color:#4B008D;" | ''' | + | | width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''get_float''' |
|- | |- | ||
| − | | colspan="2" | | + | | colspan="2" | Embedded - Get/Set uses Type Specified to maintain efficiency Sim - Reverts to long type so 8/16 bit will also fit |
|- | |- | ||
|- | |- | ||
| Line 190: | Line 227: | ||
| colspan="2" | | | colspan="2" | | ||
|- | |- | ||
| − | | width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9- | + | | width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-f32-icon.png]] - FLOAT |
| width="90%" style="border-top: 2px solid #000;" | ''Return'' | | width="90%" style="border-top: 2px solid #000;" | ''Return'' | ||
|} | |} | ||
| + | ===put=== | ||
{| class="wikitable" style="width:60%; background-color:#FFFFFF;" | {| class="wikitable" style="width:60%; background-color:#FFFFFF;" | ||
|- | |- | ||
| width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]] | | width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]] | ||
| − | | width="90%" style="background-color:#D8C9D8; color:#4B008D;" | ''' | + | | width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''put''' |
| + | |- | ||
| + | | colspan="2" | Embedded - Get/Set uses Type Specified to maintain efficiency Sim - Reverts to long type so 8/16 bit will also fit | ||
| + | |- | ||
| + | |- | ||
| + | | width="10%" align="center" | [[File:Fc9-u16-icon.png]] - UINT | ||
| + | | width="90%" | Idx | ||
|- | |- | ||
| colspan="2" | | | colspan="2" | | ||
|- | |- | ||
| − | + | | width="10%" align="center" | [[File:Fc9-s32-icon.png]] - LONG | |
| − | | width="10%" align="center" | [[File:Fc9- | + | | width="90%" | Val |
| − | | width="90%" | | ||
|- | |- | ||
| colspan="2" | | | colspan="2" | | ||
| Line 213: | Line 256: | ||
| + | ===put_float=== | ||
{| class="wikitable" style="width:60%; background-color:#FFFFFF;" | {| class="wikitable" style="width:60%; background-color:#FFFFFF;" | ||
|- | |- | ||
| width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]] | | width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]] | ||
| − | | width="90%" style="background-color:#D8C9D8; color:#4B008D;" | ''' | + | | width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''put_float''' |
|- | |- | ||
| colspan="2" | Embedded - Get/Set uses Type Specified to maintain efficiency Sim - Reverts to long type so 8/16 bit will also fit | | colspan="2" | Embedded - Get/Set uses Type Specified to maintain efficiency Sim - Reverts to long type so 8/16 bit will also fit | ||
| Line 226: | Line 270: | ||
| colspan="2" | | | colspan="2" | | ||
|- | |- | ||
| − | | width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9- | + | | width="10%" align="center" | [[File:Fc9-f32-icon.png]] - FLOAT |
| + | | width="90%" | Val | ||
| + | |- | ||
| + | | colspan="2" | | ||
| + | |- | ||
| + | | 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'' | | width="90%" style="border-top: 2px solid #000;" | ''Return'' | ||
|} | |} | ||
| − | |||
| − | |||
| Line 278: | Line 325: | ||
| width="10%" align="center" | [[File:Fc9-type-16-icon.png]] | | width="10%" align="center" | [[File:Fc9-type-16-icon.png]] | ||
| width="90%" | Orientation | | width="90%" | Orientation | ||
| + | |- | ||
| + | | colspan="2" | | ||
| + | |- | ||
| + | | width="10%" align="center" | [[File:Fc9-type-12-icon.png]] | ||
| + | | width="90%" | Style | ||
| + | |- | ||
| + | | colspan="2" | Outline line style | ||
| + | |- | ||
| + | | width="10%" align="center" | [[File:Fc9-type-15-icon.png]] | ||
| + | | width="90%" | Thickness | ||
| + | |- | ||
| + | | colspan="2" | Thickness of the line | ||
| + | |- | ||
| + | | width="10%" align="center" | [[File:Fc9-type-2-icon.png]] | ||
| + | | width="90%" | Colour | ||
| + | |- | ||
| + | | colspan="2" | Colour of the line | ||
| + | |- | ||
| + | | width="10%" align="center" | [[File:Fc9-type-21-icon.png]] | ||
| + | | width="90%" | TimerRetryCount | ||
|- | |- | ||
| colspan="2" | | | colspan="2" | | ||
|} | |} | ||
Latest revision as of 15:07, 5 December 2023
| Author | Matrix TSL |
| Version | 1.0 |
| Category | DSP |
Contents
DSPBufferRef component
Reference and access to a specific DSP buffer inside another DSP component. Used for a DSP component input buffer.
Component Source Code
Please click here to download the component source project: FC_Comp_Source_DSP_Buff_Ref.fcfx
Please click here to view the component source code (Beta): FC_Comp_Source_DSP_Buff_Ref.fcfx
Detailed description
No detailed description exists yet for this component
Examples
No additional examples
Macro reference
Prv_GetConsole
|
Prv_GetConsole |
 - UINT
|
Idx |
 - ULONG
|
Return |
Prv_GetPropStr
|
|
Prv_GetPropStr |
| - UINT
|
Idx |
| - UINT
|
Return |
Prv_PutConsole
|
|
Prv_PutConsole |
| - UINT
|
Idx |
| - ULONG
|
Val |
 - VOID
|
Return |
Prv_PutPropStr
|
|
Prv_PutPropStr |
| - UINT
|
Idx |
| - UINT
|
Val |
| - VOID
|
Return |
SetHandle
|
|
SetHandle |
 - HANDLE
|
Handle |
| - VOID
|
Return |
get
|
|
get |
| Embedded - Get/Set uses Type Specified to maintain efficiency Sim - Reverts to long type so 8/16 bit will also fit | |
| - UINT
|
Idx |
 - LONG
|
Return |
get_float
|
|
get_float |
| Embedded - Get/Set uses Type Specified to maintain efficiency Sim - Reverts to long type so 8/16 bit will also fit | |
| - UINT
|
Idx |
 - FLOAT
|
Return |
put
|
|
put |
| Embedded - Get/Set uses Type Specified to maintain efficiency Sim - Reverts to long type so 8/16 bit will also fit | |
| - UINT
|
Idx |
| - LONG
|
Val |
| - VOID
|
Return |
put_float
|
|
put_float |
| Embedded - Get/Set uses Type Specified to maintain efficiency Sim - Reverts to long type so 8/16 bit will also fit | |
| - UINT
|
Idx |
| - FLOAT
|
Val |
| - VOID
|
Return |
Property reference
|
Properties |
|
Link To |
| DSP component with output buffer to collect our data from. | |
|
Subname |
|
Subhandle |
|
|
Buffer Size |
|
|
Buffer Type |
|
|
Console Handle |
|
|
Text |
|
|
Orientation |
|
Style |
| Outline line style | |
|
Thickness |
| Thickness of the line | |
|
Colour |
| Colour of the line | |
|
|
TimerRetryCount |
