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

Revision as of 11:59, 3 February 2023

Author	Matrix TSL
Version	1.0
Category	DSP

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_temp/DSP_Buff_Ref.fcfx

Please click here to view the component source code (Beta): FC_Comp_Source_temp/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

@@ Line 17: / Line 17: @@
 ==Component Source Code==
-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 download the component source project: [https://www.flowcode.co.uk/wiki/componentsource/FC_Comp_Source_temp/DSP_Buff_Ref.fcfx FC_Comp_Source_temp/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]
+Please click here to view the component source code (Beta): [https://www.flowcode.co.uk/FlowchartView/?wfile=componentsource/FC_Comp_Source_temp/DSP_Buff_Ref.fcfx FC_Comp_Source_temp/DSP_Buff_Ref.fcfx]
 ==Detailed description==
@@ Line 72: / Line 72: @@
 ''<span style="color:red;">No additional examples</span>''
@@ Line 79: / Line 81: @@
 ==Macro reference==
-===Prv_PutPropStr===
+===Prv_GetConsole===
 {| 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;" | '''Prv_PutPropStr'''
+| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''Prv_GetConsole'''
 |-
 | colspan="2" | &nbsp;
@@ Line 93: / Line 95: @@
 | colspan="2" | &nbsp;
 |-
-| width="10%" align="center" | [[File:Fc9-u16-icon.png]] - UINT
+| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-u32-icon.png]] - ULONG
-| width="90%" | Val
-|-
-| 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''
 |}
-===Prv_PutConsole===
+===Prv_GetPropStr===
 {| 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;" | '''Prv_PutConsole'''
+| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''Prv_GetPropStr'''
 |-
 | colspan="2" | &nbsp;
@@ Line 117: / Line 114: @@
 | colspan="2" | &nbsp;
 |-
-| width="10%" align="center" | [[File:Fc9-u32-icon.png]] - ULONG
+| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-u16-icon.png]] - UINT
-| width="90%" | Val
-|-
-| 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''
 |}
-===get===
+===Prv_PutConsole===
 {| 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;" | '''get'''
+| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''Prv_PutConsole'''
 |-
-| colspan="2" | Embedded - Get/Set uses Type Specified to maintain efficiency Sim - Reverts to long type so 8/16 bit will also fit&nbsp;
+| colspan="2" | &nbsp;
 |-
 |-
@@ Line 141: / Line 133: @@
 | colspan="2" | &nbsp;
 |-
-| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-s32-icon.png]] - LONG
+| width="10%" align="center" | [[File:Fc9-u32-icon.png]] - ULONG
+| width="90%" | Val
+|-
+| 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''
 |}
-===put===
+===Prv_PutPropStr===
 {| 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;" | '''put'''
+| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''Prv_PutPropStr'''
 |-
-| colspan="2" | Embedded - Get/Set uses Type Specified to maintain efficiency Sim - Reverts to long type so 8/16 bit will also fit&nbsp;
+| colspan="2" | &nbsp;
 |-
 |-
@@ Line 160: / Line 157: @@
 | colspan="2" | &nbsp;
 |-
-| width="10%" align="center" | [[File:Fc9-s32-icon.png]] - LONG
+| width="10%" align="center" | [[File:Fc9-u16-icon.png]] - UINT
 | width="90%" | Val
 |-
@@ Line 170: / Line 167: @@
-===put_float===
+===SetHandle===
 {| 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;" | '''put_float'''
+| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''SetHandle'''
 |-
-| colspan="2" | Embedded - Get/Set uses Type Specified to maintain efficiency Sim - Reverts to long type so 8/16 bit will also fit&nbsp;
+| colspan="2" | &nbsp;
 |-
 |-
-| width="10%" align="center" | [[File:Fc9-u16-icon.png]] - UINT
+| width="10%" align="center" | [[File:Fc9-h32-icon.png]] - HANDLE
-| width="90%" | Idx
+| width="90%" | Handle
-|-
-| colspan="2" | &nbsp;
-|-
-| width="10%" align="center" | [[File:Fc9-f32-icon.png]] - FLOAT
-| width="90%" | Val
 |-
 | colspan="2" | &nbsp;
@@ Line 194: / Line 186: @@
-===Prv_GetPropStr===
+===get===
 {| 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;" | '''Prv_GetPropStr'''
+| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''get'''
 |-
-| colspan="2" | &nbsp;
+| colspan="2" | Embedded - Get/Set uses Type Specified to maintain efficiency Sim - Reverts to long type so 8/16 bit will also fit&nbsp;
 |-
 |-
@@ Line 208: / Line 200: @@
 | colspan="2" | &nbsp;
 |-
-| 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-s32-icon.png]] - LONG
 | width="90%" style="border-top: 2px solid #000;" | ''Return''
 |}
-===Prv_GetConsole===
+===get_float===
 {| 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;" | '''Prv_GetConsole'''
+| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''get_float'''
 |-
-| colspan="2" | &nbsp;
+| colspan="2" | Embedded - Get/Set uses Type Specified to maintain efficiency Sim - Reverts to long type so 8/16 bit will also fit&nbsp;
 |-
 |-
@@ Line 227: / Line 219: @@
 | colspan="2" | &nbsp;
 |-
-| 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-f32-icon.png]] - FLOAT
 | width="90%" style="border-top: 2px solid #000;" | ''Return''
 |}
-===SetHandle===
+===put===
 {| 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;" | '''SetHandle'''
+| 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&nbsp;
+|-
+|-
+| width="10%" align="center" | [[File:Fc9-u16-icon.png]] - UINT
+| width="90%" | Idx
 |-
 | colspan="2" | &nbsp;
 |-
-|-
+| width="10%" align="center" | [[File:Fc9-s32-icon.png]] - LONG
-| width="10%" align="center" | [[File:Fc9-h32-icon.png]] - HANDLE
+| width="90%" | Val
-| width="90%" | Handle
 |-
 | colspan="2" | &nbsp;
@@ Line 251: / Line 248: @@
-===get_float===
+===put_float===
 {| 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;" | '''get_float'''
+| 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&nbsp;
@@ Line 265: / Line 262: @@
 | colspan="2" | &nbsp;
 |-
-| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-f32-icon.png]] - FLOAT
+| width="10%" align="center" | [[File:Fc9-f32-icon.png]] - FLOAT
+| width="90%" | Val
+|-
+| 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''
 |}

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

Revision as of 11:59, 3 February 2023

Contents