MfpgaSetDestination

See also

User Guide:

Source and destination image buffers Steps to develop a function that performs an operation using a Processing FPGA

Reference:

MbufAlloc1d MbufAllocColor MfpgaSetLink MfuncInquire

Availability

Available in MIL-Lite

Available in MIL

Available on Windows

Available on Linux

Not supported on:

Not supported on Host system (a)

Not supported on Matrox GigE Vision driver (MIL 10, Update 25, Update 54, or Update 85)* (c)

Not supported on Matrox Morphis (g)

Not supported on Matrox Morphis QxT (h)

Not supported on Matrox Orion HD (i)

Not supported on Matrox USB3 Vision driver (Update 19) (o)

Not supported on Matrox Radient eV-CL (Update 27 or 74) (r)

Not supported on Matrox Iris GTR (Update 28 or Update 68) (t)

Not supported on Matrox Clarity UHD (Update 36 or 76) (u)

Not supported on Matrox GenTL driver (Update 34) (v)

Not supported on Matrox Indio (Update 53 or Update 68) (w)

Not supported on Matrox Concord PoE with ToE (Update 82) (z)

Not supported on Matrox Rapixo CL Pro (Update 96) (aa)

Partially supported on:

Partially supported on Matrox Solios eA/XA (l)

Partially supported on Matrox Solios ecl/xcl/ev-cl (m)

Fully supported on:

Fully supported on Matrox Radient eCL (j)

Fully supported on Matrox Radient eV-CXP (MIL 10 or Update 29)* (k)

Fully supported on Matrox RadientPro-CL (Update 7) (p)

Fully supported on Matrox Rapixo CXP (Update 75 or Update 84) (y)

* Refer to the MIL system-specific information
in the MIL Reference for the minimum update required.

For any information regarding a MIL system added during a MIL Update, see the MIL system’s release note

Available on Non-Matrox computer

Available on Matrox 4Sight-X

Available on Matrox 4Sight GP/GPm

Available on Matrox Supersight

Function map

Examples

fdkoffsetgainlutmapprimitive.cpp
fdkoffsetgainprimitive.cpp
lutmapprimitive.cpp

Function Map

- DstBuf

Table:

For specifying the rank of the stream output port

- ControlFlag

Compilation information

Synopsis

Specify a destination buffer for the FPGA processing operation.

Syntax

void MfpgaSetDestination(

MIL_FPGA_CONTEXT FpgaCommandContext,	//in
MIL_BUFFER_INFO DstBuf,	//in
MIL_INT StreamOutputNumber,	//in
MIL_INT64 ControlFlag	//in

)

Description

This function specifies a destination buffer for the FPGA processing operation. This buffer is used to save the data from the specified stream output port of the PU associated with the specified FPGA command context. To route the data to another PU, refer to MfpgaSetLink().

All PUs have documented limitations on the types of buffers to which their stream output port(s) can output data. You must keep these limitations in mind when allocating your destination MIL buffer(s). This function will not automatically convert the buffers so that they are appropriate for the operation. For more information, refer to the PU documentation available in the Matrox FPGA Component Reference help file.

Note that in general, child buffers are not supported; only color-band child buffers are supported.

[Matrox Solios eA/XA; Matrox Solios ecl/xcl/ev-cl]

When allocating destination buffers on Matrox Solios, special care should be taken regarding the buffer width. The width of buffers allocated in acquisition memory must be a multiple of 64 bytes. The width of destination buffers on the Host must be a multiple of 8 bytes.

Note that this function reference has not been updated for a MIL system added during a MIL update. Refer to the MIL system's release note to see which MIL system’s documentation you should use in its place and any possible differences.

Parameters

This function is not supported on the selected boards.

This function reference has not been updated for the selected MIL system. To show the content of this page, choose a second MIL system; refer to the MIL system's release note to see which MIL system’s documentation to choose and any possible differences.

Parameters

FpgaCommandContext

Specifies the handle of the FPGA command context associated with the PU.

DstBuf

Specifies the handle of the destination buffer. Use MfuncInquire() with M_BUFFER_INFO to get the handle. The destination buffer can reside in Host memory or in on-board memory, if supported by the FPGA configuration. If allocated in Host memory, the destination buffer must be in non-paged, Processing FPGA accessible memory (using MbufAlloc...() with M_FPGA_ACCESSIBLE + M_HOST_MEMORY). If allocated on-board, the destination buffer must be allocated in on-board, Processing FPGA accessible memory (using MbufAlloc...() with M_FPGA_ACCESSIBLE).

StreamOutputNumber

Specifies the stream output port whose data will be routed to the destination buffer. You must set this parameter to the following value:

For specifying the rank of the stream output port
Value	Description	MIL system-specific tooltip (‡)
M_OUTPUTn	Specifies the rank of the stream output port. You can set n to a value between 0 and 9, inclusive. (summarize) Specifies the rank of the stream output port. (more details...)	‡	j	k M10	l	m	p	y U75